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.
Files changed (83) hide show
  1. eval_studio_client/api/__init__.py +20 -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 +1057 -0
  7. eval_studio_client/api/api/workflow_service_api.py +1420 -101
  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/TestServiceApi.md +268 -0
  11. eval_studio_client/api/docs/TestServiceGrantTestAccessRequest.md +30 -0
  12. eval_studio_client/api/docs/TestServiceRevokeTestAccessRequest.md +30 -0
  13. eval_studio_client/api/docs/V1FindWorkflowsByCollectionIDResponse.md +29 -0
  14. eval_studio_client/api/docs/V1GetStatsResponse.md +29 -0
  15. eval_studio_client/api/docs/V1GetWorkflowResultCorpusPatchResponse.md +29 -0
  16. eval_studio_client/api/docs/V1GetWorkflowResultReportResponse.md +29 -0
  17. eval_studio_client/api/docs/V1GetWorkflowResultSummaryResponse.md +32 -0
  18. eval_studio_client/api/docs/V1GetWorkflowResultSystemPromptPatchResponse.md +29 -0
  19. eval_studio_client/api/docs/V1Info.md +1 -0
  20. eval_studio_client/api/docs/V1ListDashboardAccessResponse.md +29 -0
  21. eval_studio_client/api/docs/V1ListDashboardsSharedWithMeResponse.md +29 -0
  22. eval_studio_client/api/docs/V1ListTestAccessResponse.md +29 -0
  23. eval_studio_client/api/docs/V1ListTestsSharedWithMeResponse.md +29 -0
  24. eval_studio_client/api/docs/V1ListWorkflowAccessResponse.md +29 -0
  25. eval_studio_client/api/docs/V1ListWorkflowsSharedWithMeResponse.md +29 -0
  26. eval_studio_client/api/docs/V1Role.md +12 -0
  27. eval_studio_client/api/docs/V1RoleBinding.md +32 -0
  28. eval_studio_client/api/docs/V1Stats.md +31 -0
  29. eval_studio_client/api/docs/V1WorkflowResultArtifactType.md +12 -0
  30. eval_studio_client/api/docs/WorkflowResultServiceApi.md +280 -0
  31. eval_studio_client/api/docs/WorkflowServiceApi.md +345 -5
  32. eval_studio_client/api/docs/WorkflowServiceRevokeWorkflowAccessRequest.md +30 -0
  33. eval_studio_client/api/models/__init__.py +19 -0
  34. eval_studio_client/api/models/test_service_grant_test_access_request.py +90 -0
  35. eval_studio_client/api/models/test_service_revoke_test_access_request.py +90 -0
  36. eval_studio_client/api/models/v1_find_workflows_by_collection_id_response.py +95 -0
  37. eval_studio_client/api/models/v1_get_stats_response.py +91 -0
  38. eval_studio_client/api/models/v1_get_workflow_result_corpus_patch_response.py +87 -0
  39. eval_studio_client/api/models/v1_get_workflow_result_report_response.py +87 -0
  40. eval_studio_client/api/models/v1_get_workflow_result_summary_response.py +94 -0
  41. eval_studio_client/api/models/v1_get_workflow_result_system_prompt_patch_response.py +87 -0
  42. eval_studio_client/api/models/v1_info.py +4 -2
  43. eval_studio_client/api/models/v1_list_dashboard_access_response.py +95 -0
  44. eval_studio_client/api/models/v1_list_dashboards_shared_with_me_response.py +95 -0
  45. eval_studio_client/api/models/v1_list_test_access_response.py +95 -0
  46. eval_studio_client/api/models/v1_list_tests_shared_with_me_response.py +95 -0
  47. eval_studio_client/api/models/v1_list_workflow_access_response.py +95 -0
  48. eval_studio_client/api/models/v1_list_workflows_shared_with_me_response.py +95 -0
  49. eval_studio_client/api/models/v1_role.py +38 -0
  50. eval_studio_client/api/models/v1_role_binding.py +92 -0
  51. eval_studio_client/api/models/v1_stats.py +99 -0
  52. eval_studio_client/api/models/v1_workflow_result_artifact_type.py +40 -0
  53. eval_studio_client/api/models/workflow_service_revoke_workflow_access_request.py +90 -0
  54. eval_studio_client/api/test/test_dashboard_service_api.py +28 -0
  55. eval_studio_client/api/test/test_info_service_api.py +6 -0
  56. eval_studio_client/api/test/test_test_service_api.py +24 -0
  57. eval_studio_client/api/test/test_test_service_grant_test_access_request.py +52 -0
  58. eval_studio_client/api/test/test_test_service_revoke_test_access_request.py +52 -0
  59. eval_studio_client/api/test/test_v1_find_workflows_by_collection_id_response.py +95 -0
  60. eval_studio_client/api/test/test_v1_get_info_response.py +2 -1
  61. eval_studio_client/api/test/test_v1_get_stats_response.py +53 -0
  62. eval_studio_client/api/test/test_v1_get_workflow_result_corpus_patch_response.py +51 -0
  63. eval_studio_client/api/test/test_v1_get_workflow_result_report_response.py +51 -0
  64. eval_studio_client/api/test/test_v1_get_workflow_result_summary_response.py +58 -0
  65. eval_studio_client/api/test/test_v1_get_workflow_result_system_prompt_patch_response.py +51 -0
  66. eval_studio_client/api/test/test_v1_info.py +2 -1
  67. eval_studio_client/api/test/test_v1_list_dashboard_access_response.py +56 -0
  68. eval_studio_client/api/test/test_v1_list_dashboards_shared_with_me_response.py +69 -0
  69. eval_studio_client/api/test/test_v1_list_test_access_response.py +56 -0
  70. eval_studio_client/api/test/test_v1_list_tests_shared_with_me_response.py +70 -0
  71. eval_studio_client/api/test/test_v1_list_workflow_access_response.py +56 -0
  72. eval_studio_client/api/test/test_v1_list_workflows_shared_with_me_response.py +95 -0
  73. eval_studio_client/api/test/test_v1_role.py +33 -0
  74. eval_studio_client/api/test/test_v1_role_binding.py +53 -0
  75. eval_studio_client/api/test/test_v1_stats.py +52 -0
  76. eval_studio_client/api/test/test_v1_workflow_result_artifact_type.py +33 -0
  77. eval_studio_client/api/test/test_workflow_result_service_api.py +59 -0
  78. eval_studio_client/api/test/test_workflow_service_api.py +35 -0
  79. eval_studio_client/api/test/test_workflow_service_revoke_workflow_access_request.py +52 -0
  80. eval_studio_client/gen/openapiv2/eval_studio.swagger.json +905 -16
  81. {eval_studio_client-1.2.0a1.dist-info → eval_studio_client-1.2.0a2.dist-info}/METADATA +2 -1
  82. {eval_studio_client-1.2.0a1.dist-info → eval_studio_client-1.2.0a2.dist-info}/RECORD +83 -23
  83. {eval_studio_client-1.2.0a1.dist-info → eval_studio_client-1.2.0a2.dist-info}/WHEEL +0 -0
@@ -0,0 +1,280 @@
1
+ # eval_studio_client.api.WorkflowResultServiceApi
2
+
3
+ All URIs are relative to *http://localhost*
4
+
5
+ Method | HTTP request | Description
6
+ ------------- | ------------- | -------------
7
+ [**workflow_result_service_get_workflow_result_corpus_patch**](WorkflowResultServiceApi.md#workflow_result_service_get_workflow_result_corpus_patch) | **GET** /v1/{name_14} | 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.
8
+ [**workflow_result_service_get_workflow_result_report**](WorkflowResultServiceApi.md#workflow_result_service_get_workflow_result_report) | **GET** /v1/{name_13} | GetWorkflowResultReport retrieves the report of a Workflow result. The report is a detailed HTML document summarizing the Workflow's execution and findings.
9
+ [**workflow_result_service_get_workflow_result_summary**](WorkflowResultServiceApi.md#workflow_result_service_get_workflow_result_summary) | **GET** /v1/{name_12} | 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.
10
+ [**workflow_result_service_get_workflow_result_system_prompt_patch**](WorkflowResultServiceApi.md#workflow_result_service_get_workflow_result_system_prompt_patch) | **GET** /v1/{name_15} | GetWorkflowResultSystemPromptPatch retrieves the system prompt patch of a Workflow result.
11
+
12
+
13
+ # **workflow_result_service_get_workflow_result_corpus_patch**
14
+ > V1GetWorkflowResultCorpusPatchResponse workflow_result_service_get_workflow_result_corpus_patch(name_14)
15
+
16
+ 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.
17
+
18
+ ### Example
19
+
20
+
21
+ ```python
22
+ import eval_studio_client.api
23
+ from eval_studio_client.api.models.v1_get_workflow_result_corpus_patch_response import V1GetWorkflowResultCorpusPatchResponse
24
+ from eval_studio_client.api.rest import ApiException
25
+ from pprint import pprint
26
+
27
+ # Defining the host is optional and defaults to http://localhost
28
+ # See configuration.py for a list of all supported configuration parameters.
29
+ configuration = eval_studio_client.api.Configuration(
30
+ host = "http://localhost"
31
+ )
32
+
33
+
34
+ # Enter a context with an instance of the API client
35
+ with eval_studio_client.api.ApiClient(configuration) as api_client:
36
+ # Create an instance of the API class
37
+ api_instance = eval_studio_client.api.WorkflowResultServiceApi(api_client)
38
+ name_14 = 'name_14_example' # str | Required. The name of the corpus patch workflow for which to retrieve the corpus patch.
39
+
40
+ try:
41
+ # 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.
42
+ api_response = api_instance.workflow_result_service_get_workflow_result_corpus_patch(name_14)
43
+ print("The response of WorkflowResultServiceApi->workflow_result_service_get_workflow_result_corpus_patch:\n")
44
+ pprint(api_response)
45
+ except Exception as e:
46
+ print("Exception when calling WorkflowResultServiceApi->workflow_result_service_get_workflow_result_corpus_patch: %s\n" % e)
47
+ ```
48
+
49
+
50
+
51
+ ### Parameters
52
+
53
+
54
+ Name | Type | Description | Notes
55
+ ------------- | ------------- | ------------- | -------------
56
+ **name_14** | **str**| Required. The name of the corpus patch workflow for which to retrieve the corpus patch. |
57
+
58
+ ### Return type
59
+
60
+ [**V1GetWorkflowResultCorpusPatchResponse**](V1GetWorkflowResultCorpusPatchResponse.md)
61
+
62
+ ### Authorization
63
+
64
+ No authorization required
65
+
66
+ ### HTTP request headers
67
+
68
+ - **Content-Type**: Not defined
69
+ - **Accept**: application/json
70
+
71
+ ### HTTP response details
72
+
73
+ | Status code | Description | Response headers |
74
+ |-------------|-------------|------------------|
75
+ **200** | A successful response. | - |
76
+ **0** | An unexpected error response. | - |
77
+
78
+ [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
79
+
80
+ # **workflow_result_service_get_workflow_result_report**
81
+ > V1GetWorkflowResultReportResponse workflow_result_service_get_workflow_result_report(name_13)
82
+
83
+ GetWorkflowResultReport retrieves the report of a Workflow result. The report is a detailed HTML document summarizing the Workflow's execution and findings.
84
+
85
+ ### Example
86
+
87
+
88
+ ```python
89
+ import eval_studio_client.api
90
+ from eval_studio_client.api.models.v1_get_workflow_result_report_response import V1GetWorkflowResultReportResponse
91
+ from eval_studio_client.api.rest import ApiException
92
+ from pprint import pprint
93
+
94
+ # Defining the host is optional and defaults to http://localhost
95
+ # See configuration.py for a list of all supported configuration parameters.
96
+ configuration = eval_studio_client.api.Configuration(
97
+ host = "http://localhost"
98
+ )
99
+
100
+
101
+ # Enter a context with an instance of the API client
102
+ with eval_studio_client.api.ApiClient(configuration) as api_client:
103
+ # Create an instance of the API class
104
+ api_instance = eval_studio_client.api.WorkflowResultServiceApi(api_client)
105
+ name_13 = 'name_13_example' # str | Required. The name of the report workflow for which to retrieve the report.
106
+
107
+ try:
108
+ # GetWorkflowResultReport retrieves the report of a Workflow result. The report is a detailed HTML document summarizing the Workflow's execution and findings.
109
+ api_response = api_instance.workflow_result_service_get_workflow_result_report(name_13)
110
+ print("The response of WorkflowResultServiceApi->workflow_result_service_get_workflow_result_report:\n")
111
+ pprint(api_response)
112
+ except Exception as e:
113
+ print("Exception when calling WorkflowResultServiceApi->workflow_result_service_get_workflow_result_report: %s\n" % e)
114
+ ```
115
+
116
+
117
+
118
+ ### Parameters
119
+
120
+
121
+ Name | Type | Description | Notes
122
+ ------------- | ------------- | ------------- | -------------
123
+ **name_13** | **str**| Required. The name of the report workflow for which to retrieve the report. |
124
+
125
+ ### Return type
126
+
127
+ [**V1GetWorkflowResultReportResponse**](V1GetWorkflowResultReportResponse.md)
128
+
129
+ ### Authorization
130
+
131
+ No authorization required
132
+
133
+ ### HTTP request headers
134
+
135
+ - **Content-Type**: Not defined
136
+ - **Accept**: application/json
137
+
138
+ ### HTTP response details
139
+
140
+ | Status code | Description | Response headers |
141
+ |-------------|-------------|------------------|
142
+ **200** | A successful response. | - |
143
+ **0** | An unexpected error response. | - |
144
+
145
+ [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
146
+
147
+ # **workflow_result_service_get_workflow_result_summary**
148
+ > V1GetWorkflowResultSummaryResponse workflow_result_service_get_workflow_result_summary(name_12)
149
+
150
+ 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.
151
+
152
+ ### Example
153
+
154
+
155
+ ```python
156
+ import eval_studio_client.api
157
+ from eval_studio_client.api.models.v1_get_workflow_result_summary_response import V1GetWorkflowResultSummaryResponse
158
+ from eval_studio_client.api.rest import ApiException
159
+ from pprint import pprint
160
+
161
+ # Defining the host is optional and defaults to http://localhost
162
+ # See configuration.py for a list of all supported configuration parameters.
163
+ configuration = eval_studio_client.api.Configuration(
164
+ host = "http://localhost"
165
+ )
166
+
167
+
168
+ # Enter a context with an instance of the API client
169
+ with eval_studio_client.api.ApiClient(configuration) as api_client:
170
+ # Create an instance of the API class
171
+ api_instance = eval_studio_client.api.WorkflowResultServiceApi(api_client)
172
+ name_12 = 'name_12_example' # str | Required. The name of the Workflow for which to retrieve the 3x3x3 summary.
173
+
174
+ try:
175
+ # 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.
176
+ api_response = api_instance.workflow_result_service_get_workflow_result_summary(name_12)
177
+ print("The response of WorkflowResultServiceApi->workflow_result_service_get_workflow_result_summary:\n")
178
+ pprint(api_response)
179
+ except Exception as e:
180
+ print("Exception when calling WorkflowResultServiceApi->workflow_result_service_get_workflow_result_summary: %s\n" % e)
181
+ ```
182
+
183
+
184
+
185
+ ### Parameters
186
+
187
+
188
+ Name | Type | Description | Notes
189
+ ------------- | ------------- | ------------- | -------------
190
+ **name_12** | **str**| Required. The name of the Workflow for which to retrieve the 3x3x3 summary. |
191
+
192
+ ### Return type
193
+
194
+ [**V1GetWorkflowResultSummaryResponse**](V1GetWorkflowResultSummaryResponse.md)
195
+
196
+ ### Authorization
197
+
198
+ No authorization required
199
+
200
+ ### HTTP request headers
201
+
202
+ - **Content-Type**: Not defined
203
+ - **Accept**: application/json
204
+
205
+ ### HTTP response details
206
+
207
+ | Status code | Description | Response headers |
208
+ |-------------|-------------|------------------|
209
+ **200** | A successful response. | - |
210
+ **0** | An unexpected error response. | - |
211
+
212
+ [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
213
+
214
+ # **workflow_result_service_get_workflow_result_system_prompt_patch**
215
+ > V1GetWorkflowResultSystemPromptPatchResponse workflow_result_service_get_workflow_result_system_prompt_patch(name_15)
216
+
217
+ GetWorkflowResultSystemPromptPatch retrieves the system prompt patch of a Workflow result.
218
+
219
+ ### Example
220
+
221
+
222
+ ```python
223
+ import eval_studio_client.api
224
+ from eval_studio_client.api.models.v1_get_workflow_result_system_prompt_patch_response import V1GetWorkflowResultSystemPromptPatchResponse
225
+ from eval_studio_client.api.rest import ApiException
226
+ from pprint import pprint
227
+
228
+ # Defining the host is optional and defaults to http://localhost
229
+ # See configuration.py for a list of all supported configuration parameters.
230
+ configuration = eval_studio_client.api.Configuration(
231
+ host = "http://localhost"
232
+ )
233
+
234
+
235
+ # Enter a context with an instance of the API client
236
+ with eval_studio_client.api.ApiClient(configuration) as api_client:
237
+ # Create an instance of the API class
238
+ api_instance = eval_studio_client.api.WorkflowResultServiceApi(api_client)
239
+ name_15 = 'name_15_example' # str | Required. The name of the system prompt patch workflow for which to retrieve the system prompt patch.
240
+
241
+ try:
242
+ # GetWorkflowResultSystemPromptPatch retrieves the system prompt patch of a Workflow result.
243
+ api_response = api_instance.workflow_result_service_get_workflow_result_system_prompt_patch(name_15)
244
+ print("The response of WorkflowResultServiceApi->workflow_result_service_get_workflow_result_system_prompt_patch:\n")
245
+ pprint(api_response)
246
+ except Exception as e:
247
+ print("Exception when calling WorkflowResultServiceApi->workflow_result_service_get_workflow_result_system_prompt_patch: %s\n" % e)
248
+ ```
249
+
250
+
251
+
252
+ ### Parameters
253
+
254
+
255
+ Name | Type | Description | Notes
256
+ ------------- | ------------- | ------------- | -------------
257
+ **name_15** | **str**| Required. The name of the system prompt patch workflow for which to retrieve the system prompt patch. |
258
+
259
+ ### Return type
260
+
261
+ [**V1GetWorkflowResultSystemPromptPatchResponse**](V1GetWorkflowResultSystemPromptPatchResponse.md)
262
+
263
+ ### Authorization
264
+
265
+ No authorization required
266
+
267
+ ### HTTP request headers
268
+
269
+ - **Content-Type**: Not defined
270
+ - **Accept**: application/json
271
+
272
+ ### HTTP response details
273
+
274
+ | Status code | Description | Response headers |
275
+ |-------------|-------------|------------------|
276
+ **200** | A successful response. | - |
277
+ **0** | An unexpected error response. | - |
278
+
279
+ [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
280
+
@@ -8,10 +8,15 @@ Method | HTTP request | Description
8
8
  [**workflow_service_clone_workflow**](WorkflowServiceApi.md#workflow_service_clone_workflow) | **POST** /v1/{name_1}:clone | CloneWorkflow clones an existing Workflow.
9
9
  [**workflow_service_create_workflow**](WorkflowServiceApi.md#workflow_service_create_workflow) | **POST** /v1/workflows | CreateWorkflow creates a Workflow.
10
10
  [**workflow_service_delete_workflow**](WorkflowServiceApi.md#workflow_service_delete_workflow) | **DELETE** /v1/{name_9} | DeleteWorkflow deletes a Workflow by name. If the Workflow does not exist an error is returned.
11
+ [**workflow_service_find_workflows_by_collection_id**](WorkflowServiceApi.md#workflow_service_find_workflows_by_collection_id) | **GET** /v1/workflows:findWorkflowByH2OGPTeCollectionID | FindWorkflowByCollectionID finds a Workflow by used H2OGPTe collection ID.
11
12
  [**workflow_service_get_guardrails_configuration**](WorkflowServiceApi.md#workflow_service_get_guardrails_configuration) | **GET** /v1/{name}:getGuardrailsConfiguration |
12
- [**workflow_service_get_workflow**](WorkflowServiceApi.md#workflow_service_get_workflow) | **GET** /v1/{name_12} | GetWorkflow retrieves a Workflow by name. Deleted Workflow is returned without error, it has a delete_time and deleter fields set.
13
+ [**workflow_service_get_workflow**](WorkflowServiceApi.md#workflow_service_get_workflow) | **GET** /v1/{name_16} | GetWorkflow retrieves a Workflow by name. Deleted Workflow is returned without error, it has a delete_time and deleter fields set.
14
+ [**workflow_service_grant_workflow_access**](WorkflowServiceApi.md#workflow_service_grant_workflow_access) | **POST** /v1/{name_2}:grantAccess | GrantWorkflowAccess grants access to a Workflow to a subject with a specified role.
15
+ [**workflow_service_list_workflow_access**](WorkflowServiceApi.md#workflow_service_list_workflow_access) | **GET** /v1/{name_2}:listAccess | ListWorkflowAccess lists access to a Workflow.
13
16
  [**workflow_service_list_workflow_dependencies**](WorkflowServiceApi.md#workflow_service_list_workflow_dependencies) | **GET** /v1/{name}:nodeDependencies | ListWorkflowDependencies lists workflow nodes and map of the node dependencies.
14
17
  [**workflow_service_list_workflows**](WorkflowServiceApi.md#workflow_service_list_workflows) | **GET** /v1/workflows | ListWorkflows lists Workflows.
18
+ [**workflow_service_list_workflows_shared_with_me**](WorkflowServiceApi.md#workflow_service_list_workflows_shared_with_me) | **GET** /v1/workflows:sharedWithMe | ListWorkflowsSharedWithMe lists Workflows shared with the authenticated user.
19
+ [**workflow_service_revoke_workflow_access**](WorkflowServiceApi.md#workflow_service_revoke_workflow_access) | **POST** /v1/{name_2}:revokeAccess | RevokeWorkflowAccess revokes access to a Workflow from a subject.
15
20
  [**workflow_service_update_workflow**](WorkflowServiceApi.md#workflow_service_update_workflow) | **PATCH** /v1/{workflow.name} | UpdateWorkflow updates a Workflow. The update_mask is used to specify the fields to be updated.
16
21
 
17
22
 
@@ -288,6 +293,73 @@ No authorization required
288
293
 
289
294
  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
290
295
 
296
+ # **workflow_service_find_workflows_by_collection_id**
297
+ > V1FindWorkflowsByCollectionIDResponse workflow_service_find_workflows_by_collection_id(collection_id=collection_id)
298
+
299
+ FindWorkflowByCollectionID finds a Workflow by used H2OGPTe collection ID.
300
+
301
+ ### Example
302
+
303
+
304
+ ```python
305
+ import eval_studio_client.api
306
+ from eval_studio_client.api.models.v1_find_workflows_by_collection_id_response import V1FindWorkflowsByCollectionIDResponse
307
+ from eval_studio_client.api.rest import ApiException
308
+ from pprint import pprint
309
+
310
+ # Defining the host is optional and defaults to http://localhost
311
+ # See configuration.py for a list of all supported configuration parameters.
312
+ configuration = eval_studio_client.api.Configuration(
313
+ host = "http://localhost"
314
+ )
315
+
316
+
317
+ # Enter a context with an instance of the API client
318
+ with eval_studio_client.api.ApiClient(configuration) as api_client:
319
+ # Create an instance of the API class
320
+ api_instance = eval_studio_client.api.WorkflowServiceApi(api_client)
321
+ collection_id = 'collection_id_example' # str | Required. The H2OGPTe collection ID to find the Workflow by. (optional)
322
+
323
+ try:
324
+ # FindWorkflowByCollectionID finds a Workflow by used H2OGPTe collection ID.
325
+ api_response = api_instance.workflow_service_find_workflows_by_collection_id(collection_id=collection_id)
326
+ print("The response of WorkflowServiceApi->workflow_service_find_workflows_by_collection_id:\n")
327
+ pprint(api_response)
328
+ except Exception as e:
329
+ print("Exception when calling WorkflowServiceApi->workflow_service_find_workflows_by_collection_id: %s\n" % e)
330
+ ```
331
+
332
+
333
+
334
+ ### Parameters
335
+
336
+
337
+ Name | Type | Description | Notes
338
+ ------------- | ------------- | ------------- | -------------
339
+ **collection_id** | **str**| Required. The H2OGPTe collection ID to find the Workflow by. | [optional]
340
+
341
+ ### Return type
342
+
343
+ [**V1FindWorkflowsByCollectionIDResponse**](V1FindWorkflowsByCollectionIDResponse.md)
344
+
345
+ ### Authorization
346
+
347
+ No authorization required
348
+
349
+ ### HTTP request headers
350
+
351
+ - **Content-Type**: Not defined
352
+ - **Accept**: application/json
353
+
354
+ ### HTTP response details
355
+
356
+ | Status code | Description | Response headers |
357
+ |-------------|-------------|------------------|
358
+ **200** | A successful response. | - |
359
+ **0** | An unexpected error response. | - |
360
+
361
+ [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
362
+
291
363
  # **workflow_service_get_guardrails_configuration**
292
364
  > V1GetGuardrailsConfigurationResponse workflow_service_get_guardrails_configuration(name)
293
365
 
@@ -355,7 +427,7 @@ No authorization required
355
427
  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
356
428
 
357
429
  # **workflow_service_get_workflow**
358
- > V1GetWorkflowResponse workflow_service_get_workflow(name_12)
430
+ > V1GetWorkflowResponse workflow_service_get_workflow(name_16)
359
431
 
360
432
  GetWorkflow retrieves a Workflow by name. Deleted Workflow is returned without error, it has a delete_time and deleter fields set.
361
433
 
@@ -379,11 +451,11 @@ configuration = eval_studio_client.api.Configuration(
379
451
  with eval_studio_client.api.ApiClient(configuration) as api_client:
380
452
  # Create an instance of the API class
381
453
  api_instance = eval_studio_client.api.WorkflowServiceApi(api_client)
382
- name_12 = 'name_12_example' # str | Required. The name of the Workflow to retrieve.
454
+ name_16 = 'name_16_example' # str | Required. The name of the Workflow to retrieve.
383
455
 
384
456
  try:
385
457
  # GetWorkflow retrieves a Workflow by name. Deleted Workflow is returned without error, it has a delete_time and deleter fields set.
386
- api_response = api_instance.workflow_service_get_workflow(name_12)
458
+ api_response = api_instance.workflow_service_get_workflow(name_16)
387
459
  print("The response of WorkflowServiceApi->workflow_service_get_workflow:\n")
388
460
  pprint(api_response)
389
461
  except Exception as e:
@@ -397,7 +469,7 @@ with eval_studio_client.api.ApiClient(configuration) as api_client:
397
469
 
398
470
  Name | Type | Description | Notes
399
471
  ------------- | ------------- | ------------- | -------------
400
- **name_12** | **str**| Required. The name of the Workflow to retrieve. |
472
+ **name_16** | **str**| Required. The name of the Workflow to retrieve. |
401
473
 
402
474
  ### Return type
403
475
 
@@ -421,6 +493,142 @@ No authorization required
421
493
 
422
494
  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
423
495
 
496
+ # **workflow_service_grant_workflow_access**
497
+ > object workflow_service_grant_workflow_access(name_2, body)
498
+
499
+ GrantWorkflowAccess grants access to a Workflow to a subject with a specified role.
500
+
501
+ ### Example
502
+
503
+
504
+ ```python
505
+ import eval_studio_client.api
506
+ from eval_studio_client.api.models.test_service_grant_test_access_request import TestServiceGrantTestAccessRequest
507
+ from eval_studio_client.api.rest import ApiException
508
+ from pprint import pprint
509
+
510
+ # Defining the host is optional and defaults to http://localhost
511
+ # See configuration.py for a list of all supported configuration parameters.
512
+ configuration = eval_studio_client.api.Configuration(
513
+ host = "http://localhost"
514
+ )
515
+
516
+
517
+ # Enter a context with an instance of the API client
518
+ with eval_studio_client.api.ApiClient(configuration) as api_client:
519
+ # Create an instance of the API class
520
+ api_instance = eval_studio_client.api.WorkflowServiceApi(api_client)
521
+ name_2 = 'name_2_example' # str | Required. The name of the Workflow to grant access to.
522
+ body = eval_studio_client.api.TestServiceGrantTestAccessRequest() # TestServiceGrantTestAccessRequest |
523
+
524
+ try:
525
+ # GrantWorkflowAccess grants access to a Workflow to a subject with a specified role.
526
+ api_response = api_instance.workflow_service_grant_workflow_access(name_2, body)
527
+ print("The response of WorkflowServiceApi->workflow_service_grant_workflow_access:\n")
528
+ pprint(api_response)
529
+ except Exception as e:
530
+ print("Exception when calling WorkflowServiceApi->workflow_service_grant_workflow_access: %s\n" % e)
531
+ ```
532
+
533
+
534
+
535
+ ### Parameters
536
+
537
+
538
+ Name | Type | Description | Notes
539
+ ------------- | ------------- | ------------- | -------------
540
+ **name_2** | **str**| Required. The name of the Workflow to grant access to. |
541
+ **body** | [**TestServiceGrantTestAccessRequest**](TestServiceGrantTestAccessRequest.md)| |
542
+
543
+ ### Return type
544
+
545
+ **object**
546
+
547
+ ### Authorization
548
+
549
+ No authorization required
550
+
551
+ ### HTTP request headers
552
+
553
+ - **Content-Type**: application/json
554
+ - **Accept**: application/json
555
+
556
+ ### HTTP response details
557
+
558
+ | Status code | Description | Response headers |
559
+ |-------------|-------------|------------------|
560
+ **200** | A successful response. | - |
561
+ **0** | An unexpected error response. | - |
562
+
563
+ [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
564
+
565
+ # **workflow_service_list_workflow_access**
566
+ > V1ListWorkflowAccessResponse workflow_service_list_workflow_access(name_2)
567
+
568
+ ListWorkflowAccess lists access to a Workflow.
569
+
570
+ ### Example
571
+
572
+
573
+ ```python
574
+ import eval_studio_client.api
575
+ from eval_studio_client.api.models.v1_list_workflow_access_response import V1ListWorkflowAccessResponse
576
+ from eval_studio_client.api.rest import ApiException
577
+ from pprint import pprint
578
+
579
+ # Defining the host is optional and defaults to http://localhost
580
+ # See configuration.py for a list of all supported configuration parameters.
581
+ configuration = eval_studio_client.api.Configuration(
582
+ host = "http://localhost"
583
+ )
584
+
585
+
586
+ # Enter a context with an instance of the API client
587
+ with eval_studio_client.api.ApiClient(configuration) as api_client:
588
+ # Create an instance of the API class
589
+ api_instance = eval_studio_client.api.WorkflowServiceApi(api_client)
590
+ name_2 = 'name_2_example' # str | Required. The name of the Workflow to list access for.
591
+
592
+ try:
593
+ # ListWorkflowAccess lists access to a Workflow.
594
+ api_response = api_instance.workflow_service_list_workflow_access(name_2)
595
+ print("The response of WorkflowServiceApi->workflow_service_list_workflow_access:\n")
596
+ pprint(api_response)
597
+ except Exception as e:
598
+ print("Exception when calling WorkflowServiceApi->workflow_service_list_workflow_access: %s\n" % e)
599
+ ```
600
+
601
+
602
+
603
+ ### Parameters
604
+
605
+
606
+ Name | Type | Description | Notes
607
+ ------------- | ------------- | ------------- | -------------
608
+ **name_2** | **str**| Required. The name of the Workflow to list access for. |
609
+
610
+ ### Return type
611
+
612
+ [**V1ListWorkflowAccessResponse**](V1ListWorkflowAccessResponse.md)
613
+
614
+ ### Authorization
615
+
616
+ No authorization required
617
+
618
+ ### HTTP request headers
619
+
620
+ - **Content-Type**: Not defined
621
+ - **Accept**: application/json
622
+
623
+ ### HTTP response details
624
+
625
+ | Status code | Description | Response headers |
626
+ |-------------|-------------|------------------|
627
+ **200** | A successful response. | - |
628
+ **0** | An unexpected error response. | - |
629
+
630
+ [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
631
+
424
632
  # **workflow_service_list_workflow_dependencies**
425
633
  > V1ListWorkflowDependenciesResponse workflow_service_list_workflow_dependencies(name)
426
634
 
@@ -551,6 +759,138 @@ No authorization required
551
759
 
552
760
  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
553
761
 
762
+ # **workflow_service_list_workflows_shared_with_me**
763
+ > V1ListWorkflowsSharedWithMeResponse workflow_service_list_workflows_shared_with_me()
764
+
765
+ ListWorkflowsSharedWithMe lists Workflows shared with the authenticated user.
766
+
767
+ ### Example
768
+
769
+
770
+ ```python
771
+ import eval_studio_client.api
772
+ from eval_studio_client.api.models.v1_list_workflows_shared_with_me_response import V1ListWorkflowsSharedWithMeResponse
773
+ from eval_studio_client.api.rest import ApiException
774
+ from pprint import pprint
775
+
776
+ # Defining the host is optional and defaults to http://localhost
777
+ # See configuration.py for a list of all supported configuration parameters.
778
+ configuration = eval_studio_client.api.Configuration(
779
+ host = "http://localhost"
780
+ )
781
+
782
+
783
+ # Enter a context with an instance of the API client
784
+ with eval_studio_client.api.ApiClient(configuration) as api_client:
785
+ # Create an instance of the API class
786
+ api_instance = eval_studio_client.api.WorkflowServiceApi(api_client)
787
+
788
+ try:
789
+ # ListWorkflowsSharedWithMe lists Workflows shared with the authenticated user.
790
+ api_response = api_instance.workflow_service_list_workflows_shared_with_me()
791
+ print("The response of WorkflowServiceApi->workflow_service_list_workflows_shared_with_me:\n")
792
+ pprint(api_response)
793
+ except Exception as e:
794
+ print("Exception when calling WorkflowServiceApi->workflow_service_list_workflows_shared_with_me: %s\n" % e)
795
+ ```
796
+
797
+
798
+
799
+ ### Parameters
800
+
801
+ This endpoint does not need any parameter.
802
+
803
+ ### Return type
804
+
805
+ [**V1ListWorkflowsSharedWithMeResponse**](V1ListWorkflowsSharedWithMeResponse.md)
806
+
807
+ ### Authorization
808
+
809
+ No authorization required
810
+
811
+ ### HTTP request headers
812
+
813
+ - **Content-Type**: Not defined
814
+ - **Accept**: application/json
815
+
816
+ ### HTTP response details
817
+
818
+ | Status code | Description | Response headers |
819
+ |-------------|-------------|------------------|
820
+ **200** | A successful response. | - |
821
+ **0** | An unexpected error response. | - |
822
+
823
+ [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
824
+
825
+ # **workflow_service_revoke_workflow_access**
826
+ > object workflow_service_revoke_workflow_access(name_2, body)
827
+
828
+ RevokeWorkflowAccess revokes access to a Workflow from a subject.
829
+
830
+ ### Example
831
+
832
+
833
+ ```python
834
+ import eval_studio_client.api
835
+ from eval_studio_client.api.models.workflow_service_revoke_workflow_access_request import WorkflowServiceRevokeWorkflowAccessRequest
836
+ from eval_studio_client.api.rest import ApiException
837
+ from pprint import pprint
838
+
839
+ # Defining the host is optional and defaults to http://localhost
840
+ # See configuration.py for a list of all supported configuration parameters.
841
+ configuration = eval_studio_client.api.Configuration(
842
+ host = "http://localhost"
843
+ )
844
+
845
+
846
+ # Enter a context with an instance of the API client
847
+ with eval_studio_client.api.ApiClient(configuration) as api_client:
848
+ # Create an instance of the API class
849
+ api_instance = eval_studio_client.api.WorkflowServiceApi(api_client)
850
+ name_2 = 'name_2_example' # str | Required. The name of the Workflow to revoke access from.
851
+ body = eval_studio_client.api.WorkflowServiceRevokeWorkflowAccessRequest() # WorkflowServiceRevokeWorkflowAccessRequest |
852
+
853
+ try:
854
+ # RevokeWorkflowAccess revokes access to a Workflow from a subject.
855
+ api_response = api_instance.workflow_service_revoke_workflow_access(name_2, body)
856
+ print("The response of WorkflowServiceApi->workflow_service_revoke_workflow_access:\n")
857
+ pprint(api_response)
858
+ except Exception as e:
859
+ print("Exception when calling WorkflowServiceApi->workflow_service_revoke_workflow_access: %s\n" % e)
860
+ ```
861
+
862
+
863
+
864
+ ### Parameters
865
+
866
+
867
+ Name | Type | Description | Notes
868
+ ------------- | ------------- | ------------- | -------------
869
+ **name_2** | **str**| Required. The name of the Workflow to revoke access from. |
870
+ **body** | [**WorkflowServiceRevokeWorkflowAccessRequest**](WorkflowServiceRevokeWorkflowAccessRequest.md)| |
871
+
872
+ ### Return type
873
+
874
+ **object**
875
+
876
+ ### Authorization
877
+
878
+ No authorization required
879
+
880
+ ### HTTP request headers
881
+
882
+ - **Content-Type**: application/json
883
+ - **Accept**: application/json
884
+
885
+ ### HTTP response details
886
+
887
+ | Status code | Description | Response headers |
888
+ |-------------|-------------|------------------|
889
+ **200** | A successful response. | - |
890
+ **0** | An unexpected error response. | - |
891
+
892
+ [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
893
+
554
894
  # **workflow_service_update_workflow**
555
895
  > V1UpdateWorkflowResponse workflow_service_update_workflow(workflow_name, workflow)
556
896