eval-studio-client 1.2.0a1__py3-none-any.whl → 1.2.0a2__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- eval_studio_client/api/__init__.py +20 -0
- eval_studio_client/api/api/__init__.py +1 -0
- eval_studio_client/api/api/dashboard_service_api.py +1134 -73
- eval_studio_client/api/api/info_service_api.py +240 -0
- eval_studio_client/api/api/test_service_api.py +1233 -172
- eval_studio_client/api/api/workflow_result_service_api.py +1057 -0
- eval_studio_client/api/api/workflow_service_api.py +1420 -101
- eval_studio_client/api/docs/DashboardServiceApi.md +272 -0
- eval_studio_client/api/docs/InfoServiceApi.md +63 -0
- eval_studio_client/api/docs/TestServiceApi.md +268 -0
- eval_studio_client/api/docs/TestServiceGrantTestAccessRequest.md +30 -0
- eval_studio_client/api/docs/TestServiceRevokeTestAccessRequest.md +30 -0
- eval_studio_client/api/docs/V1FindWorkflowsByCollectionIDResponse.md +29 -0
- eval_studio_client/api/docs/V1GetStatsResponse.md +29 -0
- eval_studio_client/api/docs/V1GetWorkflowResultCorpusPatchResponse.md +29 -0
- eval_studio_client/api/docs/V1GetWorkflowResultReportResponse.md +29 -0
- eval_studio_client/api/docs/V1GetWorkflowResultSummaryResponse.md +32 -0
- eval_studio_client/api/docs/V1GetWorkflowResultSystemPromptPatchResponse.md +29 -0
- eval_studio_client/api/docs/V1Info.md +1 -0
- eval_studio_client/api/docs/V1ListDashboardAccessResponse.md +29 -0
- eval_studio_client/api/docs/V1ListDashboardsSharedWithMeResponse.md +29 -0
- eval_studio_client/api/docs/V1ListTestAccessResponse.md +29 -0
- eval_studio_client/api/docs/V1ListTestsSharedWithMeResponse.md +29 -0
- eval_studio_client/api/docs/V1ListWorkflowAccessResponse.md +29 -0
- eval_studio_client/api/docs/V1ListWorkflowsSharedWithMeResponse.md +29 -0
- eval_studio_client/api/docs/V1Role.md +12 -0
- eval_studio_client/api/docs/V1RoleBinding.md +32 -0
- eval_studio_client/api/docs/V1Stats.md +31 -0
- eval_studio_client/api/docs/V1WorkflowResultArtifactType.md +12 -0
- eval_studio_client/api/docs/WorkflowResultServiceApi.md +280 -0
- eval_studio_client/api/docs/WorkflowServiceApi.md +345 -5
- eval_studio_client/api/docs/WorkflowServiceRevokeWorkflowAccessRequest.md +30 -0
- eval_studio_client/api/models/__init__.py +19 -0
- eval_studio_client/api/models/test_service_grant_test_access_request.py +90 -0
- eval_studio_client/api/models/test_service_revoke_test_access_request.py +90 -0
- eval_studio_client/api/models/v1_find_workflows_by_collection_id_response.py +95 -0
- eval_studio_client/api/models/v1_get_stats_response.py +91 -0
- eval_studio_client/api/models/v1_get_workflow_result_corpus_patch_response.py +87 -0
- eval_studio_client/api/models/v1_get_workflow_result_report_response.py +87 -0
- eval_studio_client/api/models/v1_get_workflow_result_summary_response.py +94 -0
- eval_studio_client/api/models/v1_get_workflow_result_system_prompt_patch_response.py +87 -0
- eval_studio_client/api/models/v1_info.py +4 -2
- eval_studio_client/api/models/v1_list_dashboard_access_response.py +95 -0
- eval_studio_client/api/models/v1_list_dashboards_shared_with_me_response.py +95 -0
- eval_studio_client/api/models/v1_list_test_access_response.py +95 -0
- eval_studio_client/api/models/v1_list_tests_shared_with_me_response.py +95 -0
- eval_studio_client/api/models/v1_list_workflow_access_response.py +95 -0
- eval_studio_client/api/models/v1_list_workflows_shared_with_me_response.py +95 -0
- eval_studio_client/api/models/v1_role.py +38 -0
- eval_studio_client/api/models/v1_role_binding.py +92 -0
- eval_studio_client/api/models/v1_stats.py +99 -0
- eval_studio_client/api/models/v1_workflow_result_artifact_type.py +40 -0
- eval_studio_client/api/models/workflow_service_revoke_workflow_access_request.py +90 -0
- eval_studio_client/api/test/test_dashboard_service_api.py +28 -0
- eval_studio_client/api/test/test_info_service_api.py +6 -0
- eval_studio_client/api/test/test_test_service_api.py +24 -0
- eval_studio_client/api/test/test_test_service_grant_test_access_request.py +52 -0
- eval_studio_client/api/test/test_test_service_revoke_test_access_request.py +52 -0
- eval_studio_client/api/test/test_v1_find_workflows_by_collection_id_response.py +95 -0
- eval_studio_client/api/test/test_v1_get_info_response.py +2 -1
- eval_studio_client/api/test/test_v1_get_stats_response.py +53 -0
- eval_studio_client/api/test/test_v1_get_workflow_result_corpus_patch_response.py +51 -0
- eval_studio_client/api/test/test_v1_get_workflow_result_report_response.py +51 -0
- eval_studio_client/api/test/test_v1_get_workflow_result_summary_response.py +58 -0
- eval_studio_client/api/test/test_v1_get_workflow_result_system_prompt_patch_response.py +51 -0
- eval_studio_client/api/test/test_v1_info.py +2 -1
- eval_studio_client/api/test/test_v1_list_dashboard_access_response.py +56 -0
- eval_studio_client/api/test/test_v1_list_dashboards_shared_with_me_response.py +69 -0
- eval_studio_client/api/test/test_v1_list_test_access_response.py +56 -0
- eval_studio_client/api/test/test_v1_list_tests_shared_with_me_response.py +70 -0
- eval_studio_client/api/test/test_v1_list_workflow_access_response.py +56 -0
- eval_studio_client/api/test/test_v1_list_workflows_shared_with_me_response.py +95 -0
- eval_studio_client/api/test/test_v1_role.py +33 -0
- eval_studio_client/api/test/test_v1_role_binding.py +53 -0
- eval_studio_client/api/test/test_v1_stats.py +52 -0
- eval_studio_client/api/test/test_v1_workflow_result_artifact_type.py +33 -0
- eval_studio_client/api/test/test_workflow_result_service_api.py +59 -0
- eval_studio_client/api/test/test_workflow_service_api.py +35 -0
- eval_studio_client/api/test/test_workflow_service_revoke_workflow_access_request.py +52 -0
- eval_studio_client/gen/openapiv2/eval_studio.swagger.json +905 -16
- {eval_studio_client-1.2.0a1.dist-info → eval_studio_client-1.2.0a2.dist-info}/METADATA +2 -1
- {eval_studio_client-1.2.0a1.dist-info → eval_studio_client-1.2.0a2.dist-info}/RECORD +83 -23
- {eval_studio_client-1.2.0a1.dist-info → eval_studio_client-1.2.0a2.dist-info}/WHEEL +0 -0
|
@@ -0,0 +1,1057 @@
|
|
|
1
|
+
# coding: utf-8
|
|
2
|
+
|
|
3
|
+
"""
|
|
4
|
+
ai/h2o/eval_studio/v1/insight.proto
|
|
5
|
+
|
|
6
|
+
No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
7
|
+
|
|
8
|
+
The version of the OpenAPI document: version not set
|
|
9
|
+
Generated by OpenAPI Generator (https://openapi-generator.tech)
|
|
10
|
+
|
|
11
|
+
Do not edit the class manually.
|
|
12
|
+
""" # noqa: E501
|
|
13
|
+
|
|
14
|
+
import warnings
|
|
15
|
+
from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt
|
|
16
|
+
from typing import Any, Dict, List, Optional, Tuple, Union
|
|
17
|
+
from typing_extensions import Annotated
|
|
18
|
+
|
|
19
|
+
from pydantic import Field, field_validator
|
|
20
|
+
from typing_extensions import Annotated
|
|
21
|
+
from eval_studio_client.api.models.v1_get_workflow_result_corpus_patch_response import V1GetWorkflowResultCorpusPatchResponse
|
|
22
|
+
from eval_studio_client.api.models.v1_get_workflow_result_report_response import V1GetWorkflowResultReportResponse
|
|
23
|
+
from eval_studio_client.api.models.v1_get_workflow_result_summary_response import V1GetWorkflowResultSummaryResponse
|
|
24
|
+
from eval_studio_client.api.models.v1_get_workflow_result_system_prompt_patch_response import V1GetWorkflowResultSystemPromptPatchResponse
|
|
25
|
+
|
|
26
|
+
from eval_studio_client.api.api_client import ApiClient, RequestSerialized
|
|
27
|
+
from eval_studio_client.api.api_response import ApiResponse
|
|
28
|
+
from eval_studio_client.api.rest import RESTResponseType
|
|
29
|
+
|
|
30
|
+
|
|
31
|
+
class WorkflowResultServiceApi:
|
|
32
|
+
"""NOTE: This class is auto generated by OpenAPI Generator
|
|
33
|
+
Ref: https://openapi-generator.tech
|
|
34
|
+
|
|
35
|
+
Do not edit the class manually.
|
|
36
|
+
"""
|
|
37
|
+
|
|
38
|
+
def __init__(self, api_client=None) -> None:
|
|
39
|
+
if api_client is None:
|
|
40
|
+
api_client = ApiClient.get_default()
|
|
41
|
+
self.api_client = api_client
|
|
42
|
+
|
|
43
|
+
|
|
44
|
+
@validate_call
|
|
45
|
+
def workflow_result_service_get_workflow_result_corpus_patch(
|
|
46
|
+
self,
|
|
47
|
+
name_14: Annotated[str, Field(strict=True, description="Required. The name of the corpus patch workflow for which to retrieve the corpus patch.")],
|
|
48
|
+
_request_timeout: Union[
|
|
49
|
+
None,
|
|
50
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
51
|
+
Tuple[
|
|
52
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
53
|
+
Annotated[StrictFloat, Field(gt=0)]
|
|
54
|
+
]
|
|
55
|
+
] = None,
|
|
56
|
+
_request_auth: Optional[Dict[StrictStr, Any]] = None,
|
|
57
|
+
_content_type: Optional[StrictStr] = None,
|
|
58
|
+
_headers: Optional[Dict[StrictStr, Any]] = None,
|
|
59
|
+
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
|
|
60
|
+
) -> V1GetWorkflowResultCorpusPatchResponse:
|
|
61
|
+
"""GetWorkflowResultCorpusPatch retrieves the corpus patch of a Workflow result. The corpus patch is a HTML document that contains questions and answers identified as problematic in HEC and RT IV workflow steps.
|
|
62
|
+
|
|
63
|
+
|
|
64
|
+
:param name_14: Required. The name of the corpus patch workflow for which to retrieve the corpus patch. (required)
|
|
65
|
+
:type name_14: str
|
|
66
|
+
:param _request_timeout: timeout setting for this request. If one
|
|
67
|
+
number provided, it will be total request
|
|
68
|
+
timeout. It can also be a pair (tuple) of
|
|
69
|
+
(connection, read) timeouts.
|
|
70
|
+
:type _request_timeout: int, tuple(int, int), optional
|
|
71
|
+
:param _request_auth: set to override the auth_settings for an a single
|
|
72
|
+
request; this effectively ignores the
|
|
73
|
+
authentication in the spec for a single request.
|
|
74
|
+
:type _request_auth: dict, optional
|
|
75
|
+
:param _content_type: force content-type for the request.
|
|
76
|
+
:type _content_type: str, Optional
|
|
77
|
+
:param _headers: set to override the headers for a single
|
|
78
|
+
request; this effectively ignores the headers
|
|
79
|
+
in the spec for a single request.
|
|
80
|
+
:type _headers: dict, optional
|
|
81
|
+
:param _host_index: set to override the host_index for a single
|
|
82
|
+
request; this effectively ignores the host_index
|
|
83
|
+
in the spec for a single request.
|
|
84
|
+
:type _host_index: int, optional
|
|
85
|
+
:return: Returns the result object.
|
|
86
|
+
""" # noqa: E501
|
|
87
|
+
|
|
88
|
+
_param = self._workflow_result_service_get_workflow_result_corpus_patch_serialize(
|
|
89
|
+
name_14=name_14,
|
|
90
|
+
_request_auth=_request_auth,
|
|
91
|
+
_content_type=_content_type,
|
|
92
|
+
_headers=_headers,
|
|
93
|
+
_host_index=_host_index
|
|
94
|
+
)
|
|
95
|
+
|
|
96
|
+
_response_types_map: Dict[str, Optional[str]] = {
|
|
97
|
+
'200': "V1GetWorkflowResultCorpusPatchResponse",
|
|
98
|
+
}
|
|
99
|
+
response_data = self.api_client.call_api(
|
|
100
|
+
*_param,
|
|
101
|
+
_request_timeout=_request_timeout
|
|
102
|
+
)
|
|
103
|
+
response_data.read()
|
|
104
|
+
return self.api_client.response_deserialize(
|
|
105
|
+
response_data=response_data,
|
|
106
|
+
response_types_map=_response_types_map,
|
|
107
|
+
).data
|
|
108
|
+
|
|
109
|
+
|
|
110
|
+
@validate_call
|
|
111
|
+
def workflow_result_service_get_workflow_result_corpus_patch_with_http_info(
|
|
112
|
+
self,
|
|
113
|
+
name_14: Annotated[str, Field(strict=True, description="Required. The name of the corpus patch workflow for which to retrieve the corpus patch.")],
|
|
114
|
+
_request_timeout: Union[
|
|
115
|
+
None,
|
|
116
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
117
|
+
Tuple[
|
|
118
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
119
|
+
Annotated[StrictFloat, Field(gt=0)]
|
|
120
|
+
]
|
|
121
|
+
] = None,
|
|
122
|
+
_request_auth: Optional[Dict[StrictStr, Any]] = None,
|
|
123
|
+
_content_type: Optional[StrictStr] = None,
|
|
124
|
+
_headers: Optional[Dict[StrictStr, Any]] = None,
|
|
125
|
+
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
|
|
126
|
+
) -> ApiResponse[V1GetWorkflowResultCorpusPatchResponse]:
|
|
127
|
+
"""GetWorkflowResultCorpusPatch retrieves the corpus patch of a Workflow result. The corpus patch is a HTML document that contains questions and answers identified as problematic in HEC and RT IV workflow steps.
|
|
128
|
+
|
|
129
|
+
|
|
130
|
+
:param name_14: Required. The name of the corpus patch workflow for which to retrieve the corpus patch. (required)
|
|
131
|
+
:type name_14: str
|
|
132
|
+
:param _request_timeout: timeout setting for this request. If one
|
|
133
|
+
number provided, it will be total request
|
|
134
|
+
timeout. It can also be a pair (tuple) of
|
|
135
|
+
(connection, read) timeouts.
|
|
136
|
+
:type _request_timeout: int, tuple(int, int), optional
|
|
137
|
+
:param _request_auth: set to override the auth_settings for an a single
|
|
138
|
+
request; this effectively ignores the
|
|
139
|
+
authentication in the spec for a single request.
|
|
140
|
+
:type _request_auth: dict, optional
|
|
141
|
+
:param _content_type: force content-type for the request.
|
|
142
|
+
:type _content_type: str, Optional
|
|
143
|
+
:param _headers: set to override the headers for a single
|
|
144
|
+
request; this effectively ignores the headers
|
|
145
|
+
in the spec for a single request.
|
|
146
|
+
:type _headers: dict, optional
|
|
147
|
+
:param _host_index: set to override the host_index for a single
|
|
148
|
+
request; this effectively ignores the host_index
|
|
149
|
+
in the spec for a single request.
|
|
150
|
+
:type _host_index: int, optional
|
|
151
|
+
:return: Returns the result object.
|
|
152
|
+
""" # noqa: E501
|
|
153
|
+
|
|
154
|
+
_param = self._workflow_result_service_get_workflow_result_corpus_patch_serialize(
|
|
155
|
+
name_14=name_14,
|
|
156
|
+
_request_auth=_request_auth,
|
|
157
|
+
_content_type=_content_type,
|
|
158
|
+
_headers=_headers,
|
|
159
|
+
_host_index=_host_index
|
|
160
|
+
)
|
|
161
|
+
|
|
162
|
+
_response_types_map: Dict[str, Optional[str]] = {
|
|
163
|
+
'200': "V1GetWorkflowResultCorpusPatchResponse",
|
|
164
|
+
}
|
|
165
|
+
response_data = self.api_client.call_api(
|
|
166
|
+
*_param,
|
|
167
|
+
_request_timeout=_request_timeout
|
|
168
|
+
)
|
|
169
|
+
response_data.read()
|
|
170
|
+
return self.api_client.response_deserialize(
|
|
171
|
+
response_data=response_data,
|
|
172
|
+
response_types_map=_response_types_map,
|
|
173
|
+
)
|
|
174
|
+
|
|
175
|
+
|
|
176
|
+
@validate_call
|
|
177
|
+
def workflow_result_service_get_workflow_result_corpus_patch_without_preload_content(
|
|
178
|
+
self,
|
|
179
|
+
name_14: Annotated[str, Field(strict=True, description="Required. The name of the corpus patch workflow for which to retrieve the corpus patch.")],
|
|
180
|
+
_request_timeout: Union[
|
|
181
|
+
None,
|
|
182
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
183
|
+
Tuple[
|
|
184
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
185
|
+
Annotated[StrictFloat, Field(gt=0)]
|
|
186
|
+
]
|
|
187
|
+
] = None,
|
|
188
|
+
_request_auth: Optional[Dict[StrictStr, Any]] = None,
|
|
189
|
+
_content_type: Optional[StrictStr] = None,
|
|
190
|
+
_headers: Optional[Dict[StrictStr, Any]] = None,
|
|
191
|
+
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
|
|
192
|
+
) -> RESTResponseType:
|
|
193
|
+
"""GetWorkflowResultCorpusPatch retrieves the corpus patch of a Workflow result. The corpus patch is a HTML document that contains questions and answers identified as problematic in HEC and RT IV workflow steps.
|
|
194
|
+
|
|
195
|
+
|
|
196
|
+
:param name_14: Required. The name of the corpus patch workflow for which to retrieve the corpus patch. (required)
|
|
197
|
+
:type name_14: str
|
|
198
|
+
:param _request_timeout: timeout setting for this request. If one
|
|
199
|
+
number provided, it will be total request
|
|
200
|
+
timeout. It can also be a pair (tuple) of
|
|
201
|
+
(connection, read) timeouts.
|
|
202
|
+
:type _request_timeout: int, tuple(int, int), optional
|
|
203
|
+
:param _request_auth: set to override the auth_settings for an a single
|
|
204
|
+
request; this effectively ignores the
|
|
205
|
+
authentication in the spec for a single request.
|
|
206
|
+
:type _request_auth: dict, optional
|
|
207
|
+
:param _content_type: force content-type for the request.
|
|
208
|
+
:type _content_type: str, Optional
|
|
209
|
+
:param _headers: set to override the headers for a single
|
|
210
|
+
request; this effectively ignores the headers
|
|
211
|
+
in the spec for a single request.
|
|
212
|
+
:type _headers: dict, optional
|
|
213
|
+
:param _host_index: set to override the host_index for a single
|
|
214
|
+
request; this effectively ignores the host_index
|
|
215
|
+
in the spec for a single request.
|
|
216
|
+
:type _host_index: int, optional
|
|
217
|
+
:return: Returns the result object.
|
|
218
|
+
""" # noqa: E501
|
|
219
|
+
|
|
220
|
+
_param = self._workflow_result_service_get_workflow_result_corpus_patch_serialize(
|
|
221
|
+
name_14=name_14,
|
|
222
|
+
_request_auth=_request_auth,
|
|
223
|
+
_content_type=_content_type,
|
|
224
|
+
_headers=_headers,
|
|
225
|
+
_host_index=_host_index
|
|
226
|
+
)
|
|
227
|
+
|
|
228
|
+
_response_types_map: Dict[str, Optional[str]] = {
|
|
229
|
+
'200': "V1GetWorkflowResultCorpusPatchResponse",
|
|
230
|
+
}
|
|
231
|
+
response_data = self.api_client.call_api(
|
|
232
|
+
*_param,
|
|
233
|
+
_request_timeout=_request_timeout
|
|
234
|
+
)
|
|
235
|
+
return response_data.response
|
|
236
|
+
|
|
237
|
+
|
|
238
|
+
def _workflow_result_service_get_workflow_result_corpus_patch_serialize(
|
|
239
|
+
self,
|
|
240
|
+
name_14,
|
|
241
|
+
_request_auth,
|
|
242
|
+
_content_type,
|
|
243
|
+
_headers,
|
|
244
|
+
_host_index,
|
|
245
|
+
) -> RequestSerialized:
|
|
246
|
+
|
|
247
|
+
_host = None
|
|
248
|
+
|
|
249
|
+
_collection_formats: Dict[str, str] = {
|
|
250
|
+
}
|
|
251
|
+
|
|
252
|
+
_path_params: Dict[str, str] = {}
|
|
253
|
+
_query_params: List[Tuple[str, str]] = []
|
|
254
|
+
_header_params: Dict[str, Optional[str]] = _headers or {}
|
|
255
|
+
_form_params: List[Tuple[str, str]] = []
|
|
256
|
+
_files: Dict[str, Union[str, bytes]] = {}
|
|
257
|
+
_body_params: Optional[bytes] = None
|
|
258
|
+
|
|
259
|
+
# process the path parameters
|
|
260
|
+
if name_14 is not None:
|
|
261
|
+
_path_params['name_14'] = name_14
|
|
262
|
+
# process the query parameters
|
|
263
|
+
# process the header parameters
|
|
264
|
+
# process the form parameters
|
|
265
|
+
# process the body parameter
|
|
266
|
+
|
|
267
|
+
|
|
268
|
+
# set the HTTP header `Accept`
|
|
269
|
+
_header_params['Accept'] = self.api_client.select_header_accept(
|
|
270
|
+
[
|
|
271
|
+
'application/json'
|
|
272
|
+
]
|
|
273
|
+
)
|
|
274
|
+
|
|
275
|
+
|
|
276
|
+
# authentication setting
|
|
277
|
+
_auth_settings: List[str] = [
|
|
278
|
+
]
|
|
279
|
+
|
|
280
|
+
return self.api_client.param_serialize(
|
|
281
|
+
method='GET',
|
|
282
|
+
resource_path='/v1/{name_14}',
|
|
283
|
+
path_params=_path_params,
|
|
284
|
+
query_params=_query_params,
|
|
285
|
+
header_params=_header_params,
|
|
286
|
+
body=_body_params,
|
|
287
|
+
post_params=_form_params,
|
|
288
|
+
files=_files,
|
|
289
|
+
auth_settings=_auth_settings,
|
|
290
|
+
collection_formats=_collection_formats,
|
|
291
|
+
_host=_host,
|
|
292
|
+
_request_auth=_request_auth
|
|
293
|
+
)
|
|
294
|
+
|
|
295
|
+
|
|
296
|
+
|
|
297
|
+
|
|
298
|
+
@validate_call
|
|
299
|
+
def workflow_result_service_get_workflow_result_report(
|
|
300
|
+
self,
|
|
301
|
+
name_13: Annotated[str, Field(strict=True, description="Required. The name of the report workflow for which to retrieve the report.")],
|
|
302
|
+
_request_timeout: Union[
|
|
303
|
+
None,
|
|
304
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
305
|
+
Tuple[
|
|
306
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
307
|
+
Annotated[StrictFloat, Field(gt=0)]
|
|
308
|
+
]
|
|
309
|
+
] = None,
|
|
310
|
+
_request_auth: Optional[Dict[StrictStr, Any]] = None,
|
|
311
|
+
_content_type: Optional[StrictStr] = None,
|
|
312
|
+
_headers: Optional[Dict[StrictStr, Any]] = None,
|
|
313
|
+
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
|
|
314
|
+
) -> V1GetWorkflowResultReportResponse:
|
|
315
|
+
"""GetWorkflowResultReport retrieves the report of a Workflow result. The report is a detailed HTML document summarizing the Workflow's execution and findings.
|
|
316
|
+
|
|
317
|
+
|
|
318
|
+
:param name_13: Required. The name of the report workflow for which to retrieve the report. (required)
|
|
319
|
+
:type name_13: str
|
|
320
|
+
:param _request_timeout: timeout setting for this request. If one
|
|
321
|
+
number provided, it will be total request
|
|
322
|
+
timeout. It can also be a pair (tuple) of
|
|
323
|
+
(connection, read) timeouts.
|
|
324
|
+
:type _request_timeout: int, tuple(int, int), optional
|
|
325
|
+
:param _request_auth: set to override the auth_settings for an a single
|
|
326
|
+
request; this effectively ignores the
|
|
327
|
+
authentication in the spec for a single request.
|
|
328
|
+
:type _request_auth: dict, optional
|
|
329
|
+
:param _content_type: force content-type for the request.
|
|
330
|
+
:type _content_type: str, Optional
|
|
331
|
+
:param _headers: set to override the headers for a single
|
|
332
|
+
request; this effectively ignores the headers
|
|
333
|
+
in the spec for a single request.
|
|
334
|
+
:type _headers: dict, optional
|
|
335
|
+
:param _host_index: set to override the host_index for a single
|
|
336
|
+
request; this effectively ignores the host_index
|
|
337
|
+
in the spec for a single request.
|
|
338
|
+
:type _host_index: int, optional
|
|
339
|
+
:return: Returns the result object.
|
|
340
|
+
""" # noqa: E501
|
|
341
|
+
|
|
342
|
+
_param = self._workflow_result_service_get_workflow_result_report_serialize(
|
|
343
|
+
name_13=name_13,
|
|
344
|
+
_request_auth=_request_auth,
|
|
345
|
+
_content_type=_content_type,
|
|
346
|
+
_headers=_headers,
|
|
347
|
+
_host_index=_host_index
|
|
348
|
+
)
|
|
349
|
+
|
|
350
|
+
_response_types_map: Dict[str, Optional[str]] = {
|
|
351
|
+
'200': "V1GetWorkflowResultReportResponse",
|
|
352
|
+
}
|
|
353
|
+
response_data = self.api_client.call_api(
|
|
354
|
+
*_param,
|
|
355
|
+
_request_timeout=_request_timeout
|
|
356
|
+
)
|
|
357
|
+
response_data.read()
|
|
358
|
+
return self.api_client.response_deserialize(
|
|
359
|
+
response_data=response_data,
|
|
360
|
+
response_types_map=_response_types_map,
|
|
361
|
+
).data
|
|
362
|
+
|
|
363
|
+
|
|
364
|
+
@validate_call
|
|
365
|
+
def workflow_result_service_get_workflow_result_report_with_http_info(
|
|
366
|
+
self,
|
|
367
|
+
name_13: Annotated[str, Field(strict=True, description="Required. The name of the report workflow for which to retrieve the report.")],
|
|
368
|
+
_request_timeout: Union[
|
|
369
|
+
None,
|
|
370
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
371
|
+
Tuple[
|
|
372
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
373
|
+
Annotated[StrictFloat, Field(gt=0)]
|
|
374
|
+
]
|
|
375
|
+
] = None,
|
|
376
|
+
_request_auth: Optional[Dict[StrictStr, Any]] = None,
|
|
377
|
+
_content_type: Optional[StrictStr] = None,
|
|
378
|
+
_headers: Optional[Dict[StrictStr, Any]] = None,
|
|
379
|
+
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
|
|
380
|
+
) -> ApiResponse[V1GetWorkflowResultReportResponse]:
|
|
381
|
+
"""GetWorkflowResultReport retrieves the report of a Workflow result. The report is a detailed HTML document summarizing the Workflow's execution and findings.
|
|
382
|
+
|
|
383
|
+
|
|
384
|
+
:param name_13: Required. The name of the report workflow for which to retrieve the report. (required)
|
|
385
|
+
:type name_13: str
|
|
386
|
+
:param _request_timeout: timeout setting for this request. If one
|
|
387
|
+
number provided, it will be total request
|
|
388
|
+
timeout. It can also be a pair (tuple) of
|
|
389
|
+
(connection, read) timeouts.
|
|
390
|
+
:type _request_timeout: int, tuple(int, int), optional
|
|
391
|
+
:param _request_auth: set to override the auth_settings for an a single
|
|
392
|
+
request; this effectively ignores the
|
|
393
|
+
authentication in the spec for a single request.
|
|
394
|
+
:type _request_auth: dict, optional
|
|
395
|
+
:param _content_type: force content-type for the request.
|
|
396
|
+
:type _content_type: str, Optional
|
|
397
|
+
:param _headers: set to override the headers for a single
|
|
398
|
+
request; this effectively ignores the headers
|
|
399
|
+
in the spec for a single request.
|
|
400
|
+
:type _headers: dict, optional
|
|
401
|
+
:param _host_index: set to override the host_index for a single
|
|
402
|
+
request; this effectively ignores the host_index
|
|
403
|
+
in the spec for a single request.
|
|
404
|
+
:type _host_index: int, optional
|
|
405
|
+
:return: Returns the result object.
|
|
406
|
+
""" # noqa: E501
|
|
407
|
+
|
|
408
|
+
_param = self._workflow_result_service_get_workflow_result_report_serialize(
|
|
409
|
+
name_13=name_13,
|
|
410
|
+
_request_auth=_request_auth,
|
|
411
|
+
_content_type=_content_type,
|
|
412
|
+
_headers=_headers,
|
|
413
|
+
_host_index=_host_index
|
|
414
|
+
)
|
|
415
|
+
|
|
416
|
+
_response_types_map: Dict[str, Optional[str]] = {
|
|
417
|
+
'200': "V1GetWorkflowResultReportResponse",
|
|
418
|
+
}
|
|
419
|
+
response_data = self.api_client.call_api(
|
|
420
|
+
*_param,
|
|
421
|
+
_request_timeout=_request_timeout
|
|
422
|
+
)
|
|
423
|
+
response_data.read()
|
|
424
|
+
return self.api_client.response_deserialize(
|
|
425
|
+
response_data=response_data,
|
|
426
|
+
response_types_map=_response_types_map,
|
|
427
|
+
)
|
|
428
|
+
|
|
429
|
+
|
|
430
|
+
@validate_call
|
|
431
|
+
def workflow_result_service_get_workflow_result_report_without_preload_content(
|
|
432
|
+
self,
|
|
433
|
+
name_13: Annotated[str, Field(strict=True, description="Required. The name of the report workflow for which to retrieve the report.")],
|
|
434
|
+
_request_timeout: Union[
|
|
435
|
+
None,
|
|
436
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
437
|
+
Tuple[
|
|
438
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
439
|
+
Annotated[StrictFloat, Field(gt=0)]
|
|
440
|
+
]
|
|
441
|
+
] = None,
|
|
442
|
+
_request_auth: Optional[Dict[StrictStr, Any]] = None,
|
|
443
|
+
_content_type: Optional[StrictStr] = None,
|
|
444
|
+
_headers: Optional[Dict[StrictStr, Any]] = None,
|
|
445
|
+
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
|
|
446
|
+
) -> RESTResponseType:
|
|
447
|
+
"""GetWorkflowResultReport retrieves the report of a Workflow result. The report is a detailed HTML document summarizing the Workflow's execution and findings.
|
|
448
|
+
|
|
449
|
+
|
|
450
|
+
:param name_13: Required. The name of the report workflow for which to retrieve the report. (required)
|
|
451
|
+
:type name_13: str
|
|
452
|
+
:param _request_timeout: timeout setting for this request. If one
|
|
453
|
+
number provided, it will be total request
|
|
454
|
+
timeout. It can also be a pair (tuple) of
|
|
455
|
+
(connection, read) timeouts.
|
|
456
|
+
:type _request_timeout: int, tuple(int, int), optional
|
|
457
|
+
:param _request_auth: set to override the auth_settings for an a single
|
|
458
|
+
request; this effectively ignores the
|
|
459
|
+
authentication in the spec for a single request.
|
|
460
|
+
:type _request_auth: dict, optional
|
|
461
|
+
:param _content_type: force content-type for the request.
|
|
462
|
+
:type _content_type: str, Optional
|
|
463
|
+
:param _headers: set to override the headers for a single
|
|
464
|
+
request; this effectively ignores the headers
|
|
465
|
+
in the spec for a single request.
|
|
466
|
+
:type _headers: dict, optional
|
|
467
|
+
:param _host_index: set to override the host_index for a single
|
|
468
|
+
request; this effectively ignores the host_index
|
|
469
|
+
in the spec for a single request.
|
|
470
|
+
:type _host_index: int, optional
|
|
471
|
+
:return: Returns the result object.
|
|
472
|
+
""" # noqa: E501
|
|
473
|
+
|
|
474
|
+
_param = self._workflow_result_service_get_workflow_result_report_serialize(
|
|
475
|
+
name_13=name_13,
|
|
476
|
+
_request_auth=_request_auth,
|
|
477
|
+
_content_type=_content_type,
|
|
478
|
+
_headers=_headers,
|
|
479
|
+
_host_index=_host_index
|
|
480
|
+
)
|
|
481
|
+
|
|
482
|
+
_response_types_map: Dict[str, Optional[str]] = {
|
|
483
|
+
'200': "V1GetWorkflowResultReportResponse",
|
|
484
|
+
}
|
|
485
|
+
response_data = self.api_client.call_api(
|
|
486
|
+
*_param,
|
|
487
|
+
_request_timeout=_request_timeout
|
|
488
|
+
)
|
|
489
|
+
return response_data.response
|
|
490
|
+
|
|
491
|
+
|
|
492
|
+
def _workflow_result_service_get_workflow_result_report_serialize(
|
|
493
|
+
self,
|
|
494
|
+
name_13,
|
|
495
|
+
_request_auth,
|
|
496
|
+
_content_type,
|
|
497
|
+
_headers,
|
|
498
|
+
_host_index,
|
|
499
|
+
) -> RequestSerialized:
|
|
500
|
+
|
|
501
|
+
_host = None
|
|
502
|
+
|
|
503
|
+
_collection_formats: Dict[str, str] = {
|
|
504
|
+
}
|
|
505
|
+
|
|
506
|
+
_path_params: Dict[str, str] = {}
|
|
507
|
+
_query_params: List[Tuple[str, str]] = []
|
|
508
|
+
_header_params: Dict[str, Optional[str]] = _headers or {}
|
|
509
|
+
_form_params: List[Tuple[str, str]] = []
|
|
510
|
+
_files: Dict[str, Union[str, bytes]] = {}
|
|
511
|
+
_body_params: Optional[bytes] = None
|
|
512
|
+
|
|
513
|
+
# process the path parameters
|
|
514
|
+
if name_13 is not None:
|
|
515
|
+
_path_params['name_13'] = name_13
|
|
516
|
+
# process the query parameters
|
|
517
|
+
# process the header parameters
|
|
518
|
+
# process the form parameters
|
|
519
|
+
# process the body parameter
|
|
520
|
+
|
|
521
|
+
|
|
522
|
+
# set the HTTP header `Accept`
|
|
523
|
+
_header_params['Accept'] = self.api_client.select_header_accept(
|
|
524
|
+
[
|
|
525
|
+
'application/json'
|
|
526
|
+
]
|
|
527
|
+
)
|
|
528
|
+
|
|
529
|
+
|
|
530
|
+
# authentication setting
|
|
531
|
+
_auth_settings: List[str] = [
|
|
532
|
+
]
|
|
533
|
+
|
|
534
|
+
return self.api_client.param_serialize(
|
|
535
|
+
method='GET',
|
|
536
|
+
resource_path='/v1/{name_13}',
|
|
537
|
+
path_params=_path_params,
|
|
538
|
+
query_params=_query_params,
|
|
539
|
+
header_params=_header_params,
|
|
540
|
+
body=_body_params,
|
|
541
|
+
post_params=_form_params,
|
|
542
|
+
files=_files,
|
|
543
|
+
auth_settings=_auth_settings,
|
|
544
|
+
collection_formats=_collection_formats,
|
|
545
|
+
_host=_host,
|
|
546
|
+
_request_auth=_request_auth
|
|
547
|
+
)
|
|
548
|
+
|
|
549
|
+
|
|
550
|
+
|
|
551
|
+
|
|
552
|
+
@validate_call
|
|
553
|
+
def workflow_result_service_get_workflow_result_summary(
|
|
554
|
+
self,
|
|
555
|
+
name_12: Annotated[str, Field(strict=True, description="Required. The name of the Workflow for which to retrieve the 3x3x3 summary.")],
|
|
556
|
+
_request_timeout: Union[
|
|
557
|
+
None,
|
|
558
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
559
|
+
Tuple[
|
|
560
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
561
|
+
Annotated[StrictFloat, Field(gt=0)]
|
|
562
|
+
]
|
|
563
|
+
] = None,
|
|
564
|
+
_request_auth: Optional[Dict[StrictStr, Any]] = None,
|
|
565
|
+
_content_type: Optional[StrictStr] = None,
|
|
566
|
+
_headers: Optional[Dict[StrictStr, Any]] = None,
|
|
567
|
+
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
|
|
568
|
+
) -> V1GetWorkflowResultSummaryResponse:
|
|
569
|
+
"""GetWorkflowResultSummary retrieves the 3x3x3 summary of a Workflow result. The summary includes 3 summary sentences, 3 bullets with most serious highlights, and 3 recommended actions sentences.
|
|
570
|
+
|
|
571
|
+
|
|
572
|
+
:param name_12: Required. The name of the Workflow for which to retrieve the 3x3x3 summary. (required)
|
|
573
|
+
:type name_12: str
|
|
574
|
+
:param _request_timeout: timeout setting for this request. If one
|
|
575
|
+
number provided, it will be total request
|
|
576
|
+
timeout. It can also be a pair (tuple) of
|
|
577
|
+
(connection, read) timeouts.
|
|
578
|
+
:type _request_timeout: int, tuple(int, int), optional
|
|
579
|
+
:param _request_auth: set to override the auth_settings for an a single
|
|
580
|
+
request; this effectively ignores the
|
|
581
|
+
authentication in the spec for a single request.
|
|
582
|
+
:type _request_auth: dict, optional
|
|
583
|
+
:param _content_type: force content-type for the request.
|
|
584
|
+
:type _content_type: str, Optional
|
|
585
|
+
:param _headers: set to override the headers for a single
|
|
586
|
+
request; this effectively ignores the headers
|
|
587
|
+
in the spec for a single request.
|
|
588
|
+
:type _headers: dict, optional
|
|
589
|
+
:param _host_index: set to override the host_index for a single
|
|
590
|
+
request; this effectively ignores the host_index
|
|
591
|
+
in the spec for a single request.
|
|
592
|
+
:type _host_index: int, optional
|
|
593
|
+
:return: Returns the result object.
|
|
594
|
+
""" # noqa: E501
|
|
595
|
+
|
|
596
|
+
_param = self._workflow_result_service_get_workflow_result_summary_serialize(
|
|
597
|
+
name_12=name_12,
|
|
598
|
+
_request_auth=_request_auth,
|
|
599
|
+
_content_type=_content_type,
|
|
600
|
+
_headers=_headers,
|
|
601
|
+
_host_index=_host_index
|
|
602
|
+
)
|
|
603
|
+
|
|
604
|
+
_response_types_map: Dict[str, Optional[str]] = {
|
|
605
|
+
'200': "V1GetWorkflowResultSummaryResponse",
|
|
606
|
+
}
|
|
607
|
+
response_data = self.api_client.call_api(
|
|
608
|
+
*_param,
|
|
609
|
+
_request_timeout=_request_timeout
|
|
610
|
+
)
|
|
611
|
+
response_data.read()
|
|
612
|
+
return self.api_client.response_deserialize(
|
|
613
|
+
response_data=response_data,
|
|
614
|
+
response_types_map=_response_types_map,
|
|
615
|
+
).data
|
|
616
|
+
|
|
617
|
+
|
|
618
|
+
@validate_call
|
|
619
|
+
def workflow_result_service_get_workflow_result_summary_with_http_info(
|
|
620
|
+
self,
|
|
621
|
+
name_12: Annotated[str, Field(strict=True, description="Required. The name of the Workflow for which to retrieve the 3x3x3 summary.")],
|
|
622
|
+
_request_timeout: Union[
|
|
623
|
+
None,
|
|
624
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
625
|
+
Tuple[
|
|
626
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
627
|
+
Annotated[StrictFloat, Field(gt=0)]
|
|
628
|
+
]
|
|
629
|
+
] = None,
|
|
630
|
+
_request_auth: Optional[Dict[StrictStr, Any]] = None,
|
|
631
|
+
_content_type: Optional[StrictStr] = None,
|
|
632
|
+
_headers: Optional[Dict[StrictStr, Any]] = None,
|
|
633
|
+
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
|
|
634
|
+
) -> ApiResponse[V1GetWorkflowResultSummaryResponse]:
|
|
635
|
+
"""GetWorkflowResultSummary retrieves the 3x3x3 summary of a Workflow result. The summary includes 3 summary sentences, 3 bullets with most serious highlights, and 3 recommended actions sentences.
|
|
636
|
+
|
|
637
|
+
|
|
638
|
+
:param name_12: Required. The name of the Workflow for which to retrieve the 3x3x3 summary. (required)
|
|
639
|
+
:type name_12: str
|
|
640
|
+
:param _request_timeout: timeout setting for this request. If one
|
|
641
|
+
number provided, it will be total request
|
|
642
|
+
timeout. It can also be a pair (tuple) of
|
|
643
|
+
(connection, read) timeouts.
|
|
644
|
+
:type _request_timeout: int, tuple(int, int), optional
|
|
645
|
+
:param _request_auth: set to override the auth_settings for an a single
|
|
646
|
+
request; this effectively ignores the
|
|
647
|
+
authentication in the spec for a single request.
|
|
648
|
+
:type _request_auth: dict, optional
|
|
649
|
+
:param _content_type: force content-type for the request.
|
|
650
|
+
:type _content_type: str, Optional
|
|
651
|
+
:param _headers: set to override the headers for a single
|
|
652
|
+
request; this effectively ignores the headers
|
|
653
|
+
in the spec for a single request.
|
|
654
|
+
:type _headers: dict, optional
|
|
655
|
+
:param _host_index: set to override the host_index for a single
|
|
656
|
+
request; this effectively ignores the host_index
|
|
657
|
+
in the spec for a single request.
|
|
658
|
+
:type _host_index: int, optional
|
|
659
|
+
:return: Returns the result object.
|
|
660
|
+
""" # noqa: E501
|
|
661
|
+
|
|
662
|
+
_param = self._workflow_result_service_get_workflow_result_summary_serialize(
|
|
663
|
+
name_12=name_12,
|
|
664
|
+
_request_auth=_request_auth,
|
|
665
|
+
_content_type=_content_type,
|
|
666
|
+
_headers=_headers,
|
|
667
|
+
_host_index=_host_index
|
|
668
|
+
)
|
|
669
|
+
|
|
670
|
+
_response_types_map: Dict[str, Optional[str]] = {
|
|
671
|
+
'200': "V1GetWorkflowResultSummaryResponse",
|
|
672
|
+
}
|
|
673
|
+
response_data = self.api_client.call_api(
|
|
674
|
+
*_param,
|
|
675
|
+
_request_timeout=_request_timeout
|
|
676
|
+
)
|
|
677
|
+
response_data.read()
|
|
678
|
+
return self.api_client.response_deserialize(
|
|
679
|
+
response_data=response_data,
|
|
680
|
+
response_types_map=_response_types_map,
|
|
681
|
+
)
|
|
682
|
+
|
|
683
|
+
|
|
684
|
+
@validate_call
|
|
685
|
+
def workflow_result_service_get_workflow_result_summary_without_preload_content(
|
|
686
|
+
self,
|
|
687
|
+
name_12: Annotated[str, Field(strict=True, description="Required. The name of the Workflow for which to retrieve the 3x3x3 summary.")],
|
|
688
|
+
_request_timeout: Union[
|
|
689
|
+
None,
|
|
690
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
691
|
+
Tuple[
|
|
692
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
693
|
+
Annotated[StrictFloat, Field(gt=0)]
|
|
694
|
+
]
|
|
695
|
+
] = None,
|
|
696
|
+
_request_auth: Optional[Dict[StrictStr, Any]] = None,
|
|
697
|
+
_content_type: Optional[StrictStr] = None,
|
|
698
|
+
_headers: Optional[Dict[StrictStr, Any]] = None,
|
|
699
|
+
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
|
|
700
|
+
) -> RESTResponseType:
|
|
701
|
+
"""GetWorkflowResultSummary retrieves the 3x3x3 summary of a Workflow result. The summary includes 3 summary sentences, 3 bullets with most serious highlights, and 3 recommended actions sentences.
|
|
702
|
+
|
|
703
|
+
|
|
704
|
+
:param name_12: Required. The name of the Workflow for which to retrieve the 3x3x3 summary. (required)
|
|
705
|
+
:type name_12: str
|
|
706
|
+
:param _request_timeout: timeout setting for this request. If one
|
|
707
|
+
number provided, it will be total request
|
|
708
|
+
timeout. It can also be a pair (tuple) of
|
|
709
|
+
(connection, read) timeouts.
|
|
710
|
+
:type _request_timeout: int, tuple(int, int), optional
|
|
711
|
+
:param _request_auth: set to override the auth_settings for an a single
|
|
712
|
+
request; this effectively ignores the
|
|
713
|
+
authentication in the spec for a single request.
|
|
714
|
+
:type _request_auth: dict, optional
|
|
715
|
+
:param _content_type: force content-type for the request.
|
|
716
|
+
:type _content_type: str, Optional
|
|
717
|
+
:param _headers: set to override the headers for a single
|
|
718
|
+
request; this effectively ignores the headers
|
|
719
|
+
in the spec for a single request.
|
|
720
|
+
:type _headers: dict, optional
|
|
721
|
+
:param _host_index: set to override the host_index for a single
|
|
722
|
+
request; this effectively ignores the host_index
|
|
723
|
+
in the spec for a single request.
|
|
724
|
+
:type _host_index: int, optional
|
|
725
|
+
:return: Returns the result object.
|
|
726
|
+
""" # noqa: E501
|
|
727
|
+
|
|
728
|
+
_param = self._workflow_result_service_get_workflow_result_summary_serialize(
|
|
729
|
+
name_12=name_12,
|
|
730
|
+
_request_auth=_request_auth,
|
|
731
|
+
_content_type=_content_type,
|
|
732
|
+
_headers=_headers,
|
|
733
|
+
_host_index=_host_index
|
|
734
|
+
)
|
|
735
|
+
|
|
736
|
+
_response_types_map: Dict[str, Optional[str]] = {
|
|
737
|
+
'200': "V1GetWorkflowResultSummaryResponse",
|
|
738
|
+
}
|
|
739
|
+
response_data = self.api_client.call_api(
|
|
740
|
+
*_param,
|
|
741
|
+
_request_timeout=_request_timeout
|
|
742
|
+
)
|
|
743
|
+
return response_data.response
|
|
744
|
+
|
|
745
|
+
|
|
746
|
+
def _workflow_result_service_get_workflow_result_summary_serialize(
|
|
747
|
+
self,
|
|
748
|
+
name_12,
|
|
749
|
+
_request_auth,
|
|
750
|
+
_content_type,
|
|
751
|
+
_headers,
|
|
752
|
+
_host_index,
|
|
753
|
+
) -> RequestSerialized:
|
|
754
|
+
|
|
755
|
+
_host = None
|
|
756
|
+
|
|
757
|
+
_collection_formats: Dict[str, str] = {
|
|
758
|
+
}
|
|
759
|
+
|
|
760
|
+
_path_params: Dict[str, str] = {}
|
|
761
|
+
_query_params: List[Tuple[str, str]] = []
|
|
762
|
+
_header_params: Dict[str, Optional[str]] = _headers or {}
|
|
763
|
+
_form_params: List[Tuple[str, str]] = []
|
|
764
|
+
_files: Dict[str, Union[str, bytes]] = {}
|
|
765
|
+
_body_params: Optional[bytes] = None
|
|
766
|
+
|
|
767
|
+
# process the path parameters
|
|
768
|
+
if name_12 is not None:
|
|
769
|
+
_path_params['name_12'] = name_12
|
|
770
|
+
# process the query parameters
|
|
771
|
+
# process the header parameters
|
|
772
|
+
# process the form parameters
|
|
773
|
+
# process the body parameter
|
|
774
|
+
|
|
775
|
+
|
|
776
|
+
# set the HTTP header `Accept`
|
|
777
|
+
_header_params['Accept'] = self.api_client.select_header_accept(
|
|
778
|
+
[
|
|
779
|
+
'application/json'
|
|
780
|
+
]
|
|
781
|
+
)
|
|
782
|
+
|
|
783
|
+
|
|
784
|
+
# authentication setting
|
|
785
|
+
_auth_settings: List[str] = [
|
|
786
|
+
]
|
|
787
|
+
|
|
788
|
+
return self.api_client.param_serialize(
|
|
789
|
+
method='GET',
|
|
790
|
+
resource_path='/v1/{name_12}',
|
|
791
|
+
path_params=_path_params,
|
|
792
|
+
query_params=_query_params,
|
|
793
|
+
header_params=_header_params,
|
|
794
|
+
body=_body_params,
|
|
795
|
+
post_params=_form_params,
|
|
796
|
+
files=_files,
|
|
797
|
+
auth_settings=_auth_settings,
|
|
798
|
+
collection_formats=_collection_formats,
|
|
799
|
+
_host=_host,
|
|
800
|
+
_request_auth=_request_auth
|
|
801
|
+
)
|
|
802
|
+
|
|
803
|
+
|
|
804
|
+
|
|
805
|
+
|
|
806
|
+
@validate_call
|
|
807
|
+
def workflow_result_service_get_workflow_result_system_prompt_patch(
|
|
808
|
+
self,
|
|
809
|
+
name_15: Annotated[str, Field(strict=True, description="Required. The name of the system prompt patch workflow for which to retrieve the system prompt patch.")],
|
|
810
|
+
_request_timeout: Union[
|
|
811
|
+
None,
|
|
812
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
813
|
+
Tuple[
|
|
814
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
815
|
+
Annotated[StrictFloat, Field(gt=0)]
|
|
816
|
+
]
|
|
817
|
+
] = None,
|
|
818
|
+
_request_auth: Optional[Dict[StrictStr, Any]] = None,
|
|
819
|
+
_content_type: Optional[StrictStr] = None,
|
|
820
|
+
_headers: Optional[Dict[StrictStr, Any]] = None,
|
|
821
|
+
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
|
|
822
|
+
) -> V1GetWorkflowResultSystemPromptPatchResponse:
|
|
823
|
+
"""GetWorkflowResultSystemPromptPatch retrieves the system prompt patch of a Workflow result.
|
|
824
|
+
|
|
825
|
+
|
|
826
|
+
:param name_15: Required. The name of the system prompt patch workflow for which to retrieve the system prompt patch. (required)
|
|
827
|
+
:type name_15: str
|
|
828
|
+
:param _request_timeout: timeout setting for this request. If one
|
|
829
|
+
number provided, it will be total request
|
|
830
|
+
timeout. It can also be a pair (tuple) of
|
|
831
|
+
(connection, read) timeouts.
|
|
832
|
+
:type _request_timeout: int, tuple(int, int), optional
|
|
833
|
+
:param _request_auth: set to override the auth_settings for an a single
|
|
834
|
+
request; this effectively ignores the
|
|
835
|
+
authentication in the spec for a single request.
|
|
836
|
+
:type _request_auth: dict, optional
|
|
837
|
+
:param _content_type: force content-type for the request.
|
|
838
|
+
:type _content_type: str, Optional
|
|
839
|
+
:param _headers: set to override the headers for a single
|
|
840
|
+
request; this effectively ignores the headers
|
|
841
|
+
in the spec for a single request.
|
|
842
|
+
:type _headers: dict, optional
|
|
843
|
+
:param _host_index: set to override the host_index for a single
|
|
844
|
+
request; this effectively ignores the host_index
|
|
845
|
+
in the spec for a single request.
|
|
846
|
+
:type _host_index: int, optional
|
|
847
|
+
:return: Returns the result object.
|
|
848
|
+
""" # noqa: E501
|
|
849
|
+
|
|
850
|
+
_param = self._workflow_result_service_get_workflow_result_system_prompt_patch_serialize(
|
|
851
|
+
name_15=name_15,
|
|
852
|
+
_request_auth=_request_auth,
|
|
853
|
+
_content_type=_content_type,
|
|
854
|
+
_headers=_headers,
|
|
855
|
+
_host_index=_host_index
|
|
856
|
+
)
|
|
857
|
+
|
|
858
|
+
_response_types_map: Dict[str, Optional[str]] = {
|
|
859
|
+
'200': "V1GetWorkflowResultSystemPromptPatchResponse",
|
|
860
|
+
}
|
|
861
|
+
response_data = self.api_client.call_api(
|
|
862
|
+
*_param,
|
|
863
|
+
_request_timeout=_request_timeout
|
|
864
|
+
)
|
|
865
|
+
response_data.read()
|
|
866
|
+
return self.api_client.response_deserialize(
|
|
867
|
+
response_data=response_data,
|
|
868
|
+
response_types_map=_response_types_map,
|
|
869
|
+
).data
|
|
870
|
+
|
|
871
|
+
|
|
872
|
+
@validate_call
|
|
873
|
+
def workflow_result_service_get_workflow_result_system_prompt_patch_with_http_info(
|
|
874
|
+
self,
|
|
875
|
+
name_15: Annotated[str, Field(strict=True, description="Required. The name of the system prompt patch workflow for which to retrieve the system prompt patch.")],
|
|
876
|
+
_request_timeout: Union[
|
|
877
|
+
None,
|
|
878
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
879
|
+
Tuple[
|
|
880
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
881
|
+
Annotated[StrictFloat, Field(gt=0)]
|
|
882
|
+
]
|
|
883
|
+
] = None,
|
|
884
|
+
_request_auth: Optional[Dict[StrictStr, Any]] = None,
|
|
885
|
+
_content_type: Optional[StrictStr] = None,
|
|
886
|
+
_headers: Optional[Dict[StrictStr, Any]] = None,
|
|
887
|
+
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
|
|
888
|
+
) -> ApiResponse[V1GetWorkflowResultSystemPromptPatchResponse]:
|
|
889
|
+
"""GetWorkflowResultSystemPromptPatch retrieves the system prompt patch of a Workflow result.
|
|
890
|
+
|
|
891
|
+
|
|
892
|
+
:param name_15: Required. The name of the system prompt patch workflow for which to retrieve the system prompt patch. (required)
|
|
893
|
+
:type name_15: str
|
|
894
|
+
:param _request_timeout: timeout setting for this request. If one
|
|
895
|
+
number provided, it will be total request
|
|
896
|
+
timeout. It can also be a pair (tuple) of
|
|
897
|
+
(connection, read) timeouts.
|
|
898
|
+
:type _request_timeout: int, tuple(int, int), optional
|
|
899
|
+
:param _request_auth: set to override the auth_settings for an a single
|
|
900
|
+
request; this effectively ignores the
|
|
901
|
+
authentication in the spec for a single request.
|
|
902
|
+
:type _request_auth: dict, optional
|
|
903
|
+
:param _content_type: force content-type for the request.
|
|
904
|
+
:type _content_type: str, Optional
|
|
905
|
+
:param _headers: set to override the headers for a single
|
|
906
|
+
request; this effectively ignores the headers
|
|
907
|
+
in the spec for a single request.
|
|
908
|
+
:type _headers: dict, optional
|
|
909
|
+
:param _host_index: set to override the host_index for a single
|
|
910
|
+
request; this effectively ignores the host_index
|
|
911
|
+
in the spec for a single request.
|
|
912
|
+
:type _host_index: int, optional
|
|
913
|
+
:return: Returns the result object.
|
|
914
|
+
""" # noqa: E501
|
|
915
|
+
|
|
916
|
+
_param = self._workflow_result_service_get_workflow_result_system_prompt_patch_serialize(
|
|
917
|
+
name_15=name_15,
|
|
918
|
+
_request_auth=_request_auth,
|
|
919
|
+
_content_type=_content_type,
|
|
920
|
+
_headers=_headers,
|
|
921
|
+
_host_index=_host_index
|
|
922
|
+
)
|
|
923
|
+
|
|
924
|
+
_response_types_map: Dict[str, Optional[str]] = {
|
|
925
|
+
'200': "V1GetWorkflowResultSystemPromptPatchResponse",
|
|
926
|
+
}
|
|
927
|
+
response_data = self.api_client.call_api(
|
|
928
|
+
*_param,
|
|
929
|
+
_request_timeout=_request_timeout
|
|
930
|
+
)
|
|
931
|
+
response_data.read()
|
|
932
|
+
return self.api_client.response_deserialize(
|
|
933
|
+
response_data=response_data,
|
|
934
|
+
response_types_map=_response_types_map,
|
|
935
|
+
)
|
|
936
|
+
|
|
937
|
+
|
|
938
|
+
@validate_call
|
|
939
|
+
def workflow_result_service_get_workflow_result_system_prompt_patch_without_preload_content(
|
|
940
|
+
self,
|
|
941
|
+
name_15: Annotated[str, Field(strict=True, description="Required. The name of the system prompt patch workflow for which to retrieve the system prompt patch.")],
|
|
942
|
+
_request_timeout: Union[
|
|
943
|
+
None,
|
|
944
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
945
|
+
Tuple[
|
|
946
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
947
|
+
Annotated[StrictFloat, Field(gt=0)]
|
|
948
|
+
]
|
|
949
|
+
] = None,
|
|
950
|
+
_request_auth: Optional[Dict[StrictStr, Any]] = None,
|
|
951
|
+
_content_type: Optional[StrictStr] = None,
|
|
952
|
+
_headers: Optional[Dict[StrictStr, Any]] = None,
|
|
953
|
+
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
|
|
954
|
+
) -> RESTResponseType:
|
|
955
|
+
"""GetWorkflowResultSystemPromptPatch retrieves the system prompt patch of a Workflow result.
|
|
956
|
+
|
|
957
|
+
|
|
958
|
+
:param name_15: Required. The name of the system prompt patch workflow for which to retrieve the system prompt patch. (required)
|
|
959
|
+
:type name_15: str
|
|
960
|
+
:param _request_timeout: timeout setting for this request. If one
|
|
961
|
+
number provided, it will be total request
|
|
962
|
+
timeout. It can also be a pair (tuple) of
|
|
963
|
+
(connection, read) timeouts.
|
|
964
|
+
:type _request_timeout: int, tuple(int, int), optional
|
|
965
|
+
:param _request_auth: set to override the auth_settings for an a single
|
|
966
|
+
request; this effectively ignores the
|
|
967
|
+
authentication in the spec for a single request.
|
|
968
|
+
:type _request_auth: dict, optional
|
|
969
|
+
:param _content_type: force content-type for the request.
|
|
970
|
+
:type _content_type: str, Optional
|
|
971
|
+
:param _headers: set to override the headers for a single
|
|
972
|
+
request; this effectively ignores the headers
|
|
973
|
+
in the spec for a single request.
|
|
974
|
+
:type _headers: dict, optional
|
|
975
|
+
:param _host_index: set to override the host_index for a single
|
|
976
|
+
request; this effectively ignores the host_index
|
|
977
|
+
in the spec for a single request.
|
|
978
|
+
:type _host_index: int, optional
|
|
979
|
+
:return: Returns the result object.
|
|
980
|
+
""" # noqa: E501
|
|
981
|
+
|
|
982
|
+
_param = self._workflow_result_service_get_workflow_result_system_prompt_patch_serialize(
|
|
983
|
+
name_15=name_15,
|
|
984
|
+
_request_auth=_request_auth,
|
|
985
|
+
_content_type=_content_type,
|
|
986
|
+
_headers=_headers,
|
|
987
|
+
_host_index=_host_index
|
|
988
|
+
)
|
|
989
|
+
|
|
990
|
+
_response_types_map: Dict[str, Optional[str]] = {
|
|
991
|
+
'200': "V1GetWorkflowResultSystemPromptPatchResponse",
|
|
992
|
+
}
|
|
993
|
+
response_data = self.api_client.call_api(
|
|
994
|
+
*_param,
|
|
995
|
+
_request_timeout=_request_timeout
|
|
996
|
+
)
|
|
997
|
+
return response_data.response
|
|
998
|
+
|
|
999
|
+
|
|
1000
|
+
def _workflow_result_service_get_workflow_result_system_prompt_patch_serialize(
|
|
1001
|
+
self,
|
|
1002
|
+
name_15,
|
|
1003
|
+
_request_auth,
|
|
1004
|
+
_content_type,
|
|
1005
|
+
_headers,
|
|
1006
|
+
_host_index,
|
|
1007
|
+
) -> RequestSerialized:
|
|
1008
|
+
|
|
1009
|
+
_host = None
|
|
1010
|
+
|
|
1011
|
+
_collection_formats: Dict[str, str] = {
|
|
1012
|
+
}
|
|
1013
|
+
|
|
1014
|
+
_path_params: Dict[str, str] = {}
|
|
1015
|
+
_query_params: List[Tuple[str, str]] = []
|
|
1016
|
+
_header_params: Dict[str, Optional[str]] = _headers or {}
|
|
1017
|
+
_form_params: List[Tuple[str, str]] = []
|
|
1018
|
+
_files: Dict[str, Union[str, bytes]] = {}
|
|
1019
|
+
_body_params: Optional[bytes] = None
|
|
1020
|
+
|
|
1021
|
+
# process the path parameters
|
|
1022
|
+
if name_15 is not None:
|
|
1023
|
+
_path_params['name_15'] = name_15
|
|
1024
|
+
# process the query parameters
|
|
1025
|
+
# process the header parameters
|
|
1026
|
+
# process the form parameters
|
|
1027
|
+
# process the body parameter
|
|
1028
|
+
|
|
1029
|
+
|
|
1030
|
+
# set the HTTP header `Accept`
|
|
1031
|
+
_header_params['Accept'] = self.api_client.select_header_accept(
|
|
1032
|
+
[
|
|
1033
|
+
'application/json'
|
|
1034
|
+
]
|
|
1035
|
+
)
|
|
1036
|
+
|
|
1037
|
+
|
|
1038
|
+
# authentication setting
|
|
1039
|
+
_auth_settings: List[str] = [
|
|
1040
|
+
]
|
|
1041
|
+
|
|
1042
|
+
return self.api_client.param_serialize(
|
|
1043
|
+
method='GET',
|
|
1044
|
+
resource_path='/v1/{name_15}',
|
|
1045
|
+
path_params=_path_params,
|
|
1046
|
+
query_params=_query_params,
|
|
1047
|
+
header_params=_header_params,
|
|
1048
|
+
body=_body_params,
|
|
1049
|
+
post_params=_form_params,
|
|
1050
|
+
files=_files,
|
|
1051
|
+
auth_settings=_auth_settings,
|
|
1052
|
+
collection_formats=_collection_formats,
|
|
1053
|
+
_host=_host,
|
|
1054
|
+
_request_auth=_request_auth
|
|
1055
|
+
)
|
|
1056
|
+
|
|
1057
|
+
|