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