eval-studio-client 0.7.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 (470) hide show
  1. eval_studio_client/__about__.py +1 -0
  2. eval_studio_client/__init__.py +4 -0
  3. eval_studio_client/api/__init__.py +180 -0
  4. eval_studio_client/api/api/__init__.py +20 -0
  5. eval_studio_client/api/api/dashboard_service_api.py +2142 -0
  6. eval_studio_client/api/api/document_service_api.py +1868 -0
  7. eval_studio_client/api/api/evaluation_service_api.py +1603 -0
  8. eval_studio_client/api/api/evaluator_service_api.py +1343 -0
  9. eval_studio_client/api/api/info_service_api.py +275 -0
  10. eval_studio_client/api/api/leaderboard_service_api.py +3336 -0
  11. eval_studio_client/api/api/model_service_api.py +2913 -0
  12. eval_studio_client/api/api/operation_progress_service_api.py +292 -0
  13. eval_studio_client/api/api/operation_service_api.py +1359 -0
  14. eval_studio_client/api/api/perturbation_service_api.py +321 -0
  15. eval_studio_client/api/api/perturbator_service_api.py +532 -0
  16. eval_studio_client/api/api/test_case_service_api.py +1913 -0
  17. eval_studio_client/api/api/test_class_service_api.py +532 -0
  18. eval_studio_client/api/api/test_lab_service_api.py +634 -0
  19. eval_studio_client/api/api/test_service_api.py +2712 -0
  20. eval_studio_client/api/api/who_am_i_service_api.py +275 -0
  21. eval_studio_client/api/api_client.py +770 -0
  22. eval_studio_client/api/api_response.py +21 -0
  23. eval_studio_client/api/configuration.py +436 -0
  24. eval_studio_client/api/docs/DashboardServiceApi.md +549 -0
  25. eval_studio_client/api/docs/DocumentServiceApi.md +478 -0
  26. eval_studio_client/api/docs/EvaluationServiceApi.md +332 -0
  27. eval_studio_client/api/docs/EvaluatorServiceApi.md +345 -0
  28. eval_studio_client/api/docs/InfoServiceApi.md +71 -0
  29. eval_studio_client/api/docs/LeaderboardServiceApi.md +835 -0
  30. eval_studio_client/api/docs/ModelServiceApi.md +750 -0
  31. eval_studio_client/api/docs/OperationProgressServiceApi.md +75 -0
  32. eval_studio_client/api/docs/OperationServiceApi.md +345 -0
  33. eval_studio_client/api/docs/PerturbationServiceApi.md +78 -0
  34. eval_studio_client/api/docs/PerturbationServiceCreatePerturbationRequest.md +31 -0
  35. eval_studio_client/api/docs/PerturbatorServiceApi.md +138 -0
  36. eval_studio_client/api/docs/ProtobufAny.md +30 -0
  37. eval_studio_client/api/docs/RequiredTheDashboardToUpdate.md +41 -0
  38. eval_studio_client/api/docs/RequiredTheDocumentToUpdate.md +38 -0
  39. eval_studio_client/api/docs/RequiredTheLeaderboardToUpdate.md +54 -0
  40. eval_studio_client/api/docs/RequiredTheModelToUpdate.md +41 -0
  41. eval_studio_client/api/docs/RequiredTheOperationToFinalize.md +39 -0
  42. eval_studio_client/api/docs/RequiredTheOperationToUpdate.md +39 -0
  43. eval_studio_client/api/docs/RequiredTheTestCaseToUpdate.md +39 -0
  44. eval_studio_client/api/docs/RequiredTheTestToUpdate.md +39 -0
  45. eval_studio_client/api/docs/RpcStatus.md +32 -0
  46. eval_studio_client/api/docs/TestCaseServiceApi.md +486 -0
  47. eval_studio_client/api/docs/TestCaseServiceBatchDeleteTestCasesRequest.md +29 -0
  48. eval_studio_client/api/docs/TestClassServiceApi.md +138 -0
  49. eval_studio_client/api/docs/TestLabServiceApi.md +151 -0
  50. eval_studio_client/api/docs/TestServiceApi.md +689 -0
  51. eval_studio_client/api/docs/TestServicePerturbTestRequest.md +31 -0
  52. eval_studio_client/api/docs/V1alphaBatchCreateLeaderboardsRequest.md +31 -0
  53. eval_studio_client/api/docs/V1alphaBatchCreateLeaderboardsResponse.md +29 -0
  54. eval_studio_client/api/docs/V1alphaBatchDeleteDashboardsRequest.md +29 -0
  55. eval_studio_client/api/docs/V1alphaBatchDeleteDashboardsResponse.md +29 -0
  56. eval_studio_client/api/docs/V1alphaBatchDeleteDocumentsRequest.md +29 -0
  57. eval_studio_client/api/docs/V1alphaBatchDeleteDocumentsResponse.md +29 -0
  58. eval_studio_client/api/docs/V1alphaBatchDeleteEvaluatorsRequest.md +29 -0
  59. eval_studio_client/api/docs/V1alphaBatchDeleteEvaluatorsResponse.md +29 -0
  60. eval_studio_client/api/docs/V1alphaBatchDeleteLeaderboardsRequest.md +30 -0
  61. eval_studio_client/api/docs/V1alphaBatchDeleteLeaderboardsResponse.md +29 -0
  62. eval_studio_client/api/docs/V1alphaBatchDeleteModelsRequest.md +29 -0
  63. eval_studio_client/api/docs/V1alphaBatchDeleteModelsResponse.md +29 -0
  64. eval_studio_client/api/docs/V1alphaBatchDeleteTestCasesResponse.md +29 -0
  65. eval_studio_client/api/docs/V1alphaBatchDeleteTestsRequest.md +30 -0
  66. eval_studio_client/api/docs/V1alphaBatchDeleteTestsResponse.md +29 -0
  67. eval_studio_client/api/docs/V1alphaBatchGetDashboardsResponse.md +29 -0
  68. eval_studio_client/api/docs/V1alphaBatchGetDocumentsResponse.md +29 -0
  69. eval_studio_client/api/docs/V1alphaBatchGetLeaderboardsResponse.md +29 -0
  70. eval_studio_client/api/docs/V1alphaBatchGetModelsResponse.md +29 -0
  71. eval_studio_client/api/docs/V1alphaBatchGetOperationsResponse.md +29 -0
  72. eval_studio_client/api/docs/V1alphaBatchGetTestsResponse.md +29 -0
  73. eval_studio_client/api/docs/V1alphaBatchImportLeaderboardRequest.md +37 -0
  74. eval_studio_client/api/docs/V1alphaBatchImportLeaderboardResponse.md +29 -0
  75. eval_studio_client/api/docs/V1alphaBatchImportTestsRequest.md +32 -0
  76. eval_studio_client/api/docs/V1alphaBatchImportTestsResponse.md +29 -0
  77. eval_studio_client/api/docs/V1alphaCheckBaseModelsResponse.md +30 -0
  78. eval_studio_client/api/docs/V1alphaCollectionInfo.md +33 -0
  79. eval_studio_client/api/docs/V1alphaCreateDashboardResponse.md +29 -0
  80. eval_studio_client/api/docs/V1alphaCreateDocumentResponse.md +29 -0
  81. eval_studio_client/api/docs/V1alphaCreateEvaluationRequest.md +37 -0
  82. eval_studio_client/api/docs/V1alphaCreateEvaluatorResponse.md +29 -0
  83. eval_studio_client/api/docs/V1alphaCreateLeaderboardRequest.md +29 -0
  84. eval_studio_client/api/docs/V1alphaCreateLeaderboardResponse.md +29 -0
  85. eval_studio_client/api/docs/V1alphaCreateLeaderboardWithoutCacheResponse.md +29 -0
  86. eval_studio_client/api/docs/V1alphaCreateModelResponse.md +29 -0
  87. eval_studio_client/api/docs/V1alphaCreatePerturbationResponse.md +29 -0
  88. eval_studio_client/api/docs/V1alphaCreateTestCaseResponse.md +29 -0
  89. eval_studio_client/api/docs/V1alphaCreateTestLabResponse.md +29 -0
  90. eval_studio_client/api/docs/V1alphaCreateTestResponse.md +29 -0
  91. eval_studio_client/api/docs/V1alphaDashboard.md +41 -0
  92. eval_studio_client/api/docs/V1alphaDashboardStatus.md +12 -0
  93. eval_studio_client/api/docs/V1alphaDeleteDashboardResponse.md +29 -0
  94. eval_studio_client/api/docs/V1alphaDeleteDocumentResponse.md +29 -0
  95. eval_studio_client/api/docs/V1alphaDeleteEvaluatorResponse.md +29 -0
  96. eval_studio_client/api/docs/V1alphaDeleteLeaderboardResponse.md +29 -0
  97. eval_studio_client/api/docs/V1alphaDeleteModelResponse.md +29 -0
  98. eval_studio_client/api/docs/V1alphaDeleteTestCaseResponse.md +29 -0
  99. eval_studio_client/api/docs/V1alphaDeleteTestResponse.md +29 -0
  100. eval_studio_client/api/docs/V1alphaDocument.md +38 -0
  101. eval_studio_client/api/docs/V1alphaEvaluationTest.md +32 -0
  102. eval_studio_client/api/docs/V1alphaEvaluator.md +45 -0
  103. eval_studio_client/api/docs/V1alphaEvaluatorParamType.md +12 -0
  104. eval_studio_client/api/docs/V1alphaEvaluatorParameter.md +40 -0
  105. eval_studio_client/api/docs/V1alphaEvaluatorView.md +12 -0
  106. eval_studio_client/api/docs/V1alphaFinalizeOperationResponse.md +29 -0
  107. eval_studio_client/api/docs/V1alphaFindAllTestCasesByIDResponse.md +29 -0
  108. eval_studio_client/api/docs/V1alphaFindTestLabResponse.md +29 -0
  109. eval_studio_client/api/docs/V1alphaGetDashboardResponse.md +29 -0
  110. eval_studio_client/api/docs/V1alphaGetDocumentResponse.md +29 -0
  111. eval_studio_client/api/docs/V1alphaGetEvaluatorResponse.md +29 -0
  112. eval_studio_client/api/docs/V1alphaGetInfoResponse.md +29 -0
  113. eval_studio_client/api/docs/V1alphaGetLeaderboardResponse.md +29 -0
  114. eval_studio_client/api/docs/V1alphaGetModelResponse.md +29 -0
  115. eval_studio_client/api/docs/V1alphaGetOperationProgressByParentResponse.md +29 -0
  116. eval_studio_client/api/docs/V1alphaGetOperationResponse.md +29 -0
  117. eval_studio_client/api/docs/V1alphaGetPerturbatorResponse.md +29 -0
  118. eval_studio_client/api/docs/V1alphaGetTestCaseResponse.md +29 -0
  119. eval_studio_client/api/docs/V1alphaGetTestClassResponse.md +29 -0
  120. eval_studio_client/api/docs/V1alphaGetTestResponse.md +29 -0
  121. eval_studio_client/api/docs/V1alphaImportEvaluationRequest.md +33 -0
  122. eval_studio_client/api/docs/V1alphaImportLeaderboardRequest.md +37 -0
  123. eval_studio_client/api/docs/V1alphaImportLeaderboardResponse.md +29 -0
  124. eval_studio_client/api/docs/V1alphaInfo.md +35 -0
  125. eval_studio_client/api/docs/V1alphaInsight.md +40 -0
  126. eval_studio_client/api/docs/V1alphaLeaderboard.md +54 -0
  127. eval_studio_client/api/docs/V1alphaLeaderboardStatus.md +12 -0
  128. eval_studio_client/api/docs/V1alphaLeaderboardType.md +12 -0
  129. eval_studio_client/api/docs/V1alphaLeaderboardView.md +12 -0
  130. eval_studio_client/api/docs/V1alphaListBaseModelsResponse.md +29 -0
  131. eval_studio_client/api/docs/V1alphaListDashboardsResponse.md +29 -0
  132. eval_studio_client/api/docs/V1alphaListDocumentsResponse.md +29 -0
  133. eval_studio_client/api/docs/V1alphaListEvaluatorsResponse.md +29 -0
  134. eval_studio_client/api/docs/V1alphaListLLMModelsResponse.md +29 -0
  135. eval_studio_client/api/docs/V1alphaListLeaderboardsResponse.md +30 -0
  136. eval_studio_client/api/docs/V1alphaListModelCollectionsResponse.md +29 -0
  137. eval_studio_client/api/docs/V1alphaListModelsResponse.md +29 -0
  138. eval_studio_client/api/docs/V1alphaListMostRecentDashboardsResponse.md +29 -0
  139. eval_studio_client/api/docs/V1alphaListMostRecentLeaderboardsResponse.md +29 -0
  140. eval_studio_client/api/docs/V1alphaListMostRecentModelsResponse.md +29 -0
  141. eval_studio_client/api/docs/V1alphaListMostRecentTestsResponse.md +29 -0
  142. eval_studio_client/api/docs/V1alphaListOperationsResponse.md +29 -0
  143. eval_studio_client/api/docs/V1alphaListPerturbatorsResponse.md +29 -0
  144. eval_studio_client/api/docs/V1alphaListRAGCollectionsResponse.md +29 -0
  145. eval_studio_client/api/docs/V1alphaListTestCasesResponse.md +29 -0
  146. eval_studio_client/api/docs/V1alphaListTestClassesResponse.md +29 -0
  147. eval_studio_client/api/docs/V1alphaListTestsResponse.md +29 -0
  148. eval_studio_client/api/docs/V1alphaModel.md +42 -0
  149. eval_studio_client/api/docs/V1alphaModelType.md +12 -0
  150. eval_studio_client/api/docs/V1alphaOperation.md +40 -0
  151. eval_studio_client/api/docs/V1alphaOperationProgress.md +32 -0
  152. eval_studio_client/api/docs/V1alphaPerturbTestResponse.md +29 -0
  153. eval_studio_client/api/docs/V1alphaPerturbator.md +39 -0
  154. eval_studio_client/api/docs/V1alphaPerturbatorConfiguration.md +32 -0
  155. eval_studio_client/api/docs/V1alphaPerturbatorIntensity.md +11 -0
  156. eval_studio_client/api/docs/V1alphaProblemAndAction.md +39 -0
  157. eval_studio_client/api/docs/V1alphaTest.md +40 -0
  158. eval_studio_client/api/docs/V1alphaTestCase.md +40 -0
  159. eval_studio_client/api/docs/V1alphaTestCaseRelationship.md +31 -0
  160. eval_studio_client/api/docs/V1alphaTestClass.md +41 -0
  161. eval_studio_client/api/docs/V1alphaTestClassType.md +12 -0
  162. eval_studio_client/api/docs/V1alphaTestLab.md +41 -0
  163. eval_studio_client/api/docs/V1alphaUpdateDashboardResponse.md +29 -0
  164. eval_studio_client/api/docs/V1alphaUpdateDocumentResponse.md +29 -0
  165. eval_studio_client/api/docs/V1alphaUpdateLeaderboardResponse.md +29 -0
  166. eval_studio_client/api/docs/V1alphaUpdateModelResponse.md +29 -0
  167. eval_studio_client/api/docs/V1alphaUpdateOperationResponse.md +29 -0
  168. eval_studio_client/api/docs/V1alphaUpdateTestCaseResponse.md +29 -0
  169. eval_studio_client/api/docs/V1alphaUpdateTestResponse.md +29 -0
  170. eval_studio_client/api/docs/V1alphaWhoAmIResponse.md +31 -0
  171. eval_studio_client/api/docs/WhoAmIServiceApi.md +72 -0
  172. eval_studio_client/api/exceptions.py +199 -0
  173. eval_studio_client/api/models/__init__.py +148 -0
  174. eval_studio_client/api/models/perturbation_service_create_perturbation_request.py +115 -0
  175. eval_studio_client/api/models/protobuf_any.py +100 -0
  176. eval_studio_client/api/models/required_the_dashboard_to_update.py +127 -0
  177. eval_studio_client/api/models/required_the_document_to_update.py +116 -0
  178. eval_studio_client/api/models/required_the_leaderboard_to_update.py +178 -0
  179. eval_studio_client/api/models/required_the_model_to_update.py +127 -0
  180. eval_studio_client/api/models/required_the_operation_to_finalize.py +129 -0
  181. eval_studio_client/api/models/required_the_operation_to_update.py +129 -0
  182. eval_studio_client/api/models/required_the_test_case_to_update.py +120 -0
  183. eval_studio_client/api/models/required_the_test_to_update.py +122 -0
  184. eval_studio_client/api/models/rpc_status.py +99 -0
  185. eval_studio_client/api/models/test_case_service_batch_delete_test_cases_request.py +87 -0
  186. eval_studio_client/api/models/test_service_perturb_test_request.py +99 -0
  187. eval_studio_client/api/models/v1alpha_batch_create_leaderboards_request.py +99 -0
  188. eval_studio_client/api/models/v1alpha_batch_create_leaderboards_response.py +91 -0
  189. eval_studio_client/api/models/v1alpha_batch_delete_dashboards_request.py +87 -0
  190. eval_studio_client/api/models/v1alpha_batch_delete_dashboards_response.py +95 -0
  191. eval_studio_client/api/models/v1alpha_batch_delete_documents_request.py +87 -0
  192. eval_studio_client/api/models/v1alpha_batch_delete_documents_response.py +95 -0
  193. eval_studio_client/api/models/v1alpha_batch_delete_evaluators_request.py +87 -0
  194. eval_studio_client/api/models/v1alpha_batch_delete_evaluators_response.py +95 -0
  195. eval_studio_client/api/models/v1alpha_batch_delete_leaderboards_request.py +90 -0
  196. eval_studio_client/api/models/v1alpha_batch_delete_leaderboards_response.py +95 -0
  197. eval_studio_client/api/models/v1alpha_batch_delete_models_request.py +87 -0
  198. eval_studio_client/api/models/v1alpha_batch_delete_models_response.py +95 -0
  199. eval_studio_client/api/models/v1alpha_batch_delete_test_cases_response.py +95 -0
  200. eval_studio_client/api/models/v1alpha_batch_delete_tests_request.py +89 -0
  201. eval_studio_client/api/models/v1alpha_batch_delete_tests_response.py +95 -0
  202. eval_studio_client/api/models/v1alpha_batch_get_dashboards_response.py +95 -0
  203. eval_studio_client/api/models/v1alpha_batch_get_documents_response.py +95 -0
  204. eval_studio_client/api/models/v1alpha_batch_get_leaderboards_response.py +95 -0
  205. eval_studio_client/api/models/v1alpha_batch_get_models_response.py +95 -0
  206. eval_studio_client/api/models/v1alpha_batch_get_operations_response.py +95 -0
  207. eval_studio_client/api/models/v1alpha_batch_get_tests_response.py +95 -0
  208. eval_studio_client/api/models/v1alpha_batch_import_leaderboard_request.py +104 -0
  209. eval_studio_client/api/models/v1alpha_batch_import_leaderboard_response.py +91 -0
  210. eval_studio_client/api/models/v1alpha_batch_import_tests_request.py +93 -0
  211. eval_studio_client/api/models/v1alpha_batch_import_tests_response.py +95 -0
  212. eval_studio_client/api/models/v1alpha_check_base_models_response.py +89 -0
  213. eval_studio_client/api/models/v1alpha_collection_info.py +93 -0
  214. eval_studio_client/api/models/v1alpha_create_dashboard_response.py +91 -0
  215. eval_studio_client/api/models/v1alpha_create_document_response.py +91 -0
  216. eval_studio_client/api/models/v1alpha_create_evaluation_request.py +115 -0
  217. eval_studio_client/api/models/v1alpha_create_evaluator_response.py +91 -0
  218. eval_studio_client/api/models/v1alpha_create_leaderboard_request.py +91 -0
  219. eval_studio_client/api/models/v1alpha_create_leaderboard_response.py +91 -0
  220. eval_studio_client/api/models/v1alpha_create_leaderboard_without_cache_response.py +91 -0
  221. eval_studio_client/api/models/v1alpha_create_model_response.py +91 -0
  222. eval_studio_client/api/models/v1alpha_create_perturbation_response.py +87 -0
  223. eval_studio_client/api/models/v1alpha_create_test_case_response.py +91 -0
  224. eval_studio_client/api/models/v1alpha_create_test_lab_response.py +91 -0
  225. eval_studio_client/api/models/v1alpha_create_test_response.py +91 -0
  226. eval_studio_client/api/models/v1alpha_dashboard.py +131 -0
  227. eval_studio_client/api/models/v1alpha_dashboard_status.py +39 -0
  228. eval_studio_client/api/models/v1alpha_delete_dashboard_response.py +91 -0
  229. eval_studio_client/api/models/v1alpha_delete_document_response.py +91 -0
  230. eval_studio_client/api/models/v1alpha_delete_evaluator_response.py +91 -0
  231. eval_studio_client/api/models/v1alpha_delete_leaderboard_response.py +91 -0
  232. eval_studio_client/api/models/v1alpha_delete_model_response.py +91 -0
  233. eval_studio_client/api/models/v1alpha_delete_test_case_response.py +91 -0
  234. eval_studio_client/api/models/v1alpha_delete_test_response.py +91 -0
  235. eval_studio_client/api/models/v1alpha_document.py +120 -0
  236. eval_studio_client/api/models/v1alpha_evaluation_test.py +107 -0
  237. eval_studio_client/api/models/v1alpha_evaluator.py +155 -0
  238. eval_studio_client/api/models/v1alpha_evaluator_param_type.py +42 -0
  239. eval_studio_client/api/models/v1alpha_evaluator_parameter.py +126 -0
  240. eval_studio_client/api/models/v1alpha_evaluator_view.py +38 -0
  241. eval_studio_client/api/models/v1alpha_finalize_operation_response.py +91 -0
  242. eval_studio_client/api/models/v1alpha_find_all_test_cases_by_id_response.py +95 -0
  243. eval_studio_client/api/models/v1alpha_find_test_lab_response.py +91 -0
  244. eval_studio_client/api/models/v1alpha_get_dashboard_response.py +91 -0
  245. eval_studio_client/api/models/v1alpha_get_document_response.py +91 -0
  246. eval_studio_client/api/models/v1alpha_get_evaluator_response.py +91 -0
  247. eval_studio_client/api/models/v1alpha_get_info_response.py +91 -0
  248. eval_studio_client/api/models/v1alpha_get_leaderboard_response.py +91 -0
  249. eval_studio_client/api/models/v1alpha_get_model_response.py +91 -0
  250. eval_studio_client/api/models/v1alpha_get_operation_progress_by_parent_response.py +91 -0
  251. eval_studio_client/api/models/v1alpha_get_operation_response.py +91 -0
  252. eval_studio_client/api/models/v1alpha_get_perturbator_response.py +91 -0
  253. eval_studio_client/api/models/v1alpha_get_test_case_response.py +91 -0
  254. eval_studio_client/api/models/v1alpha_get_test_class_response.py +91 -0
  255. eval_studio_client/api/models/v1alpha_get_test_response.py +91 -0
  256. eval_studio_client/api/models/v1alpha_import_evaluation_request.py +99 -0
  257. eval_studio_client/api/models/v1alpha_import_leaderboard_request.py +104 -0
  258. eval_studio_client/api/models/v1alpha_import_leaderboard_response.py +91 -0
  259. eval_studio_client/api/models/v1alpha_info.py +99 -0
  260. eval_studio_client/api/models/v1alpha_insight.py +107 -0
  261. eval_studio_client/api/models/v1alpha_leaderboard.py +182 -0
  262. eval_studio_client/api/models/v1alpha_leaderboard_status.py +39 -0
  263. eval_studio_client/api/models/v1alpha_leaderboard_type.py +39 -0
  264. eval_studio_client/api/models/v1alpha_leaderboard_view.py +39 -0
  265. eval_studio_client/api/models/v1alpha_list_base_models_response.py +87 -0
  266. eval_studio_client/api/models/v1alpha_list_dashboards_response.py +95 -0
  267. eval_studio_client/api/models/v1alpha_list_documents_response.py +95 -0
  268. eval_studio_client/api/models/v1alpha_list_evaluators_response.py +95 -0
  269. eval_studio_client/api/models/v1alpha_list_leaderboards_response.py +97 -0
  270. eval_studio_client/api/models/v1alpha_list_llm_models_response.py +87 -0
  271. eval_studio_client/api/models/v1alpha_list_model_collections_response.py +95 -0
  272. eval_studio_client/api/models/v1alpha_list_models_response.py +95 -0
  273. eval_studio_client/api/models/v1alpha_list_most_recent_dashboards_response.py +95 -0
  274. eval_studio_client/api/models/v1alpha_list_most_recent_leaderboards_response.py +95 -0
  275. eval_studio_client/api/models/v1alpha_list_most_recent_models_response.py +95 -0
  276. eval_studio_client/api/models/v1alpha_list_most_recent_tests_response.py +95 -0
  277. eval_studio_client/api/models/v1alpha_list_operations_response.py +95 -0
  278. eval_studio_client/api/models/v1alpha_list_perturbators_response.py +95 -0
  279. eval_studio_client/api/models/v1alpha_list_rag_collections_response.py +95 -0
  280. eval_studio_client/api/models/v1alpha_list_test_cases_response.py +95 -0
  281. eval_studio_client/api/models/v1alpha_list_test_classes_response.py +95 -0
  282. eval_studio_client/api/models/v1alpha_list_tests_response.py +95 -0
  283. eval_studio_client/api/models/v1alpha_model.py +131 -0
  284. eval_studio_client/api/models/v1alpha_model_type.py +46 -0
  285. eval_studio_client/api/models/v1alpha_operation.py +133 -0
  286. eval_studio_client/api/models/v1alpha_operation_progress.py +99 -0
  287. eval_studio_client/api/models/v1alpha_perturb_test_response.py +91 -0
  288. eval_studio_client/api/models/v1alpha_perturbator.py +122 -0
  289. eval_studio_client/api/models/v1alpha_perturbator_configuration.py +92 -0
  290. eval_studio_client/api/models/v1alpha_perturbator_intensity.py +39 -0
  291. eval_studio_client/api/models/v1alpha_problem_and_action.py +129 -0
  292. eval_studio_client/api/models/v1alpha_test.py +126 -0
  293. eval_studio_client/api/models/v1alpha_test_case.py +124 -0
  294. eval_studio_client/api/models/v1alpha_test_case_relationship.py +91 -0
  295. eval_studio_client/api/models/v1alpha_test_class.py +127 -0
  296. eval_studio_client/api/models/v1alpha_test_class_type.py +42 -0
  297. eval_studio_client/api/models/v1alpha_test_lab.py +137 -0
  298. eval_studio_client/api/models/v1alpha_update_dashboard_response.py +91 -0
  299. eval_studio_client/api/models/v1alpha_update_document_response.py +91 -0
  300. eval_studio_client/api/models/v1alpha_update_leaderboard_response.py +91 -0
  301. eval_studio_client/api/models/v1alpha_update_model_response.py +91 -0
  302. eval_studio_client/api/models/v1alpha_update_operation_response.py +91 -0
  303. eval_studio_client/api/models/v1alpha_update_test_case_response.py +91 -0
  304. eval_studio_client/api/models/v1alpha_update_test_response.py +91 -0
  305. eval_studio_client/api/models/v1alpha_who_am_i_response.py +91 -0
  306. eval_studio_client/api/rest.py +257 -0
  307. eval_studio_client/api/test/__init__.py +0 -0
  308. eval_studio_client/api/test/test_dashboard_service_api.py +79 -0
  309. eval_studio_client/api/test/test_document_service_api.py +73 -0
  310. eval_studio_client/api/test/test_evaluation_service_api.py +55 -0
  311. eval_studio_client/api/test/test_evaluator_service_api.py +61 -0
  312. eval_studio_client/api/test/test_info_service_api.py +37 -0
  313. eval_studio_client/api/test/test_leaderboard_service_api.py +103 -0
  314. eval_studio_client/api/test/test_model_service_api.py +97 -0
  315. eval_studio_client/api/test/test_operation_progress_service_api.py +37 -0
  316. eval_studio_client/api/test/test_operation_service_api.py +61 -0
  317. eval_studio_client/api/test/test_perturbation_service_api.py +37 -0
  318. eval_studio_client/api/test/test_perturbation_service_create_perturbation_request.py +79 -0
  319. eval_studio_client/api/test/test_perturbator_service_api.py +43 -0
  320. eval_studio_client/api/test/test_protobuf_any.py +51 -0
  321. eval_studio_client/api/test/test_required_the_dashboard_to_update.py +64 -0
  322. eval_studio_client/api/test/test_required_the_document_to_update.py +59 -0
  323. eval_studio_client/api/test/test_required_the_leaderboard_to_update.py +115 -0
  324. eval_studio_client/api/test/test_required_the_model_to_update.py +63 -0
  325. eval_studio_client/api/test/test_required_the_operation_to_finalize.py +71 -0
  326. eval_studio_client/api/test/test_required_the_operation_to_update.py +71 -0
  327. eval_studio_client/api/test/test_required_the_test_case_to_update.py +63 -0
  328. eval_studio_client/api/test/test_required_the_test_to_update.py +65 -0
  329. eval_studio_client/api/test/test_rpc_status.py +57 -0
  330. eval_studio_client/api/test/test_test_case_service_api.py +73 -0
  331. eval_studio_client/api/test/test_test_case_service_batch_delete_test_cases_request.py +53 -0
  332. eval_studio_client/api/test/test_test_class_service_api.py +43 -0
  333. eval_studio_client/api/test/test_test_lab_service_api.py +43 -0
  334. eval_studio_client/api/test/test_test_service_api.py +91 -0
  335. eval_studio_client/api/test/test_test_service_perturb_test_request.py +58 -0
  336. eval_studio_client/api/test/test_v1alpha_batch_create_leaderboards_request.py +119 -0
  337. eval_studio_client/api/test/test_v1alpha_batch_create_leaderboards_response.py +71 -0
  338. eval_studio_client/api/test/test_v1alpha_batch_delete_dashboards_request.py +53 -0
  339. eval_studio_client/api/test/test_v1alpha_batch_delete_dashboards_response.py +68 -0
  340. eval_studio_client/api/test/test_v1alpha_batch_delete_documents_request.py +53 -0
  341. eval_studio_client/api/test/test_v1alpha_batch_delete_documents_response.py +63 -0
  342. eval_studio_client/api/test/test_v1alpha_batch_delete_evaluators_request.py +53 -0
  343. eval_studio_client/api/test/test_v1alpha_batch_delete_evaluators_response.py +91 -0
  344. eval_studio_client/api/test/test_v1alpha_batch_delete_leaderboards_request.py +54 -0
  345. eval_studio_client/api/test/test_v1alpha_batch_delete_leaderboards_response.py +116 -0
  346. eval_studio_client/api/test/test_v1alpha_batch_delete_models_request.py +53 -0
  347. eval_studio_client/api/test/test_v1alpha_batch_delete_models_response.py +67 -0
  348. eval_studio_client/api/test/test_v1alpha_batch_delete_test_cases_response.py +67 -0
  349. eval_studio_client/api/test/test_v1alpha_batch_delete_tests_request.py +54 -0
  350. eval_studio_client/api/test/test_v1alpha_batch_delete_tests_response.py +69 -0
  351. eval_studio_client/api/test/test_v1alpha_batch_get_dashboards_response.py +68 -0
  352. eval_studio_client/api/test/test_v1alpha_batch_get_documents_response.py +63 -0
  353. eval_studio_client/api/test/test_v1alpha_batch_get_leaderboards_response.py +116 -0
  354. eval_studio_client/api/test/test_v1alpha_batch_get_models_response.py +67 -0
  355. eval_studio_client/api/test/test_v1alpha_batch_get_operations_response.py +73 -0
  356. eval_studio_client/api/test/test_v1alpha_batch_get_tests_response.py +69 -0
  357. eval_studio_client/api/test/test_v1alpha_batch_import_leaderboard_request.py +61 -0
  358. eval_studio_client/api/test/test_v1alpha_batch_import_leaderboard_response.py +71 -0
  359. eval_studio_client/api/test/test_v1alpha_batch_import_tests_request.py +54 -0
  360. eval_studio_client/api/test/test_v1alpha_batch_import_tests_response.py +69 -0
  361. eval_studio_client/api/test/test_v1alpha_check_base_models_response.py +52 -0
  362. eval_studio_client/api/test/test_v1alpha_collection_info.py +54 -0
  363. eval_studio_client/api/test/test_v1alpha_create_dashboard_response.py +66 -0
  364. eval_studio_client/api/test/test_v1alpha_create_document_response.py +61 -0
  365. eval_studio_client/api/test/test_v1alpha_create_evaluation_request.py +107 -0
  366. eval_studio_client/api/test/test_v1alpha_create_evaluator_response.py +89 -0
  367. eval_studio_client/api/test/test_v1alpha_create_leaderboard_request.py +114 -0
  368. eval_studio_client/api/test/test_v1alpha_create_leaderboard_response.py +71 -0
  369. eval_studio_client/api/test/test_v1alpha_create_leaderboard_without_cache_response.py +71 -0
  370. eval_studio_client/api/test/test_v1alpha_create_model_response.py +65 -0
  371. eval_studio_client/api/test/test_v1alpha_create_perturbation_response.py +51 -0
  372. eval_studio_client/api/test/test_v1alpha_create_test_case_response.py +65 -0
  373. eval_studio_client/api/test/test_v1alpha_create_test_lab_response.py +68 -0
  374. eval_studio_client/api/test/test_v1alpha_create_test_response.py +67 -0
  375. eval_studio_client/api/test/test_v1alpha_dashboard.py +65 -0
  376. eval_studio_client/api/test/test_v1alpha_dashboard_status.py +33 -0
  377. eval_studio_client/api/test/test_v1alpha_delete_dashboard_response.py +66 -0
  378. eval_studio_client/api/test/test_v1alpha_delete_document_response.py +61 -0
  379. eval_studio_client/api/test/test_v1alpha_delete_evaluator_response.py +89 -0
  380. eval_studio_client/api/test/test_v1alpha_delete_leaderboard_response.py +114 -0
  381. eval_studio_client/api/test/test_v1alpha_delete_model_response.py +65 -0
  382. eval_studio_client/api/test/test_v1alpha_delete_test_case_response.py +65 -0
  383. eval_studio_client/api/test/test_v1alpha_delete_test_response.py +67 -0
  384. eval_studio_client/api/test/test_v1alpha_document.py +60 -0
  385. eval_studio_client/api/test/test_v1alpha_evaluation_test.py +76 -0
  386. eval_studio_client/api/test/test_v1alpha_evaluator.py +91 -0
  387. eval_studio_client/api/test/test_v1alpha_evaluator_param_type.py +33 -0
  388. eval_studio_client/api/test/test_v1alpha_evaluator_parameter.py +68 -0
  389. eval_studio_client/api/test/test_v1alpha_evaluator_view.py +33 -0
  390. eval_studio_client/api/test/test_v1alpha_finalize_operation_response.py +71 -0
  391. eval_studio_client/api/test/test_v1alpha_find_all_test_cases_by_id_response.py +67 -0
  392. eval_studio_client/api/test/test_v1alpha_find_test_lab_response.py +68 -0
  393. eval_studio_client/api/test/test_v1alpha_get_dashboard_response.py +66 -0
  394. eval_studio_client/api/test/test_v1alpha_get_document_response.py +61 -0
  395. eval_studio_client/api/test/test_v1alpha_get_evaluator_response.py +89 -0
  396. eval_studio_client/api/test/test_v1alpha_get_info_response.py +60 -0
  397. eval_studio_client/api/test/test_v1alpha_get_leaderboard_response.py +114 -0
  398. eval_studio_client/api/test/test_v1alpha_get_model_response.py +65 -0
  399. eval_studio_client/api/test/test_v1alpha_get_operation_progress_by_parent_response.py +55 -0
  400. eval_studio_client/api/test/test_v1alpha_get_operation_response.py +71 -0
  401. eval_studio_client/api/test/test_v1alpha_get_perturbator_response.py +64 -0
  402. eval_studio_client/api/test/test_v1alpha_get_test_case_response.py +65 -0
  403. eval_studio_client/api/test/test_v1alpha_get_test_class_response.py +70 -0
  404. eval_studio_client/api/test/test_v1alpha_get_test_response.py +67 -0
  405. eval_studio_client/api/test/test_v1alpha_import_evaluation_request.py +73 -0
  406. eval_studio_client/api/test/test_v1alpha_import_leaderboard_request.py +59 -0
  407. eval_studio_client/api/test/test_v1alpha_import_leaderboard_response.py +71 -0
  408. eval_studio_client/api/test/test_v1alpha_info.py +59 -0
  409. eval_studio_client/api/test/test_v1alpha_insight.py +67 -0
  410. eval_studio_client/api/test/test_v1alpha_leaderboard.py +116 -0
  411. eval_studio_client/api/test/test_v1alpha_leaderboard_status.py +33 -0
  412. eval_studio_client/api/test/test_v1alpha_leaderboard_type.py +33 -0
  413. eval_studio_client/api/test/test_v1alpha_leaderboard_view.py +33 -0
  414. eval_studio_client/api/test/test_v1alpha_list_base_models_response.py +53 -0
  415. eval_studio_client/api/test/test_v1alpha_list_dashboards_response.py +68 -0
  416. eval_studio_client/api/test/test_v1alpha_list_documents_response.py +63 -0
  417. eval_studio_client/api/test/test_v1alpha_list_evaluators_response.py +91 -0
  418. eval_studio_client/api/test/test_v1alpha_list_leaderboards_response.py +117 -0
  419. eval_studio_client/api/test/test_v1alpha_list_llm_models_response.py +53 -0
  420. eval_studio_client/api/test/test_v1alpha_list_model_collections_response.py +57 -0
  421. eval_studio_client/api/test/test_v1alpha_list_models_response.py +67 -0
  422. eval_studio_client/api/test/test_v1alpha_list_most_recent_dashboards_response.py +68 -0
  423. eval_studio_client/api/test/test_v1alpha_list_most_recent_leaderboards_response.py +116 -0
  424. eval_studio_client/api/test/test_v1alpha_list_most_recent_models_response.py +67 -0
  425. eval_studio_client/api/test/test_v1alpha_list_most_recent_tests_response.py +69 -0
  426. eval_studio_client/api/test/test_v1alpha_list_operations_response.py +73 -0
  427. eval_studio_client/api/test/test_v1alpha_list_perturbators_response.py +66 -0
  428. eval_studio_client/api/test/test_v1alpha_list_rag_collections_response.py +57 -0
  429. eval_studio_client/api/test/test_v1alpha_list_test_cases_response.py +67 -0
  430. eval_studio_client/api/test/test_v1alpha_list_test_classes_response.py +72 -0
  431. eval_studio_client/api/test/test_v1alpha_list_tests_response.py +69 -0
  432. eval_studio_client/api/test/test_v1alpha_model.py +64 -0
  433. eval_studio_client/api/test/test_v1alpha_model_type.py +33 -0
  434. eval_studio_client/api/test/test_v1alpha_operation.py +72 -0
  435. eval_studio_client/api/test/test_v1alpha_operation_progress.py +54 -0
  436. eval_studio_client/api/test/test_v1alpha_perturb_test_response.py +67 -0
  437. eval_studio_client/api/test/test_v1alpha_perturbator.py +63 -0
  438. eval_studio_client/api/test/test_v1alpha_perturbator_configuration.py +53 -0
  439. eval_studio_client/api/test/test_v1alpha_perturbator_intensity.py +33 -0
  440. eval_studio_client/api/test/test_v1alpha_problem_and_action.py +65 -0
  441. eval_studio_client/api/test/test_v1alpha_test.py +66 -0
  442. eval_studio_client/api/test/test_v1alpha_test_case.py +64 -0
  443. eval_studio_client/api/test/test_v1alpha_test_case_relationship.py +53 -0
  444. eval_studio_client/api/test/test_v1alpha_test_class.py +69 -0
  445. eval_studio_client/api/test/test_v1alpha_test_class_type.py +33 -0
  446. eval_studio_client/api/test/test_v1alpha_test_lab.py +67 -0
  447. eval_studio_client/api/test/test_v1alpha_update_dashboard_response.py +66 -0
  448. eval_studio_client/api/test/test_v1alpha_update_document_response.py +61 -0
  449. eval_studio_client/api/test/test_v1alpha_update_leaderboard_response.py +114 -0
  450. eval_studio_client/api/test/test_v1alpha_update_model_response.py +65 -0
  451. eval_studio_client/api/test/test_v1alpha_update_operation_response.py +71 -0
  452. eval_studio_client/api/test/test_v1alpha_update_test_case_response.py +65 -0
  453. eval_studio_client/api/test/test_v1alpha_update_test_response.py +67 -0
  454. eval_studio_client/api/test/test_v1alpha_who_am_i_response.py +53 -0
  455. eval_studio_client/api/test/test_who_am_i_service_api.py +38 -0
  456. eval_studio_client/client.py +98 -0
  457. eval_studio_client/dashboards.py +187 -0
  458. eval_studio_client/documents.py +95 -0
  459. eval_studio_client/evaluators.py +65 -0
  460. eval_studio_client/gen/openapiv2/eval_studio.swagger.json +6043 -0
  461. eval_studio_client/insights.py +35 -0
  462. eval_studio_client/leaderboards.py +207 -0
  463. eval_studio_client/models.py +522 -0
  464. eval_studio_client/perturbators.py +101 -0
  465. eval_studio_client/problems.py +50 -0
  466. eval_studio_client/test_labs.py +319 -0
  467. eval_studio_client/tests.py +369 -0
  468. eval_studio_client-0.7.0.dist-info/METADATA +18 -0
  469. eval_studio_client-0.7.0.dist-info/RECORD +470 -0
  470. eval_studio_client-0.7.0.dist-info/WHEEL +4 -0
@@ -0,0 +1,1868 @@
1
+ # coding: utf-8
2
+
3
+ """
4
+ ai/h2o/eval_studio/v1alpha/collection.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 List, Optional
21
+ from typing_extensions import Annotated
22
+ from eval_studio_client.api.models.required_the_document_to_update import RequiredTheDocumentToUpdate
23
+ from eval_studio_client.api.models.v1alpha_batch_delete_documents_request import V1alphaBatchDeleteDocumentsRequest
24
+ from eval_studio_client.api.models.v1alpha_batch_delete_documents_response import V1alphaBatchDeleteDocumentsResponse
25
+ from eval_studio_client.api.models.v1alpha_batch_get_documents_response import V1alphaBatchGetDocumentsResponse
26
+ from eval_studio_client.api.models.v1alpha_create_document_response import V1alphaCreateDocumentResponse
27
+ from eval_studio_client.api.models.v1alpha_delete_document_response import V1alphaDeleteDocumentResponse
28
+ from eval_studio_client.api.models.v1alpha_document import V1alphaDocument
29
+ from eval_studio_client.api.models.v1alpha_get_document_response import V1alphaGetDocumentResponse
30
+ from eval_studio_client.api.models.v1alpha_list_documents_response import V1alphaListDocumentsResponse
31
+ from eval_studio_client.api.models.v1alpha_update_document_response import V1alphaUpdateDocumentResponse
32
+
33
+ from eval_studio_client.api.api_client import ApiClient, RequestSerialized
34
+ from eval_studio_client.api.api_response import ApiResponse
35
+ from eval_studio_client.api.rest import RESTResponseType
36
+
37
+
38
+ class DocumentServiceApi:
39
+ """NOTE: This class is auto generated by OpenAPI Generator
40
+ Ref: https://openapi-generator.tech
41
+
42
+ Do not edit the class manually.
43
+ """
44
+
45
+ def __init__(self, api_client=None) -> None:
46
+ if api_client is None:
47
+ api_client = ApiClient.get_default()
48
+ self.api_client = api_client
49
+
50
+
51
+ @validate_call
52
+ def document_service_batch_delete_documents(
53
+ self,
54
+ body: V1alphaBatchDeleteDocumentsRequest,
55
+ _request_timeout: Union[
56
+ None,
57
+ Annotated[StrictFloat, Field(gt=0)],
58
+ Tuple[
59
+ Annotated[StrictFloat, Field(gt=0)],
60
+ Annotated[StrictFloat, Field(gt=0)]
61
+ ]
62
+ ] = None,
63
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
64
+ _content_type: Optional[StrictStr] = None,
65
+ _headers: Optional[Dict[StrictStr, Any]] = None,
66
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
67
+ ) -> V1alphaBatchDeleteDocumentsResponse:
68
+ """document_service_batch_delete_documents
69
+
70
+
71
+ :param body: (required)
72
+ :type body: V1alphaBatchDeleteDocumentsRequest
73
+ :param _request_timeout: timeout setting for this request. If one
74
+ number provided, it will be total request
75
+ timeout. It can also be a pair (tuple) of
76
+ (connection, read) timeouts.
77
+ :type _request_timeout: int, tuple(int, int), optional
78
+ :param _request_auth: set to override the auth_settings for an a single
79
+ request; this effectively ignores the
80
+ authentication in the spec for a single request.
81
+ :type _request_auth: dict, optional
82
+ :param _content_type: force content-type for the request.
83
+ :type _content_type: str, Optional
84
+ :param _headers: set to override the headers for a single
85
+ request; this effectively ignores the headers
86
+ in the spec for a single request.
87
+ :type _headers: dict, optional
88
+ :param _host_index: set to override the host_index for a single
89
+ request; this effectively ignores the host_index
90
+ in the spec for a single request.
91
+ :type _host_index: int, optional
92
+ :return: Returns the result object.
93
+ """ # noqa: E501
94
+
95
+ _param = self._document_service_batch_delete_documents_serialize(
96
+ body=body,
97
+ _request_auth=_request_auth,
98
+ _content_type=_content_type,
99
+ _headers=_headers,
100
+ _host_index=_host_index
101
+ )
102
+
103
+ _response_types_map: Dict[str, Optional[str]] = {
104
+ '200': "V1alphaBatchDeleteDocumentsResponse",
105
+ }
106
+ response_data = self.api_client.call_api(
107
+ *_param,
108
+ _request_timeout=_request_timeout
109
+ )
110
+ response_data.read()
111
+ return self.api_client.response_deserialize(
112
+ response_data=response_data,
113
+ response_types_map=_response_types_map,
114
+ ).data
115
+
116
+
117
+ @validate_call
118
+ def document_service_batch_delete_documents_with_http_info(
119
+ self,
120
+ body: V1alphaBatchDeleteDocumentsRequest,
121
+ _request_timeout: Union[
122
+ None,
123
+ Annotated[StrictFloat, Field(gt=0)],
124
+ Tuple[
125
+ Annotated[StrictFloat, Field(gt=0)],
126
+ Annotated[StrictFloat, Field(gt=0)]
127
+ ]
128
+ ] = None,
129
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
130
+ _content_type: Optional[StrictStr] = None,
131
+ _headers: Optional[Dict[StrictStr, Any]] = None,
132
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
133
+ ) -> ApiResponse[V1alphaBatchDeleteDocumentsResponse]:
134
+ """document_service_batch_delete_documents
135
+
136
+
137
+ :param body: (required)
138
+ :type body: V1alphaBatchDeleteDocumentsRequest
139
+ :param _request_timeout: timeout setting for this request. If one
140
+ number provided, it will be total request
141
+ timeout. It can also be a pair (tuple) of
142
+ (connection, read) timeouts.
143
+ :type _request_timeout: int, tuple(int, int), optional
144
+ :param _request_auth: set to override the auth_settings for an a single
145
+ request; this effectively ignores the
146
+ authentication in the spec for a single request.
147
+ :type _request_auth: dict, optional
148
+ :param _content_type: force content-type for the request.
149
+ :type _content_type: str, Optional
150
+ :param _headers: set to override the headers for a single
151
+ request; this effectively ignores the headers
152
+ in the spec for a single request.
153
+ :type _headers: dict, optional
154
+ :param _host_index: set to override the host_index for a single
155
+ request; this effectively ignores the host_index
156
+ in the spec for a single request.
157
+ :type _host_index: int, optional
158
+ :return: Returns the result object.
159
+ """ # noqa: E501
160
+
161
+ _param = self._document_service_batch_delete_documents_serialize(
162
+ body=body,
163
+ _request_auth=_request_auth,
164
+ _content_type=_content_type,
165
+ _headers=_headers,
166
+ _host_index=_host_index
167
+ )
168
+
169
+ _response_types_map: Dict[str, Optional[str]] = {
170
+ '200': "V1alphaBatchDeleteDocumentsResponse",
171
+ }
172
+ response_data = self.api_client.call_api(
173
+ *_param,
174
+ _request_timeout=_request_timeout
175
+ )
176
+ response_data.read()
177
+ return self.api_client.response_deserialize(
178
+ response_data=response_data,
179
+ response_types_map=_response_types_map,
180
+ )
181
+
182
+
183
+ @validate_call
184
+ def document_service_batch_delete_documents_without_preload_content(
185
+ self,
186
+ body: V1alphaBatchDeleteDocumentsRequest,
187
+ _request_timeout: Union[
188
+ None,
189
+ Annotated[StrictFloat, Field(gt=0)],
190
+ Tuple[
191
+ Annotated[StrictFloat, Field(gt=0)],
192
+ Annotated[StrictFloat, Field(gt=0)]
193
+ ]
194
+ ] = None,
195
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
196
+ _content_type: Optional[StrictStr] = None,
197
+ _headers: Optional[Dict[StrictStr, Any]] = None,
198
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
199
+ ) -> RESTResponseType:
200
+ """document_service_batch_delete_documents
201
+
202
+
203
+ :param body: (required)
204
+ :type body: V1alphaBatchDeleteDocumentsRequest
205
+ :param _request_timeout: timeout setting for this request. If one
206
+ number provided, it will be total request
207
+ timeout. It can also be a pair (tuple) of
208
+ (connection, read) timeouts.
209
+ :type _request_timeout: int, tuple(int, int), optional
210
+ :param _request_auth: set to override the auth_settings for an a single
211
+ request; this effectively ignores the
212
+ authentication in the spec for a single request.
213
+ :type _request_auth: dict, optional
214
+ :param _content_type: force content-type for the request.
215
+ :type _content_type: str, Optional
216
+ :param _headers: set to override the headers for a single
217
+ request; this effectively ignores the headers
218
+ in the spec for a single request.
219
+ :type _headers: dict, optional
220
+ :param _host_index: set to override the host_index for a single
221
+ request; this effectively ignores the host_index
222
+ in the spec for a single request.
223
+ :type _host_index: int, optional
224
+ :return: Returns the result object.
225
+ """ # noqa: E501
226
+
227
+ _param = self._document_service_batch_delete_documents_serialize(
228
+ body=body,
229
+ _request_auth=_request_auth,
230
+ _content_type=_content_type,
231
+ _headers=_headers,
232
+ _host_index=_host_index
233
+ )
234
+
235
+ _response_types_map: Dict[str, Optional[str]] = {
236
+ '200': "V1alphaBatchDeleteDocumentsResponse",
237
+ }
238
+ response_data = self.api_client.call_api(
239
+ *_param,
240
+ _request_timeout=_request_timeout
241
+ )
242
+ return response_data.response
243
+
244
+
245
+ def _document_service_batch_delete_documents_serialize(
246
+ self,
247
+ body,
248
+ _request_auth,
249
+ _content_type,
250
+ _headers,
251
+ _host_index,
252
+ ) -> RequestSerialized:
253
+
254
+ _host = None
255
+
256
+ _collection_formats: Dict[str, str] = {
257
+ }
258
+
259
+ _path_params: Dict[str, str] = {}
260
+ _query_params: List[Tuple[str, str]] = []
261
+ _header_params: Dict[str, Optional[str]] = _headers or {}
262
+ _form_params: List[Tuple[str, str]] = []
263
+ _files: Dict[str, Union[str, bytes]] = {}
264
+ _body_params: Optional[bytes] = None
265
+
266
+ # process the path parameters
267
+ # process the query parameters
268
+ # process the header parameters
269
+ # process the form parameters
270
+ # process the body parameter
271
+ if body is not None:
272
+ _body_params = body
273
+
274
+
275
+ # set the HTTP header `Accept`
276
+ _header_params['Accept'] = self.api_client.select_header_accept(
277
+ [
278
+ 'application/json'
279
+ ]
280
+ )
281
+
282
+ # set the HTTP header `Content-Type`
283
+ if _content_type:
284
+ _header_params['Content-Type'] = _content_type
285
+ else:
286
+ _default_content_type = (
287
+ self.api_client.select_header_content_type(
288
+ [
289
+ 'application/json'
290
+ ]
291
+ )
292
+ )
293
+ if _default_content_type is not None:
294
+ _header_params['Content-Type'] = _default_content_type
295
+
296
+ # authentication setting
297
+ _auth_settings: List[str] = [
298
+ ]
299
+
300
+ return self.api_client.param_serialize(
301
+ method='POST',
302
+ resource_path='/v1alpha/documents:batchDelete',
303
+ path_params=_path_params,
304
+ query_params=_query_params,
305
+ header_params=_header_params,
306
+ body=_body_params,
307
+ post_params=_form_params,
308
+ files=_files,
309
+ auth_settings=_auth_settings,
310
+ collection_formats=_collection_formats,
311
+ _host=_host,
312
+ _request_auth=_request_auth
313
+ )
314
+
315
+
316
+
317
+
318
+ @validate_call
319
+ def document_service_batch_get_documents(
320
+ self,
321
+ names: Annotated[Optional[List[StrictStr]], Field(description="The names of the Documents to retrieve. A maximum of 1000 can be specified.")] = None,
322
+ _request_timeout: Union[
323
+ None,
324
+ Annotated[StrictFloat, Field(gt=0)],
325
+ Tuple[
326
+ Annotated[StrictFloat, Field(gt=0)],
327
+ Annotated[StrictFloat, Field(gt=0)]
328
+ ]
329
+ ] = None,
330
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
331
+ _content_type: Optional[StrictStr] = None,
332
+ _headers: Optional[Dict[StrictStr, Any]] = None,
333
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
334
+ ) -> V1alphaBatchGetDocumentsResponse:
335
+ """document_service_batch_get_documents
336
+
337
+
338
+ :param names: The names of the Documents to retrieve. A maximum of 1000 can be specified.
339
+ :type names: List[str]
340
+ :param _request_timeout: timeout setting for this request. If one
341
+ number provided, it will be total request
342
+ timeout. It can also be a pair (tuple) of
343
+ (connection, read) timeouts.
344
+ :type _request_timeout: int, tuple(int, int), optional
345
+ :param _request_auth: set to override the auth_settings for an a single
346
+ request; this effectively ignores the
347
+ authentication in the spec for a single request.
348
+ :type _request_auth: dict, optional
349
+ :param _content_type: force content-type for the request.
350
+ :type _content_type: str, Optional
351
+ :param _headers: set to override the headers for a single
352
+ request; this effectively ignores the headers
353
+ in the spec for a single request.
354
+ :type _headers: dict, optional
355
+ :param _host_index: set to override the host_index for a single
356
+ request; this effectively ignores the host_index
357
+ in the spec for a single request.
358
+ :type _host_index: int, optional
359
+ :return: Returns the result object.
360
+ """ # noqa: E501
361
+
362
+ _param = self._document_service_batch_get_documents_serialize(
363
+ names=names,
364
+ _request_auth=_request_auth,
365
+ _content_type=_content_type,
366
+ _headers=_headers,
367
+ _host_index=_host_index
368
+ )
369
+
370
+ _response_types_map: Dict[str, Optional[str]] = {
371
+ '200': "V1alphaBatchGetDocumentsResponse",
372
+ }
373
+ response_data = self.api_client.call_api(
374
+ *_param,
375
+ _request_timeout=_request_timeout
376
+ )
377
+ response_data.read()
378
+ return self.api_client.response_deserialize(
379
+ response_data=response_data,
380
+ response_types_map=_response_types_map,
381
+ ).data
382
+
383
+
384
+ @validate_call
385
+ def document_service_batch_get_documents_with_http_info(
386
+ self,
387
+ names: Annotated[Optional[List[StrictStr]], Field(description="The names of the Documents to retrieve. A maximum of 1000 can be specified.")] = None,
388
+ _request_timeout: Union[
389
+ None,
390
+ Annotated[StrictFloat, Field(gt=0)],
391
+ Tuple[
392
+ Annotated[StrictFloat, Field(gt=0)],
393
+ Annotated[StrictFloat, Field(gt=0)]
394
+ ]
395
+ ] = None,
396
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
397
+ _content_type: Optional[StrictStr] = None,
398
+ _headers: Optional[Dict[StrictStr, Any]] = None,
399
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
400
+ ) -> ApiResponse[V1alphaBatchGetDocumentsResponse]:
401
+ """document_service_batch_get_documents
402
+
403
+
404
+ :param names: The names of the Documents to retrieve. A maximum of 1000 can be specified.
405
+ :type names: List[str]
406
+ :param _request_timeout: timeout setting for this request. If one
407
+ number provided, it will be total request
408
+ timeout. It can also be a pair (tuple) of
409
+ (connection, read) timeouts.
410
+ :type _request_timeout: int, tuple(int, int), optional
411
+ :param _request_auth: set to override the auth_settings for an a single
412
+ request; this effectively ignores the
413
+ authentication in the spec for a single request.
414
+ :type _request_auth: dict, optional
415
+ :param _content_type: force content-type for the request.
416
+ :type _content_type: str, Optional
417
+ :param _headers: set to override the headers for a single
418
+ request; this effectively ignores the headers
419
+ in the spec for a single request.
420
+ :type _headers: dict, optional
421
+ :param _host_index: set to override the host_index for a single
422
+ request; this effectively ignores the host_index
423
+ in the spec for a single request.
424
+ :type _host_index: int, optional
425
+ :return: Returns the result object.
426
+ """ # noqa: E501
427
+
428
+ _param = self._document_service_batch_get_documents_serialize(
429
+ names=names,
430
+ _request_auth=_request_auth,
431
+ _content_type=_content_type,
432
+ _headers=_headers,
433
+ _host_index=_host_index
434
+ )
435
+
436
+ _response_types_map: Dict[str, Optional[str]] = {
437
+ '200': "V1alphaBatchGetDocumentsResponse",
438
+ }
439
+ response_data = self.api_client.call_api(
440
+ *_param,
441
+ _request_timeout=_request_timeout
442
+ )
443
+ response_data.read()
444
+ return self.api_client.response_deserialize(
445
+ response_data=response_data,
446
+ response_types_map=_response_types_map,
447
+ )
448
+
449
+
450
+ @validate_call
451
+ def document_service_batch_get_documents_without_preload_content(
452
+ self,
453
+ names: Annotated[Optional[List[StrictStr]], Field(description="The names of the Documents to retrieve. A maximum of 1000 can be specified.")] = None,
454
+ _request_timeout: Union[
455
+ None,
456
+ Annotated[StrictFloat, Field(gt=0)],
457
+ Tuple[
458
+ Annotated[StrictFloat, Field(gt=0)],
459
+ Annotated[StrictFloat, Field(gt=0)]
460
+ ]
461
+ ] = None,
462
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
463
+ _content_type: Optional[StrictStr] = None,
464
+ _headers: Optional[Dict[StrictStr, Any]] = None,
465
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
466
+ ) -> RESTResponseType:
467
+ """document_service_batch_get_documents
468
+
469
+
470
+ :param names: The names of the Documents to retrieve. A maximum of 1000 can be specified.
471
+ :type names: List[str]
472
+ :param _request_timeout: timeout setting for this request. If one
473
+ number provided, it will be total request
474
+ timeout. It can also be a pair (tuple) of
475
+ (connection, read) timeouts.
476
+ :type _request_timeout: int, tuple(int, int), optional
477
+ :param _request_auth: set to override the auth_settings for an a single
478
+ request; this effectively ignores the
479
+ authentication in the spec for a single request.
480
+ :type _request_auth: dict, optional
481
+ :param _content_type: force content-type for the request.
482
+ :type _content_type: str, Optional
483
+ :param _headers: set to override the headers for a single
484
+ request; this effectively ignores the headers
485
+ in the spec for a single request.
486
+ :type _headers: dict, optional
487
+ :param _host_index: set to override the host_index for a single
488
+ request; this effectively ignores the host_index
489
+ in the spec for a single request.
490
+ :type _host_index: int, optional
491
+ :return: Returns the result object.
492
+ """ # noqa: E501
493
+
494
+ _param = self._document_service_batch_get_documents_serialize(
495
+ names=names,
496
+ _request_auth=_request_auth,
497
+ _content_type=_content_type,
498
+ _headers=_headers,
499
+ _host_index=_host_index
500
+ )
501
+
502
+ _response_types_map: Dict[str, Optional[str]] = {
503
+ '200': "V1alphaBatchGetDocumentsResponse",
504
+ }
505
+ response_data = self.api_client.call_api(
506
+ *_param,
507
+ _request_timeout=_request_timeout
508
+ )
509
+ return response_data.response
510
+
511
+
512
+ def _document_service_batch_get_documents_serialize(
513
+ self,
514
+ names,
515
+ _request_auth,
516
+ _content_type,
517
+ _headers,
518
+ _host_index,
519
+ ) -> RequestSerialized:
520
+
521
+ _host = None
522
+
523
+ _collection_formats: Dict[str, str] = {
524
+ 'names': 'multi',
525
+ }
526
+
527
+ _path_params: Dict[str, str] = {}
528
+ _query_params: List[Tuple[str, str]] = []
529
+ _header_params: Dict[str, Optional[str]] = _headers or {}
530
+ _form_params: List[Tuple[str, str]] = []
531
+ _files: Dict[str, Union[str, bytes]] = {}
532
+ _body_params: Optional[bytes] = None
533
+
534
+ # process the path parameters
535
+ # process the query parameters
536
+ if names is not None:
537
+
538
+ _query_params.append(('names', names))
539
+
540
+ # process the header parameters
541
+ # process the form parameters
542
+ # process the body parameter
543
+
544
+
545
+ # set the HTTP header `Accept`
546
+ _header_params['Accept'] = self.api_client.select_header_accept(
547
+ [
548
+ 'application/json'
549
+ ]
550
+ )
551
+
552
+
553
+ # authentication setting
554
+ _auth_settings: List[str] = [
555
+ ]
556
+
557
+ return self.api_client.param_serialize(
558
+ method='GET',
559
+ resource_path='/v1alpha/documents:batchGet',
560
+ path_params=_path_params,
561
+ query_params=_query_params,
562
+ header_params=_header_params,
563
+ body=_body_params,
564
+ post_params=_form_params,
565
+ files=_files,
566
+ auth_settings=_auth_settings,
567
+ collection_formats=_collection_formats,
568
+ _host=_host,
569
+ _request_auth=_request_auth
570
+ )
571
+
572
+
573
+
574
+
575
+ @validate_call
576
+ def document_service_create_document(
577
+ self,
578
+ document: Annotated[V1alphaDocument, Field(description="Required. The Document to create.")],
579
+ _request_timeout: Union[
580
+ None,
581
+ Annotated[StrictFloat, Field(gt=0)],
582
+ Tuple[
583
+ Annotated[StrictFloat, Field(gt=0)],
584
+ Annotated[StrictFloat, Field(gt=0)]
585
+ ]
586
+ ] = None,
587
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
588
+ _content_type: Optional[StrictStr] = None,
589
+ _headers: Optional[Dict[StrictStr, Any]] = None,
590
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
591
+ ) -> V1alphaCreateDocumentResponse:
592
+ """document_service_create_document
593
+
594
+
595
+ :param document: Required. The Document to create. (required)
596
+ :type document: V1alphaDocument
597
+ :param _request_timeout: timeout setting for this request. If one
598
+ number provided, it will be total request
599
+ timeout. It can also be a pair (tuple) of
600
+ (connection, read) timeouts.
601
+ :type _request_timeout: int, tuple(int, int), optional
602
+ :param _request_auth: set to override the auth_settings for an a single
603
+ request; this effectively ignores the
604
+ authentication in the spec for a single request.
605
+ :type _request_auth: dict, optional
606
+ :param _content_type: force content-type for the request.
607
+ :type _content_type: str, Optional
608
+ :param _headers: set to override the headers for a single
609
+ request; this effectively ignores the headers
610
+ in the spec for a single request.
611
+ :type _headers: dict, optional
612
+ :param _host_index: set to override the host_index for a single
613
+ request; this effectively ignores the host_index
614
+ in the spec for a single request.
615
+ :type _host_index: int, optional
616
+ :return: Returns the result object.
617
+ """ # noqa: E501
618
+
619
+ _param = self._document_service_create_document_serialize(
620
+ document=document,
621
+ _request_auth=_request_auth,
622
+ _content_type=_content_type,
623
+ _headers=_headers,
624
+ _host_index=_host_index
625
+ )
626
+
627
+ _response_types_map: Dict[str, Optional[str]] = {
628
+ '200': "V1alphaCreateDocumentResponse",
629
+ }
630
+ response_data = self.api_client.call_api(
631
+ *_param,
632
+ _request_timeout=_request_timeout
633
+ )
634
+ response_data.read()
635
+ return self.api_client.response_deserialize(
636
+ response_data=response_data,
637
+ response_types_map=_response_types_map,
638
+ ).data
639
+
640
+
641
+ @validate_call
642
+ def document_service_create_document_with_http_info(
643
+ self,
644
+ document: Annotated[V1alphaDocument, Field(description="Required. The Document to create.")],
645
+ _request_timeout: Union[
646
+ None,
647
+ Annotated[StrictFloat, Field(gt=0)],
648
+ Tuple[
649
+ Annotated[StrictFloat, Field(gt=0)],
650
+ Annotated[StrictFloat, Field(gt=0)]
651
+ ]
652
+ ] = None,
653
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
654
+ _content_type: Optional[StrictStr] = None,
655
+ _headers: Optional[Dict[StrictStr, Any]] = None,
656
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
657
+ ) -> ApiResponse[V1alphaCreateDocumentResponse]:
658
+ """document_service_create_document
659
+
660
+
661
+ :param document: Required. The Document to create. (required)
662
+ :type document: V1alphaDocument
663
+ :param _request_timeout: timeout setting for this request. If one
664
+ number provided, it will be total request
665
+ timeout. It can also be a pair (tuple) of
666
+ (connection, read) timeouts.
667
+ :type _request_timeout: int, tuple(int, int), optional
668
+ :param _request_auth: set to override the auth_settings for an a single
669
+ request; this effectively ignores the
670
+ authentication in the spec for a single request.
671
+ :type _request_auth: dict, optional
672
+ :param _content_type: force content-type for the request.
673
+ :type _content_type: str, Optional
674
+ :param _headers: set to override the headers for a single
675
+ request; this effectively ignores the headers
676
+ in the spec for a single request.
677
+ :type _headers: dict, optional
678
+ :param _host_index: set to override the host_index for a single
679
+ request; this effectively ignores the host_index
680
+ in the spec for a single request.
681
+ :type _host_index: int, optional
682
+ :return: Returns the result object.
683
+ """ # noqa: E501
684
+
685
+ _param = self._document_service_create_document_serialize(
686
+ document=document,
687
+ _request_auth=_request_auth,
688
+ _content_type=_content_type,
689
+ _headers=_headers,
690
+ _host_index=_host_index
691
+ )
692
+
693
+ _response_types_map: Dict[str, Optional[str]] = {
694
+ '200': "V1alphaCreateDocumentResponse",
695
+ }
696
+ response_data = self.api_client.call_api(
697
+ *_param,
698
+ _request_timeout=_request_timeout
699
+ )
700
+ response_data.read()
701
+ return self.api_client.response_deserialize(
702
+ response_data=response_data,
703
+ response_types_map=_response_types_map,
704
+ )
705
+
706
+
707
+ @validate_call
708
+ def document_service_create_document_without_preload_content(
709
+ self,
710
+ document: Annotated[V1alphaDocument, Field(description="Required. The Document to create.")],
711
+ _request_timeout: Union[
712
+ None,
713
+ Annotated[StrictFloat, Field(gt=0)],
714
+ Tuple[
715
+ Annotated[StrictFloat, Field(gt=0)],
716
+ Annotated[StrictFloat, Field(gt=0)]
717
+ ]
718
+ ] = None,
719
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
720
+ _content_type: Optional[StrictStr] = None,
721
+ _headers: Optional[Dict[StrictStr, Any]] = None,
722
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
723
+ ) -> RESTResponseType:
724
+ """document_service_create_document
725
+
726
+
727
+ :param document: Required. The Document to create. (required)
728
+ :type document: V1alphaDocument
729
+ :param _request_timeout: timeout setting for this request. If one
730
+ number provided, it will be total request
731
+ timeout. It can also be a pair (tuple) of
732
+ (connection, read) timeouts.
733
+ :type _request_timeout: int, tuple(int, int), optional
734
+ :param _request_auth: set to override the auth_settings for an a single
735
+ request; this effectively ignores the
736
+ authentication in the spec for a single request.
737
+ :type _request_auth: dict, optional
738
+ :param _content_type: force content-type for the request.
739
+ :type _content_type: str, Optional
740
+ :param _headers: set to override the headers for a single
741
+ request; this effectively ignores the headers
742
+ in the spec for a single request.
743
+ :type _headers: dict, optional
744
+ :param _host_index: set to override the host_index for a single
745
+ request; this effectively ignores the host_index
746
+ in the spec for a single request.
747
+ :type _host_index: int, optional
748
+ :return: Returns the result object.
749
+ """ # noqa: E501
750
+
751
+ _param = self._document_service_create_document_serialize(
752
+ document=document,
753
+ _request_auth=_request_auth,
754
+ _content_type=_content_type,
755
+ _headers=_headers,
756
+ _host_index=_host_index
757
+ )
758
+
759
+ _response_types_map: Dict[str, Optional[str]] = {
760
+ '200': "V1alphaCreateDocumentResponse",
761
+ }
762
+ response_data = self.api_client.call_api(
763
+ *_param,
764
+ _request_timeout=_request_timeout
765
+ )
766
+ return response_data.response
767
+
768
+
769
+ def _document_service_create_document_serialize(
770
+ self,
771
+ document,
772
+ _request_auth,
773
+ _content_type,
774
+ _headers,
775
+ _host_index,
776
+ ) -> RequestSerialized:
777
+
778
+ _host = None
779
+
780
+ _collection_formats: Dict[str, str] = {
781
+ }
782
+
783
+ _path_params: Dict[str, str] = {}
784
+ _query_params: List[Tuple[str, str]] = []
785
+ _header_params: Dict[str, Optional[str]] = _headers or {}
786
+ _form_params: List[Tuple[str, str]] = []
787
+ _files: Dict[str, Union[str, bytes]] = {}
788
+ _body_params: Optional[bytes] = None
789
+
790
+ # process the path parameters
791
+ # process the query parameters
792
+ # process the header parameters
793
+ # process the form parameters
794
+ # process the body parameter
795
+ if document is not None:
796
+ _body_params = document
797
+
798
+
799
+ # set the HTTP header `Accept`
800
+ _header_params['Accept'] = self.api_client.select_header_accept(
801
+ [
802
+ 'application/json'
803
+ ]
804
+ )
805
+
806
+ # set the HTTP header `Content-Type`
807
+ if _content_type:
808
+ _header_params['Content-Type'] = _content_type
809
+ else:
810
+ _default_content_type = (
811
+ self.api_client.select_header_content_type(
812
+ [
813
+ 'application/json'
814
+ ]
815
+ )
816
+ )
817
+ if _default_content_type is not None:
818
+ _header_params['Content-Type'] = _default_content_type
819
+
820
+ # authentication setting
821
+ _auth_settings: List[str] = [
822
+ ]
823
+
824
+ return self.api_client.param_serialize(
825
+ method='POST',
826
+ resource_path='/v1alpha/documents',
827
+ path_params=_path_params,
828
+ query_params=_query_params,
829
+ header_params=_header_params,
830
+ body=_body_params,
831
+ post_params=_form_params,
832
+ files=_files,
833
+ auth_settings=_auth_settings,
834
+ collection_formats=_collection_formats,
835
+ _host=_host,
836
+ _request_auth=_request_auth
837
+ )
838
+
839
+
840
+
841
+
842
+ @validate_call
843
+ def document_service_delete_document(
844
+ self,
845
+ name_1: Annotated[str, Field(strict=True, description="Required. The name of the Document to delete.")],
846
+ _request_timeout: Union[
847
+ None,
848
+ Annotated[StrictFloat, Field(gt=0)],
849
+ Tuple[
850
+ Annotated[StrictFloat, Field(gt=0)],
851
+ Annotated[StrictFloat, Field(gt=0)]
852
+ ]
853
+ ] = None,
854
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
855
+ _content_type: Optional[StrictStr] = None,
856
+ _headers: Optional[Dict[StrictStr, Any]] = None,
857
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
858
+ ) -> V1alphaDeleteDocumentResponse:
859
+ """document_service_delete_document
860
+
861
+
862
+ :param name_1: Required. The name of the Document to delete. (required)
863
+ :type name_1: str
864
+ :param _request_timeout: timeout setting for this request. If one
865
+ number provided, it will be total request
866
+ timeout. It can also be a pair (tuple) of
867
+ (connection, read) timeouts.
868
+ :type _request_timeout: int, tuple(int, int), optional
869
+ :param _request_auth: set to override the auth_settings for an a single
870
+ request; this effectively ignores the
871
+ authentication in the spec for a single request.
872
+ :type _request_auth: dict, optional
873
+ :param _content_type: force content-type for the request.
874
+ :type _content_type: str, Optional
875
+ :param _headers: set to override the headers for a single
876
+ request; this effectively ignores the headers
877
+ in the spec for a single request.
878
+ :type _headers: dict, optional
879
+ :param _host_index: set to override the host_index for a single
880
+ request; this effectively ignores the host_index
881
+ in the spec for a single request.
882
+ :type _host_index: int, optional
883
+ :return: Returns the result object.
884
+ """ # noqa: E501
885
+
886
+ _param = self._document_service_delete_document_serialize(
887
+ name_1=name_1,
888
+ _request_auth=_request_auth,
889
+ _content_type=_content_type,
890
+ _headers=_headers,
891
+ _host_index=_host_index
892
+ )
893
+
894
+ _response_types_map: Dict[str, Optional[str]] = {
895
+ '200': "V1alphaDeleteDocumentResponse",
896
+ }
897
+ response_data = self.api_client.call_api(
898
+ *_param,
899
+ _request_timeout=_request_timeout
900
+ )
901
+ response_data.read()
902
+ return self.api_client.response_deserialize(
903
+ response_data=response_data,
904
+ response_types_map=_response_types_map,
905
+ ).data
906
+
907
+
908
+ @validate_call
909
+ def document_service_delete_document_with_http_info(
910
+ self,
911
+ name_1: Annotated[str, Field(strict=True, description="Required. The name of the Document to delete.")],
912
+ _request_timeout: Union[
913
+ None,
914
+ Annotated[StrictFloat, Field(gt=0)],
915
+ Tuple[
916
+ Annotated[StrictFloat, Field(gt=0)],
917
+ Annotated[StrictFloat, Field(gt=0)]
918
+ ]
919
+ ] = None,
920
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
921
+ _content_type: Optional[StrictStr] = None,
922
+ _headers: Optional[Dict[StrictStr, Any]] = None,
923
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
924
+ ) -> ApiResponse[V1alphaDeleteDocumentResponse]:
925
+ """document_service_delete_document
926
+
927
+
928
+ :param name_1: Required. The name of the Document to delete. (required)
929
+ :type name_1: str
930
+ :param _request_timeout: timeout setting for this request. If one
931
+ number provided, it will be total request
932
+ timeout. It can also be a pair (tuple) of
933
+ (connection, read) timeouts.
934
+ :type _request_timeout: int, tuple(int, int), optional
935
+ :param _request_auth: set to override the auth_settings for an a single
936
+ request; this effectively ignores the
937
+ authentication in the spec for a single request.
938
+ :type _request_auth: dict, optional
939
+ :param _content_type: force content-type for the request.
940
+ :type _content_type: str, Optional
941
+ :param _headers: set to override the headers for a single
942
+ request; this effectively ignores the headers
943
+ in the spec for a single request.
944
+ :type _headers: dict, optional
945
+ :param _host_index: set to override the host_index for a single
946
+ request; this effectively ignores the host_index
947
+ in the spec for a single request.
948
+ :type _host_index: int, optional
949
+ :return: Returns the result object.
950
+ """ # noqa: E501
951
+
952
+ _param = self._document_service_delete_document_serialize(
953
+ name_1=name_1,
954
+ _request_auth=_request_auth,
955
+ _content_type=_content_type,
956
+ _headers=_headers,
957
+ _host_index=_host_index
958
+ )
959
+
960
+ _response_types_map: Dict[str, Optional[str]] = {
961
+ '200': "V1alphaDeleteDocumentResponse",
962
+ }
963
+ response_data = self.api_client.call_api(
964
+ *_param,
965
+ _request_timeout=_request_timeout
966
+ )
967
+ response_data.read()
968
+ return self.api_client.response_deserialize(
969
+ response_data=response_data,
970
+ response_types_map=_response_types_map,
971
+ )
972
+
973
+
974
+ @validate_call
975
+ def document_service_delete_document_without_preload_content(
976
+ self,
977
+ name_1: Annotated[str, Field(strict=True, description="Required. The name of the Document to delete.")],
978
+ _request_timeout: Union[
979
+ None,
980
+ Annotated[StrictFloat, Field(gt=0)],
981
+ Tuple[
982
+ Annotated[StrictFloat, Field(gt=0)],
983
+ Annotated[StrictFloat, Field(gt=0)]
984
+ ]
985
+ ] = None,
986
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
987
+ _content_type: Optional[StrictStr] = None,
988
+ _headers: Optional[Dict[StrictStr, Any]] = None,
989
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
990
+ ) -> RESTResponseType:
991
+ """document_service_delete_document
992
+
993
+
994
+ :param name_1: Required. The name of the Document to delete. (required)
995
+ :type name_1: str
996
+ :param _request_timeout: timeout setting for this request. If one
997
+ number provided, it will be total request
998
+ timeout. It can also be a pair (tuple) of
999
+ (connection, read) timeouts.
1000
+ :type _request_timeout: int, tuple(int, int), optional
1001
+ :param _request_auth: set to override the auth_settings for an a single
1002
+ request; this effectively ignores the
1003
+ authentication in the spec for a single request.
1004
+ :type _request_auth: dict, optional
1005
+ :param _content_type: force content-type for the request.
1006
+ :type _content_type: str, Optional
1007
+ :param _headers: set to override the headers for a single
1008
+ request; this effectively ignores the headers
1009
+ in the spec for a single request.
1010
+ :type _headers: dict, optional
1011
+ :param _host_index: set to override the host_index for a single
1012
+ request; this effectively ignores the host_index
1013
+ in the spec for a single request.
1014
+ :type _host_index: int, optional
1015
+ :return: Returns the result object.
1016
+ """ # noqa: E501
1017
+
1018
+ _param = self._document_service_delete_document_serialize(
1019
+ name_1=name_1,
1020
+ _request_auth=_request_auth,
1021
+ _content_type=_content_type,
1022
+ _headers=_headers,
1023
+ _host_index=_host_index
1024
+ )
1025
+
1026
+ _response_types_map: Dict[str, Optional[str]] = {
1027
+ '200': "V1alphaDeleteDocumentResponse",
1028
+ }
1029
+ response_data = self.api_client.call_api(
1030
+ *_param,
1031
+ _request_timeout=_request_timeout
1032
+ )
1033
+ return response_data.response
1034
+
1035
+
1036
+ def _document_service_delete_document_serialize(
1037
+ self,
1038
+ name_1,
1039
+ _request_auth,
1040
+ _content_type,
1041
+ _headers,
1042
+ _host_index,
1043
+ ) -> RequestSerialized:
1044
+
1045
+ _host = None
1046
+
1047
+ _collection_formats: Dict[str, str] = {
1048
+ }
1049
+
1050
+ _path_params: Dict[str, str] = {}
1051
+ _query_params: List[Tuple[str, str]] = []
1052
+ _header_params: Dict[str, Optional[str]] = _headers or {}
1053
+ _form_params: List[Tuple[str, str]] = []
1054
+ _files: Dict[str, Union[str, bytes]] = {}
1055
+ _body_params: Optional[bytes] = None
1056
+
1057
+ # process the path parameters
1058
+ if name_1 is not None:
1059
+ _path_params['name_1'] = name_1
1060
+ # process the query parameters
1061
+ # process the header parameters
1062
+ # process the form parameters
1063
+ # process the body parameter
1064
+
1065
+
1066
+ # set the HTTP header `Accept`
1067
+ _header_params['Accept'] = self.api_client.select_header_accept(
1068
+ [
1069
+ 'application/json'
1070
+ ]
1071
+ )
1072
+
1073
+
1074
+ # authentication setting
1075
+ _auth_settings: List[str] = [
1076
+ ]
1077
+
1078
+ return self.api_client.param_serialize(
1079
+ method='DELETE',
1080
+ resource_path='/v1alpha/{name_1}',
1081
+ path_params=_path_params,
1082
+ query_params=_query_params,
1083
+ header_params=_header_params,
1084
+ body=_body_params,
1085
+ post_params=_form_params,
1086
+ files=_files,
1087
+ auth_settings=_auth_settings,
1088
+ collection_formats=_collection_formats,
1089
+ _host=_host,
1090
+ _request_auth=_request_auth
1091
+ )
1092
+
1093
+
1094
+
1095
+
1096
+ @validate_call
1097
+ def document_service_get_document(
1098
+ self,
1099
+ name_1: Annotated[str, Field(strict=True, description="Required. The name of the Document to retrieve.")],
1100
+ _request_timeout: Union[
1101
+ None,
1102
+ Annotated[StrictFloat, Field(gt=0)],
1103
+ Tuple[
1104
+ Annotated[StrictFloat, Field(gt=0)],
1105
+ Annotated[StrictFloat, Field(gt=0)]
1106
+ ]
1107
+ ] = None,
1108
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1109
+ _content_type: Optional[StrictStr] = None,
1110
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1111
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1112
+ ) -> V1alphaGetDocumentResponse:
1113
+ """document_service_get_document
1114
+
1115
+
1116
+ :param name_1: Required. The name of the Document to retrieve. (required)
1117
+ :type name_1: str
1118
+ :param _request_timeout: timeout setting for this request. If one
1119
+ number provided, it will be total request
1120
+ timeout. It can also be a pair (tuple) of
1121
+ (connection, read) timeouts.
1122
+ :type _request_timeout: int, tuple(int, int), optional
1123
+ :param _request_auth: set to override the auth_settings for an a single
1124
+ request; this effectively ignores the
1125
+ authentication in the spec for a single request.
1126
+ :type _request_auth: dict, optional
1127
+ :param _content_type: force content-type for the request.
1128
+ :type _content_type: str, Optional
1129
+ :param _headers: set to override the headers for a single
1130
+ request; this effectively ignores the headers
1131
+ in the spec for a single request.
1132
+ :type _headers: dict, optional
1133
+ :param _host_index: set to override the host_index for a single
1134
+ request; this effectively ignores the host_index
1135
+ in the spec for a single request.
1136
+ :type _host_index: int, optional
1137
+ :return: Returns the result object.
1138
+ """ # noqa: E501
1139
+
1140
+ _param = self._document_service_get_document_serialize(
1141
+ name_1=name_1,
1142
+ _request_auth=_request_auth,
1143
+ _content_type=_content_type,
1144
+ _headers=_headers,
1145
+ _host_index=_host_index
1146
+ )
1147
+
1148
+ _response_types_map: Dict[str, Optional[str]] = {
1149
+ '200': "V1alphaGetDocumentResponse",
1150
+ }
1151
+ response_data = self.api_client.call_api(
1152
+ *_param,
1153
+ _request_timeout=_request_timeout
1154
+ )
1155
+ response_data.read()
1156
+ return self.api_client.response_deserialize(
1157
+ response_data=response_data,
1158
+ response_types_map=_response_types_map,
1159
+ ).data
1160
+
1161
+
1162
+ @validate_call
1163
+ def document_service_get_document_with_http_info(
1164
+ self,
1165
+ name_1: Annotated[str, Field(strict=True, description="Required. The name of the Document to retrieve.")],
1166
+ _request_timeout: Union[
1167
+ None,
1168
+ Annotated[StrictFloat, Field(gt=0)],
1169
+ Tuple[
1170
+ Annotated[StrictFloat, Field(gt=0)],
1171
+ Annotated[StrictFloat, Field(gt=0)]
1172
+ ]
1173
+ ] = None,
1174
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1175
+ _content_type: Optional[StrictStr] = None,
1176
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1177
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1178
+ ) -> ApiResponse[V1alphaGetDocumentResponse]:
1179
+ """document_service_get_document
1180
+
1181
+
1182
+ :param name_1: Required. The name of the Document to retrieve. (required)
1183
+ :type name_1: str
1184
+ :param _request_timeout: timeout setting for this request. If one
1185
+ number provided, it will be total request
1186
+ timeout. It can also be a pair (tuple) of
1187
+ (connection, read) timeouts.
1188
+ :type _request_timeout: int, tuple(int, int), optional
1189
+ :param _request_auth: set to override the auth_settings for an a single
1190
+ request; this effectively ignores the
1191
+ authentication in the spec for a single request.
1192
+ :type _request_auth: dict, optional
1193
+ :param _content_type: force content-type for the request.
1194
+ :type _content_type: str, Optional
1195
+ :param _headers: set to override the headers for a single
1196
+ request; this effectively ignores the headers
1197
+ in the spec for a single request.
1198
+ :type _headers: dict, optional
1199
+ :param _host_index: set to override the host_index for a single
1200
+ request; this effectively ignores the host_index
1201
+ in the spec for a single request.
1202
+ :type _host_index: int, optional
1203
+ :return: Returns the result object.
1204
+ """ # noqa: E501
1205
+
1206
+ _param = self._document_service_get_document_serialize(
1207
+ name_1=name_1,
1208
+ _request_auth=_request_auth,
1209
+ _content_type=_content_type,
1210
+ _headers=_headers,
1211
+ _host_index=_host_index
1212
+ )
1213
+
1214
+ _response_types_map: Dict[str, Optional[str]] = {
1215
+ '200': "V1alphaGetDocumentResponse",
1216
+ }
1217
+ response_data = self.api_client.call_api(
1218
+ *_param,
1219
+ _request_timeout=_request_timeout
1220
+ )
1221
+ response_data.read()
1222
+ return self.api_client.response_deserialize(
1223
+ response_data=response_data,
1224
+ response_types_map=_response_types_map,
1225
+ )
1226
+
1227
+
1228
+ @validate_call
1229
+ def document_service_get_document_without_preload_content(
1230
+ self,
1231
+ name_1: Annotated[str, Field(strict=True, description="Required. The name of the Document to retrieve.")],
1232
+ _request_timeout: Union[
1233
+ None,
1234
+ Annotated[StrictFloat, Field(gt=0)],
1235
+ Tuple[
1236
+ Annotated[StrictFloat, Field(gt=0)],
1237
+ Annotated[StrictFloat, Field(gt=0)]
1238
+ ]
1239
+ ] = None,
1240
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1241
+ _content_type: Optional[StrictStr] = None,
1242
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1243
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1244
+ ) -> RESTResponseType:
1245
+ """document_service_get_document
1246
+
1247
+
1248
+ :param name_1: Required. The name of the Document to retrieve. (required)
1249
+ :type name_1: str
1250
+ :param _request_timeout: timeout setting for this request. If one
1251
+ number provided, it will be total request
1252
+ timeout. It can also be a pair (tuple) of
1253
+ (connection, read) timeouts.
1254
+ :type _request_timeout: int, tuple(int, int), optional
1255
+ :param _request_auth: set to override the auth_settings for an a single
1256
+ request; this effectively ignores the
1257
+ authentication in the spec for a single request.
1258
+ :type _request_auth: dict, optional
1259
+ :param _content_type: force content-type for the request.
1260
+ :type _content_type: str, Optional
1261
+ :param _headers: set to override the headers for a single
1262
+ request; this effectively ignores the headers
1263
+ in the spec for a single request.
1264
+ :type _headers: dict, optional
1265
+ :param _host_index: set to override the host_index for a single
1266
+ request; this effectively ignores the host_index
1267
+ in the spec for a single request.
1268
+ :type _host_index: int, optional
1269
+ :return: Returns the result object.
1270
+ """ # noqa: E501
1271
+
1272
+ _param = self._document_service_get_document_serialize(
1273
+ name_1=name_1,
1274
+ _request_auth=_request_auth,
1275
+ _content_type=_content_type,
1276
+ _headers=_headers,
1277
+ _host_index=_host_index
1278
+ )
1279
+
1280
+ _response_types_map: Dict[str, Optional[str]] = {
1281
+ '200': "V1alphaGetDocumentResponse",
1282
+ }
1283
+ response_data = self.api_client.call_api(
1284
+ *_param,
1285
+ _request_timeout=_request_timeout
1286
+ )
1287
+ return response_data.response
1288
+
1289
+
1290
+ def _document_service_get_document_serialize(
1291
+ self,
1292
+ name_1,
1293
+ _request_auth,
1294
+ _content_type,
1295
+ _headers,
1296
+ _host_index,
1297
+ ) -> RequestSerialized:
1298
+
1299
+ _host = None
1300
+
1301
+ _collection_formats: Dict[str, str] = {
1302
+ }
1303
+
1304
+ _path_params: Dict[str, str] = {}
1305
+ _query_params: List[Tuple[str, str]] = []
1306
+ _header_params: Dict[str, Optional[str]] = _headers or {}
1307
+ _form_params: List[Tuple[str, str]] = []
1308
+ _files: Dict[str, Union[str, bytes]] = {}
1309
+ _body_params: Optional[bytes] = None
1310
+
1311
+ # process the path parameters
1312
+ if name_1 is not None:
1313
+ _path_params['name_1'] = name_1
1314
+ # process the query parameters
1315
+ # process the header parameters
1316
+ # process the form parameters
1317
+ # process the body parameter
1318
+
1319
+
1320
+ # set the HTTP header `Accept`
1321
+ _header_params['Accept'] = self.api_client.select_header_accept(
1322
+ [
1323
+ 'application/json'
1324
+ ]
1325
+ )
1326
+
1327
+
1328
+ # authentication setting
1329
+ _auth_settings: List[str] = [
1330
+ ]
1331
+
1332
+ return self.api_client.param_serialize(
1333
+ method='GET',
1334
+ resource_path='/v1alpha/{name_1}',
1335
+ path_params=_path_params,
1336
+ query_params=_query_params,
1337
+ header_params=_header_params,
1338
+ body=_body_params,
1339
+ post_params=_form_params,
1340
+ files=_files,
1341
+ auth_settings=_auth_settings,
1342
+ collection_formats=_collection_formats,
1343
+ _host=_host,
1344
+ _request_auth=_request_auth
1345
+ )
1346
+
1347
+
1348
+
1349
+
1350
+ @validate_call
1351
+ def document_service_list_documents(
1352
+ self,
1353
+ _request_timeout: Union[
1354
+ None,
1355
+ Annotated[StrictFloat, Field(gt=0)],
1356
+ Tuple[
1357
+ Annotated[StrictFloat, Field(gt=0)],
1358
+ Annotated[StrictFloat, Field(gt=0)]
1359
+ ]
1360
+ ] = None,
1361
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1362
+ _content_type: Optional[StrictStr] = None,
1363
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1364
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1365
+ ) -> V1alphaListDocumentsResponse:
1366
+ """document_service_list_documents
1367
+
1368
+
1369
+ :param _request_timeout: timeout setting for this request. If one
1370
+ number provided, it will be total request
1371
+ timeout. It can also be a pair (tuple) of
1372
+ (connection, read) timeouts.
1373
+ :type _request_timeout: int, tuple(int, int), optional
1374
+ :param _request_auth: set to override the auth_settings for an a single
1375
+ request; this effectively ignores the
1376
+ authentication in the spec for a single request.
1377
+ :type _request_auth: dict, optional
1378
+ :param _content_type: force content-type for the request.
1379
+ :type _content_type: str, Optional
1380
+ :param _headers: set to override the headers for a single
1381
+ request; this effectively ignores the headers
1382
+ in the spec for a single request.
1383
+ :type _headers: dict, optional
1384
+ :param _host_index: set to override the host_index for a single
1385
+ request; this effectively ignores the host_index
1386
+ in the spec for a single request.
1387
+ :type _host_index: int, optional
1388
+ :return: Returns the result object.
1389
+ """ # noqa: E501
1390
+
1391
+ _param = self._document_service_list_documents_serialize(
1392
+ _request_auth=_request_auth,
1393
+ _content_type=_content_type,
1394
+ _headers=_headers,
1395
+ _host_index=_host_index
1396
+ )
1397
+
1398
+ _response_types_map: Dict[str, Optional[str]] = {
1399
+ '200': "V1alphaListDocumentsResponse",
1400
+ }
1401
+ response_data = self.api_client.call_api(
1402
+ *_param,
1403
+ _request_timeout=_request_timeout
1404
+ )
1405
+ response_data.read()
1406
+ return self.api_client.response_deserialize(
1407
+ response_data=response_data,
1408
+ response_types_map=_response_types_map,
1409
+ ).data
1410
+
1411
+
1412
+ @validate_call
1413
+ def document_service_list_documents_with_http_info(
1414
+ self,
1415
+ _request_timeout: Union[
1416
+ None,
1417
+ Annotated[StrictFloat, Field(gt=0)],
1418
+ Tuple[
1419
+ Annotated[StrictFloat, Field(gt=0)],
1420
+ Annotated[StrictFloat, Field(gt=0)]
1421
+ ]
1422
+ ] = None,
1423
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1424
+ _content_type: Optional[StrictStr] = None,
1425
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1426
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1427
+ ) -> ApiResponse[V1alphaListDocumentsResponse]:
1428
+ """document_service_list_documents
1429
+
1430
+
1431
+ :param _request_timeout: timeout setting for this request. If one
1432
+ number provided, it will be total request
1433
+ timeout. It can also be a pair (tuple) of
1434
+ (connection, read) timeouts.
1435
+ :type _request_timeout: int, tuple(int, int), optional
1436
+ :param _request_auth: set to override the auth_settings for an a single
1437
+ request; this effectively ignores the
1438
+ authentication in the spec for a single request.
1439
+ :type _request_auth: dict, optional
1440
+ :param _content_type: force content-type for the request.
1441
+ :type _content_type: str, Optional
1442
+ :param _headers: set to override the headers for a single
1443
+ request; this effectively ignores the headers
1444
+ in the spec for a single request.
1445
+ :type _headers: dict, optional
1446
+ :param _host_index: set to override the host_index for a single
1447
+ request; this effectively ignores the host_index
1448
+ in the spec for a single request.
1449
+ :type _host_index: int, optional
1450
+ :return: Returns the result object.
1451
+ """ # noqa: E501
1452
+
1453
+ _param = self._document_service_list_documents_serialize(
1454
+ _request_auth=_request_auth,
1455
+ _content_type=_content_type,
1456
+ _headers=_headers,
1457
+ _host_index=_host_index
1458
+ )
1459
+
1460
+ _response_types_map: Dict[str, Optional[str]] = {
1461
+ '200': "V1alphaListDocumentsResponse",
1462
+ }
1463
+ response_data = self.api_client.call_api(
1464
+ *_param,
1465
+ _request_timeout=_request_timeout
1466
+ )
1467
+ response_data.read()
1468
+ return self.api_client.response_deserialize(
1469
+ response_data=response_data,
1470
+ response_types_map=_response_types_map,
1471
+ )
1472
+
1473
+
1474
+ @validate_call
1475
+ def document_service_list_documents_without_preload_content(
1476
+ self,
1477
+ _request_timeout: Union[
1478
+ None,
1479
+ Annotated[StrictFloat, Field(gt=0)],
1480
+ Tuple[
1481
+ Annotated[StrictFloat, Field(gt=0)],
1482
+ Annotated[StrictFloat, Field(gt=0)]
1483
+ ]
1484
+ ] = None,
1485
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1486
+ _content_type: Optional[StrictStr] = None,
1487
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1488
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1489
+ ) -> RESTResponseType:
1490
+ """document_service_list_documents
1491
+
1492
+
1493
+ :param _request_timeout: timeout setting for this request. If one
1494
+ number provided, it will be total request
1495
+ timeout. It can also be a pair (tuple) of
1496
+ (connection, read) timeouts.
1497
+ :type _request_timeout: int, tuple(int, int), optional
1498
+ :param _request_auth: set to override the auth_settings for an a single
1499
+ request; this effectively ignores the
1500
+ authentication in the spec for a single request.
1501
+ :type _request_auth: dict, optional
1502
+ :param _content_type: force content-type for the request.
1503
+ :type _content_type: str, Optional
1504
+ :param _headers: set to override the headers for a single
1505
+ request; this effectively ignores the headers
1506
+ in the spec for a single request.
1507
+ :type _headers: dict, optional
1508
+ :param _host_index: set to override the host_index for a single
1509
+ request; this effectively ignores the host_index
1510
+ in the spec for a single request.
1511
+ :type _host_index: int, optional
1512
+ :return: Returns the result object.
1513
+ """ # noqa: E501
1514
+
1515
+ _param = self._document_service_list_documents_serialize(
1516
+ _request_auth=_request_auth,
1517
+ _content_type=_content_type,
1518
+ _headers=_headers,
1519
+ _host_index=_host_index
1520
+ )
1521
+
1522
+ _response_types_map: Dict[str, Optional[str]] = {
1523
+ '200': "V1alphaListDocumentsResponse",
1524
+ }
1525
+ response_data = self.api_client.call_api(
1526
+ *_param,
1527
+ _request_timeout=_request_timeout
1528
+ )
1529
+ return response_data.response
1530
+
1531
+
1532
+ def _document_service_list_documents_serialize(
1533
+ self,
1534
+ _request_auth,
1535
+ _content_type,
1536
+ _headers,
1537
+ _host_index,
1538
+ ) -> RequestSerialized:
1539
+
1540
+ _host = None
1541
+
1542
+ _collection_formats: Dict[str, str] = {
1543
+ }
1544
+
1545
+ _path_params: Dict[str, str] = {}
1546
+ _query_params: List[Tuple[str, str]] = []
1547
+ _header_params: Dict[str, Optional[str]] = _headers or {}
1548
+ _form_params: List[Tuple[str, str]] = []
1549
+ _files: Dict[str, Union[str, bytes]] = {}
1550
+ _body_params: Optional[bytes] = None
1551
+
1552
+ # process the path parameters
1553
+ # process the query parameters
1554
+ # process the header parameters
1555
+ # process the form parameters
1556
+ # process the body parameter
1557
+
1558
+
1559
+ # set the HTTP header `Accept`
1560
+ _header_params['Accept'] = self.api_client.select_header_accept(
1561
+ [
1562
+ 'application/json'
1563
+ ]
1564
+ )
1565
+
1566
+
1567
+ # authentication setting
1568
+ _auth_settings: List[str] = [
1569
+ ]
1570
+
1571
+ return self.api_client.param_serialize(
1572
+ method='GET',
1573
+ resource_path='/v1alpha/documents',
1574
+ path_params=_path_params,
1575
+ query_params=_query_params,
1576
+ header_params=_header_params,
1577
+ body=_body_params,
1578
+ post_params=_form_params,
1579
+ files=_files,
1580
+ auth_settings=_auth_settings,
1581
+ collection_formats=_collection_formats,
1582
+ _host=_host,
1583
+ _request_auth=_request_auth
1584
+ )
1585
+
1586
+
1587
+
1588
+
1589
+ @validate_call
1590
+ def document_service_update_document(
1591
+ self,
1592
+ document_name: Annotated[str, Field(strict=True, description="Output only. Name of the Document resource. e.g.: \"documents/<UUID>\"")],
1593
+ document: Annotated[RequiredTheDocumentToUpdate, Field(description="Required. The Document to update. The Document's name field is used to identify the Document to be updated. Format: documents/{document}")],
1594
+ _request_timeout: Union[
1595
+ None,
1596
+ Annotated[StrictFloat, Field(gt=0)],
1597
+ Tuple[
1598
+ Annotated[StrictFloat, Field(gt=0)],
1599
+ Annotated[StrictFloat, Field(gt=0)]
1600
+ ]
1601
+ ] = None,
1602
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1603
+ _content_type: Optional[StrictStr] = None,
1604
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1605
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1606
+ ) -> V1alphaUpdateDocumentResponse:
1607
+ """document_service_update_document
1608
+
1609
+
1610
+ :param document_name: Output only. Name of the Document resource. e.g.: \"documents/<UUID>\" (required)
1611
+ :type document_name: str
1612
+ :param document: Required. The Document to update. The Document's name field is used to identify the Document to be updated. Format: documents/{document} (required)
1613
+ :type document: RequiredTheDocumentToUpdate
1614
+ :param _request_timeout: timeout setting for this request. If one
1615
+ number provided, it will be total request
1616
+ timeout. It can also be a pair (tuple) of
1617
+ (connection, read) timeouts.
1618
+ :type _request_timeout: int, tuple(int, int), optional
1619
+ :param _request_auth: set to override the auth_settings for an a single
1620
+ request; this effectively ignores the
1621
+ authentication in the spec for a single request.
1622
+ :type _request_auth: dict, optional
1623
+ :param _content_type: force content-type for the request.
1624
+ :type _content_type: str, Optional
1625
+ :param _headers: set to override the headers for a single
1626
+ request; this effectively ignores the headers
1627
+ in the spec for a single request.
1628
+ :type _headers: dict, optional
1629
+ :param _host_index: set to override the host_index for a single
1630
+ request; this effectively ignores the host_index
1631
+ in the spec for a single request.
1632
+ :type _host_index: int, optional
1633
+ :return: Returns the result object.
1634
+ """ # noqa: E501
1635
+
1636
+ _param = self._document_service_update_document_serialize(
1637
+ document_name=document_name,
1638
+ document=document,
1639
+ _request_auth=_request_auth,
1640
+ _content_type=_content_type,
1641
+ _headers=_headers,
1642
+ _host_index=_host_index
1643
+ )
1644
+
1645
+ _response_types_map: Dict[str, Optional[str]] = {
1646
+ '200': "V1alphaUpdateDocumentResponse",
1647
+ }
1648
+ response_data = self.api_client.call_api(
1649
+ *_param,
1650
+ _request_timeout=_request_timeout
1651
+ )
1652
+ response_data.read()
1653
+ return self.api_client.response_deserialize(
1654
+ response_data=response_data,
1655
+ response_types_map=_response_types_map,
1656
+ ).data
1657
+
1658
+
1659
+ @validate_call
1660
+ def document_service_update_document_with_http_info(
1661
+ self,
1662
+ document_name: Annotated[str, Field(strict=True, description="Output only. Name of the Document resource. e.g.: \"documents/<UUID>\"")],
1663
+ document: Annotated[RequiredTheDocumentToUpdate, Field(description="Required. The Document to update. The Document's name field is used to identify the Document to be updated. Format: documents/{document}")],
1664
+ _request_timeout: Union[
1665
+ None,
1666
+ Annotated[StrictFloat, Field(gt=0)],
1667
+ Tuple[
1668
+ Annotated[StrictFloat, Field(gt=0)],
1669
+ Annotated[StrictFloat, Field(gt=0)]
1670
+ ]
1671
+ ] = None,
1672
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1673
+ _content_type: Optional[StrictStr] = None,
1674
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1675
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1676
+ ) -> ApiResponse[V1alphaUpdateDocumentResponse]:
1677
+ """document_service_update_document
1678
+
1679
+
1680
+ :param document_name: Output only. Name of the Document resource. e.g.: \"documents/<UUID>\" (required)
1681
+ :type document_name: str
1682
+ :param document: Required. The Document to update. The Document's name field is used to identify the Document to be updated. Format: documents/{document} (required)
1683
+ :type document: RequiredTheDocumentToUpdate
1684
+ :param _request_timeout: timeout setting for this request. If one
1685
+ number provided, it will be total request
1686
+ timeout. It can also be a pair (tuple) of
1687
+ (connection, read) timeouts.
1688
+ :type _request_timeout: int, tuple(int, int), optional
1689
+ :param _request_auth: set to override the auth_settings for an a single
1690
+ request; this effectively ignores the
1691
+ authentication in the spec for a single request.
1692
+ :type _request_auth: dict, optional
1693
+ :param _content_type: force content-type for the request.
1694
+ :type _content_type: str, Optional
1695
+ :param _headers: set to override the headers for a single
1696
+ request; this effectively ignores the headers
1697
+ in the spec for a single request.
1698
+ :type _headers: dict, optional
1699
+ :param _host_index: set to override the host_index for a single
1700
+ request; this effectively ignores the host_index
1701
+ in the spec for a single request.
1702
+ :type _host_index: int, optional
1703
+ :return: Returns the result object.
1704
+ """ # noqa: E501
1705
+
1706
+ _param = self._document_service_update_document_serialize(
1707
+ document_name=document_name,
1708
+ document=document,
1709
+ _request_auth=_request_auth,
1710
+ _content_type=_content_type,
1711
+ _headers=_headers,
1712
+ _host_index=_host_index
1713
+ )
1714
+
1715
+ _response_types_map: Dict[str, Optional[str]] = {
1716
+ '200': "V1alphaUpdateDocumentResponse",
1717
+ }
1718
+ response_data = self.api_client.call_api(
1719
+ *_param,
1720
+ _request_timeout=_request_timeout
1721
+ )
1722
+ response_data.read()
1723
+ return self.api_client.response_deserialize(
1724
+ response_data=response_data,
1725
+ response_types_map=_response_types_map,
1726
+ )
1727
+
1728
+
1729
+ @validate_call
1730
+ def document_service_update_document_without_preload_content(
1731
+ self,
1732
+ document_name: Annotated[str, Field(strict=True, description="Output only. Name of the Document resource. e.g.: \"documents/<UUID>\"")],
1733
+ document: Annotated[RequiredTheDocumentToUpdate, Field(description="Required. The Document to update. The Document's name field is used to identify the Document to be updated. Format: documents/{document}")],
1734
+ _request_timeout: Union[
1735
+ None,
1736
+ Annotated[StrictFloat, Field(gt=0)],
1737
+ Tuple[
1738
+ Annotated[StrictFloat, Field(gt=0)],
1739
+ Annotated[StrictFloat, Field(gt=0)]
1740
+ ]
1741
+ ] = None,
1742
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1743
+ _content_type: Optional[StrictStr] = None,
1744
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1745
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1746
+ ) -> RESTResponseType:
1747
+ """document_service_update_document
1748
+
1749
+
1750
+ :param document_name: Output only. Name of the Document resource. e.g.: \"documents/<UUID>\" (required)
1751
+ :type document_name: str
1752
+ :param document: Required. The Document to update. The Document's name field is used to identify the Document to be updated. Format: documents/{document} (required)
1753
+ :type document: RequiredTheDocumentToUpdate
1754
+ :param _request_timeout: timeout setting for this request. If one
1755
+ number provided, it will be total request
1756
+ timeout. It can also be a pair (tuple) of
1757
+ (connection, read) timeouts.
1758
+ :type _request_timeout: int, tuple(int, int), optional
1759
+ :param _request_auth: set to override the auth_settings for an a single
1760
+ request; this effectively ignores the
1761
+ authentication in the spec for a single request.
1762
+ :type _request_auth: dict, optional
1763
+ :param _content_type: force content-type for the request.
1764
+ :type _content_type: str, Optional
1765
+ :param _headers: set to override the headers for a single
1766
+ request; this effectively ignores the headers
1767
+ in the spec for a single request.
1768
+ :type _headers: dict, optional
1769
+ :param _host_index: set to override the host_index for a single
1770
+ request; this effectively ignores the host_index
1771
+ in the spec for a single request.
1772
+ :type _host_index: int, optional
1773
+ :return: Returns the result object.
1774
+ """ # noqa: E501
1775
+
1776
+ _param = self._document_service_update_document_serialize(
1777
+ document_name=document_name,
1778
+ document=document,
1779
+ _request_auth=_request_auth,
1780
+ _content_type=_content_type,
1781
+ _headers=_headers,
1782
+ _host_index=_host_index
1783
+ )
1784
+
1785
+ _response_types_map: Dict[str, Optional[str]] = {
1786
+ '200': "V1alphaUpdateDocumentResponse",
1787
+ }
1788
+ response_data = self.api_client.call_api(
1789
+ *_param,
1790
+ _request_timeout=_request_timeout
1791
+ )
1792
+ return response_data.response
1793
+
1794
+
1795
+ def _document_service_update_document_serialize(
1796
+ self,
1797
+ document_name,
1798
+ document,
1799
+ _request_auth,
1800
+ _content_type,
1801
+ _headers,
1802
+ _host_index,
1803
+ ) -> RequestSerialized:
1804
+
1805
+ _host = None
1806
+
1807
+ _collection_formats: Dict[str, str] = {
1808
+ }
1809
+
1810
+ _path_params: Dict[str, str] = {}
1811
+ _query_params: List[Tuple[str, str]] = []
1812
+ _header_params: Dict[str, Optional[str]] = _headers or {}
1813
+ _form_params: List[Tuple[str, str]] = []
1814
+ _files: Dict[str, Union[str, bytes]] = {}
1815
+ _body_params: Optional[bytes] = None
1816
+
1817
+ # process the path parameters
1818
+ if document_name is not None:
1819
+ _path_params['document.name'] = document_name
1820
+ # process the query parameters
1821
+ # process the header parameters
1822
+ # process the form parameters
1823
+ # process the body parameter
1824
+ if document is not None:
1825
+ _body_params = document
1826
+
1827
+
1828
+ # set the HTTP header `Accept`
1829
+ _header_params['Accept'] = self.api_client.select_header_accept(
1830
+ [
1831
+ 'application/json'
1832
+ ]
1833
+ )
1834
+
1835
+ # set the HTTP header `Content-Type`
1836
+ if _content_type:
1837
+ _header_params['Content-Type'] = _content_type
1838
+ else:
1839
+ _default_content_type = (
1840
+ self.api_client.select_header_content_type(
1841
+ [
1842
+ 'application/json'
1843
+ ]
1844
+ )
1845
+ )
1846
+ if _default_content_type is not None:
1847
+ _header_params['Content-Type'] = _default_content_type
1848
+
1849
+ # authentication setting
1850
+ _auth_settings: List[str] = [
1851
+ ]
1852
+
1853
+ return self.api_client.param_serialize(
1854
+ method='PATCH',
1855
+ resource_path='/v1alpha/{document.name}',
1856
+ path_params=_path_params,
1857
+ query_params=_query_params,
1858
+ header_params=_header_params,
1859
+ body=_body_params,
1860
+ post_params=_form_params,
1861
+ files=_files,
1862
+ auth_settings=_auth_settings,
1863
+ collection_formats=_collection_formats,
1864
+ _host=_host,
1865
+ _request_auth=_request_auth
1866
+ )
1867
+
1868
+