qanswer-sdk 0.46.0.dev0__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 (624) hide show
  1. qanswer_sdk/__init__.py +1268 -0
  2. qanswer_sdk/api/__init__.py +64 -0
  3. qanswer_sdk/api/admin_api.py +7383 -0
  4. qanswer_sdk/api/ai_assistant_access_rights_api.py +5879 -0
  5. qanswer_sdk/api/ai_assistant_api.py +8960 -0
  6. qanswer_sdk/api/auto_complete_api.py +612 -0
  7. qanswer_sdk/api/bot_slack_api.py +1069 -0
  8. qanswer_sdk/api/branding_api.py +5723 -0
  9. qanswer_sdk/api/chatbot_api.py +1102 -0
  10. qanswer_sdk/api/connector_audio_api.py +3264 -0
  11. qanswer_sdk/api/connector_document_api.py +1990 -0
  12. qanswer_sdk/api/connector_e_consilium_api.py +313 -0
  13. qanswer_sdk/api/connector_e_consilium_search_index_api_api.py +1164 -0
  14. qanswer_sdk/api/connector_google_drive_api.py +1896 -0
  15. qanswer_sdk/api/connector_imapapi_api.py +1775 -0
  16. qanswer_sdk/api/connector_one_drive_api.py +1579 -0
  17. qanswer_sdk/api/connector_onenote_api.py +1596 -0
  18. qanswer_sdk/api/connector_pinecone_api.py +893 -0
  19. qanswer_sdk/api/connector_publication_office_api_api.py +1230 -0
  20. qanswer_sdk/api/connector_qn_a_api.py +1521 -0
  21. qanswer_sdk/api/connector_rdf_answer_api.py +1393 -0
  22. qanswer_sdk/api/connector_rdf_api.py +5093 -0
  23. qanswer_sdk/api/connector_sharepoint_api.py +3445 -0
  24. qanswer_sdk/api/connector_websearch_api.py +332 -0
  25. qanswer_sdk/api/connector_website_api.py +2829 -0
  26. qanswer_sdk/api/connectors_api.py +6824 -0
  27. qanswer_sdk/api/connectors_data_api.py +5415 -0
  28. qanswer_sdk/api/conversation_logs_api.py +13159 -0
  29. qanswer_sdk/api/dataset_api.py +6487 -0
  30. qanswer_sdk/api/dataset_config_api.py +4643 -0
  31. qanswer_sdk/api/debug_api.py +278 -0
  32. qanswer_sdk/api/default_api.py +763 -0
  33. qanswer_sdk/api/embedder_endpoint_api.py +3330 -0
  34. qanswer_sdk/api/frontend_config_api.py +270 -0
  35. qanswer_sdk/api/health_check_api_api.py +278 -0
  36. qanswer_sdk/api/llm_endpoint_api.py +4660 -0
  37. qanswer_sdk/api/mcp_api.py +11201 -0
  38. qanswer_sdk/api/metadata_api.py +2070 -0
  39. qanswer_sdk/api/notifications_api.py +1841 -0
  40. qanswer_sdk/api/o_auth2_api.py +648 -0
  41. qanswer_sdk/api/payment_api.py +1852 -0
  42. qanswer_sdk/api/socket_api.py +4220 -0
  43. qanswer_sdk/api/speech_to_text_api.py +919 -0
  44. qanswer_sdk/api/task_ai_excel_api.py +7541 -0
  45. qanswer_sdk/api/task_chat_api.py +2598 -0
  46. qanswer_sdk/api/task_document_parsing_api.py +619 -0
  47. qanswer_sdk/api/task_entity_linking_api.py +315 -0
  48. qanswer_sdk/api/task_rdf_linker_api.py +4408 -0
  49. qanswer_sdk/api/task_rdf_sparql_endpoint_api.py +3189 -0
  50. qanswer_sdk/api/task_rdf_text_linker_api.py +1452 -0
  51. qanswer_sdk/api/task_report_copilot_api.py +7010 -0
  52. qanswer_sdk/api/task_search_api.py +2012 -0
  53. qanswer_sdk/api/task_text2sparql_api.py +902 -0
  54. qanswer_sdk/api/task_text_classification_api.py +592 -0
  55. qanswer_sdk/api/tasks_api.py +318 -0
  56. qanswer_sdk/api/tool_embedder_api.py +5208 -0
  57. qanswer_sdk/api/tool_llm_api.py +6518 -0
  58. qanswer_sdk/api/unit_organizations_api.py +7086 -0
  59. qanswer_sdk/api/unit_teams_api.py +4255 -0
  60. qanswer_sdk/api/unit_user_api.py +11948 -0
  61. qanswer_sdk/api/v1_chat_completion_api.py +330 -0
  62. qanswer_sdk/api/v1_embeddings_api.py +297 -0
  63. qanswer_sdk/api_client.py +804 -0
  64. qanswer_sdk/api_response.py +21 -0
  65. qanswer_sdk/configuration.py +614 -0
  66. qanswer_sdk/exceptions.py +216 -0
  67. qanswer_sdk/models/__init__.py +567 -0
  68. qanswer_sdk/models/access_audio_spans_response_model.py +91 -0
  69. qanswer_sdk/models/access_pdf_payload_model.py +111 -0
  70. qanswer_sdk/models/access_type.py +42 -0
  71. qanswer_sdk/models/access_type_shared.py +38 -0
  72. qanswer_sdk/models/add_qn_a_request.py +103 -0
  73. qanswer_sdk/models/add_synonyms.py +93 -0
  74. qanswer_sdk/models/add_synonyms_resp.py +89 -0
  75. qanswer_sdk/models/admin_overall_stats_response.py +105 -0
  76. qanswer_sdk/models/admin_user_overall_stats.py +99 -0
  77. qanswer_sdk/models/advanced_o_auth2_mcp_authentication_config.py +95 -0
  78. qanswer_sdk/models/aggregate.py +93 -0
  79. qanswer_sdk/models/aggregation.py +116 -0
  80. qanswer_sdk/models/aggregation_type.py +41 -0
  81. qanswer_sdk/models/aggregations_group.py +102 -0
  82. qanswer_sdk/models/ai_assistant_clone_response.py +91 -0
  83. qanswer_sdk/models/ai_assistant_dto.py +122 -0
  84. qanswer_sdk/models/ai_assistant_filter_dto.py +113 -0
  85. qanswer_sdk/models/ai_assistant_list.py +101 -0
  86. qanswer_sdk/models/ai_assistant_share_response.py +93 -0
  87. qanswer_sdk/models/ai_assistant_shared_access.py +113 -0
  88. qanswer_sdk/models/ai_excel_task_settings.py +125 -0
  89. qanswer_sdk/models/ai_excel_task_update.py +125 -0
  90. qanswer_sdk/models/ai_task_settings_update_payload.py +95 -0
  91. qanswer_sdk/models/ai_template_base_with_id.py +95 -0
  92. qanswer_sdk/models/ai_template_cell.py +113 -0
  93. qanswer_sdk/models/ai_template_cell_base.py +87 -0
  94. qanswer_sdk/models/ai_template_cell_update_payload.py +95 -0
  95. qanswer_sdk/models/ai_template_column.py +99 -0
  96. qanswer_sdk/models/ai_template_column_base.py +93 -0
  97. qanswer_sdk/models/ai_template_column_update_payload.py +109 -0
  98. qanswer_sdk/models/ai_template_column_with_cells.py +109 -0
  99. qanswer_sdk/models/ai_template_create_payload.py +128 -0
  100. qanswer_sdk/models/ai_template_row.py +93 -0
  101. qanswer_sdk/models/ai_template_row_base.py +87 -0
  102. qanswer_sdk/models/ai_template_row_update_payload.py +103 -0
  103. qanswer_sdk/models/ai_template_row_with_cells.py +103 -0
  104. qanswer_sdk/models/ai_template_with_cells.py +134 -0
  105. qanswer_sdk/models/ai_template_with_cells_new_column_id.py +136 -0
  106. qanswer_sdk/models/allowed_extension.py +53 -0
  107. qanswer_sdk/models/allowed_file_extensions.py +98 -0
  108. qanswer_sdk/models/api_key_header_type.py +38 -0
  109. qanswer_sdk/models/api_key_mcp_authentication_config.py +94 -0
  110. qanswer_sdk/models/applied_filter_type.py +37 -0
  111. qanswer_sdk/models/applied_metadata_filter.py +103 -0
  112. qanswer_sdk/models/apply_template_task_settings_to_slots_response.py +89 -0
  113. qanswer_sdk/models/assistant_category_color_definition.py +89 -0
  114. qanswer_sdk/models/assistant_category_color_item.py +89 -0
  115. qanswer_sdk/models/assistant_category_colors_update_payload.py +95 -0
  116. qanswer_sdk/models/assistant_category_count.py +91 -0
  117. qanswer_sdk/models/assistant_message_stop.py +93 -0
  118. qanswer_sdk/models/assistant_task.py +43 -0
  119. qanswer_sdk/models/assistant_template.py +111 -0
  120. qanswer_sdk/models/assistant_template_filter_dto.py +120 -0
  121. qanswer_sdk/models/assistant_template_with_tools_selection_dto.py +121 -0
  122. qanswer_sdk/models/audio_allowed_file_extensions.py +87 -0
  123. qanswer_sdk/models/audio_file_upload_payload.py +107 -0
  124. qanswer_sdk/models/audio_format.py +37 -0
  125. qanswer_sdk/models/audio_segment.py +95 -0
  126. qanswer_sdk/models/audio_segment_update_payload.py +97 -0
  127. qanswer_sdk/models/audio_segment_update_response.py +91 -0
  128. qanswer_sdk/models/audio_speaker_update_payload.py +99 -0
  129. qanswer_sdk/models/audio_speaker_update_response.py +91 -0
  130. qanswer_sdk/models/audio_transcription_list_response.py +101 -0
  131. qanswer_sdk/models/audio_transcription_mode.py +37 -0
  132. qanswer_sdk/models/audio_transcription_record.py +101 -0
  133. qanswer_sdk/models/audio_upload_response.py +99 -0
  134. qanswer_sdk/models/audio_upload_transcription.py +99 -0
  135. qanswer_sdk/models/audio_word_segment.py +93 -0
  136. qanswer_sdk/models/audio_word_span_change.py +94 -0
  137. qanswer_sdk/models/audio_word_span_update_payload.py +104 -0
  138. qanswer_sdk/models/audio_word_span_update_response.py +91 -0
  139. qanswer_sdk/models/audio_word_update_payload.py +100 -0
  140. qanswer_sdk/models/audio_word_update_response.py +91 -0
  141. qanswer_sdk/models/auth_link_response.py +91 -0
  142. qanswer_sdk/models/auto_bot_description_request.py +89 -0
  143. qanswer_sdk/models/auto_bot_description_response.py +87 -0
  144. qanswer_sdk/models/available_aggregation.py +98 -0
  145. qanswer_sdk/models/available_connectors_response.py +99 -0
  146. qanswer_sdk/models/available_embedding_models_response.py +95 -0
  147. qanswer_sdk/models/available_endpoints_response.py +95 -0
  148. qanswer_sdk/models/available_logs_visibility_policy.py +103 -0
  149. qanswer_sdk/models/available_space_quota_for_dataset.py +95 -0
  150. qanswer_sdk/models/available_storage_preference.py +103 -0
  151. qanswer_sdk/models/base_connectors_response.py +89 -0
  152. qanswer_sdk/models/base_conversation_response.py +89 -0
  153. qanswer_sdk/models/base_feedback_response.py +89 -0
  154. qanswer_sdk/models/bot_answer_length.py +38 -0
  155. qanswer_sdk/models/branding_app_title.py +87 -0
  156. qanswer_sdk/models/branding_system_message.py +87 -0
  157. qanswer_sdk/models/bulk_update_tool_selections_request.py +87 -0
  158. qanswer_sdk/models/capability_type.py +37 -0
  159. qanswer_sdk/models/cell.py +89 -0
  160. qanswer_sdk/models/change_password.py +89 -0
  161. qanswer_sdk/models/change_password_admin.py +89 -0
  162. qanswer_sdk/models/change_role.py +96 -0
  163. qanswer_sdk/models/chat_task_settings.py +141 -0
  164. qanswer_sdk/models/chat_task_settings_update_payload.py +95 -0
  165. qanswer_sdk/models/chat_task_update.py +139 -0
  166. qanswer_sdk/models/chatbot_chat_payload.py +148 -0
  167. qanswer_sdk/models/chatbot_default_settings_response.py +95 -0
  168. qanswer_sdk/models/chatbot_llm_dto.py +147 -0
  169. qanswer_sdk/models/chatbot_response.py +151 -0
  170. qanswer_sdk/models/chatbot_setting_dto.py +99 -0
  171. qanswer_sdk/models/chatbot_setting_request.py +91 -0
  172. qanswer_sdk/models/class_info.py +89 -0
  173. qanswer_sdk/models/clone_dataset_request.py +104 -0
  174. qanswer_sdk/models/clone_dataset_response.py +91 -0
  175. qanswer_sdk/models/config.py +228 -0
  176. qanswer_sdk/models/config1.py +138 -0
  177. qanswer_sdk/models/connector_config_list_response.py +99 -0
  178. qanswer_sdk/models/connector_config_model.py +102 -0
  179. qanswer_sdk/models/connector_config_patch_payload.py +93 -0
  180. qanswer_sdk/models/connector_config_response.py +95 -0
  181. qanswer_sdk/models/connector_config_sync_response.py +93 -0
  182. qanswer_sdk/models/connector_config_type.py +37 -0
  183. qanswer_sdk/models/connector_model.py +118 -0
  184. qanswer_sdk/models/connector_type.py +50 -0
  185. qanswer_sdk/models/connector_type_dto.py +98 -0
  186. qanswer_sdk/models/connector_type_list_dto.py +95 -0
  187. qanswer_sdk/models/content_item.py +130 -0
  188. qanswer_sdk/models/content_item_type.py +39 -0
  189. qanswer_sdk/models/conversation_message.py +259 -0
  190. qanswer_sdk/models/conversation_message_error_key.py +52 -0
  191. qanswer_sdk/models/conversation_message_search_result.py +121 -0
  192. qanswer_sdk/models/conversation_model.py +169 -0
  193. qanswer_sdk/models/conversation_overall_stats.py +97 -0
  194. qanswer_sdk/models/conversation_overall_stats_response.py +95 -0
  195. qanswer_sdk/models/conversation_retention_response.py +91 -0
  196. qanswer_sdk/models/conversation_statistics.py +95 -0
  197. qanswer_sdk/models/conversation_update.py +93 -0
  198. qanswer_sdk/models/conversation_users_stats.py +99 -0
  199. qanswer_sdk/models/conversation_users_stats_response.py +99 -0
  200. qanswer_sdk/models/coordinates.py +89 -0
  201. qanswer_sdk/models/cost_summary_dto.py +99 -0
  202. qanswer_sdk/models/create_connector_request.py +95 -0
  203. qanswer_sdk/models/create_connector_response.py +95 -0
  204. qanswer_sdk/models/create_dataset_request.py +145 -0
  205. qanswer_sdk/models/create_imap_connector_request.py +105 -0
  206. qanswer_sdk/models/create_pinecone_connector_request.py +97 -0
  207. qanswer_sdk/models/create_sharepoint_connector_from_certificate_request.py +105 -0
  208. qanswer_sdk/models/create_sharepoint_connector_request.py +103 -0
  209. qanswer_sdk/models/credits_info_global_dto.py +97 -0
  210. qanswer_sdk/models/credits_info_organization_dto.py +95 -0
  211. qanswer_sdk/models/currency.py +38 -0
  212. qanswer_sdk/models/data_filling_mode.py +39 -0
  213. qanswer_sdk/models/data_storage_preference.py +38 -0
  214. qanswer_sdk/models/dataset_config_request.py +138 -0
  215. qanswer_sdk/models/dataset_default_values_model.py +138 -0
  216. qanswer_sdk/models/dataset_detail.py +137 -0
  217. qanswer_sdk/models/dataset_detail_kg.py +97 -0
  218. qanswer_sdk/models/dataset_schema.py +242 -0
  219. qanswer_sdk/models/dataset_size_response.py +91 -0
  220. qanswer_sdk/models/dataset_type.py +38 -0
  221. qanswer_sdk/models/dataset_update_object.py +216 -0
  222. qanswer_sdk/models/dataset_users_response.py +87 -0
  223. qanswer_sdk/models/default_prompt.py +106 -0
  224. qanswer_sdk/models/delete_connector_model.py +96 -0
  225. qanswer_sdk/models/delete_connector_request.py +99 -0
  226. qanswer_sdk/models/delete_connectors_response.py +89 -0
  227. qanswer_sdk/models/delete_files_status_response.py +91 -0
  228. qanswer_sdk/models/delete_index.py +91 -0
  229. qanswer_sdk/models/delete_index_resp.py +89 -0
  230. qanswer_sdk/models/delete_qn_a_pair_request.py +95 -0
  231. qanswer_sdk/models/delete_qn_a_pair_response.py +89 -0
  232. qanswer_sdk/models/delete_synonym.py +93 -0
  233. qanswer_sdk/models/delete_synonym_resp.py +89 -0
  234. qanswer_sdk/models/delete_synonyms.py +91 -0
  235. qanswer_sdk/models/delete_user_response.py +89 -0
  236. qanswer_sdk/models/diarization_queue_status.py +99 -0
  237. qanswer_sdk/models/document_content_response.py +91 -0
  238. qanswer_sdk/models/document_content_update_model.py +99 -0
  239. qanswer_sdk/models/document_file_delete_by_connector_model.py +101 -0
  240. qanswer_sdk/models/document_file_delete_by_id_model.py +91 -0
  241. qanswer_sdk/models/document_metadata.py +173 -0
  242. qanswer_sdk/models/document_metadata_list_wrapper.py +100 -0
  243. qanswer_sdk/models/document_parsing_task_settings.py +130 -0
  244. qanswer_sdk/models/document_parsing_task_settings_update_payload.py +95 -0
  245. qanswer_sdk/models/document_parsing_task_update.py +127 -0
  246. qanswer_sdk/models/document_status_response.py +89 -0
  247. qanswer_sdk/models/dummy_error.py +89 -0
  248. qanswer_sdk/models/duplicate_report_template_payload.py +97 -0
  249. qanswer_sdk/models/duplicate_report_template_response.py +87 -0
  250. qanswer_sdk/models/e_consilium_connector_config.py +108 -0
  251. qanswer_sdk/models/e_consilium_search_index_search_response.py +113 -0
  252. qanswer_sdk/models/econsilium_file_metadata.py +105 -0
  253. qanswer_sdk/models/econsilium_search_index_add_payload.py +107 -0
  254. qanswer_sdk/models/econsilium_search_index_additional_fields.py +103 -0
  255. qanswer_sdk/models/email_folder.py +91 -0
  256. qanswer_sdk/models/email_request.py +87 -0
  257. qanswer_sdk/models/embedder_cost_entry.py +91 -0
  258. qanswer_sdk/models/embedder_cost_filter.py +112 -0
  259. qanswer_sdk/models/embedder_cost_list.py +111 -0
  260. qanswer_sdk/models/embedder_create_dto.py +149 -0
  261. qanswer_sdk/models/embedder_detailed_dto.py +171 -0
  262. qanswer_sdk/models/embedder_dto.py +101 -0
  263. qanswer_sdk/models/embedder_list_dto.py +101 -0
  264. qanswer_sdk/models/embedder_update_dto.py +143 -0
  265. qanswer_sdk/models/embedding_endpoint.py +149 -0
  266. qanswer_sdk/models/embedding_endpoint_create.py +147 -0
  267. qanswer_sdk/models/embedding_endpoint_export_payload.py +87 -0
  268. qanswer_sdk/models/embedding_endpoint_import_failure.py +89 -0
  269. qanswer_sdk/models/embedding_endpoint_import_response.py +99 -0
  270. qanswer_sdk/models/embedding_endpoint_modality.py +37 -0
  271. qanswer_sdk/models/embedding_endpoint_names_validation_payload.py +87 -0
  272. qanswer_sdk/models/embedding_endpoint_update.py +141 -0
  273. qanswer_sdk/models/embedding_endpoint_validation_response.py +96 -0
  274. qanswer_sdk/models/embedding_model.py +96 -0
  275. qanswer_sdk/models/embedding_provider.py +44 -0
  276. qanswer_sdk/models/enable_enhanced_context_payload.py +91 -0
  277. qanswer_sdk/models/enable_enhanced_context_response.py +87 -0
  278. qanswer_sdk/models/endpoint_status.py +38 -0
  279. qanswer_sdk/models/entity_description.py +93 -0
  280. qanswer_sdk/models/entity_description_dto.py +93 -0
  281. qanswer_sdk/models/entity_linking_payload.py +97 -0
  282. qanswer_sdk/models/entity_linking_response.py +97 -0
  283. qanswer_sdk/models/entity_model_in_linking.py +95 -0
  284. qanswer_sdk/models/es_meta_data.py +98 -0
  285. qanswer_sdk/models/es_meta_data_value.py +87 -0
  286. qanswer_sdk/models/evaluate_feedback_response.py +109 -0
  287. qanswer_sdk/models/evaluate_single_feedback_response.py +97 -0
  288. qanswer_sdk/models/external_sources_quota_request.py +91 -0
  289. qanswer_sdk/models/external_sources_quota_response.py +89 -0
  290. qanswer_sdk/models/extra_body.py +91 -0
  291. qanswer_sdk/models/extract_hyper_links_payload.py +100 -0
  292. qanswer_sdk/models/extract_robot_links_payload.py +88 -0
  293. qanswer_sdk/models/extract_robot_links_response.py +88 -0
  294. qanswer_sdk/models/fact.py +96 -0
  295. qanswer_sdk/models/feedback_evaluation_history_entries_response.py +101 -0
  296. qanswer_sdk/models/feedback_evaluation_history_entry_model.py +105 -0
  297. qanswer_sdk/models/feedback_model.py +141 -0
  298. qanswer_sdk/models/feedback_response.py +95 -0
  299. qanswer_sdk/models/feedback_update.py +105 -0
  300. qanswer_sdk/models/file_es_meta_data.py +116 -0
  301. qanswer_sdk/models/file_failure_reason.py +48 -0
  302. qanswer_sdk/models/file_folder_model.py +115 -0
  303. qanswer_sdk/models/file_model.py +130 -0
  304. qanswer_sdk/models/file_status.py +43 -0
  305. qanswer_sdk/models/file_type.py +37 -0
  306. qanswer_sdk/models/file_upload_payload.py +107 -0
  307. qanswer_sdk/models/files_by_connector_model.py +89 -0
  308. qanswer_sdk/models/g_drive_connector_info.py +96 -0
  309. qanswer_sdk/models/g_drive_download_by_ids.py +89 -0
  310. qanswer_sdk/models/g_drive_download_request.py +103 -0
  311. qanswer_sdk/models/generate_ai_cells_by_dimension_payload.py +91 -0
  312. qanswer_sdk/models/generate_ai_cells_payload.py +95 -0
  313. qanswer_sdk/models/generation_params.py +89 -0
  314. qanswer_sdk/models/get_aggregations_payload.py +104 -0
  315. qanswer_sdk/models/get_connector_by_id_response.py +91 -0
  316. qanswer_sdk/models/get_conversation_response.py +95 -0
  317. qanswer_sdk/models/global_config_dto.py +135 -0
  318. qanswer_sdk/models/google_drive_connector_config.py +110 -0
  319. qanswer_sdk/models/guardrail_endpoint.py +121 -0
  320. qanswer_sdk/models/guardrail_mode.py +38 -0
  321. qanswer_sdk/models/highlight_audio_payload_model.py +109 -0
  322. qanswer_sdk/models/http_validation_error.py +95 -0
  323. qanswer_sdk/models/iframe_strategy.py +38 -0
  324. qanswer_sdk/models/image_url_detail.py +38 -0
  325. qanswer_sdk/models/imap_add_payload.py +105 -0
  326. qanswer_sdk/models/imap_additional_fields.py +101 -0
  327. qanswer_sdk/models/imap_file_metadata.py +114 -0
  328. qanswer_sdk/models/imap_search_response.py +113 -0
  329. qanswer_sdk/models/index_config.py +89 -0
  330. qanswer_sdk/models/install_response.py +89 -0
  331. qanswer_sdk/models/interface_origin.py +48 -0
  332. qanswer_sdk/models/ip2_geo_response.py +91 -0
  333. qanswer_sdk/models/is_enabled_response.py +87 -0
  334. qanswer_sdk/models/jwt_authentication_response.py +93 -0
  335. qanswer_sdk/models/label.py +89 -0
  336. qanswer_sdk/models/labeled_node.py +89 -0
  337. qanswer_sdk/models/language.py +42 -0
  338. qanswer_sdk/models/last_updated_template_conversation_id_response.py +87 -0
  339. qanswer_sdk/models/link.py +99 -0
  340. qanswer_sdk/models/link_extraction_response.py +97 -0
  341. qanswer_sdk/models/link_result_paginated.py +97 -0
  342. qanswer_sdk/models/linked_entity_model_in_linking.py +99 -0
  343. qanswer_sdk/models/linker.py +103 -0
  344. qanswer_sdk/models/linking_result_input.py +95 -0
  345. qanswer_sdk/models/linking_result_output.py +95 -0
  346. qanswer_sdk/models/links.py +99 -0
  347. qanswer_sdk/models/list_ai_templates_response.py +101 -0
  348. qanswer_sdk/models/list_connectors_response.py +95 -0
  349. qanswer_sdk/models/list_conversation_response.py +105 -0
  350. qanswer_sdk/models/list_feedback_response.py +105 -0
  351. qanswer_sdk/models/list_files_connector_response.py +107 -0
  352. qanswer_sdk/models/list_published_assistants_payload.py +115 -0
  353. qanswer_sdk/models/list_socket_events.py +95 -0
  354. qanswer_sdk/models/list_synonyms_model.py +95 -0
  355. qanswer_sdk/models/llm_context_ranges.py +93 -0
  356. qanswer_sdk/models/llm_context_ranges_response.py +93 -0
  357. qanswer_sdk/models/llm_cost_entry.py +97 -0
  358. qanswer_sdk/models/llm_cost_filter.py +112 -0
  359. qanswer_sdk/models/llm_cost_list.py +111 -0
  360. qanswer_sdk/models/llm_create_dto.py +208 -0
  361. qanswer_sdk/models/llm_detailed_dto.py +231 -0
  362. qanswer_sdk/models/llm_details.py +123 -0
  363. qanswer_sdk/models/llm_dto.py +147 -0
  364. qanswer_sdk/models/llm_endpoint.py +212 -0
  365. qanswer_sdk/models/llm_endpoint_create.py +204 -0
  366. qanswer_sdk/models/llm_endpoint_default_prompts.py +93 -0
  367. qanswer_sdk/models/llm_endpoint_export_payload.py +87 -0
  368. qanswer_sdk/models/llm_endpoint_import_failure.py +89 -0
  369. qanswer_sdk/models/llm_endpoint_import_response.py +99 -0
  370. qanswer_sdk/models/llm_endpoint_input.py +212 -0
  371. qanswer_sdk/models/llm_endpoint_modality.py +37 -0
  372. qanswer_sdk/models/llm_endpoint_names_validation_payload.py +87 -0
  373. qanswer_sdk/models/llm_endpoint_provider.py +44 -0
  374. qanswer_sdk/models/llm_endpoint_read_input.py +212 -0
  375. qanswer_sdk/models/llm_endpoint_read_output.py +212 -0
  376. qanswer_sdk/models/llm_endpoint_update.py +204 -0
  377. qanswer_sdk/models/llm_endpoint_usage_migration_response.py +93 -0
  378. qanswer_sdk/models/llm_endpoint_validation_response.py +96 -0
  379. qanswer_sdk/models/llm_filter_dto.py +111 -0
  380. qanswer_sdk/models/llm_health_response.py +89 -0
  381. qanswer_sdk/models/llm_list_detailed_dto.py +101 -0
  382. qanswer_sdk/models/llm_list_dto.py +101 -0
  383. qanswer_sdk/models/llm_update_dto.py +208 -0
  384. qanswer_sdk/models/llm_usage_origin.py +63 -0
  385. qanswer_sdk/models/location_details.py +97 -0
  386. qanswer_sdk/models/log_request.py +125 -0
  387. qanswer_sdk/models/login_request.py +89 -0
  388. qanswer_sdk/models/logs_visibility_policy.py +38 -0
  389. qanswer_sdk/models/logs_visibility_policy_payload.py +98 -0
  390. qanswer_sdk/models/logs_visibility_policy_response.py +98 -0
  391. qanswer_sdk/models/mcp_authentication_type.py +39 -0
  392. qanswer_sdk/models/mcp_connection.py +105 -0
  393. qanswer_sdk/models/mcp_connection_create.py +98 -0
  394. qanswer_sdk/models/mcp_server.py +167 -0
  395. qanswer_sdk/models/mcp_server0.py +167 -0
  396. qanswer_sdk/models/mcp_server_create.py +133 -0
  397. qanswer_sdk/models/mcp_server_dto.py +167 -0
  398. qanswer_sdk/models/mcp_server_type.py +37 -0
  399. qanswer_sdk/models/mcp_server_update.py +131 -0
  400. qanswer_sdk/models/mcp_tool_dto.py +141 -0
  401. qanswer_sdk/models/mcp_tool_info.py +95 -0
  402. qanswer_sdk/models/mcp_tool_selection_source.py +37 -0
  403. qanswer_sdk/models/mcp_tool_update.py +91 -0
  404. qanswer_sdk/models/mcp_transport.py +37 -0
  405. qanswer_sdk/models/mcp_visibility.py +38 -0
  406. qanswer_sdk/models/mcpo_auth2_initiating_origin.py +42 -0
  407. qanswer_sdk/models/message_role.py +38 -0
  408. qanswer_sdk/models/messages_stats_per_day_response.py +99 -0
  409. qanswer_sdk/models/microsoft_connector_config.py +110 -0
  410. qanswer_sdk/models/modify_connector_request.py +107 -0
  411. qanswer_sdk/models/modify_file_display_name_request.py +97 -0
  412. qanswer_sdk/models/notification_dto.py +137 -0
  413. qanswer_sdk/models/notification_filter.py +116 -0
  414. qanswer_sdk/models/notification_list_dto.py +101 -0
  415. qanswer_sdk/models/notification_payload_add_to_org_dto.py +87 -0
  416. qanswer_sdk/models/notification_payload_add_to_team_dto.py +89 -0
  417. qanswer_sdk/models/notification_payload_ai_assistant_shared_dto.py +109 -0
  418. qanswer_sdk/models/notification_payload_conversation_shared_dto.py +105 -0
  419. qanswer_sdk/models/notification_payload_dto.py +193 -0
  420. qanswer_sdk/models/notification_payload_human_takeover_requested_dto.py +89 -0
  421. qanswer_sdk/models/notification_payload_quota_reaching_dto.py +91 -0
  422. qanswer_sdk/models/notification_read_dto.py +89 -0
  423. qanswer_sdk/models/notification_type.py +44 -0
  424. qanswer_sdk/models/o_auth_redirect_response.py +89 -0
  425. qanswer_sdk/models/o_auth_service_dto.py +89 -0
  426. qanswer_sdk/models/one_drive_download_by_ids.py +89 -0
  427. qanswer_sdk/models/one_drive_download_request.py +103 -0
  428. qanswer_sdk/models/one_note_download_by_ids.py +91 -0
  429. qanswer_sdk/models/one_note_download_request.py +103 -0
  430. qanswer_sdk/models/org_llm_detailed_dto.py +105 -0
  431. qanswer_sdk/models/organization.py +93 -0
  432. qanswer_sdk/models/organization_creation.py +91 -0
  433. qanswer_sdk/models/organization_dto.py +93 -0
  434. qanswer_sdk/models/organization_filter_dto.py +134 -0
  435. qanswer_sdk/models/organization_list_dto.py +101 -0
  436. qanswer_sdk/models/paginated_report_templates.py +101 -0
  437. qanswer_sdk/models/password.py +89 -0
  438. qanswer_sdk/models/pinecone_index_model.py +91 -0
  439. qanswer_sdk/models/plan_dto.py +132 -0
  440. qanswer_sdk/models/predicted_class.py +89 -0
  441. qanswer_sdk/models/prepare_synonyms_upload_resp.py +99 -0
  442. qanswer_sdk/models/prepared_synonym_group.py +87 -0
  443. qanswer_sdk/models/pricing_plan.py +51 -0
  444. qanswer_sdk/models/pricing_type.py +38 -0
  445. qanswer_sdk/models/prompt_type.py +51 -0
  446. qanswer_sdk/models/provider.py +87 -0
  447. qanswer_sdk/models/publication_add_payload.py +105 -0
  448. qanswer_sdk/models/publication_file_metadata.py +105 -0
  449. qanswer_sdk/models/publication_office_additional_fields.py +111 -0
  450. qanswer_sdk/models/publication_office_connector_config.py +110 -0
  451. qanswer_sdk/models/publication_search_index_search_response.py +113 -0
  452. qanswer_sdk/models/published_assistant_from_java.py +94 -0
  453. qanswer_sdk/models/put_cell_payload.py +89 -0
  454. qanswer_sdk/models/qa_context.py +129 -0
  455. qanswer_sdk/models/qa_context_display_type.py +44 -0
  456. qanswer_sdk/models/qa_contexts.py +116 -0
  457. qanswer_sdk/models/qa_table.py +100 -0
  458. qanswer_sdk/models/qn_a_pair_model.py +103 -0
  459. qanswer_sdk/models/qn_a_pair_response.py +95 -0
  460. qanswer_sdk/models/question_suggestion_response.py +87 -0
  461. qanswer_sdk/models/rag_params.py +89 -0
  462. qanswer_sdk/models/rag_payload.py +186 -0
  463. qanswer_sdk/models/rag_response.py +155 -0
  464. qanswer_sdk/models/rdf_entity_linker_response.py +99 -0
  465. qanswer_sdk/models/rdf_linked_entity.py +97 -0
  466. qanswer_sdk/models/reasoning_effort.py +39 -0
  467. qanswer_sdk/models/reference_model.py +99 -0
  468. qanswer_sdk/models/refresh_frequency.py +39 -0
  469. qanswer_sdk/models/refresh_token_request.py +87 -0
  470. qanswer_sdk/models/refresh_website_connector_payload.py +94 -0
  471. qanswer_sdk/models/register_pinecone_connector_request.py +95 -0
  472. qanswer_sdk/models/report_copilot_generation_from_slots_ack.py +91 -0
  473. qanswer_sdk/models/report_copilot_generation_from_slots_payload.py +95 -0
  474. qanswer_sdk/models/report_copilot_refinement_payload.py +106 -0
  475. qanswer_sdk/models/report_copilot_refinement_response.py +87 -0
  476. qanswer_sdk/models/report_copilot_slot_feedback_update.py +95 -0
  477. qanswer_sdk/models/report_copilot_slot_feedback_update_response.py +95 -0
  478. qanswer_sdk/models/report_copilot_slot_task_settings.py +127 -0
  479. qanswer_sdk/models/report_copilot_slot_task_settings_update.py +127 -0
  480. qanswer_sdk/models/report_copilot_task_settings.py +125 -0
  481. qanswer_sdk/models/report_copilot_task_settings_update_payload.py +95 -0
  482. qanswer_sdk/models/report_copilot_task_update.py +125 -0
  483. qanswer_sdk/models/report_template.py +139 -0
  484. qanswer_sdk/models/report_template_create_payload.py +117 -0
  485. qanswer_sdk/models/report_template_image_upload_response.py +87 -0
  486. qanswer_sdk/models/report_template_simplified.py +115 -0
  487. qanswer_sdk/models/report_template_simplified_payload.py +91 -0
  488. qanswer_sdk/models/report_template_task_settings_update_payload.py +91 -0
  489. qanswer_sdk/models/report_template_update_payload.py +121 -0
  490. qanswer_sdk/models/report_templates_search_payload.py +106 -0
  491. qanswer_sdk/models/reset_password.py +87 -0
  492. qanswer_sdk/models/response_audit_model.py +99 -0
  493. qanswer_sdk/models/response_audit_stats_response.py +101 -0
  494. qanswer_sdk/models/response_get_dummy_union_connector_config_model_backend_api_connectors_config_dummy_models_union_get.py +228 -0
  495. qanswer_sdk/models/retreive_all_synonyms_resp.py +99 -0
  496. qanswer_sdk/models/retry_params.py +89 -0
  497. qanswer_sdk/models/return_type.py +38 -0
  498. qanswer_sdk/models/role.py +99 -0
  499. qanswer_sdk/models/role_name.py +37 -0
  500. qanswer_sdk/models/scrolling_strategy.py +37 -0
  501. qanswer_sdk/models/search_conversation_messages_response.py +105 -0
  502. qanswer_sdk/models/search_document_response.py +105 -0
  503. qanswer_sdk/models/search_index_payload.py +114 -0
  504. qanswer_sdk/models/search_metadata_filter.py +94 -0
  505. qanswer_sdk/models/search_payload.py +146 -0
  506. qanswer_sdk/models/search_response.py +125 -0
  507. qanswer_sdk/models/search_synonyms_resp.py +91 -0
  508. qanswer_sdk/models/search_task_settings.py +139 -0
  509. qanswer_sdk/models/search_task_settings_update_payload.py +95 -0
  510. qanswer_sdk/models/search_task_update.py +137 -0
  511. qanswer_sdk/models/sender_type.py +38 -0
  512. qanswer_sdk/models/share_point_connector_settings.py +94 -0
  513. qanswer_sdk/models/share_point_download_by_ids.py +99 -0
  514. qanswer_sdk/models/share_point_download_request.py +103 -0
  515. qanswer_sdk/models/shared_by.py +38 -0
  516. qanswer_sdk/models/shared_entity_type.py +38 -0
  517. qanswer_sdk/models/shared_organization_access.py +125 -0
  518. qanswer_sdk/models/shared_organization_access_dto.py +125 -0
  519. qanswer_sdk/models/shared_team_access.py +125 -0
  520. qanswer_sdk/models/shared_team_access_dto.py +125 -0
  521. qanswer_sdk/models/shared_user.py +99 -0
  522. qanswer_sdk/models/sign_up_request.py +108 -0
  523. qanswer_sdk/models/signout_request.py +87 -0
  524. qanswer_sdk/models/slot.py +162 -0
  525. qanswer_sdk/models/slot_history_entry.py +127 -0
  526. qanswer_sdk/models/slot_in_prompt.py +91 -0
  527. qanswer_sdk/models/slot_info_with_latest_version.py +95 -0
  528. qanswer_sdk/models/slot_update.py +142 -0
  529. qanswer_sdk/models/socker_join_user.py +91 -0
  530. qanswer_sdk/models/socket_ai_cell_generation.py +99 -0
  531. qanswer_sdk/models/socket_conversation_message.py +280 -0
  532. qanswer_sdk/models/socket_events_q_answer.py +51 -0
  533. qanswer_sdk/models/socket_feedback_evaluation_progress.py +114 -0
  534. qanswer_sdk/models/socket_file_metadata.py +207 -0
  535. qanswer_sdk/models/socket_join_conversation.py +97 -0
  536. qanswer_sdk/models/socket_join_dataset.py +93 -0
  537. qanswer_sdk/models/socket_message_status.py +40 -0
  538. qanswer_sdk/models/socket_notification.py +127 -0
  539. qanswer_sdk/models/socket_report_continuation_response.py +106 -0
  540. qanswer_sdk/models/socket_report_copilot_generation_from_slots_response.py +122 -0
  541. qanswer_sdk/models/socket_report_copilot_generation_from_template_response.py +122 -0
  542. qanswer_sdk/models/socket_report_copilot_refinement_response.py +108 -0
  543. qanswer_sdk/models/socket_speech2_text_response.py +131 -0
  544. qanswer_sdk/models/socket_stop_conversation.py +97 -0
  545. qanswer_sdk/models/source.py +125 -0
  546. qanswer_sdk/models/source_metadata.py +109 -0
  547. qanswer_sdk/models/speech2_text_response.py +119 -0
  548. qanswer_sdk/models/stat_per_date.py +89 -0
  549. qanswer_sdk/models/status_response.py +89 -0
  550. qanswer_sdk/models/stop_template_generation_payload.py +91 -0
  551. qanswer_sdk/models/storage_active_status.py +37 -0
  552. qanswer_sdk/models/subscription_response.py +101 -0
  553. qanswer_sdk/models/subscription_status.py +39 -0
  554. qanswer_sdk/models/suggestion_list_response.py +87 -0
  555. qanswer_sdk/models/summa_server.py +101 -0
  556. qanswer_sdk/models/task_category.py +58 -0
  557. qanswer_sdk/models/task_name.py +43 -0
  558. qanswer_sdk/models/team.py +93 -0
  559. qanswer_sdk/models/team_creation.py +89 -0
  560. qanswer_sdk/models/team_creation_dto.py +89 -0
  561. qanswer_sdk/models/team_dto.py +93 -0
  562. qanswer_sdk/models/team_filter_dto.py +141 -0
  563. qanswer_sdk/models/team_list_dto.py +101 -0
  564. qanswer_sdk/models/template_clip_structure.py +114 -0
  565. qanswer_sdk/models/template_toggle_request.py +93 -0
  566. qanswer_sdk/models/terms_bucket.py +94 -0
  567. qanswer_sdk/models/test_imap_connection_payload.py +95 -0
  568. qanswer_sdk/models/text2_sparql_payload.py +188 -0
  569. qanswer_sdk/models/text2_sparql_task_settings.py +125 -0
  570. qanswer_sdk/models/text2_sparql_task_settings_update_payload.py +95 -0
  571. qanswer_sdk/models/text2_sparql_task_update.py +125 -0
  572. qanswer_sdk/models/text_classification_payload.py +99 -0
  573. qanswer_sdk/models/text_classification_response.py +87 -0
  574. qanswer_sdk/models/text_classification_v2_payload.py +99 -0
  575. qanswer_sdk/models/text_classification_v2_response.py +95 -0
  576. qanswer_sdk/models/thinking_block.py +91 -0
  577. qanswer_sdk/models/tool_selection.py +89 -0
  578. qanswer_sdk/models/total_stat.py +96 -0
  579. qanswer_sdk/models/ui_mappings.py +141 -0
  580. qanswer_sdk/models/update_cells_payload.py +93 -0
  581. qanswer_sdk/models/update_file_es_meta_data.py +116 -0
  582. qanswer_sdk/models/update_metadata_model_input.py +97 -0
  583. qanswer_sdk/models/update_metadata_model_output.py +97 -0
  584. qanswer_sdk/models/update_qn_a_pair_request.py +101 -0
  585. qanswer_sdk/models/update_qn_a_pair_response.py +89 -0
  586. qanswer_sdk/models/update_synonyms.py +95 -0
  587. qanswer_sdk/models/update_synonyms_resp.py +89 -0
  588. qanswer_sdk/models/update_template_cells_payload.py +101 -0
  589. qanswer_sdk/models/upload_metadata.py +115 -0
  590. qanswer_sdk/models/user.py +91 -0
  591. qanswer_sdk/models/user_credits_config_dto.py +99 -0
  592. qanswer_sdk/models/user_credits_dto.py +106 -0
  593. qanswer_sdk/models/user_dataset_api_key.py +120 -0
  594. qanswer_sdk/models/user_dataset_api_key_dto.py +120 -0
  595. qanswer_sdk/models/user_dataset_mcp_tool_selection_dto.py +102 -0
  596. qanswer_sdk/models/user_dto.py +91 -0
  597. qanswer_sdk/models/user_filter_dto.py +155 -0
  598. qanswer_sdk/models/user_identity_availability.py +87 -0
  599. qanswer_sdk/models/user_info_dto.py +95 -0
  600. qanswer_sdk/models/user_list_dto.py +101 -0
  601. qanswer_sdk/models/user_log.py +102 -0
  602. qanswer_sdk/models/user_log_dto.py +102 -0
  603. qanswer_sdk/models/user_logs_list_dto.py +97 -0
  604. qanswer_sdk/models/user_mcp_tool_selection_dto.py +118 -0
  605. qanswer_sdk/models/user_oauth_token.py +96 -0
  606. qanswer_sdk/models/user_oauth_token_dto.py +96 -0
  607. qanswer_sdk/models/user_profile_dto.py +200 -0
  608. qanswer_sdk/models/user_profile_list_dto.py +101 -0
  609. qanswer_sdk/models/user_stat_per_date.py +90 -0
  610. qanswer_sdk/models/validation_error.py +108 -0
  611. qanswer_sdk/models/validation_error_loc_inner.py +138 -0
  612. qanswer_sdk/models/warn_visibility.py +40 -0
  613. qanswer_sdk/models/websearch_connector_config.py +102 -0
  614. qanswer_sdk/models/websearch_scraping_site.py +91 -0
  615. qanswer_sdk/models/website_add_payload.py +102 -0
  616. qanswer_sdk/models/website_connector_config.py +102 -0
  617. qanswer_sdk/models/website_connector_settings.py +160 -0
  618. qanswer_sdk/models/widget_configs.py +109 -0
  619. qanswer_sdk/py.typed +0 -0
  620. qanswer_sdk/rest.py +258 -0
  621. qanswer_sdk-0.46.0.dev0.dist-info/METADATA +252 -0
  622. qanswer_sdk-0.46.0.dev0.dist-info/RECORD +624 -0
  623. qanswer_sdk-0.46.0.dev0.dist-info/WHEEL +5 -0
  624. qanswer_sdk-0.46.0.dev0.dist-info/top_level.txt +1 -0
@@ -0,0 +1,2070 @@
1
+ # coding: utf-8
2
+
3
+ """
4
+ free-text-client
5
+
6
+ QAnswer 2.0 API
7
+
8
+ The version of the OpenAPI document: 2.0.0
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
20
+ from typing import List, Optional
21
+ from typing_extensions import Annotated
22
+ from qanswer_sdk.models.available_embedding_models_response import AvailableEmbeddingModelsResponse
23
+ from qanswer_sdk.models.available_endpoints_response import AvailableEndpointsResponse
24
+ from qanswer_sdk.models.available_logs_visibility_policy import AvailableLogsVisibilityPolicy
25
+ from qanswer_sdk.models.available_storage_preference import AvailableStoragePreference
26
+ from qanswer_sdk.models.chatbot_default_settings_response import ChatbotDefaultSettingsResponse
27
+ from qanswer_sdk.models.data_storage_preference import DataStoragePreference
28
+ from qanswer_sdk.models.dataset_default_values_model import DatasetDefaultValuesModel
29
+ from qanswer_sdk.models.llm_context_ranges_response import LLMContextRangesResponse
30
+
31
+ from qanswer_sdk.api_client import ApiClient, RequestSerialized
32
+ from qanswer_sdk.api_response import ApiResponse
33
+ from qanswer_sdk.rest import RESTResponseType
34
+
35
+
36
+ class MetadataApi:
37
+ """NOTE: This class is auto generated by OpenAPI Generator
38
+ Ref: https://openapi-generator.tech
39
+
40
+ Do not edit the class manually.
41
+ """
42
+
43
+ def __init__(self, api_client=None) -> None:
44
+ if api_client is None:
45
+ api_client = ApiClient.get_default()
46
+ self.api_client = api_client
47
+
48
+
49
+ @validate_call
50
+ def get_llm_context_ranges(
51
+ self,
52
+ llm_choice: Annotated[StrictStr, Field(description="Fetch min/max context window for certain llm choice.")],
53
+ _request_timeout: Union[
54
+ None,
55
+ Annotated[StrictFloat, Field(gt=0)],
56
+ Tuple[
57
+ Annotated[StrictFloat, Field(gt=0)],
58
+ Annotated[StrictFloat, Field(gt=0)]
59
+ ]
60
+ ] = None,
61
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
62
+ _content_type: Optional[StrictStr] = None,
63
+ _headers: Optional[Dict[StrictStr, Any]] = None,
64
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
65
+ ) -> LLMContextRangesResponse:
66
+ """(Deprecated) Get Llm Context Ranges
67
+
68
+ (Deprecated) Fetch min/max context window for certain llm choice.
69
+
70
+ :param llm_choice: Fetch min/max context window for certain llm choice. (required)
71
+ :type llm_choice: str
72
+ :param _request_timeout: timeout setting for this request. If one
73
+ number provided, it will be total request
74
+ timeout. It can also be a pair (tuple) of
75
+ (connection, read) timeouts.
76
+ :type _request_timeout: int, tuple(int, int), optional
77
+ :param _request_auth: set to override the auth_settings for an a single
78
+ request; this effectively ignores the
79
+ authentication in the spec for a single request.
80
+ :type _request_auth: dict, optional
81
+ :param _content_type: force content-type for the request.
82
+ :type _content_type: str, Optional
83
+ :param _headers: set to override the headers for a single
84
+ request; this effectively ignores the headers
85
+ in the spec for a single request.
86
+ :type _headers: dict, optional
87
+ :param _host_index: set to override the host_index for a single
88
+ request; this effectively ignores the host_index
89
+ in the spec for a single request.
90
+ :type _host_index: int, optional
91
+ :return: Returns the result object.
92
+ """ # noqa: E501
93
+ warnings.warn("GET /backend/api/metadata/llm/context-ranges is deprecated.", DeprecationWarning)
94
+
95
+ _param = self._get_llm_context_ranges_serialize(
96
+ llm_choice=llm_choice,
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': "LLMContextRangesResponse",
105
+ '422': "HTTPValidationError",
106
+ }
107
+ response_data = self.api_client.call_api(
108
+ *_param,
109
+ _request_timeout=_request_timeout
110
+ )
111
+ response_data.read()
112
+ return self.api_client.response_deserialize(
113
+ response_data=response_data,
114
+ response_types_map=_response_types_map,
115
+ ).data
116
+
117
+
118
+ @validate_call
119
+ def get_llm_context_ranges_with_http_info(
120
+ self,
121
+ llm_choice: Annotated[StrictStr, Field(description="Fetch min/max context window for certain llm choice.")],
122
+ _request_timeout: Union[
123
+ None,
124
+ Annotated[StrictFloat, Field(gt=0)],
125
+ Tuple[
126
+ Annotated[StrictFloat, Field(gt=0)],
127
+ Annotated[StrictFloat, Field(gt=0)]
128
+ ]
129
+ ] = None,
130
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
131
+ _content_type: Optional[StrictStr] = None,
132
+ _headers: Optional[Dict[StrictStr, Any]] = None,
133
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
134
+ ) -> ApiResponse[LLMContextRangesResponse]:
135
+ """(Deprecated) Get Llm Context Ranges
136
+
137
+ (Deprecated) Fetch min/max context window for certain llm choice.
138
+
139
+ :param llm_choice: Fetch min/max context window for certain llm choice. (required)
140
+ :type llm_choice: str
141
+ :param _request_timeout: timeout setting for this request. If one
142
+ number provided, it will be total request
143
+ timeout. It can also be a pair (tuple) of
144
+ (connection, read) timeouts.
145
+ :type _request_timeout: int, tuple(int, int), optional
146
+ :param _request_auth: set to override the auth_settings for an a single
147
+ request; this effectively ignores the
148
+ authentication in the spec for a single request.
149
+ :type _request_auth: dict, optional
150
+ :param _content_type: force content-type for the request.
151
+ :type _content_type: str, Optional
152
+ :param _headers: set to override the headers for a single
153
+ request; this effectively ignores the headers
154
+ in the spec for a single request.
155
+ :type _headers: dict, optional
156
+ :param _host_index: set to override the host_index for a single
157
+ request; this effectively ignores the host_index
158
+ in the spec for a single request.
159
+ :type _host_index: int, optional
160
+ :return: Returns the result object.
161
+ """ # noqa: E501
162
+ warnings.warn("GET /backend/api/metadata/llm/context-ranges is deprecated.", DeprecationWarning)
163
+
164
+ _param = self._get_llm_context_ranges_serialize(
165
+ llm_choice=llm_choice,
166
+ _request_auth=_request_auth,
167
+ _content_type=_content_type,
168
+ _headers=_headers,
169
+ _host_index=_host_index
170
+ )
171
+
172
+ _response_types_map: Dict[str, Optional[str]] = {
173
+ '200': "LLMContextRangesResponse",
174
+ '422': "HTTPValidationError",
175
+ }
176
+ response_data = self.api_client.call_api(
177
+ *_param,
178
+ _request_timeout=_request_timeout
179
+ )
180
+ response_data.read()
181
+ return self.api_client.response_deserialize(
182
+ response_data=response_data,
183
+ response_types_map=_response_types_map,
184
+ )
185
+
186
+
187
+ @validate_call
188
+ def get_llm_context_ranges_without_preload_content(
189
+ self,
190
+ llm_choice: Annotated[StrictStr, Field(description="Fetch min/max context window for certain llm choice.")],
191
+ _request_timeout: Union[
192
+ None,
193
+ Annotated[StrictFloat, Field(gt=0)],
194
+ Tuple[
195
+ Annotated[StrictFloat, Field(gt=0)],
196
+ Annotated[StrictFloat, Field(gt=0)]
197
+ ]
198
+ ] = None,
199
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
200
+ _content_type: Optional[StrictStr] = None,
201
+ _headers: Optional[Dict[StrictStr, Any]] = None,
202
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
203
+ ) -> RESTResponseType:
204
+ """(Deprecated) Get Llm Context Ranges
205
+
206
+ (Deprecated) Fetch min/max context window for certain llm choice.
207
+
208
+ :param llm_choice: Fetch min/max context window for certain llm choice. (required)
209
+ :type llm_choice: str
210
+ :param _request_timeout: timeout setting for this request. If one
211
+ number provided, it will be total request
212
+ timeout. It can also be a pair (tuple) of
213
+ (connection, read) timeouts.
214
+ :type _request_timeout: int, tuple(int, int), optional
215
+ :param _request_auth: set to override the auth_settings for an a single
216
+ request; this effectively ignores the
217
+ authentication in the spec for a single request.
218
+ :type _request_auth: dict, optional
219
+ :param _content_type: force content-type for the request.
220
+ :type _content_type: str, Optional
221
+ :param _headers: set to override the headers for a single
222
+ request; this effectively ignores the headers
223
+ in the spec for a single request.
224
+ :type _headers: dict, optional
225
+ :param _host_index: set to override the host_index for a single
226
+ request; this effectively ignores the host_index
227
+ in the spec for a single request.
228
+ :type _host_index: int, optional
229
+ :return: Returns the result object.
230
+ """ # noqa: E501
231
+ warnings.warn("GET /backend/api/metadata/llm/context-ranges is deprecated.", DeprecationWarning)
232
+
233
+ _param = self._get_llm_context_ranges_serialize(
234
+ llm_choice=llm_choice,
235
+ _request_auth=_request_auth,
236
+ _content_type=_content_type,
237
+ _headers=_headers,
238
+ _host_index=_host_index
239
+ )
240
+
241
+ _response_types_map: Dict[str, Optional[str]] = {
242
+ '200': "LLMContextRangesResponse",
243
+ '422': "HTTPValidationError",
244
+ }
245
+ response_data = self.api_client.call_api(
246
+ *_param,
247
+ _request_timeout=_request_timeout
248
+ )
249
+ return response_data.response
250
+
251
+
252
+ def _get_llm_context_ranges_serialize(
253
+ self,
254
+ llm_choice,
255
+ _request_auth,
256
+ _content_type,
257
+ _headers,
258
+ _host_index,
259
+ ) -> RequestSerialized:
260
+
261
+ _host = None
262
+
263
+ _collection_formats: Dict[str, str] = {
264
+ }
265
+
266
+ _path_params: Dict[str, str] = {}
267
+ _query_params: List[Tuple[str, str]] = []
268
+ _header_params: Dict[str, Optional[str]] = _headers or {}
269
+ _form_params: List[Tuple[str, str]] = []
270
+ _files: Dict[
271
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
272
+ ] = {}
273
+ _body_params: Optional[bytes] = None
274
+
275
+ # process the path parameters
276
+ # process the query parameters
277
+ if llm_choice is not None:
278
+
279
+ _query_params.append(('llm_choice', llm_choice))
280
+
281
+ # process the header parameters
282
+ # process the form parameters
283
+ # process the body parameter
284
+
285
+
286
+ # set the HTTP header `Accept`
287
+ if 'Accept' not in _header_params:
288
+ _header_params['Accept'] = self.api_client.select_header_accept(
289
+ [
290
+ 'application/json'
291
+ ]
292
+ )
293
+
294
+
295
+ # authentication setting
296
+ _auth_settings: List[str] = [
297
+ 'QAnswer-Api-Key',
298
+ 'Bearer token'
299
+ ]
300
+
301
+ return self.api_client.param_serialize(
302
+ method='GET',
303
+ resource_path='/backend/api/metadata/llm/context-ranges',
304
+ path_params=_path_params,
305
+ query_params=_query_params,
306
+ header_params=_header_params,
307
+ body=_body_params,
308
+ post_params=_form_params,
309
+ files=_files,
310
+ auth_settings=_auth_settings,
311
+ collection_formats=_collection_formats,
312
+ _host=_host,
313
+ _request_auth=_request_auth
314
+ )
315
+
316
+
317
+
318
+
319
+ @validate_call
320
+ def read_chatbot_default_settings(
321
+ self,
322
+ llm_choice: Annotated[Optional[StrictStr], Field(description="The LLM choice to use for the chatbot. If not provided, the default LLM will be used.")] = None,
323
+ _request_timeout: Union[
324
+ None,
325
+ Annotated[StrictFloat, Field(gt=0)],
326
+ Tuple[
327
+ Annotated[StrictFloat, Field(gt=0)],
328
+ Annotated[StrictFloat, Field(gt=0)]
329
+ ]
330
+ ] = None,
331
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
332
+ _content_type: Optional[StrictStr] = None,
333
+ _headers: Optional[Dict[StrictStr, Any]] = None,
334
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
335
+ ) -> ChatbotDefaultSettingsResponse:
336
+ """Read Chatbot Default Settings
337
+
338
+
339
+ :param llm_choice: The LLM choice to use for the chatbot. If not provided, the default LLM will be used.
340
+ :type llm_choice: str
341
+ :param _request_timeout: timeout setting for this request. If one
342
+ number provided, it will be total request
343
+ timeout. It can also be a pair (tuple) of
344
+ (connection, read) timeouts.
345
+ :type _request_timeout: int, tuple(int, int), optional
346
+ :param _request_auth: set to override the auth_settings for an a single
347
+ request; this effectively ignores the
348
+ authentication in the spec for a single request.
349
+ :type _request_auth: dict, optional
350
+ :param _content_type: force content-type for the request.
351
+ :type _content_type: str, Optional
352
+ :param _headers: set to override the headers for a single
353
+ request; this effectively ignores the headers
354
+ in the spec for a single request.
355
+ :type _headers: dict, optional
356
+ :param _host_index: set to override the host_index for a single
357
+ request; this effectively ignores the host_index
358
+ in the spec for a single request.
359
+ :type _host_index: int, optional
360
+ :return: Returns the result object.
361
+ """ # noqa: E501
362
+
363
+ _param = self._read_chatbot_default_settings_serialize(
364
+ llm_choice=llm_choice,
365
+ _request_auth=_request_auth,
366
+ _content_type=_content_type,
367
+ _headers=_headers,
368
+ _host_index=_host_index
369
+ )
370
+
371
+ _response_types_map: Dict[str, Optional[str]] = {
372
+ '200': "ChatbotDefaultSettingsResponse",
373
+ '422': "HTTPValidationError",
374
+ }
375
+ response_data = self.api_client.call_api(
376
+ *_param,
377
+ _request_timeout=_request_timeout
378
+ )
379
+ response_data.read()
380
+ return self.api_client.response_deserialize(
381
+ response_data=response_data,
382
+ response_types_map=_response_types_map,
383
+ ).data
384
+
385
+
386
+ @validate_call
387
+ def read_chatbot_default_settings_with_http_info(
388
+ self,
389
+ llm_choice: Annotated[Optional[StrictStr], Field(description="The LLM choice to use for the chatbot. If not provided, the default LLM will be used.")] = None,
390
+ _request_timeout: Union[
391
+ None,
392
+ Annotated[StrictFloat, Field(gt=0)],
393
+ Tuple[
394
+ Annotated[StrictFloat, Field(gt=0)],
395
+ Annotated[StrictFloat, Field(gt=0)]
396
+ ]
397
+ ] = None,
398
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
399
+ _content_type: Optional[StrictStr] = None,
400
+ _headers: Optional[Dict[StrictStr, Any]] = None,
401
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
402
+ ) -> ApiResponse[ChatbotDefaultSettingsResponse]:
403
+ """Read Chatbot Default Settings
404
+
405
+
406
+ :param llm_choice: The LLM choice to use for the chatbot. If not provided, the default LLM will be used.
407
+ :type llm_choice: str
408
+ :param _request_timeout: timeout setting for this request. If one
409
+ number provided, it will be total request
410
+ timeout. It can also be a pair (tuple) of
411
+ (connection, read) timeouts.
412
+ :type _request_timeout: int, tuple(int, int), optional
413
+ :param _request_auth: set to override the auth_settings for an a single
414
+ request; this effectively ignores the
415
+ authentication in the spec for a single request.
416
+ :type _request_auth: dict, optional
417
+ :param _content_type: force content-type for the request.
418
+ :type _content_type: str, Optional
419
+ :param _headers: set to override the headers for a single
420
+ request; this effectively ignores the headers
421
+ in the spec for a single request.
422
+ :type _headers: dict, optional
423
+ :param _host_index: set to override the host_index for a single
424
+ request; this effectively ignores the host_index
425
+ in the spec for a single request.
426
+ :type _host_index: int, optional
427
+ :return: Returns the result object.
428
+ """ # noqa: E501
429
+
430
+ _param = self._read_chatbot_default_settings_serialize(
431
+ llm_choice=llm_choice,
432
+ _request_auth=_request_auth,
433
+ _content_type=_content_type,
434
+ _headers=_headers,
435
+ _host_index=_host_index
436
+ )
437
+
438
+ _response_types_map: Dict[str, Optional[str]] = {
439
+ '200': "ChatbotDefaultSettingsResponse",
440
+ '422': "HTTPValidationError",
441
+ }
442
+ response_data = self.api_client.call_api(
443
+ *_param,
444
+ _request_timeout=_request_timeout
445
+ )
446
+ response_data.read()
447
+ return self.api_client.response_deserialize(
448
+ response_data=response_data,
449
+ response_types_map=_response_types_map,
450
+ )
451
+
452
+
453
+ @validate_call
454
+ def read_chatbot_default_settings_without_preload_content(
455
+ self,
456
+ llm_choice: Annotated[Optional[StrictStr], Field(description="The LLM choice to use for the chatbot. If not provided, the default LLM will be used.")] = None,
457
+ _request_timeout: Union[
458
+ None,
459
+ Annotated[StrictFloat, Field(gt=0)],
460
+ Tuple[
461
+ Annotated[StrictFloat, Field(gt=0)],
462
+ Annotated[StrictFloat, Field(gt=0)]
463
+ ]
464
+ ] = None,
465
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
466
+ _content_type: Optional[StrictStr] = None,
467
+ _headers: Optional[Dict[StrictStr, Any]] = None,
468
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
469
+ ) -> RESTResponseType:
470
+ """Read Chatbot Default Settings
471
+
472
+
473
+ :param llm_choice: The LLM choice to use for the chatbot. If not provided, the default LLM will be used.
474
+ :type llm_choice: str
475
+ :param _request_timeout: timeout setting for this request. If one
476
+ number provided, it will be total request
477
+ timeout. It can also be a pair (tuple) of
478
+ (connection, read) timeouts.
479
+ :type _request_timeout: int, tuple(int, int), optional
480
+ :param _request_auth: set to override the auth_settings for an a single
481
+ request; this effectively ignores the
482
+ authentication in the spec for a single request.
483
+ :type _request_auth: dict, optional
484
+ :param _content_type: force content-type for the request.
485
+ :type _content_type: str, Optional
486
+ :param _headers: set to override the headers for a single
487
+ request; this effectively ignores the headers
488
+ in the spec for a single request.
489
+ :type _headers: dict, optional
490
+ :param _host_index: set to override the host_index for a single
491
+ request; this effectively ignores the host_index
492
+ in the spec for a single request.
493
+ :type _host_index: int, optional
494
+ :return: Returns the result object.
495
+ """ # noqa: E501
496
+
497
+ _param = self._read_chatbot_default_settings_serialize(
498
+ llm_choice=llm_choice,
499
+ _request_auth=_request_auth,
500
+ _content_type=_content_type,
501
+ _headers=_headers,
502
+ _host_index=_host_index
503
+ )
504
+
505
+ _response_types_map: Dict[str, Optional[str]] = {
506
+ '200': "ChatbotDefaultSettingsResponse",
507
+ '422': "HTTPValidationError",
508
+ }
509
+ response_data = self.api_client.call_api(
510
+ *_param,
511
+ _request_timeout=_request_timeout
512
+ )
513
+ return response_data.response
514
+
515
+
516
+ def _read_chatbot_default_settings_serialize(
517
+ self,
518
+ llm_choice,
519
+ _request_auth,
520
+ _content_type,
521
+ _headers,
522
+ _host_index,
523
+ ) -> RequestSerialized:
524
+
525
+ _host = None
526
+
527
+ _collection_formats: Dict[str, str] = {
528
+ }
529
+
530
+ _path_params: Dict[str, str] = {}
531
+ _query_params: List[Tuple[str, str]] = []
532
+ _header_params: Dict[str, Optional[str]] = _headers or {}
533
+ _form_params: List[Tuple[str, str]] = []
534
+ _files: Dict[
535
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
536
+ ] = {}
537
+ _body_params: Optional[bytes] = None
538
+
539
+ # process the path parameters
540
+ # process the query parameters
541
+ if llm_choice is not None:
542
+
543
+ _query_params.append(('llm_choice', llm_choice))
544
+
545
+ # process the header parameters
546
+ # process the form parameters
547
+ # process the body parameter
548
+
549
+
550
+ # set the HTTP header `Accept`
551
+ if 'Accept' not in _header_params:
552
+ _header_params['Accept'] = self.api_client.select_header_accept(
553
+ [
554
+ 'application/json'
555
+ ]
556
+ )
557
+
558
+
559
+ # authentication setting
560
+ _auth_settings: List[str] = [
561
+ 'QAnswer-Api-Key',
562
+ 'Bearer token'
563
+ ]
564
+
565
+ return self.api_client.param_serialize(
566
+ method='GET',
567
+ resource_path='/backend/api/metadata/chatbot/default-settings',
568
+ path_params=_path_params,
569
+ query_params=_query_params,
570
+ header_params=_header_params,
571
+ body=_body_params,
572
+ post_params=_form_params,
573
+ files=_files,
574
+ auth_settings=_auth_settings,
575
+ collection_formats=_collection_formats,
576
+ _host=_host,
577
+ _request_auth=_request_auth
578
+ )
579
+
580
+
581
+
582
+
583
+ @validate_call
584
+ def read_dataset_data_storage_preferences(
585
+ self,
586
+ pref: StrictStr,
587
+ _request_timeout: Union[
588
+ None,
589
+ Annotated[StrictFloat, Field(gt=0)],
590
+ Tuple[
591
+ Annotated[StrictFloat, Field(gt=0)],
592
+ Annotated[StrictFloat, Field(gt=0)]
593
+ ]
594
+ ] = None,
595
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
596
+ _content_type: Optional[StrictStr] = None,
597
+ _headers: Optional[Dict[StrictStr, Any]] = None,
598
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
599
+ ) -> DataStoragePreference:
600
+ """Read Dataset Data Storage Preferences
601
+
602
+
603
+ :param pref: (required)
604
+ :type pref: str
605
+ :param _request_timeout: timeout setting for this request. If one
606
+ number provided, it will be total request
607
+ timeout. It can also be a pair (tuple) of
608
+ (connection, read) timeouts.
609
+ :type _request_timeout: int, tuple(int, int), optional
610
+ :param _request_auth: set to override the auth_settings for an a single
611
+ request; this effectively ignores the
612
+ authentication in the spec for a single request.
613
+ :type _request_auth: dict, optional
614
+ :param _content_type: force content-type for the request.
615
+ :type _content_type: str, Optional
616
+ :param _headers: set to override the headers for a single
617
+ request; this effectively ignores the headers
618
+ in the spec for a single request.
619
+ :type _headers: dict, optional
620
+ :param _host_index: set to override the host_index for a single
621
+ request; this effectively ignores the host_index
622
+ in the spec for a single request.
623
+ :type _host_index: int, optional
624
+ :return: Returns the result object.
625
+ """ # noqa: E501
626
+
627
+ _param = self._read_dataset_data_storage_preferences_serialize(
628
+ pref=pref,
629
+ _request_auth=_request_auth,
630
+ _content_type=_content_type,
631
+ _headers=_headers,
632
+ _host_index=_host_index
633
+ )
634
+
635
+ _response_types_map: Dict[str, Optional[str]] = {
636
+ '200': "DataStoragePreference",
637
+ '422': "HTTPValidationError",
638
+ }
639
+ response_data = self.api_client.call_api(
640
+ *_param,
641
+ _request_timeout=_request_timeout
642
+ )
643
+ response_data.read()
644
+ return self.api_client.response_deserialize(
645
+ response_data=response_data,
646
+ response_types_map=_response_types_map,
647
+ ).data
648
+
649
+
650
+ @validate_call
651
+ def read_dataset_data_storage_preferences_with_http_info(
652
+ self,
653
+ pref: StrictStr,
654
+ _request_timeout: Union[
655
+ None,
656
+ Annotated[StrictFloat, Field(gt=0)],
657
+ Tuple[
658
+ Annotated[StrictFloat, Field(gt=0)],
659
+ Annotated[StrictFloat, Field(gt=0)]
660
+ ]
661
+ ] = None,
662
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
663
+ _content_type: Optional[StrictStr] = None,
664
+ _headers: Optional[Dict[StrictStr, Any]] = None,
665
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
666
+ ) -> ApiResponse[DataStoragePreference]:
667
+ """Read Dataset Data Storage Preferences
668
+
669
+
670
+ :param pref: (required)
671
+ :type pref: str
672
+ :param _request_timeout: timeout setting for this request. If one
673
+ number provided, it will be total request
674
+ timeout. It can also be a pair (tuple) of
675
+ (connection, read) timeouts.
676
+ :type _request_timeout: int, tuple(int, int), optional
677
+ :param _request_auth: set to override the auth_settings for an a single
678
+ request; this effectively ignores the
679
+ authentication in the spec for a single request.
680
+ :type _request_auth: dict, optional
681
+ :param _content_type: force content-type for the request.
682
+ :type _content_type: str, Optional
683
+ :param _headers: set to override the headers for a single
684
+ request; this effectively ignores the headers
685
+ in the spec for a single request.
686
+ :type _headers: dict, optional
687
+ :param _host_index: set to override the host_index for a single
688
+ request; this effectively ignores the host_index
689
+ in the spec for a single request.
690
+ :type _host_index: int, optional
691
+ :return: Returns the result object.
692
+ """ # noqa: E501
693
+
694
+ _param = self._read_dataset_data_storage_preferences_serialize(
695
+ pref=pref,
696
+ _request_auth=_request_auth,
697
+ _content_type=_content_type,
698
+ _headers=_headers,
699
+ _host_index=_host_index
700
+ )
701
+
702
+ _response_types_map: Dict[str, Optional[str]] = {
703
+ '200': "DataStoragePreference",
704
+ '422': "HTTPValidationError",
705
+ }
706
+ response_data = self.api_client.call_api(
707
+ *_param,
708
+ _request_timeout=_request_timeout
709
+ )
710
+ response_data.read()
711
+ return self.api_client.response_deserialize(
712
+ response_data=response_data,
713
+ response_types_map=_response_types_map,
714
+ )
715
+
716
+
717
+ @validate_call
718
+ def read_dataset_data_storage_preferences_without_preload_content(
719
+ self,
720
+ pref: StrictStr,
721
+ _request_timeout: Union[
722
+ None,
723
+ Annotated[StrictFloat, Field(gt=0)],
724
+ Tuple[
725
+ Annotated[StrictFloat, Field(gt=0)],
726
+ Annotated[StrictFloat, Field(gt=0)]
727
+ ]
728
+ ] = None,
729
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
730
+ _content_type: Optional[StrictStr] = None,
731
+ _headers: Optional[Dict[StrictStr, Any]] = None,
732
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
733
+ ) -> RESTResponseType:
734
+ """Read Dataset Data Storage Preferences
735
+
736
+
737
+ :param pref: (required)
738
+ :type pref: str
739
+ :param _request_timeout: timeout setting for this request. If one
740
+ number provided, it will be total request
741
+ timeout. It can also be a pair (tuple) of
742
+ (connection, read) timeouts.
743
+ :type _request_timeout: int, tuple(int, int), optional
744
+ :param _request_auth: set to override the auth_settings for an a single
745
+ request; this effectively ignores the
746
+ authentication in the spec for a single request.
747
+ :type _request_auth: dict, optional
748
+ :param _content_type: force content-type for the request.
749
+ :type _content_type: str, Optional
750
+ :param _headers: set to override the headers for a single
751
+ request; this effectively ignores the headers
752
+ in the spec for a single request.
753
+ :type _headers: dict, optional
754
+ :param _host_index: set to override the host_index for a single
755
+ request; this effectively ignores the host_index
756
+ in the spec for a single request.
757
+ :type _host_index: int, optional
758
+ :return: Returns the result object.
759
+ """ # noqa: E501
760
+
761
+ _param = self._read_dataset_data_storage_preferences_serialize(
762
+ pref=pref,
763
+ _request_auth=_request_auth,
764
+ _content_type=_content_type,
765
+ _headers=_headers,
766
+ _host_index=_host_index
767
+ )
768
+
769
+ _response_types_map: Dict[str, Optional[str]] = {
770
+ '200': "DataStoragePreference",
771
+ '422': "HTTPValidationError",
772
+ }
773
+ response_data = self.api_client.call_api(
774
+ *_param,
775
+ _request_timeout=_request_timeout
776
+ )
777
+ return response_data.response
778
+
779
+
780
+ def _read_dataset_data_storage_preferences_serialize(
781
+ self,
782
+ pref,
783
+ _request_auth,
784
+ _content_type,
785
+ _headers,
786
+ _host_index,
787
+ ) -> RequestSerialized:
788
+
789
+ _host = None
790
+
791
+ _collection_formats: Dict[str, str] = {
792
+ }
793
+
794
+ _path_params: Dict[str, str] = {}
795
+ _query_params: List[Tuple[str, str]] = []
796
+ _header_params: Dict[str, Optional[str]] = _headers or {}
797
+ _form_params: List[Tuple[str, str]] = []
798
+ _files: Dict[
799
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
800
+ ] = {}
801
+ _body_params: Optional[bytes] = None
802
+
803
+ # process the path parameters
804
+ # process the query parameters
805
+ if pref is not None:
806
+
807
+ _query_params.append(('pref', pref))
808
+
809
+ # process the header parameters
810
+ # process the form parameters
811
+ # process the body parameter
812
+
813
+
814
+ # set the HTTP header `Accept`
815
+ if 'Accept' not in _header_params:
816
+ _header_params['Accept'] = self.api_client.select_header_accept(
817
+ [
818
+ 'application/json'
819
+ ]
820
+ )
821
+
822
+
823
+ # authentication setting
824
+ _auth_settings: List[str] = [
825
+ 'QAnswer-Api-Key',
826
+ 'Bearer token'
827
+ ]
828
+
829
+ return self.api_client.param_serialize(
830
+ method='GET',
831
+ resource_path='/backend/api/metadata/dataset/data-storage-preferences',
832
+ path_params=_path_params,
833
+ query_params=_query_params,
834
+ header_params=_header_params,
835
+ body=_body_params,
836
+ post_params=_form_params,
837
+ files=_files,
838
+ auth_settings=_auth_settings,
839
+ collection_formats=_collection_formats,
840
+ _host=_host,
841
+ _request_auth=_request_auth
842
+ )
843
+
844
+
845
+
846
+
847
+ @validate_call
848
+ def read_dataset_data_storage_preferences_available_choices(
849
+ self,
850
+ _request_timeout: Union[
851
+ None,
852
+ Annotated[StrictFloat, Field(gt=0)],
853
+ Tuple[
854
+ Annotated[StrictFloat, Field(gt=0)],
855
+ Annotated[StrictFloat, Field(gt=0)]
856
+ ]
857
+ ] = None,
858
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
859
+ _content_type: Optional[StrictStr] = None,
860
+ _headers: Optional[Dict[StrictStr, Any]] = None,
861
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
862
+ ) -> List[AvailableStoragePreference]:
863
+ """Read Dataset Data Storage Preferences Available Choices
864
+
865
+ Get the available choices for data storage preferences
866
+
867
+ :param _request_timeout: timeout setting for this request. If one
868
+ number provided, it will be total request
869
+ timeout. It can also be a pair (tuple) of
870
+ (connection, read) timeouts.
871
+ :type _request_timeout: int, tuple(int, int), optional
872
+ :param _request_auth: set to override the auth_settings for an a single
873
+ request; this effectively ignores the
874
+ authentication in the spec for a single request.
875
+ :type _request_auth: dict, optional
876
+ :param _content_type: force content-type for the request.
877
+ :type _content_type: str, Optional
878
+ :param _headers: set to override the headers for a single
879
+ request; this effectively ignores the headers
880
+ in the spec for a single request.
881
+ :type _headers: dict, optional
882
+ :param _host_index: set to override the host_index for a single
883
+ request; this effectively ignores the host_index
884
+ in the spec for a single request.
885
+ :type _host_index: int, optional
886
+ :return: Returns the result object.
887
+ """ # noqa: E501
888
+
889
+ _param = self._read_dataset_data_storage_preferences_available_choices_serialize(
890
+ _request_auth=_request_auth,
891
+ _content_type=_content_type,
892
+ _headers=_headers,
893
+ _host_index=_host_index
894
+ )
895
+
896
+ _response_types_map: Dict[str, Optional[str]] = {
897
+ '200': "List[AvailableStoragePreference]",
898
+ }
899
+ response_data = self.api_client.call_api(
900
+ *_param,
901
+ _request_timeout=_request_timeout
902
+ )
903
+ response_data.read()
904
+ return self.api_client.response_deserialize(
905
+ response_data=response_data,
906
+ response_types_map=_response_types_map,
907
+ ).data
908
+
909
+
910
+ @validate_call
911
+ def read_dataset_data_storage_preferences_available_choices_with_http_info(
912
+ self,
913
+ _request_timeout: Union[
914
+ None,
915
+ Annotated[StrictFloat, Field(gt=0)],
916
+ Tuple[
917
+ Annotated[StrictFloat, Field(gt=0)],
918
+ Annotated[StrictFloat, Field(gt=0)]
919
+ ]
920
+ ] = None,
921
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
922
+ _content_type: Optional[StrictStr] = None,
923
+ _headers: Optional[Dict[StrictStr, Any]] = None,
924
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
925
+ ) -> ApiResponse[List[AvailableStoragePreference]]:
926
+ """Read Dataset Data Storage Preferences Available Choices
927
+
928
+ Get the available choices for data storage preferences
929
+
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._read_dataset_data_storage_preferences_available_choices_serialize(
953
+ _request_auth=_request_auth,
954
+ _content_type=_content_type,
955
+ _headers=_headers,
956
+ _host_index=_host_index
957
+ )
958
+
959
+ _response_types_map: Dict[str, Optional[str]] = {
960
+ '200': "List[AvailableStoragePreference]",
961
+ }
962
+ response_data = self.api_client.call_api(
963
+ *_param,
964
+ _request_timeout=_request_timeout
965
+ )
966
+ response_data.read()
967
+ return self.api_client.response_deserialize(
968
+ response_data=response_data,
969
+ response_types_map=_response_types_map,
970
+ )
971
+
972
+
973
+ @validate_call
974
+ def read_dataset_data_storage_preferences_available_choices_without_preload_content(
975
+ self,
976
+ _request_timeout: Union[
977
+ None,
978
+ Annotated[StrictFloat, Field(gt=0)],
979
+ Tuple[
980
+ Annotated[StrictFloat, Field(gt=0)],
981
+ Annotated[StrictFloat, Field(gt=0)]
982
+ ]
983
+ ] = None,
984
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
985
+ _content_type: Optional[StrictStr] = None,
986
+ _headers: Optional[Dict[StrictStr, Any]] = None,
987
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
988
+ ) -> RESTResponseType:
989
+ """Read Dataset Data Storage Preferences Available Choices
990
+
991
+ Get the available choices for data storage preferences
992
+
993
+ :param _request_timeout: timeout setting for this request. If one
994
+ number provided, it will be total request
995
+ timeout. It can also be a pair (tuple) of
996
+ (connection, read) timeouts.
997
+ :type _request_timeout: int, tuple(int, int), optional
998
+ :param _request_auth: set to override the auth_settings for an a single
999
+ request; this effectively ignores the
1000
+ authentication in the spec for a single request.
1001
+ :type _request_auth: dict, optional
1002
+ :param _content_type: force content-type for the request.
1003
+ :type _content_type: str, Optional
1004
+ :param _headers: set to override the headers for a single
1005
+ request; this effectively ignores the headers
1006
+ in the spec for a single request.
1007
+ :type _headers: dict, optional
1008
+ :param _host_index: set to override the host_index for a single
1009
+ request; this effectively ignores the host_index
1010
+ in the spec for a single request.
1011
+ :type _host_index: int, optional
1012
+ :return: Returns the result object.
1013
+ """ # noqa: E501
1014
+
1015
+ _param = self._read_dataset_data_storage_preferences_available_choices_serialize(
1016
+ _request_auth=_request_auth,
1017
+ _content_type=_content_type,
1018
+ _headers=_headers,
1019
+ _host_index=_host_index
1020
+ )
1021
+
1022
+ _response_types_map: Dict[str, Optional[str]] = {
1023
+ '200': "List[AvailableStoragePreference]",
1024
+ }
1025
+ response_data = self.api_client.call_api(
1026
+ *_param,
1027
+ _request_timeout=_request_timeout
1028
+ )
1029
+ return response_data.response
1030
+
1031
+
1032
+ def _read_dataset_data_storage_preferences_available_choices_serialize(
1033
+ self,
1034
+ _request_auth,
1035
+ _content_type,
1036
+ _headers,
1037
+ _host_index,
1038
+ ) -> RequestSerialized:
1039
+
1040
+ _host = None
1041
+
1042
+ _collection_formats: Dict[str, str] = {
1043
+ }
1044
+
1045
+ _path_params: Dict[str, str] = {}
1046
+ _query_params: List[Tuple[str, str]] = []
1047
+ _header_params: Dict[str, Optional[str]] = _headers or {}
1048
+ _form_params: List[Tuple[str, str]] = []
1049
+ _files: Dict[
1050
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
1051
+ ] = {}
1052
+ _body_params: Optional[bytes] = None
1053
+
1054
+ # process the path parameters
1055
+ # process the query parameters
1056
+ # process the header parameters
1057
+ # process the form parameters
1058
+ # process the body parameter
1059
+
1060
+
1061
+ # set the HTTP header `Accept`
1062
+ if 'Accept' not in _header_params:
1063
+ _header_params['Accept'] = self.api_client.select_header_accept(
1064
+ [
1065
+ 'application/json'
1066
+ ]
1067
+ )
1068
+
1069
+
1070
+ # authentication setting
1071
+ _auth_settings: List[str] = [
1072
+ 'QAnswer-Api-Key',
1073
+ 'Bearer token'
1074
+ ]
1075
+
1076
+ return self.api_client.param_serialize(
1077
+ method='GET',
1078
+ resource_path='/backend/api/metadata/dataset/data-storage-preferences/available-choices',
1079
+ path_params=_path_params,
1080
+ query_params=_query_params,
1081
+ header_params=_header_params,
1082
+ body=_body_params,
1083
+ post_params=_form_params,
1084
+ files=_files,
1085
+ auth_settings=_auth_settings,
1086
+ collection_formats=_collection_formats,
1087
+ _host=_host,
1088
+ _request_auth=_request_auth
1089
+ )
1090
+
1091
+
1092
+
1093
+
1094
+ @validate_call
1095
+ def read_dataset_default_values(
1096
+ self,
1097
+ _request_timeout: Union[
1098
+ None,
1099
+ Annotated[StrictFloat, Field(gt=0)],
1100
+ Tuple[
1101
+ Annotated[StrictFloat, Field(gt=0)],
1102
+ Annotated[StrictFloat, Field(gt=0)]
1103
+ ]
1104
+ ] = None,
1105
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1106
+ _content_type: Optional[StrictStr] = None,
1107
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1108
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1109
+ ) -> DatasetDefaultValuesModel:
1110
+ """Read Dataset Default Values
1111
+
1112
+
1113
+ :param _request_timeout: timeout setting for this request. If one
1114
+ number provided, it will be total request
1115
+ timeout. It can also be a pair (tuple) of
1116
+ (connection, read) timeouts.
1117
+ :type _request_timeout: int, tuple(int, int), optional
1118
+ :param _request_auth: set to override the auth_settings for an a single
1119
+ request; this effectively ignores the
1120
+ authentication in the spec for a single request.
1121
+ :type _request_auth: dict, optional
1122
+ :param _content_type: force content-type for the request.
1123
+ :type _content_type: str, Optional
1124
+ :param _headers: set to override the headers for a single
1125
+ request; this effectively ignores the headers
1126
+ in the spec for a single request.
1127
+ :type _headers: dict, optional
1128
+ :param _host_index: set to override the host_index for a single
1129
+ request; this effectively ignores the host_index
1130
+ in the spec for a single request.
1131
+ :type _host_index: int, optional
1132
+ :return: Returns the result object.
1133
+ """ # noqa: E501
1134
+
1135
+ _param = self._read_dataset_default_values_serialize(
1136
+ _request_auth=_request_auth,
1137
+ _content_type=_content_type,
1138
+ _headers=_headers,
1139
+ _host_index=_host_index
1140
+ )
1141
+
1142
+ _response_types_map: Dict[str, Optional[str]] = {
1143
+ '200': "DatasetDefaultValuesModel",
1144
+ }
1145
+ response_data = self.api_client.call_api(
1146
+ *_param,
1147
+ _request_timeout=_request_timeout
1148
+ )
1149
+ response_data.read()
1150
+ return self.api_client.response_deserialize(
1151
+ response_data=response_data,
1152
+ response_types_map=_response_types_map,
1153
+ ).data
1154
+
1155
+
1156
+ @validate_call
1157
+ def read_dataset_default_values_with_http_info(
1158
+ self,
1159
+ _request_timeout: Union[
1160
+ None,
1161
+ Annotated[StrictFloat, Field(gt=0)],
1162
+ Tuple[
1163
+ Annotated[StrictFloat, Field(gt=0)],
1164
+ Annotated[StrictFloat, Field(gt=0)]
1165
+ ]
1166
+ ] = None,
1167
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1168
+ _content_type: Optional[StrictStr] = None,
1169
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1170
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1171
+ ) -> ApiResponse[DatasetDefaultValuesModel]:
1172
+ """Read Dataset Default Values
1173
+
1174
+
1175
+ :param _request_timeout: timeout setting for this request. If one
1176
+ number provided, it will be total request
1177
+ timeout. It can also be a pair (tuple) of
1178
+ (connection, read) timeouts.
1179
+ :type _request_timeout: int, tuple(int, int), optional
1180
+ :param _request_auth: set to override the auth_settings for an a single
1181
+ request; this effectively ignores the
1182
+ authentication in the spec for a single request.
1183
+ :type _request_auth: dict, optional
1184
+ :param _content_type: force content-type for the request.
1185
+ :type _content_type: str, Optional
1186
+ :param _headers: set to override the headers for a single
1187
+ request; this effectively ignores the headers
1188
+ in the spec for a single request.
1189
+ :type _headers: dict, optional
1190
+ :param _host_index: set to override the host_index for a single
1191
+ request; this effectively ignores the host_index
1192
+ in the spec for a single request.
1193
+ :type _host_index: int, optional
1194
+ :return: Returns the result object.
1195
+ """ # noqa: E501
1196
+
1197
+ _param = self._read_dataset_default_values_serialize(
1198
+ _request_auth=_request_auth,
1199
+ _content_type=_content_type,
1200
+ _headers=_headers,
1201
+ _host_index=_host_index
1202
+ )
1203
+
1204
+ _response_types_map: Dict[str, Optional[str]] = {
1205
+ '200': "DatasetDefaultValuesModel",
1206
+ }
1207
+ response_data = self.api_client.call_api(
1208
+ *_param,
1209
+ _request_timeout=_request_timeout
1210
+ )
1211
+ response_data.read()
1212
+ return self.api_client.response_deserialize(
1213
+ response_data=response_data,
1214
+ response_types_map=_response_types_map,
1215
+ )
1216
+
1217
+
1218
+ @validate_call
1219
+ def read_dataset_default_values_without_preload_content(
1220
+ self,
1221
+ _request_timeout: Union[
1222
+ None,
1223
+ Annotated[StrictFloat, Field(gt=0)],
1224
+ Tuple[
1225
+ Annotated[StrictFloat, Field(gt=0)],
1226
+ Annotated[StrictFloat, Field(gt=0)]
1227
+ ]
1228
+ ] = None,
1229
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1230
+ _content_type: Optional[StrictStr] = None,
1231
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1232
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1233
+ ) -> RESTResponseType:
1234
+ """Read Dataset Default Values
1235
+
1236
+
1237
+ :param _request_timeout: timeout setting for this request. If one
1238
+ number provided, it will be total request
1239
+ timeout. It can also be a pair (tuple) of
1240
+ (connection, read) timeouts.
1241
+ :type _request_timeout: int, tuple(int, int), optional
1242
+ :param _request_auth: set to override the auth_settings for an a single
1243
+ request; this effectively ignores the
1244
+ authentication in the spec for a single request.
1245
+ :type _request_auth: dict, optional
1246
+ :param _content_type: force content-type for the request.
1247
+ :type _content_type: str, Optional
1248
+ :param _headers: set to override the headers for a single
1249
+ request; this effectively ignores the headers
1250
+ in the spec for a single request.
1251
+ :type _headers: dict, optional
1252
+ :param _host_index: set to override the host_index for a single
1253
+ request; this effectively ignores the host_index
1254
+ in the spec for a single request.
1255
+ :type _host_index: int, optional
1256
+ :return: Returns the result object.
1257
+ """ # noqa: E501
1258
+
1259
+ _param = self._read_dataset_default_values_serialize(
1260
+ _request_auth=_request_auth,
1261
+ _content_type=_content_type,
1262
+ _headers=_headers,
1263
+ _host_index=_host_index
1264
+ )
1265
+
1266
+ _response_types_map: Dict[str, Optional[str]] = {
1267
+ '200': "DatasetDefaultValuesModel",
1268
+ }
1269
+ response_data = self.api_client.call_api(
1270
+ *_param,
1271
+ _request_timeout=_request_timeout
1272
+ )
1273
+ return response_data.response
1274
+
1275
+
1276
+ def _read_dataset_default_values_serialize(
1277
+ self,
1278
+ _request_auth,
1279
+ _content_type,
1280
+ _headers,
1281
+ _host_index,
1282
+ ) -> RequestSerialized:
1283
+
1284
+ _host = None
1285
+
1286
+ _collection_formats: Dict[str, str] = {
1287
+ }
1288
+
1289
+ _path_params: Dict[str, str] = {}
1290
+ _query_params: List[Tuple[str, str]] = []
1291
+ _header_params: Dict[str, Optional[str]] = _headers or {}
1292
+ _form_params: List[Tuple[str, str]] = []
1293
+ _files: Dict[
1294
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
1295
+ ] = {}
1296
+ _body_params: Optional[bytes] = None
1297
+
1298
+ # process the path parameters
1299
+ # process the query parameters
1300
+ # process the header parameters
1301
+ # process the form parameters
1302
+ # process the body parameter
1303
+
1304
+
1305
+ # set the HTTP header `Accept`
1306
+ if 'Accept' not in _header_params:
1307
+ _header_params['Accept'] = self.api_client.select_header_accept(
1308
+ [
1309
+ 'application/json'
1310
+ ]
1311
+ )
1312
+
1313
+
1314
+ # authentication setting
1315
+ _auth_settings: List[str] = [
1316
+ 'QAnswer-Api-Key',
1317
+ 'Bearer token'
1318
+ ]
1319
+
1320
+ return self.api_client.param_serialize(
1321
+ method='GET',
1322
+ resource_path='/backend/api/metadata/dataset/default-values',
1323
+ path_params=_path_params,
1324
+ query_params=_query_params,
1325
+ header_params=_header_params,
1326
+ body=_body_params,
1327
+ post_params=_form_params,
1328
+ files=_files,
1329
+ auth_settings=_auth_settings,
1330
+ collection_formats=_collection_formats,
1331
+ _host=_host,
1332
+ _request_auth=_request_auth
1333
+ )
1334
+
1335
+
1336
+
1337
+
1338
+ @validate_call
1339
+ def read_dataset_logs_visibility_policies(
1340
+ self,
1341
+ _request_timeout: Union[
1342
+ None,
1343
+ Annotated[StrictFloat, Field(gt=0)],
1344
+ Tuple[
1345
+ Annotated[StrictFloat, Field(gt=0)],
1346
+ Annotated[StrictFloat, Field(gt=0)]
1347
+ ]
1348
+ ] = None,
1349
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1350
+ _content_type: Optional[StrictStr] = None,
1351
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1352
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1353
+ ) -> List[AvailableLogsVisibilityPolicy]:
1354
+ """Read Dataset Logs Visibility Policies
1355
+
1356
+ Get the available choices for logs visibility policies
1357
+
1358
+ :param _request_timeout: timeout setting for this request. If one
1359
+ number provided, it will be total request
1360
+ timeout. It can also be a pair (tuple) of
1361
+ (connection, read) timeouts.
1362
+ :type _request_timeout: int, tuple(int, int), optional
1363
+ :param _request_auth: set to override the auth_settings for an a single
1364
+ request; this effectively ignores the
1365
+ authentication in the spec for a single request.
1366
+ :type _request_auth: dict, optional
1367
+ :param _content_type: force content-type for the request.
1368
+ :type _content_type: str, Optional
1369
+ :param _headers: set to override the headers for a single
1370
+ request; this effectively ignores the headers
1371
+ in the spec for a single request.
1372
+ :type _headers: dict, optional
1373
+ :param _host_index: set to override the host_index for a single
1374
+ request; this effectively ignores the host_index
1375
+ in the spec for a single request.
1376
+ :type _host_index: int, optional
1377
+ :return: Returns the result object.
1378
+ """ # noqa: E501
1379
+
1380
+ _param = self._read_dataset_logs_visibility_policies_serialize(
1381
+ _request_auth=_request_auth,
1382
+ _content_type=_content_type,
1383
+ _headers=_headers,
1384
+ _host_index=_host_index
1385
+ )
1386
+
1387
+ _response_types_map: Dict[str, Optional[str]] = {
1388
+ '200': "List[AvailableLogsVisibilityPolicy]",
1389
+ }
1390
+ response_data = self.api_client.call_api(
1391
+ *_param,
1392
+ _request_timeout=_request_timeout
1393
+ )
1394
+ response_data.read()
1395
+ return self.api_client.response_deserialize(
1396
+ response_data=response_data,
1397
+ response_types_map=_response_types_map,
1398
+ ).data
1399
+
1400
+
1401
+ @validate_call
1402
+ def read_dataset_logs_visibility_policies_with_http_info(
1403
+ self,
1404
+ _request_timeout: Union[
1405
+ None,
1406
+ Annotated[StrictFloat, Field(gt=0)],
1407
+ Tuple[
1408
+ Annotated[StrictFloat, Field(gt=0)],
1409
+ Annotated[StrictFloat, Field(gt=0)]
1410
+ ]
1411
+ ] = None,
1412
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1413
+ _content_type: Optional[StrictStr] = None,
1414
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1415
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1416
+ ) -> ApiResponse[List[AvailableLogsVisibilityPolicy]]:
1417
+ """Read Dataset Logs Visibility Policies
1418
+
1419
+ Get the available choices for logs visibility policies
1420
+
1421
+ :param _request_timeout: timeout setting for this request. If one
1422
+ number provided, it will be total request
1423
+ timeout. It can also be a pair (tuple) of
1424
+ (connection, read) timeouts.
1425
+ :type _request_timeout: int, tuple(int, int), optional
1426
+ :param _request_auth: set to override the auth_settings for an a single
1427
+ request; this effectively ignores the
1428
+ authentication in the spec for a single request.
1429
+ :type _request_auth: dict, optional
1430
+ :param _content_type: force content-type for the request.
1431
+ :type _content_type: str, Optional
1432
+ :param _headers: set to override the headers for a single
1433
+ request; this effectively ignores the headers
1434
+ in the spec for a single request.
1435
+ :type _headers: dict, optional
1436
+ :param _host_index: set to override the host_index for a single
1437
+ request; this effectively ignores the host_index
1438
+ in the spec for a single request.
1439
+ :type _host_index: int, optional
1440
+ :return: Returns the result object.
1441
+ """ # noqa: E501
1442
+
1443
+ _param = self._read_dataset_logs_visibility_policies_serialize(
1444
+ _request_auth=_request_auth,
1445
+ _content_type=_content_type,
1446
+ _headers=_headers,
1447
+ _host_index=_host_index
1448
+ )
1449
+
1450
+ _response_types_map: Dict[str, Optional[str]] = {
1451
+ '200': "List[AvailableLogsVisibilityPolicy]",
1452
+ }
1453
+ response_data = self.api_client.call_api(
1454
+ *_param,
1455
+ _request_timeout=_request_timeout
1456
+ )
1457
+ response_data.read()
1458
+ return self.api_client.response_deserialize(
1459
+ response_data=response_data,
1460
+ response_types_map=_response_types_map,
1461
+ )
1462
+
1463
+
1464
+ @validate_call
1465
+ def read_dataset_logs_visibility_policies_without_preload_content(
1466
+ self,
1467
+ _request_timeout: Union[
1468
+ None,
1469
+ Annotated[StrictFloat, Field(gt=0)],
1470
+ Tuple[
1471
+ Annotated[StrictFloat, Field(gt=0)],
1472
+ Annotated[StrictFloat, Field(gt=0)]
1473
+ ]
1474
+ ] = None,
1475
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1476
+ _content_type: Optional[StrictStr] = None,
1477
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1478
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1479
+ ) -> RESTResponseType:
1480
+ """Read Dataset Logs Visibility Policies
1481
+
1482
+ Get the available choices for logs visibility policies
1483
+
1484
+ :param _request_timeout: timeout setting for this request. If one
1485
+ number provided, it will be total request
1486
+ timeout. It can also be a pair (tuple) of
1487
+ (connection, read) timeouts.
1488
+ :type _request_timeout: int, tuple(int, int), optional
1489
+ :param _request_auth: set to override the auth_settings for an a single
1490
+ request; this effectively ignores the
1491
+ authentication in the spec for a single request.
1492
+ :type _request_auth: dict, optional
1493
+ :param _content_type: force content-type for the request.
1494
+ :type _content_type: str, Optional
1495
+ :param _headers: set to override the headers for a single
1496
+ request; this effectively ignores the headers
1497
+ in the spec for a single request.
1498
+ :type _headers: dict, optional
1499
+ :param _host_index: set to override the host_index for a single
1500
+ request; this effectively ignores the host_index
1501
+ in the spec for a single request.
1502
+ :type _host_index: int, optional
1503
+ :return: Returns the result object.
1504
+ """ # noqa: E501
1505
+
1506
+ _param = self._read_dataset_logs_visibility_policies_serialize(
1507
+ _request_auth=_request_auth,
1508
+ _content_type=_content_type,
1509
+ _headers=_headers,
1510
+ _host_index=_host_index
1511
+ )
1512
+
1513
+ _response_types_map: Dict[str, Optional[str]] = {
1514
+ '200': "List[AvailableLogsVisibilityPolicy]",
1515
+ }
1516
+ response_data = self.api_client.call_api(
1517
+ *_param,
1518
+ _request_timeout=_request_timeout
1519
+ )
1520
+ return response_data.response
1521
+
1522
+
1523
+ def _read_dataset_logs_visibility_policies_serialize(
1524
+ self,
1525
+ _request_auth,
1526
+ _content_type,
1527
+ _headers,
1528
+ _host_index,
1529
+ ) -> RequestSerialized:
1530
+
1531
+ _host = None
1532
+
1533
+ _collection_formats: Dict[str, str] = {
1534
+ }
1535
+
1536
+ _path_params: Dict[str, str] = {}
1537
+ _query_params: List[Tuple[str, str]] = []
1538
+ _header_params: Dict[str, Optional[str]] = _headers or {}
1539
+ _form_params: List[Tuple[str, str]] = []
1540
+ _files: Dict[
1541
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
1542
+ ] = {}
1543
+ _body_params: Optional[bytes] = None
1544
+
1545
+ # process the path parameters
1546
+ # process the query parameters
1547
+ # process the header parameters
1548
+ # process the form parameters
1549
+ # process the body parameter
1550
+
1551
+
1552
+ # set the HTTP header `Accept`
1553
+ if 'Accept' not in _header_params:
1554
+ _header_params['Accept'] = self.api_client.select_header_accept(
1555
+ [
1556
+ 'application/json'
1557
+ ]
1558
+ )
1559
+
1560
+
1561
+ # authentication setting
1562
+ _auth_settings: List[str] = [
1563
+ 'QAnswer-Api-Key',
1564
+ 'Bearer token'
1565
+ ]
1566
+
1567
+ return self.api_client.param_serialize(
1568
+ method='GET',
1569
+ resource_path='/backend/api/metadata/dataset/logs-visibility/available-choices',
1570
+ path_params=_path_params,
1571
+ query_params=_query_params,
1572
+ header_params=_header_params,
1573
+ body=_body_params,
1574
+ post_params=_form_params,
1575
+ files=_files,
1576
+ auth_settings=_auth_settings,
1577
+ collection_formats=_collection_formats,
1578
+ _host=_host,
1579
+ _request_auth=_request_auth
1580
+ )
1581
+
1582
+
1583
+
1584
+
1585
+ @validate_call
1586
+ def read_embedder_available_choices(
1587
+ self,
1588
+ _request_timeout: Union[
1589
+ None,
1590
+ Annotated[StrictFloat, Field(gt=0)],
1591
+ Tuple[
1592
+ Annotated[StrictFloat, Field(gt=0)],
1593
+ Annotated[StrictFloat, Field(gt=0)]
1594
+ ]
1595
+ ] = None,
1596
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1597
+ _content_type: Optional[StrictStr] = None,
1598
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1599
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1600
+ ) -> AvailableEmbeddingModelsResponse:
1601
+ """Read Embedder Available Choices
1602
+
1603
+
1604
+ :param _request_timeout: timeout setting for this request. If one
1605
+ number provided, it will be total request
1606
+ timeout. It can also be a pair (tuple) of
1607
+ (connection, read) timeouts.
1608
+ :type _request_timeout: int, tuple(int, int), optional
1609
+ :param _request_auth: set to override the auth_settings for an a single
1610
+ request; this effectively ignores the
1611
+ authentication in the spec for a single request.
1612
+ :type _request_auth: dict, optional
1613
+ :param _content_type: force content-type for the request.
1614
+ :type _content_type: str, Optional
1615
+ :param _headers: set to override the headers for a single
1616
+ request; this effectively ignores the headers
1617
+ in the spec for a single request.
1618
+ :type _headers: dict, optional
1619
+ :param _host_index: set to override the host_index for a single
1620
+ request; this effectively ignores the host_index
1621
+ in the spec for a single request.
1622
+ :type _host_index: int, optional
1623
+ :return: Returns the result object.
1624
+ """ # noqa: E501
1625
+
1626
+ _param = self._read_embedder_available_choices_serialize(
1627
+ _request_auth=_request_auth,
1628
+ _content_type=_content_type,
1629
+ _headers=_headers,
1630
+ _host_index=_host_index
1631
+ )
1632
+
1633
+ _response_types_map: Dict[str, Optional[str]] = {
1634
+ '200': "AvailableEmbeddingModelsResponse",
1635
+ }
1636
+ response_data = self.api_client.call_api(
1637
+ *_param,
1638
+ _request_timeout=_request_timeout
1639
+ )
1640
+ response_data.read()
1641
+ return self.api_client.response_deserialize(
1642
+ response_data=response_data,
1643
+ response_types_map=_response_types_map,
1644
+ ).data
1645
+
1646
+
1647
+ @validate_call
1648
+ def read_embedder_available_choices_with_http_info(
1649
+ self,
1650
+ _request_timeout: Union[
1651
+ None,
1652
+ Annotated[StrictFloat, Field(gt=0)],
1653
+ Tuple[
1654
+ Annotated[StrictFloat, Field(gt=0)],
1655
+ Annotated[StrictFloat, Field(gt=0)]
1656
+ ]
1657
+ ] = None,
1658
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1659
+ _content_type: Optional[StrictStr] = None,
1660
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1661
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1662
+ ) -> ApiResponse[AvailableEmbeddingModelsResponse]:
1663
+ """Read Embedder Available Choices
1664
+
1665
+
1666
+ :param _request_timeout: timeout setting for this request. If one
1667
+ number provided, it will be total request
1668
+ timeout. It can also be a pair (tuple) of
1669
+ (connection, read) timeouts.
1670
+ :type _request_timeout: int, tuple(int, int), optional
1671
+ :param _request_auth: set to override the auth_settings for an a single
1672
+ request; this effectively ignores the
1673
+ authentication in the spec for a single request.
1674
+ :type _request_auth: dict, optional
1675
+ :param _content_type: force content-type for the request.
1676
+ :type _content_type: str, Optional
1677
+ :param _headers: set to override the headers for a single
1678
+ request; this effectively ignores the headers
1679
+ in the spec for a single request.
1680
+ :type _headers: dict, optional
1681
+ :param _host_index: set to override the host_index for a single
1682
+ request; this effectively ignores the host_index
1683
+ in the spec for a single request.
1684
+ :type _host_index: int, optional
1685
+ :return: Returns the result object.
1686
+ """ # noqa: E501
1687
+
1688
+ _param = self._read_embedder_available_choices_serialize(
1689
+ _request_auth=_request_auth,
1690
+ _content_type=_content_type,
1691
+ _headers=_headers,
1692
+ _host_index=_host_index
1693
+ )
1694
+
1695
+ _response_types_map: Dict[str, Optional[str]] = {
1696
+ '200': "AvailableEmbeddingModelsResponse",
1697
+ }
1698
+ response_data = self.api_client.call_api(
1699
+ *_param,
1700
+ _request_timeout=_request_timeout
1701
+ )
1702
+ response_data.read()
1703
+ return self.api_client.response_deserialize(
1704
+ response_data=response_data,
1705
+ response_types_map=_response_types_map,
1706
+ )
1707
+
1708
+
1709
+ @validate_call
1710
+ def read_embedder_available_choices_without_preload_content(
1711
+ self,
1712
+ _request_timeout: Union[
1713
+ None,
1714
+ Annotated[StrictFloat, Field(gt=0)],
1715
+ Tuple[
1716
+ Annotated[StrictFloat, Field(gt=0)],
1717
+ Annotated[StrictFloat, Field(gt=0)]
1718
+ ]
1719
+ ] = None,
1720
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1721
+ _content_type: Optional[StrictStr] = None,
1722
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1723
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1724
+ ) -> RESTResponseType:
1725
+ """Read Embedder Available Choices
1726
+
1727
+
1728
+ :param _request_timeout: timeout setting for this request. If one
1729
+ number provided, it will be total request
1730
+ timeout. It can also be a pair (tuple) of
1731
+ (connection, read) timeouts.
1732
+ :type _request_timeout: int, tuple(int, int), optional
1733
+ :param _request_auth: set to override the auth_settings for an a single
1734
+ request; this effectively ignores the
1735
+ authentication in the spec for a single request.
1736
+ :type _request_auth: dict, optional
1737
+ :param _content_type: force content-type for the request.
1738
+ :type _content_type: str, Optional
1739
+ :param _headers: set to override the headers for a single
1740
+ request; this effectively ignores the headers
1741
+ in the spec for a single request.
1742
+ :type _headers: dict, optional
1743
+ :param _host_index: set to override the host_index for a single
1744
+ request; this effectively ignores the host_index
1745
+ in the spec for a single request.
1746
+ :type _host_index: int, optional
1747
+ :return: Returns the result object.
1748
+ """ # noqa: E501
1749
+
1750
+ _param = self._read_embedder_available_choices_serialize(
1751
+ _request_auth=_request_auth,
1752
+ _content_type=_content_type,
1753
+ _headers=_headers,
1754
+ _host_index=_host_index
1755
+ )
1756
+
1757
+ _response_types_map: Dict[str, Optional[str]] = {
1758
+ '200': "AvailableEmbeddingModelsResponse",
1759
+ }
1760
+ response_data = self.api_client.call_api(
1761
+ *_param,
1762
+ _request_timeout=_request_timeout
1763
+ )
1764
+ return response_data.response
1765
+
1766
+
1767
+ def _read_embedder_available_choices_serialize(
1768
+ self,
1769
+ _request_auth,
1770
+ _content_type,
1771
+ _headers,
1772
+ _host_index,
1773
+ ) -> RequestSerialized:
1774
+
1775
+ _host = None
1776
+
1777
+ _collection_formats: Dict[str, str] = {
1778
+ }
1779
+
1780
+ _path_params: Dict[str, str] = {}
1781
+ _query_params: List[Tuple[str, str]] = []
1782
+ _header_params: Dict[str, Optional[str]] = _headers or {}
1783
+ _form_params: List[Tuple[str, str]] = []
1784
+ _files: Dict[
1785
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
1786
+ ] = {}
1787
+ _body_params: Optional[bytes] = None
1788
+
1789
+ # process the path parameters
1790
+ # process the query parameters
1791
+ # process the header parameters
1792
+ # process the form parameters
1793
+ # process the body parameter
1794
+
1795
+
1796
+ # set the HTTP header `Accept`
1797
+ if 'Accept' not in _header_params:
1798
+ _header_params['Accept'] = self.api_client.select_header_accept(
1799
+ [
1800
+ 'application/json'
1801
+ ]
1802
+ )
1803
+
1804
+
1805
+ # authentication setting
1806
+ _auth_settings: List[str] = [
1807
+ 'QAnswer-Api-Key',
1808
+ 'Bearer token'
1809
+ ]
1810
+
1811
+ return self.api_client.param_serialize(
1812
+ method='GET',
1813
+ resource_path='/backend/api/metadata/embedder/available-choices',
1814
+ path_params=_path_params,
1815
+ query_params=_query_params,
1816
+ header_params=_header_params,
1817
+ body=_body_params,
1818
+ post_params=_form_params,
1819
+ files=_files,
1820
+ auth_settings=_auth_settings,
1821
+ collection_formats=_collection_formats,
1822
+ _host=_host,
1823
+ _request_auth=_request_auth
1824
+ )
1825
+
1826
+
1827
+
1828
+
1829
+ @validate_call
1830
+ def read_llm_available_choices(
1831
+ self,
1832
+ _request_timeout: Union[
1833
+ None,
1834
+ Annotated[StrictFloat, Field(gt=0)],
1835
+ Tuple[
1836
+ Annotated[StrictFloat, Field(gt=0)],
1837
+ Annotated[StrictFloat, Field(gt=0)]
1838
+ ]
1839
+ ] = None,
1840
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1841
+ _content_type: Optional[StrictStr] = None,
1842
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1843
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1844
+ ) -> AvailableEndpointsResponse:
1845
+ """Read Llm Available Choices
1846
+
1847
+
1848
+ :param _request_timeout: timeout setting for this request. If one
1849
+ number provided, it will be total request
1850
+ timeout. It can also be a pair (tuple) of
1851
+ (connection, read) timeouts.
1852
+ :type _request_timeout: int, tuple(int, int), optional
1853
+ :param _request_auth: set to override the auth_settings for an a single
1854
+ request; this effectively ignores the
1855
+ authentication in the spec for a single request.
1856
+ :type _request_auth: dict, optional
1857
+ :param _content_type: force content-type for the request.
1858
+ :type _content_type: str, Optional
1859
+ :param _headers: set to override the headers for a single
1860
+ request; this effectively ignores the headers
1861
+ in the spec for a single request.
1862
+ :type _headers: dict, optional
1863
+ :param _host_index: set to override the host_index for a single
1864
+ request; this effectively ignores the host_index
1865
+ in the spec for a single request.
1866
+ :type _host_index: int, optional
1867
+ :return: Returns the result object.
1868
+ """ # noqa: E501
1869
+
1870
+ _param = self._read_llm_available_choices_serialize(
1871
+ _request_auth=_request_auth,
1872
+ _content_type=_content_type,
1873
+ _headers=_headers,
1874
+ _host_index=_host_index
1875
+ )
1876
+
1877
+ _response_types_map: Dict[str, Optional[str]] = {
1878
+ '200': "AvailableEndpointsResponse",
1879
+ }
1880
+ response_data = self.api_client.call_api(
1881
+ *_param,
1882
+ _request_timeout=_request_timeout
1883
+ )
1884
+ response_data.read()
1885
+ return self.api_client.response_deserialize(
1886
+ response_data=response_data,
1887
+ response_types_map=_response_types_map,
1888
+ ).data
1889
+
1890
+
1891
+ @validate_call
1892
+ def read_llm_available_choices_with_http_info(
1893
+ self,
1894
+ _request_timeout: Union[
1895
+ None,
1896
+ Annotated[StrictFloat, Field(gt=0)],
1897
+ Tuple[
1898
+ Annotated[StrictFloat, Field(gt=0)],
1899
+ Annotated[StrictFloat, Field(gt=0)]
1900
+ ]
1901
+ ] = None,
1902
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1903
+ _content_type: Optional[StrictStr] = None,
1904
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1905
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1906
+ ) -> ApiResponse[AvailableEndpointsResponse]:
1907
+ """Read Llm Available Choices
1908
+
1909
+
1910
+ :param _request_timeout: timeout setting for this request. If one
1911
+ number provided, it will be total request
1912
+ timeout. It can also be a pair (tuple) of
1913
+ (connection, read) timeouts.
1914
+ :type _request_timeout: int, tuple(int, int), optional
1915
+ :param _request_auth: set to override the auth_settings for an a single
1916
+ request; this effectively ignores the
1917
+ authentication in the spec for a single request.
1918
+ :type _request_auth: dict, optional
1919
+ :param _content_type: force content-type for the request.
1920
+ :type _content_type: str, Optional
1921
+ :param _headers: set to override the headers for a single
1922
+ request; this effectively ignores the headers
1923
+ in the spec for a single request.
1924
+ :type _headers: dict, optional
1925
+ :param _host_index: set to override the host_index for a single
1926
+ request; this effectively ignores the host_index
1927
+ in the spec for a single request.
1928
+ :type _host_index: int, optional
1929
+ :return: Returns the result object.
1930
+ """ # noqa: E501
1931
+
1932
+ _param = self._read_llm_available_choices_serialize(
1933
+ _request_auth=_request_auth,
1934
+ _content_type=_content_type,
1935
+ _headers=_headers,
1936
+ _host_index=_host_index
1937
+ )
1938
+
1939
+ _response_types_map: Dict[str, Optional[str]] = {
1940
+ '200': "AvailableEndpointsResponse",
1941
+ }
1942
+ response_data = self.api_client.call_api(
1943
+ *_param,
1944
+ _request_timeout=_request_timeout
1945
+ )
1946
+ response_data.read()
1947
+ return self.api_client.response_deserialize(
1948
+ response_data=response_data,
1949
+ response_types_map=_response_types_map,
1950
+ )
1951
+
1952
+
1953
+ @validate_call
1954
+ def read_llm_available_choices_without_preload_content(
1955
+ self,
1956
+ _request_timeout: Union[
1957
+ None,
1958
+ Annotated[StrictFloat, Field(gt=0)],
1959
+ Tuple[
1960
+ Annotated[StrictFloat, Field(gt=0)],
1961
+ Annotated[StrictFloat, Field(gt=0)]
1962
+ ]
1963
+ ] = None,
1964
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1965
+ _content_type: Optional[StrictStr] = None,
1966
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1967
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1968
+ ) -> RESTResponseType:
1969
+ """Read Llm Available Choices
1970
+
1971
+
1972
+ :param _request_timeout: timeout setting for this request. If one
1973
+ number provided, it will be total request
1974
+ timeout. It can also be a pair (tuple) of
1975
+ (connection, read) timeouts.
1976
+ :type _request_timeout: int, tuple(int, int), optional
1977
+ :param _request_auth: set to override the auth_settings for an a single
1978
+ request; this effectively ignores the
1979
+ authentication in the spec for a single request.
1980
+ :type _request_auth: dict, optional
1981
+ :param _content_type: force content-type for the request.
1982
+ :type _content_type: str, Optional
1983
+ :param _headers: set to override the headers for a single
1984
+ request; this effectively ignores the headers
1985
+ in the spec for a single request.
1986
+ :type _headers: dict, optional
1987
+ :param _host_index: set to override the host_index for a single
1988
+ request; this effectively ignores the host_index
1989
+ in the spec for a single request.
1990
+ :type _host_index: int, optional
1991
+ :return: Returns the result object.
1992
+ """ # noqa: E501
1993
+
1994
+ _param = self._read_llm_available_choices_serialize(
1995
+ _request_auth=_request_auth,
1996
+ _content_type=_content_type,
1997
+ _headers=_headers,
1998
+ _host_index=_host_index
1999
+ )
2000
+
2001
+ _response_types_map: Dict[str, Optional[str]] = {
2002
+ '200': "AvailableEndpointsResponse",
2003
+ }
2004
+ response_data = self.api_client.call_api(
2005
+ *_param,
2006
+ _request_timeout=_request_timeout
2007
+ )
2008
+ return response_data.response
2009
+
2010
+
2011
+ def _read_llm_available_choices_serialize(
2012
+ self,
2013
+ _request_auth,
2014
+ _content_type,
2015
+ _headers,
2016
+ _host_index,
2017
+ ) -> RequestSerialized:
2018
+
2019
+ _host = None
2020
+
2021
+ _collection_formats: Dict[str, str] = {
2022
+ }
2023
+
2024
+ _path_params: Dict[str, str] = {}
2025
+ _query_params: List[Tuple[str, str]] = []
2026
+ _header_params: Dict[str, Optional[str]] = _headers or {}
2027
+ _form_params: List[Tuple[str, str]] = []
2028
+ _files: Dict[
2029
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
2030
+ ] = {}
2031
+ _body_params: Optional[bytes] = None
2032
+
2033
+ # process the path parameters
2034
+ # process the query parameters
2035
+ # process the header parameters
2036
+ # process the form parameters
2037
+ # process the body parameter
2038
+
2039
+
2040
+ # set the HTTP header `Accept`
2041
+ if 'Accept' not in _header_params:
2042
+ _header_params['Accept'] = self.api_client.select_header_accept(
2043
+ [
2044
+ 'application/json'
2045
+ ]
2046
+ )
2047
+
2048
+
2049
+ # authentication setting
2050
+ _auth_settings: List[str] = [
2051
+ 'QAnswer-Api-Key',
2052
+ 'Bearer token'
2053
+ ]
2054
+
2055
+ return self.api_client.param_serialize(
2056
+ method='GET',
2057
+ resource_path='/backend/api/metadata/llm/available-choices',
2058
+ path_params=_path_params,
2059
+ query_params=_query_params,
2060
+ header_params=_header_params,
2061
+ body=_body_params,
2062
+ post_params=_form_params,
2063
+ files=_files,
2064
+ auth_settings=_auth_settings,
2065
+ collection_formats=_collection_formats,
2066
+ _host=_host,
2067
+ _request_auth=_request_auth
2068
+ )
2069
+
2070
+