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,2598 @@
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, StrictInt, StrictStr, field_validator
20
+ from typing import Any, List, Optional
21
+ from typing_extensions import Annotated
22
+ from qanswer_sdk.models.aggregations_group import AggregationsGroup
23
+ from qanswer_sdk.models.assistant_message_stop import AssistantMessageStop
24
+ from qanswer_sdk.models.available_aggregation import AvailableAggregation
25
+ from qanswer_sdk.models.chat_task_settings import ChatTaskSettings
26
+ from qanswer_sdk.models.chat_task_settings_update_payload import ChatTaskSettingsUpdatePayload
27
+ from qanswer_sdk.models.enable_enhanced_context_payload import EnableEnhancedContextPayload
28
+ from qanswer_sdk.models.enable_enhanced_context_response import EnableEnhancedContextResponse
29
+ from qanswer_sdk.models.get_aggregations_payload import GetAggregationsPayload
30
+ from qanswer_sdk.models.llm_endpoint import LLMEndpoint
31
+ from qanswer_sdk.models.question_suggestion_response import QuestionSuggestionResponse
32
+ from qanswer_sdk.models.rag_payload import RAGPayload
33
+ from qanswer_sdk.models.rag_response import RAGResponse
34
+
35
+ from qanswer_sdk.api_client import ApiClient, RequestSerialized
36
+ from qanswer_sdk.api_response import ApiResponse
37
+ from qanswer_sdk.rest import RESTResponseType
38
+
39
+
40
+ class TaskChatApi:
41
+ """NOTE: This class is auto generated by OpenAPI Generator
42
+ Ref: https://openapi-generator.tech
43
+
44
+ Do not edit the class manually.
45
+ """
46
+
47
+ def __init__(self, api_client=None) -> None:
48
+ if api_client is None:
49
+ api_client = ApiClient.get_default()
50
+ self.api_client = api_client
51
+
52
+
53
+ @validate_call
54
+ def dummy_llm_endpoint(
55
+ self,
56
+ _request_timeout: Union[
57
+ None,
58
+ Annotated[StrictFloat, Field(gt=0)],
59
+ Tuple[
60
+ Annotated[StrictFloat, Field(gt=0)],
61
+ Annotated[StrictFloat, Field(gt=0)]
62
+ ]
63
+ ] = None,
64
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
65
+ _content_type: Optional[StrictStr] = None,
66
+ _headers: Optional[Dict[StrictStr, Any]] = None,
67
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
68
+ ) -> LLMEndpoint:
69
+ """Dummy Llm Endpoint
70
+
71
+
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
+
94
+ _param = self._dummy_llm_endpoint_serialize(
95
+ _request_auth=_request_auth,
96
+ _content_type=_content_type,
97
+ _headers=_headers,
98
+ _host_index=_host_index
99
+ )
100
+
101
+ _response_types_map: Dict[str, Optional[str]] = {
102
+ '200': "LLMEndpoint",
103
+ }
104
+ response_data = self.api_client.call_api(
105
+ *_param,
106
+ _request_timeout=_request_timeout
107
+ )
108
+ response_data.read()
109
+ return self.api_client.response_deserialize(
110
+ response_data=response_data,
111
+ response_types_map=_response_types_map,
112
+ ).data
113
+
114
+
115
+ @validate_call
116
+ def dummy_llm_endpoint_with_http_info(
117
+ self,
118
+ _request_timeout: Union[
119
+ None,
120
+ Annotated[StrictFloat, Field(gt=0)],
121
+ Tuple[
122
+ Annotated[StrictFloat, Field(gt=0)],
123
+ Annotated[StrictFloat, Field(gt=0)]
124
+ ]
125
+ ] = None,
126
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
127
+ _content_type: Optional[StrictStr] = None,
128
+ _headers: Optional[Dict[StrictStr, Any]] = None,
129
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
130
+ ) -> ApiResponse[LLMEndpoint]:
131
+ """Dummy Llm Endpoint
132
+
133
+
134
+ :param _request_timeout: timeout setting for this request. If one
135
+ number provided, it will be total request
136
+ timeout. It can also be a pair (tuple) of
137
+ (connection, read) timeouts.
138
+ :type _request_timeout: int, tuple(int, int), optional
139
+ :param _request_auth: set to override the auth_settings for an a single
140
+ request; this effectively ignores the
141
+ authentication in the spec for a single request.
142
+ :type _request_auth: dict, optional
143
+ :param _content_type: force content-type for the request.
144
+ :type _content_type: str, Optional
145
+ :param _headers: set to override the headers for a single
146
+ request; this effectively ignores the headers
147
+ in the spec for a single request.
148
+ :type _headers: dict, optional
149
+ :param _host_index: set to override the host_index for a single
150
+ request; this effectively ignores the host_index
151
+ in the spec for a single request.
152
+ :type _host_index: int, optional
153
+ :return: Returns the result object.
154
+ """ # noqa: E501
155
+
156
+ _param = self._dummy_llm_endpoint_serialize(
157
+ _request_auth=_request_auth,
158
+ _content_type=_content_type,
159
+ _headers=_headers,
160
+ _host_index=_host_index
161
+ )
162
+
163
+ _response_types_map: Dict[str, Optional[str]] = {
164
+ '200': "LLMEndpoint",
165
+ }
166
+ response_data = self.api_client.call_api(
167
+ *_param,
168
+ _request_timeout=_request_timeout
169
+ )
170
+ response_data.read()
171
+ return self.api_client.response_deserialize(
172
+ response_data=response_data,
173
+ response_types_map=_response_types_map,
174
+ )
175
+
176
+
177
+ @validate_call
178
+ def dummy_llm_endpoint_without_preload_content(
179
+ self,
180
+ _request_timeout: Union[
181
+ None,
182
+ Annotated[StrictFloat, Field(gt=0)],
183
+ Tuple[
184
+ Annotated[StrictFloat, Field(gt=0)],
185
+ Annotated[StrictFloat, Field(gt=0)]
186
+ ]
187
+ ] = None,
188
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
189
+ _content_type: Optional[StrictStr] = None,
190
+ _headers: Optional[Dict[StrictStr, Any]] = None,
191
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
192
+ ) -> RESTResponseType:
193
+ """Dummy Llm Endpoint
194
+
195
+
196
+ :param _request_timeout: timeout setting for this request. If one
197
+ number provided, it will be total request
198
+ timeout. It can also be a pair (tuple) of
199
+ (connection, read) timeouts.
200
+ :type _request_timeout: int, tuple(int, int), optional
201
+ :param _request_auth: set to override the auth_settings for an a single
202
+ request; this effectively ignores the
203
+ authentication in the spec for a single request.
204
+ :type _request_auth: dict, optional
205
+ :param _content_type: force content-type for the request.
206
+ :type _content_type: str, Optional
207
+ :param _headers: set to override the headers for a single
208
+ request; this effectively ignores the headers
209
+ in the spec for a single request.
210
+ :type _headers: dict, optional
211
+ :param _host_index: set to override the host_index for a single
212
+ request; this effectively ignores the host_index
213
+ in the spec for a single request.
214
+ :type _host_index: int, optional
215
+ :return: Returns the result object.
216
+ """ # noqa: E501
217
+
218
+ _param = self._dummy_llm_endpoint_serialize(
219
+ _request_auth=_request_auth,
220
+ _content_type=_content_type,
221
+ _headers=_headers,
222
+ _host_index=_host_index
223
+ )
224
+
225
+ _response_types_map: Dict[str, Optional[str]] = {
226
+ '200': "LLMEndpoint",
227
+ }
228
+ response_data = self.api_client.call_api(
229
+ *_param,
230
+ _request_timeout=_request_timeout
231
+ )
232
+ return response_data.response
233
+
234
+
235
+ def _dummy_llm_endpoint_serialize(
236
+ self,
237
+ _request_auth,
238
+ _content_type,
239
+ _headers,
240
+ _host_index,
241
+ ) -> RequestSerialized:
242
+
243
+ _host = None
244
+
245
+ _collection_formats: Dict[str, str] = {
246
+ }
247
+
248
+ _path_params: Dict[str, str] = {}
249
+ _query_params: List[Tuple[str, str]] = []
250
+ _header_params: Dict[str, Optional[str]] = _headers or {}
251
+ _form_params: List[Tuple[str, str]] = []
252
+ _files: Dict[
253
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
254
+ ] = {}
255
+ _body_params: Optional[bytes] = None
256
+
257
+ # process the path parameters
258
+ # process the query parameters
259
+ # process the header parameters
260
+ # process the form parameters
261
+ # process the body parameter
262
+
263
+
264
+ # set the HTTP header `Accept`
265
+ if 'Accept' not in _header_params:
266
+ _header_params['Accept'] = self.api_client.select_header_accept(
267
+ [
268
+ 'application/json'
269
+ ]
270
+ )
271
+
272
+
273
+ # authentication setting
274
+ _auth_settings: List[str] = [
275
+ ]
276
+
277
+ return self.api_client.param_serialize(
278
+ method='GET',
279
+ resource_path='/backend/api/tasks/chat/dummy-llm-endpoint',
280
+ path_params=_path_params,
281
+ query_params=_query_params,
282
+ header_params=_header_params,
283
+ body=_body_params,
284
+ post_params=_form_params,
285
+ files=_files,
286
+ auth_settings=_auth_settings,
287
+ collection_formats=_collection_formats,
288
+ _host=_host,
289
+ _request_auth=_request_auth
290
+ )
291
+
292
+
293
+
294
+
295
+ @validate_call
296
+ def enable_enhanced_context_chat(
297
+ self,
298
+ enable_enhanced_context_payload: EnableEnhancedContextPayload,
299
+ _request_timeout: Union[
300
+ None,
301
+ Annotated[StrictFloat, Field(gt=0)],
302
+ Tuple[
303
+ Annotated[StrictFloat, Field(gt=0)],
304
+ Annotated[StrictFloat, Field(gt=0)]
305
+ ]
306
+ ] = None,
307
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
308
+ _content_type: Optional[StrictStr] = None,
309
+ _headers: Optional[Dict[StrictStr, Any]] = None,
310
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
311
+ ) -> EnableEnhancedContextResponse:
312
+ """Update Enable Enhanced Context Chat
313
+
314
+
315
+ :param enable_enhanced_context_payload: (required)
316
+ :type enable_enhanced_context_payload: EnableEnhancedContextPayload
317
+ :param _request_timeout: timeout setting for this request. If one
318
+ number provided, it will be total request
319
+ timeout. It can also be a pair (tuple) of
320
+ (connection, read) timeouts.
321
+ :type _request_timeout: int, tuple(int, int), optional
322
+ :param _request_auth: set to override the auth_settings for an a single
323
+ request; this effectively ignores the
324
+ authentication in the spec for a single request.
325
+ :type _request_auth: dict, optional
326
+ :param _content_type: force content-type for the request.
327
+ :type _content_type: str, Optional
328
+ :param _headers: set to override the headers for a single
329
+ request; this effectively ignores the headers
330
+ in the spec for a single request.
331
+ :type _headers: dict, optional
332
+ :param _host_index: set to override the host_index for a single
333
+ request; this effectively ignores the host_index
334
+ in the spec for a single request.
335
+ :type _host_index: int, optional
336
+ :return: Returns the result object.
337
+ """ # noqa: E501
338
+
339
+ _param = self._enable_enhanced_context_chat_serialize(
340
+ enable_enhanced_context_payload=enable_enhanced_context_payload,
341
+ _request_auth=_request_auth,
342
+ _content_type=_content_type,
343
+ _headers=_headers,
344
+ _host_index=_host_index
345
+ )
346
+
347
+ _response_types_map: Dict[str, Optional[str]] = {
348
+ '200': "EnableEnhancedContextResponse",
349
+ '422': "HTTPValidationError",
350
+ }
351
+ response_data = self.api_client.call_api(
352
+ *_param,
353
+ _request_timeout=_request_timeout
354
+ )
355
+ response_data.read()
356
+ return self.api_client.response_deserialize(
357
+ response_data=response_data,
358
+ response_types_map=_response_types_map,
359
+ ).data
360
+
361
+
362
+ @validate_call
363
+ def enable_enhanced_context_chat_with_http_info(
364
+ self,
365
+ enable_enhanced_context_payload: EnableEnhancedContextPayload,
366
+ _request_timeout: Union[
367
+ None,
368
+ Annotated[StrictFloat, Field(gt=0)],
369
+ Tuple[
370
+ Annotated[StrictFloat, Field(gt=0)],
371
+ Annotated[StrictFloat, Field(gt=0)]
372
+ ]
373
+ ] = None,
374
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
375
+ _content_type: Optional[StrictStr] = None,
376
+ _headers: Optional[Dict[StrictStr, Any]] = None,
377
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
378
+ ) -> ApiResponse[EnableEnhancedContextResponse]:
379
+ """Update Enable Enhanced Context Chat
380
+
381
+
382
+ :param enable_enhanced_context_payload: (required)
383
+ :type enable_enhanced_context_payload: EnableEnhancedContextPayload
384
+ :param _request_timeout: timeout setting for this request. If one
385
+ number provided, it will be total request
386
+ timeout. It can also be a pair (tuple) of
387
+ (connection, read) timeouts.
388
+ :type _request_timeout: int, tuple(int, int), optional
389
+ :param _request_auth: set to override the auth_settings for an a single
390
+ request; this effectively ignores the
391
+ authentication in the spec for a single request.
392
+ :type _request_auth: dict, optional
393
+ :param _content_type: force content-type for the request.
394
+ :type _content_type: str, Optional
395
+ :param _headers: set to override the headers for a single
396
+ request; this effectively ignores the headers
397
+ in the spec for a single request.
398
+ :type _headers: dict, optional
399
+ :param _host_index: set to override the host_index for a single
400
+ request; this effectively ignores the host_index
401
+ in the spec for a single request.
402
+ :type _host_index: int, optional
403
+ :return: Returns the result object.
404
+ """ # noqa: E501
405
+
406
+ _param = self._enable_enhanced_context_chat_serialize(
407
+ enable_enhanced_context_payload=enable_enhanced_context_payload,
408
+ _request_auth=_request_auth,
409
+ _content_type=_content_type,
410
+ _headers=_headers,
411
+ _host_index=_host_index
412
+ )
413
+
414
+ _response_types_map: Dict[str, Optional[str]] = {
415
+ '200': "EnableEnhancedContextResponse",
416
+ '422': "HTTPValidationError",
417
+ }
418
+ response_data = self.api_client.call_api(
419
+ *_param,
420
+ _request_timeout=_request_timeout
421
+ )
422
+ response_data.read()
423
+ return self.api_client.response_deserialize(
424
+ response_data=response_data,
425
+ response_types_map=_response_types_map,
426
+ )
427
+
428
+
429
+ @validate_call
430
+ def enable_enhanced_context_chat_without_preload_content(
431
+ self,
432
+ enable_enhanced_context_payload: EnableEnhancedContextPayload,
433
+ _request_timeout: Union[
434
+ None,
435
+ Annotated[StrictFloat, Field(gt=0)],
436
+ Tuple[
437
+ Annotated[StrictFloat, Field(gt=0)],
438
+ Annotated[StrictFloat, Field(gt=0)]
439
+ ]
440
+ ] = None,
441
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
442
+ _content_type: Optional[StrictStr] = None,
443
+ _headers: Optional[Dict[StrictStr, Any]] = None,
444
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
445
+ ) -> RESTResponseType:
446
+ """Update Enable Enhanced Context Chat
447
+
448
+
449
+ :param enable_enhanced_context_payload: (required)
450
+ :type enable_enhanced_context_payload: EnableEnhancedContextPayload
451
+ :param _request_timeout: timeout setting for this request. If one
452
+ number provided, it will be total request
453
+ timeout. It can also be a pair (tuple) of
454
+ (connection, read) timeouts.
455
+ :type _request_timeout: int, tuple(int, int), optional
456
+ :param _request_auth: set to override the auth_settings for an a single
457
+ request; this effectively ignores the
458
+ authentication in the spec for a single request.
459
+ :type _request_auth: dict, optional
460
+ :param _content_type: force content-type for the request.
461
+ :type _content_type: str, Optional
462
+ :param _headers: set to override the headers for a single
463
+ request; this effectively ignores the headers
464
+ in the spec for a single request.
465
+ :type _headers: dict, optional
466
+ :param _host_index: set to override the host_index for a single
467
+ request; this effectively ignores the host_index
468
+ in the spec for a single request.
469
+ :type _host_index: int, optional
470
+ :return: Returns the result object.
471
+ """ # noqa: E501
472
+
473
+ _param = self._enable_enhanced_context_chat_serialize(
474
+ enable_enhanced_context_payload=enable_enhanced_context_payload,
475
+ _request_auth=_request_auth,
476
+ _content_type=_content_type,
477
+ _headers=_headers,
478
+ _host_index=_host_index
479
+ )
480
+
481
+ _response_types_map: Dict[str, Optional[str]] = {
482
+ '200': "EnableEnhancedContextResponse",
483
+ '422': "HTTPValidationError",
484
+ }
485
+ response_data = self.api_client.call_api(
486
+ *_param,
487
+ _request_timeout=_request_timeout
488
+ )
489
+ return response_data.response
490
+
491
+
492
+ def _enable_enhanced_context_chat_serialize(
493
+ self,
494
+ enable_enhanced_context_payload,
495
+ _request_auth,
496
+ _content_type,
497
+ _headers,
498
+ _host_index,
499
+ ) -> RequestSerialized:
500
+
501
+ _host = None
502
+
503
+ _collection_formats: Dict[str, str] = {
504
+ }
505
+
506
+ _path_params: Dict[str, str] = {}
507
+ _query_params: List[Tuple[str, str]] = []
508
+ _header_params: Dict[str, Optional[str]] = _headers or {}
509
+ _form_params: List[Tuple[str, str]] = []
510
+ _files: Dict[
511
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
512
+ ] = {}
513
+ _body_params: Optional[bytes] = None
514
+
515
+ # process the path parameters
516
+ # process the query parameters
517
+ # process the header parameters
518
+ # process the form parameters
519
+ # process the body parameter
520
+ if enable_enhanced_context_payload is not None:
521
+ _body_params = enable_enhanced_context_payload
522
+
523
+
524
+ # set the HTTP header `Accept`
525
+ if 'Accept' not in _header_params:
526
+ _header_params['Accept'] = self.api_client.select_header_accept(
527
+ [
528
+ 'application/json'
529
+ ]
530
+ )
531
+
532
+ # set the HTTP header `Content-Type`
533
+ if _content_type:
534
+ _header_params['Content-Type'] = _content_type
535
+ else:
536
+ _default_content_type = (
537
+ self.api_client.select_header_content_type(
538
+ [
539
+ 'application/json'
540
+ ]
541
+ )
542
+ )
543
+ if _default_content_type is not None:
544
+ _header_params['Content-Type'] = _default_content_type
545
+
546
+ # authentication setting
547
+ _auth_settings: List[str] = [
548
+ 'QAnswer-Api-Key',
549
+ 'Bearer token'
550
+ ]
551
+
552
+ return self.api_client.param_serialize(
553
+ method='PUT',
554
+ resource_path='/backend/api/tasks/chat/enable-enhanced-context',
555
+ path_params=_path_params,
556
+ query_params=_query_params,
557
+ header_params=_header_params,
558
+ body=_body_params,
559
+ post_params=_form_params,
560
+ files=_files,
561
+ auth_settings=_auth_settings,
562
+ collection_formats=_collection_formats,
563
+ _host=_host,
564
+ _request_auth=_request_auth
565
+ )
566
+
567
+
568
+
569
+
570
+ @validate_call
571
+ def free_text_chat_task_read_settings(
572
+ self,
573
+ username: StrictStr,
574
+ dataset: StrictStr,
575
+ organization_id: Annotated[Optional[StrictInt], Field(description="organization identifier")] = None,
576
+ _request_timeout: Union[
577
+ None,
578
+ Annotated[StrictFloat, Field(gt=0)],
579
+ Tuple[
580
+ Annotated[StrictFloat, Field(gt=0)],
581
+ Annotated[StrictFloat, Field(gt=0)]
582
+ ]
583
+ ] = None,
584
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
585
+ _content_type: Optional[StrictStr] = None,
586
+ _headers: Optional[Dict[StrictStr, Any]] = None,
587
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
588
+ ) -> ChatTaskSettings:
589
+ """Read Chat Task Settings
590
+
591
+
592
+ :param username: (required)
593
+ :type username: str
594
+ :param dataset: (required)
595
+ :type dataset: str
596
+ :param organization_id: organization identifier
597
+ :type organization_id: int
598
+ :param _request_timeout: timeout setting for this request. If one
599
+ number provided, it will be total request
600
+ timeout. It can also be a pair (tuple) of
601
+ (connection, read) timeouts.
602
+ :type _request_timeout: int, tuple(int, int), optional
603
+ :param _request_auth: set to override the auth_settings for an a single
604
+ request; this effectively ignores the
605
+ authentication in the spec for a single request.
606
+ :type _request_auth: dict, optional
607
+ :param _content_type: force content-type for the request.
608
+ :type _content_type: str, Optional
609
+ :param _headers: set to override the headers for a single
610
+ request; this effectively ignores the headers
611
+ in the spec for a single request.
612
+ :type _headers: dict, optional
613
+ :param _host_index: set to override the host_index for a single
614
+ request; this effectively ignores the host_index
615
+ in the spec for a single request.
616
+ :type _host_index: int, optional
617
+ :return: Returns the result object.
618
+ """ # noqa: E501
619
+
620
+ _param = self._free_text_chat_task_read_settings_serialize(
621
+ username=username,
622
+ dataset=dataset,
623
+ organization_id=organization_id,
624
+ _request_auth=_request_auth,
625
+ _content_type=_content_type,
626
+ _headers=_headers,
627
+ _host_index=_host_index
628
+ )
629
+
630
+ _response_types_map: Dict[str, Optional[str]] = {
631
+ '200': "ChatTaskSettings",
632
+ '422': "HTTPValidationError",
633
+ }
634
+ response_data = self.api_client.call_api(
635
+ *_param,
636
+ _request_timeout=_request_timeout
637
+ )
638
+ response_data.read()
639
+ return self.api_client.response_deserialize(
640
+ response_data=response_data,
641
+ response_types_map=_response_types_map,
642
+ ).data
643
+
644
+
645
+ @validate_call
646
+ def free_text_chat_task_read_settings_with_http_info(
647
+ self,
648
+ username: StrictStr,
649
+ dataset: StrictStr,
650
+ organization_id: Annotated[Optional[StrictInt], Field(description="organization identifier")] = None,
651
+ _request_timeout: Union[
652
+ None,
653
+ Annotated[StrictFloat, Field(gt=0)],
654
+ Tuple[
655
+ Annotated[StrictFloat, Field(gt=0)],
656
+ Annotated[StrictFloat, Field(gt=0)]
657
+ ]
658
+ ] = None,
659
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
660
+ _content_type: Optional[StrictStr] = None,
661
+ _headers: Optional[Dict[StrictStr, Any]] = None,
662
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
663
+ ) -> ApiResponse[ChatTaskSettings]:
664
+ """Read Chat Task Settings
665
+
666
+
667
+ :param username: (required)
668
+ :type username: str
669
+ :param dataset: (required)
670
+ :type dataset: str
671
+ :param organization_id: organization identifier
672
+ :type organization_id: int
673
+ :param _request_timeout: timeout setting for this request. If one
674
+ number provided, it will be total request
675
+ timeout. It can also be a pair (tuple) of
676
+ (connection, read) timeouts.
677
+ :type _request_timeout: int, tuple(int, int), optional
678
+ :param _request_auth: set to override the auth_settings for an a single
679
+ request; this effectively ignores the
680
+ authentication in the spec for a single request.
681
+ :type _request_auth: dict, optional
682
+ :param _content_type: force content-type for the request.
683
+ :type _content_type: str, Optional
684
+ :param _headers: set to override the headers for a single
685
+ request; this effectively ignores the headers
686
+ in the spec for a single request.
687
+ :type _headers: dict, optional
688
+ :param _host_index: set to override the host_index for a single
689
+ request; this effectively ignores the host_index
690
+ in the spec for a single request.
691
+ :type _host_index: int, optional
692
+ :return: Returns the result object.
693
+ """ # noqa: E501
694
+
695
+ _param = self._free_text_chat_task_read_settings_serialize(
696
+ username=username,
697
+ dataset=dataset,
698
+ organization_id=organization_id,
699
+ _request_auth=_request_auth,
700
+ _content_type=_content_type,
701
+ _headers=_headers,
702
+ _host_index=_host_index
703
+ )
704
+
705
+ _response_types_map: Dict[str, Optional[str]] = {
706
+ '200': "ChatTaskSettings",
707
+ '422': "HTTPValidationError",
708
+ }
709
+ response_data = self.api_client.call_api(
710
+ *_param,
711
+ _request_timeout=_request_timeout
712
+ )
713
+ response_data.read()
714
+ return self.api_client.response_deserialize(
715
+ response_data=response_data,
716
+ response_types_map=_response_types_map,
717
+ )
718
+
719
+
720
+ @validate_call
721
+ def free_text_chat_task_read_settings_without_preload_content(
722
+ self,
723
+ username: StrictStr,
724
+ dataset: StrictStr,
725
+ organization_id: Annotated[Optional[StrictInt], Field(description="organization identifier")] = None,
726
+ _request_timeout: Union[
727
+ None,
728
+ Annotated[StrictFloat, Field(gt=0)],
729
+ Tuple[
730
+ Annotated[StrictFloat, Field(gt=0)],
731
+ Annotated[StrictFloat, Field(gt=0)]
732
+ ]
733
+ ] = None,
734
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
735
+ _content_type: Optional[StrictStr] = None,
736
+ _headers: Optional[Dict[StrictStr, Any]] = None,
737
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
738
+ ) -> RESTResponseType:
739
+ """Read Chat Task Settings
740
+
741
+
742
+ :param username: (required)
743
+ :type username: str
744
+ :param dataset: (required)
745
+ :type dataset: str
746
+ :param organization_id: organization identifier
747
+ :type organization_id: int
748
+ :param _request_timeout: timeout setting for this request. If one
749
+ number provided, it will be total request
750
+ timeout. It can also be a pair (tuple) of
751
+ (connection, read) timeouts.
752
+ :type _request_timeout: int, tuple(int, int), optional
753
+ :param _request_auth: set to override the auth_settings for an a single
754
+ request; this effectively ignores the
755
+ authentication in the spec for a single request.
756
+ :type _request_auth: dict, optional
757
+ :param _content_type: force content-type for the request.
758
+ :type _content_type: str, Optional
759
+ :param _headers: set to override the headers for a single
760
+ request; this effectively ignores the headers
761
+ in the spec for a single request.
762
+ :type _headers: dict, optional
763
+ :param _host_index: set to override the host_index for a single
764
+ request; this effectively ignores the host_index
765
+ in the spec for a single request.
766
+ :type _host_index: int, optional
767
+ :return: Returns the result object.
768
+ """ # noqa: E501
769
+
770
+ _param = self._free_text_chat_task_read_settings_serialize(
771
+ username=username,
772
+ dataset=dataset,
773
+ organization_id=organization_id,
774
+ _request_auth=_request_auth,
775
+ _content_type=_content_type,
776
+ _headers=_headers,
777
+ _host_index=_host_index
778
+ )
779
+
780
+ _response_types_map: Dict[str, Optional[str]] = {
781
+ '200': "ChatTaskSettings",
782
+ '422': "HTTPValidationError",
783
+ }
784
+ response_data = self.api_client.call_api(
785
+ *_param,
786
+ _request_timeout=_request_timeout
787
+ )
788
+ return response_data.response
789
+
790
+
791
+ def _free_text_chat_task_read_settings_serialize(
792
+ self,
793
+ username,
794
+ dataset,
795
+ organization_id,
796
+ _request_auth,
797
+ _content_type,
798
+ _headers,
799
+ _host_index,
800
+ ) -> RequestSerialized:
801
+
802
+ _host = None
803
+
804
+ _collection_formats: Dict[str, str] = {
805
+ }
806
+
807
+ _path_params: Dict[str, str] = {}
808
+ _query_params: List[Tuple[str, str]] = []
809
+ _header_params: Dict[str, Optional[str]] = _headers or {}
810
+ _form_params: List[Tuple[str, str]] = []
811
+ _files: Dict[
812
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
813
+ ] = {}
814
+ _body_params: Optional[bytes] = None
815
+
816
+ # process the path parameters
817
+ # process the query parameters
818
+ if username is not None:
819
+
820
+ _query_params.append(('username', username))
821
+
822
+ if dataset is not None:
823
+
824
+ _query_params.append(('dataset', dataset))
825
+
826
+ if organization_id is not None:
827
+
828
+ _query_params.append(('organization_id', organization_id))
829
+
830
+ # process the header parameters
831
+ # process the form parameters
832
+ # process the body parameter
833
+
834
+
835
+ # set the HTTP header `Accept`
836
+ if 'Accept' not in _header_params:
837
+ _header_params['Accept'] = self.api_client.select_header_accept(
838
+ [
839
+ 'application/json'
840
+ ]
841
+ )
842
+
843
+
844
+ # authentication setting
845
+ _auth_settings: List[str] = [
846
+ 'QAnswer-Api-Key',
847
+ 'Bearer token'
848
+ ]
849
+
850
+ return self.api_client.param_serialize(
851
+ method='GET',
852
+ resource_path='/backend/api/tasks/chat/settings',
853
+ path_params=_path_params,
854
+ query_params=_query_params,
855
+ header_params=_header_params,
856
+ body=_body_params,
857
+ post_params=_form_params,
858
+ files=_files,
859
+ auth_settings=_auth_settings,
860
+ collection_formats=_collection_formats,
861
+ _host=_host,
862
+ _request_auth=_request_auth
863
+ )
864
+
865
+
866
+
867
+
868
+ @validate_call
869
+ def free_text_chat_task_stop(
870
+ self,
871
+ assistant_message_stop: AssistantMessageStop,
872
+ _request_timeout: Union[
873
+ None,
874
+ Annotated[StrictFloat, Field(gt=0)],
875
+ Tuple[
876
+ Annotated[StrictFloat, Field(gt=0)],
877
+ Annotated[StrictFloat, Field(gt=0)]
878
+ ]
879
+ ] = None,
880
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
881
+ _content_type: Optional[StrictStr] = None,
882
+ _headers: Optional[Dict[StrictStr, Any]] = None,
883
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
884
+ ) -> object:
885
+ """Task Chat Stop
886
+
887
+
888
+ :param assistant_message_stop: (required)
889
+ :type assistant_message_stop: AssistantMessageStop
890
+ :param _request_timeout: timeout setting for this request. If one
891
+ number provided, it will be total request
892
+ timeout. It can also be a pair (tuple) of
893
+ (connection, read) timeouts.
894
+ :type _request_timeout: int, tuple(int, int), optional
895
+ :param _request_auth: set to override the auth_settings for an a single
896
+ request; this effectively ignores the
897
+ authentication in the spec for a single request.
898
+ :type _request_auth: dict, optional
899
+ :param _content_type: force content-type for the request.
900
+ :type _content_type: str, Optional
901
+ :param _headers: set to override the headers for a single
902
+ request; this effectively ignores the headers
903
+ in the spec for a single request.
904
+ :type _headers: dict, optional
905
+ :param _host_index: set to override the host_index for a single
906
+ request; this effectively ignores the host_index
907
+ in the spec for a single request.
908
+ :type _host_index: int, optional
909
+ :return: Returns the result object.
910
+ """ # noqa: E501
911
+
912
+ _param = self._free_text_chat_task_stop_serialize(
913
+ assistant_message_stop=assistant_message_stop,
914
+ _request_auth=_request_auth,
915
+ _content_type=_content_type,
916
+ _headers=_headers,
917
+ _host_index=_host_index
918
+ )
919
+
920
+ _response_types_map: Dict[str, Optional[str]] = {
921
+ '200': "object",
922
+ '422': "HTTPValidationError",
923
+ }
924
+ response_data = self.api_client.call_api(
925
+ *_param,
926
+ _request_timeout=_request_timeout
927
+ )
928
+ response_data.read()
929
+ return self.api_client.response_deserialize(
930
+ response_data=response_data,
931
+ response_types_map=_response_types_map,
932
+ ).data
933
+
934
+
935
+ @validate_call
936
+ def free_text_chat_task_stop_with_http_info(
937
+ self,
938
+ assistant_message_stop: AssistantMessageStop,
939
+ _request_timeout: Union[
940
+ None,
941
+ Annotated[StrictFloat, Field(gt=0)],
942
+ Tuple[
943
+ Annotated[StrictFloat, Field(gt=0)],
944
+ Annotated[StrictFloat, Field(gt=0)]
945
+ ]
946
+ ] = None,
947
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
948
+ _content_type: Optional[StrictStr] = None,
949
+ _headers: Optional[Dict[StrictStr, Any]] = None,
950
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
951
+ ) -> ApiResponse[object]:
952
+ """Task Chat Stop
953
+
954
+
955
+ :param assistant_message_stop: (required)
956
+ :type assistant_message_stop: AssistantMessageStop
957
+ :param _request_timeout: timeout setting for this request. If one
958
+ number provided, it will be total request
959
+ timeout. It can also be a pair (tuple) of
960
+ (connection, read) timeouts.
961
+ :type _request_timeout: int, tuple(int, int), optional
962
+ :param _request_auth: set to override the auth_settings for an a single
963
+ request; this effectively ignores the
964
+ authentication in the spec for a single request.
965
+ :type _request_auth: dict, optional
966
+ :param _content_type: force content-type for the request.
967
+ :type _content_type: str, Optional
968
+ :param _headers: set to override the headers for a single
969
+ request; this effectively ignores the headers
970
+ in the spec for a single request.
971
+ :type _headers: dict, optional
972
+ :param _host_index: set to override the host_index for a single
973
+ request; this effectively ignores the host_index
974
+ in the spec for a single request.
975
+ :type _host_index: int, optional
976
+ :return: Returns the result object.
977
+ """ # noqa: E501
978
+
979
+ _param = self._free_text_chat_task_stop_serialize(
980
+ assistant_message_stop=assistant_message_stop,
981
+ _request_auth=_request_auth,
982
+ _content_type=_content_type,
983
+ _headers=_headers,
984
+ _host_index=_host_index
985
+ )
986
+
987
+ _response_types_map: Dict[str, Optional[str]] = {
988
+ '200': "object",
989
+ '422': "HTTPValidationError",
990
+ }
991
+ response_data = self.api_client.call_api(
992
+ *_param,
993
+ _request_timeout=_request_timeout
994
+ )
995
+ response_data.read()
996
+ return self.api_client.response_deserialize(
997
+ response_data=response_data,
998
+ response_types_map=_response_types_map,
999
+ )
1000
+
1001
+
1002
+ @validate_call
1003
+ def free_text_chat_task_stop_without_preload_content(
1004
+ self,
1005
+ assistant_message_stop: AssistantMessageStop,
1006
+ _request_timeout: Union[
1007
+ None,
1008
+ Annotated[StrictFloat, Field(gt=0)],
1009
+ Tuple[
1010
+ Annotated[StrictFloat, Field(gt=0)],
1011
+ Annotated[StrictFloat, Field(gt=0)]
1012
+ ]
1013
+ ] = None,
1014
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1015
+ _content_type: Optional[StrictStr] = None,
1016
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1017
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1018
+ ) -> RESTResponseType:
1019
+ """Task Chat Stop
1020
+
1021
+
1022
+ :param assistant_message_stop: (required)
1023
+ :type assistant_message_stop: AssistantMessageStop
1024
+ :param _request_timeout: timeout setting for this request. If one
1025
+ number provided, it will be total request
1026
+ timeout. It can also be a pair (tuple) of
1027
+ (connection, read) timeouts.
1028
+ :type _request_timeout: int, tuple(int, int), optional
1029
+ :param _request_auth: set to override the auth_settings for an a single
1030
+ request; this effectively ignores the
1031
+ authentication in the spec for a single request.
1032
+ :type _request_auth: dict, optional
1033
+ :param _content_type: force content-type for the request.
1034
+ :type _content_type: str, Optional
1035
+ :param _headers: set to override the headers for a single
1036
+ request; this effectively ignores the headers
1037
+ in the spec for a single request.
1038
+ :type _headers: dict, optional
1039
+ :param _host_index: set to override the host_index for a single
1040
+ request; this effectively ignores the host_index
1041
+ in the spec for a single request.
1042
+ :type _host_index: int, optional
1043
+ :return: Returns the result object.
1044
+ """ # noqa: E501
1045
+
1046
+ _param = self._free_text_chat_task_stop_serialize(
1047
+ assistant_message_stop=assistant_message_stop,
1048
+ _request_auth=_request_auth,
1049
+ _content_type=_content_type,
1050
+ _headers=_headers,
1051
+ _host_index=_host_index
1052
+ )
1053
+
1054
+ _response_types_map: Dict[str, Optional[str]] = {
1055
+ '200': "object",
1056
+ '422': "HTTPValidationError",
1057
+ }
1058
+ response_data = self.api_client.call_api(
1059
+ *_param,
1060
+ _request_timeout=_request_timeout
1061
+ )
1062
+ return response_data.response
1063
+
1064
+
1065
+ def _free_text_chat_task_stop_serialize(
1066
+ self,
1067
+ assistant_message_stop,
1068
+ _request_auth,
1069
+ _content_type,
1070
+ _headers,
1071
+ _host_index,
1072
+ ) -> RequestSerialized:
1073
+
1074
+ _host = None
1075
+
1076
+ _collection_formats: Dict[str, str] = {
1077
+ }
1078
+
1079
+ _path_params: Dict[str, str] = {}
1080
+ _query_params: List[Tuple[str, str]] = []
1081
+ _header_params: Dict[str, Optional[str]] = _headers or {}
1082
+ _form_params: List[Tuple[str, str]] = []
1083
+ _files: Dict[
1084
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
1085
+ ] = {}
1086
+ _body_params: Optional[bytes] = None
1087
+
1088
+ # process the path parameters
1089
+ # process the query parameters
1090
+ # process the header parameters
1091
+ # process the form parameters
1092
+ # process the body parameter
1093
+ if assistant_message_stop is not None:
1094
+ _body_params = assistant_message_stop
1095
+
1096
+
1097
+ # set the HTTP header `Accept`
1098
+ if 'Accept' not in _header_params:
1099
+ _header_params['Accept'] = self.api_client.select_header_accept(
1100
+ [
1101
+ 'application/json'
1102
+ ]
1103
+ )
1104
+
1105
+ # set the HTTP header `Content-Type`
1106
+ if _content_type:
1107
+ _header_params['Content-Type'] = _content_type
1108
+ else:
1109
+ _default_content_type = (
1110
+ self.api_client.select_header_content_type(
1111
+ [
1112
+ 'application/json'
1113
+ ]
1114
+ )
1115
+ )
1116
+ if _default_content_type is not None:
1117
+ _header_params['Content-Type'] = _default_content_type
1118
+
1119
+ # authentication setting
1120
+ _auth_settings: List[str] = [
1121
+ 'QAnswer-Api-Key',
1122
+ 'Bearer token'
1123
+ ]
1124
+
1125
+ return self.api_client.param_serialize(
1126
+ method='PUT',
1127
+ resource_path='/backend/api/tasks/chat/stop',
1128
+ path_params=_path_params,
1129
+ query_params=_query_params,
1130
+ header_params=_header_params,
1131
+ body=_body_params,
1132
+ post_params=_form_params,
1133
+ files=_files,
1134
+ auth_settings=_auth_settings,
1135
+ collection_formats=_collection_formats,
1136
+ _host=_host,
1137
+ _request_auth=_request_auth
1138
+ )
1139
+
1140
+
1141
+
1142
+
1143
+ @validate_call
1144
+ def free_text_chat_task_update_settings(
1145
+ self,
1146
+ chat_task_settings_update_payload: ChatTaskSettingsUpdatePayload,
1147
+ _request_timeout: Union[
1148
+ None,
1149
+ Annotated[StrictFloat, Field(gt=0)],
1150
+ Tuple[
1151
+ Annotated[StrictFloat, Field(gt=0)],
1152
+ Annotated[StrictFloat, Field(gt=0)]
1153
+ ]
1154
+ ] = None,
1155
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1156
+ _content_type: Optional[StrictStr] = None,
1157
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1158
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1159
+ ) -> ChatTaskSettings:
1160
+ """Update Chat Task Settings
1161
+
1162
+
1163
+ :param chat_task_settings_update_payload: (required)
1164
+ :type chat_task_settings_update_payload: ChatTaskSettingsUpdatePayload
1165
+ :param _request_timeout: timeout setting for this request. If one
1166
+ number provided, it will be total request
1167
+ timeout. It can also be a pair (tuple) of
1168
+ (connection, read) timeouts.
1169
+ :type _request_timeout: int, tuple(int, int), optional
1170
+ :param _request_auth: set to override the auth_settings for an a single
1171
+ request; this effectively ignores the
1172
+ authentication in the spec for a single request.
1173
+ :type _request_auth: dict, optional
1174
+ :param _content_type: force content-type for the request.
1175
+ :type _content_type: str, Optional
1176
+ :param _headers: set to override the headers for a single
1177
+ request; this effectively ignores the headers
1178
+ in the spec for a single request.
1179
+ :type _headers: dict, optional
1180
+ :param _host_index: set to override the host_index for a single
1181
+ request; this effectively ignores the host_index
1182
+ in the spec for a single request.
1183
+ :type _host_index: int, optional
1184
+ :return: Returns the result object.
1185
+ """ # noqa: E501
1186
+
1187
+ _param = self._free_text_chat_task_update_settings_serialize(
1188
+ chat_task_settings_update_payload=chat_task_settings_update_payload,
1189
+ _request_auth=_request_auth,
1190
+ _content_type=_content_type,
1191
+ _headers=_headers,
1192
+ _host_index=_host_index
1193
+ )
1194
+
1195
+ _response_types_map: Dict[str, Optional[str]] = {
1196
+ '200': "ChatTaskSettings",
1197
+ '422': "HTTPValidationError",
1198
+ }
1199
+ response_data = self.api_client.call_api(
1200
+ *_param,
1201
+ _request_timeout=_request_timeout
1202
+ )
1203
+ response_data.read()
1204
+ return self.api_client.response_deserialize(
1205
+ response_data=response_data,
1206
+ response_types_map=_response_types_map,
1207
+ ).data
1208
+
1209
+
1210
+ @validate_call
1211
+ def free_text_chat_task_update_settings_with_http_info(
1212
+ self,
1213
+ chat_task_settings_update_payload: ChatTaskSettingsUpdatePayload,
1214
+ _request_timeout: Union[
1215
+ None,
1216
+ Annotated[StrictFloat, Field(gt=0)],
1217
+ Tuple[
1218
+ Annotated[StrictFloat, Field(gt=0)],
1219
+ Annotated[StrictFloat, Field(gt=0)]
1220
+ ]
1221
+ ] = None,
1222
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1223
+ _content_type: Optional[StrictStr] = None,
1224
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1225
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1226
+ ) -> ApiResponse[ChatTaskSettings]:
1227
+ """Update Chat Task Settings
1228
+
1229
+
1230
+ :param chat_task_settings_update_payload: (required)
1231
+ :type chat_task_settings_update_payload: ChatTaskSettingsUpdatePayload
1232
+ :param _request_timeout: timeout setting for this request. If one
1233
+ number provided, it will be total request
1234
+ timeout. It can also be a pair (tuple) of
1235
+ (connection, read) timeouts.
1236
+ :type _request_timeout: int, tuple(int, int), optional
1237
+ :param _request_auth: set to override the auth_settings for an a single
1238
+ request; this effectively ignores the
1239
+ authentication in the spec for a single request.
1240
+ :type _request_auth: dict, optional
1241
+ :param _content_type: force content-type for the request.
1242
+ :type _content_type: str, Optional
1243
+ :param _headers: set to override the headers for a single
1244
+ request; this effectively ignores the headers
1245
+ in the spec for a single request.
1246
+ :type _headers: dict, optional
1247
+ :param _host_index: set to override the host_index for a single
1248
+ request; this effectively ignores the host_index
1249
+ in the spec for a single request.
1250
+ :type _host_index: int, optional
1251
+ :return: Returns the result object.
1252
+ """ # noqa: E501
1253
+
1254
+ _param = self._free_text_chat_task_update_settings_serialize(
1255
+ chat_task_settings_update_payload=chat_task_settings_update_payload,
1256
+ _request_auth=_request_auth,
1257
+ _content_type=_content_type,
1258
+ _headers=_headers,
1259
+ _host_index=_host_index
1260
+ )
1261
+
1262
+ _response_types_map: Dict[str, Optional[str]] = {
1263
+ '200': "ChatTaskSettings",
1264
+ '422': "HTTPValidationError",
1265
+ }
1266
+ response_data = self.api_client.call_api(
1267
+ *_param,
1268
+ _request_timeout=_request_timeout
1269
+ )
1270
+ response_data.read()
1271
+ return self.api_client.response_deserialize(
1272
+ response_data=response_data,
1273
+ response_types_map=_response_types_map,
1274
+ )
1275
+
1276
+
1277
+ @validate_call
1278
+ def free_text_chat_task_update_settings_without_preload_content(
1279
+ self,
1280
+ chat_task_settings_update_payload: ChatTaskSettingsUpdatePayload,
1281
+ _request_timeout: Union[
1282
+ None,
1283
+ Annotated[StrictFloat, Field(gt=0)],
1284
+ Tuple[
1285
+ Annotated[StrictFloat, Field(gt=0)],
1286
+ Annotated[StrictFloat, Field(gt=0)]
1287
+ ]
1288
+ ] = None,
1289
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1290
+ _content_type: Optional[StrictStr] = None,
1291
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1292
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1293
+ ) -> RESTResponseType:
1294
+ """Update Chat Task Settings
1295
+
1296
+
1297
+ :param chat_task_settings_update_payload: (required)
1298
+ :type chat_task_settings_update_payload: ChatTaskSettingsUpdatePayload
1299
+ :param _request_timeout: timeout setting for this request. If one
1300
+ number provided, it will be total request
1301
+ timeout. It can also be a pair (tuple) of
1302
+ (connection, read) timeouts.
1303
+ :type _request_timeout: int, tuple(int, int), optional
1304
+ :param _request_auth: set to override the auth_settings for an a single
1305
+ request; this effectively ignores the
1306
+ authentication in the spec for a single request.
1307
+ :type _request_auth: dict, optional
1308
+ :param _content_type: force content-type for the request.
1309
+ :type _content_type: str, Optional
1310
+ :param _headers: set to override the headers for a single
1311
+ request; this effectively ignores the headers
1312
+ in the spec for a single request.
1313
+ :type _headers: dict, optional
1314
+ :param _host_index: set to override the host_index for a single
1315
+ request; this effectively ignores the host_index
1316
+ in the spec for a single request.
1317
+ :type _host_index: int, optional
1318
+ :return: Returns the result object.
1319
+ """ # noqa: E501
1320
+
1321
+ _param = self._free_text_chat_task_update_settings_serialize(
1322
+ chat_task_settings_update_payload=chat_task_settings_update_payload,
1323
+ _request_auth=_request_auth,
1324
+ _content_type=_content_type,
1325
+ _headers=_headers,
1326
+ _host_index=_host_index
1327
+ )
1328
+
1329
+ _response_types_map: Dict[str, Optional[str]] = {
1330
+ '200': "ChatTaskSettings",
1331
+ '422': "HTTPValidationError",
1332
+ }
1333
+ response_data = self.api_client.call_api(
1334
+ *_param,
1335
+ _request_timeout=_request_timeout
1336
+ )
1337
+ return response_data.response
1338
+
1339
+
1340
+ def _free_text_chat_task_update_settings_serialize(
1341
+ self,
1342
+ chat_task_settings_update_payload,
1343
+ _request_auth,
1344
+ _content_type,
1345
+ _headers,
1346
+ _host_index,
1347
+ ) -> RequestSerialized:
1348
+
1349
+ _host = None
1350
+
1351
+ _collection_formats: Dict[str, str] = {
1352
+ }
1353
+
1354
+ _path_params: Dict[str, str] = {}
1355
+ _query_params: List[Tuple[str, str]] = []
1356
+ _header_params: Dict[str, Optional[str]] = _headers or {}
1357
+ _form_params: List[Tuple[str, str]] = []
1358
+ _files: Dict[
1359
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
1360
+ ] = {}
1361
+ _body_params: Optional[bytes] = None
1362
+
1363
+ # process the path parameters
1364
+ # process the query parameters
1365
+ # process the header parameters
1366
+ # process the form parameters
1367
+ # process the body parameter
1368
+ if chat_task_settings_update_payload is not None:
1369
+ _body_params = chat_task_settings_update_payload
1370
+
1371
+
1372
+ # set the HTTP header `Accept`
1373
+ if 'Accept' not in _header_params:
1374
+ _header_params['Accept'] = self.api_client.select_header_accept(
1375
+ [
1376
+ 'application/json'
1377
+ ]
1378
+ )
1379
+
1380
+ # set the HTTP header `Content-Type`
1381
+ if _content_type:
1382
+ _header_params['Content-Type'] = _content_type
1383
+ else:
1384
+ _default_content_type = (
1385
+ self.api_client.select_header_content_type(
1386
+ [
1387
+ 'application/json'
1388
+ ]
1389
+ )
1390
+ )
1391
+ if _default_content_type is not None:
1392
+ _header_params['Content-Type'] = _default_content_type
1393
+
1394
+ # authentication setting
1395
+ _auth_settings: List[str] = [
1396
+ 'QAnswer-Api-Key',
1397
+ 'Bearer token'
1398
+ ]
1399
+
1400
+ return self.api_client.param_serialize(
1401
+ method='PUT',
1402
+ resource_path='/backend/api/tasks/chat/settings',
1403
+ path_params=_path_params,
1404
+ query_params=_query_params,
1405
+ header_params=_header_params,
1406
+ body=_body_params,
1407
+ post_params=_form_params,
1408
+ files=_files,
1409
+ auth_settings=_auth_settings,
1410
+ collection_formats=_collection_formats,
1411
+ _host=_host,
1412
+ _request_auth=_request_auth
1413
+ )
1414
+
1415
+
1416
+
1417
+
1418
+ @validate_call
1419
+ def free_text_summariser_predict(
1420
+ self,
1421
+ rag_payload: RAGPayload,
1422
+ _request_timeout: Union[
1423
+ None,
1424
+ Annotated[StrictFloat, Field(gt=0)],
1425
+ Tuple[
1426
+ Annotated[StrictFloat, Field(gt=0)],
1427
+ Annotated[StrictFloat, Field(gt=0)]
1428
+ ]
1429
+ ] = None,
1430
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1431
+ _content_type: Optional[StrictStr] = None,
1432
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1433
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1434
+ ) -> RAGResponse:
1435
+ """Task Chat
1436
+
1437
+
1438
+ :param rag_payload: (required)
1439
+ :type rag_payload: RAGPayload
1440
+ :param _request_timeout: timeout setting for this request. If one
1441
+ number provided, it will be total request
1442
+ timeout. It can also be a pair (tuple) of
1443
+ (connection, read) timeouts.
1444
+ :type _request_timeout: int, tuple(int, int), optional
1445
+ :param _request_auth: set to override the auth_settings for an a single
1446
+ request; this effectively ignores the
1447
+ authentication in the spec for a single request.
1448
+ :type _request_auth: dict, optional
1449
+ :param _content_type: force content-type for the request.
1450
+ :type _content_type: str, Optional
1451
+ :param _headers: set to override the headers for a single
1452
+ request; this effectively ignores the headers
1453
+ in the spec for a single request.
1454
+ :type _headers: dict, optional
1455
+ :param _host_index: set to override the host_index for a single
1456
+ request; this effectively ignores the host_index
1457
+ in the spec for a single request.
1458
+ :type _host_index: int, optional
1459
+ :return: Returns the result object.
1460
+ """ # noqa: E501
1461
+
1462
+ _param = self._free_text_summariser_predict_serialize(
1463
+ rag_payload=rag_payload,
1464
+ _request_auth=_request_auth,
1465
+ _content_type=_content_type,
1466
+ _headers=_headers,
1467
+ _host_index=_host_index
1468
+ )
1469
+
1470
+ _response_types_map: Dict[str, Optional[str]] = {
1471
+ '200': "RAGResponse",
1472
+ '307': None,
1473
+ '422': "HTTPValidationError",
1474
+ }
1475
+ response_data = self.api_client.call_api(
1476
+ *_param,
1477
+ _request_timeout=_request_timeout
1478
+ )
1479
+ response_data.read()
1480
+ return self.api_client.response_deserialize(
1481
+ response_data=response_data,
1482
+ response_types_map=_response_types_map,
1483
+ ).data
1484
+
1485
+
1486
+ @validate_call
1487
+ def free_text_summariser_predict_with_http_info(
1488
+ self,
1489
+ rag_payload: RAGPayload,
1490
+ _request_timeout: Union[
1491
+ None,
1492
+ Annotated[StrictFloat, Field(gt=0)],
1493
+ Tuple[
1494
+ Annotated[StrictFloat, Field(gt=0)],
1495
+ Annotated[StrictFloat, Field(gt=0)]
1496
+ ]
1497
+ ] = None,
1498
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1499
+ _content_type: Optional[StrictStr] = None,
1500
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1501
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1502
+ ) -> ApiResponse[RAGResponse]:
1503
+ """Task Chat
1504
+
1505
+
1506
+ :param rag_payload: (required)
1507
+ :type rag_payload: RAGPayload
1508
+ :param _request_timeout: timeout setting for this request. If one
1509
+ number provided, it will be total request
1510
+ timeout. It can also be a pair (tuple) of
1511
+ (connection, read) timeouts.
1512
+ :type _request_timeout: int, tuple(int, int), optional
1513
+ :param _request_auth: set to override the auth_settings for an a single
1514
+ request; this effectively ignores the
1515
+ authentication in the spec for a single request.
1516
+ :type _request_auth: dict, optional
1517
+ :param _content_type: force content-type for the request.
1518
+ :type _content_type: str, Optional
1519
+ :param _headers: set to override the headers for a single
1520
+ request; this effectively ignores the headers
1521
+ in the spec for a single request.
1522
+ :type _headers: dict, optional
1523
+ :param _host_index: set to override the host_index for a single
1524
+ request; this effectively ignores the host_index
1525
+ in the spec for a single request.
1526
+ :type _host_index: int, optional
1527
+ :return: Returns the result object.
1528
+ """ # noqa: E501
1529
+
1530
+ _param = self._free_text_summariser_predict_serialize(
1531
+ rag_payload=rag_payload,
1532
+ _request_auth=_request_auth,
1533
+ _content_type=_content_type,
1534
+ _headers=_headers,
1535
+ _host_index=_host_index
1536
+ )
1537
+
1538
+ _response_types_map: Dict[str, Optional[str]] = {
1539
+ '200': "RAGResponse",
1540
+ '307': None,
1541
+ '422': "HTTPValidationError",
1542
+ }
1543
+ response_data = self.api_client.call_api(
1544
+ *_param,
1545
+ _request_timeout=_request_timeout
1546
+ )
1547
+ response_data.read()
1548
+ return self.api_client.response_deserialize(
1549
+ response_data=response_data,
1550
+ response_types_map=_response_types_map,
1551
+ )
1552
+
1553
+
1554
+ @validate_call
1555
+ def free_text_summariser_predict_without_preload_content(
1556
+ self,
1557
+ rag_payload: RAGPayload,
1558
+ _request_timeout: Union[
1559
+ None,
1560
+ Annotated[StrictFloat, Field(gt=0)],
1561
+ Tuple[
1562
+ Annotated[StrictFloat, Field(gt=0)],
1563
+ Annotated[StrictFloat, Field(gt=0)]
1564
+ ]
1565
+ ] = None,
1566
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1567
+ _content_type: Optional[StrictStr] = None,
1568
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1569
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1570
+ ) -> RESTResponseType:
1571
+ """Task Chat
1572
+
1573
+
1574
+ :param rag_payload: (required)
1575
+ :type rag_payload: RAGPayload
1576
+ :param _request_timeout: timeout setting for this request. If one
1577
+ number provided, it will be total request
1578
+ timeout. It can also be a pair (tuple) of
1579
+ (connection, read) timeouts.
1580
+ :type _request_timeout: int, tuple(int, int), optional
1581
+ :param _request_auth: set to override the auth_settings for an a single
1582
+ request; this effectively ignores the
1583
+ authentication in the spec for a single request.
1584
+ :type _request_auth: dict, optional
1585
+ :param _content_type: force content-type for the request.
1586
+ :type _content_type: str, Optional
1587
+ :param _headers: set to override the headers for a single
1588
+ request; this effectively ignores the headers
1589
+ in the spec for a single request.
1590
+ :type _headers: dict, optional
1591
+ :param _host_index: set to override the host_index for a single
1592
+ request; this effectively ignores the host_index
1593
+ in the spec for a single request.
1594
+ :type _host_index: int, optional
1595
+ :return: Returns the result object.
1596
+ """ # noqa: E501
1597
+
1598
+ _param = self._free_text_summariser_predict_serialize(
1599
+ rag_payload=rag_payload,
1600
+ _request_auth=_request_auth,
1601
+ _content_type=_content_type,
1602
+ _headers=_headers,
1603
+ _host_index=_host_index
1604
+ )
1605
+
1606
+ _response_types_map: Dict[str, Optional[str]] = {
1607
+ '200': "RAGResponse",
1608
+ '307': None,
1609
+ '422': "HTTPValidationError",
1610
+ }
1611
+ response_data = self.api_client.call_api(
1612
+ *_param,
1613
+ _request_timeout=_request_timeout
1614
+ )
1615
+ return response_data.response
1616
+
1617
+
1618
+ def _free_text_summariser_predict_serialize(
1619
+ self,
1620
+ rag_payload,
1621
+ _request_auth,
1622
+ _content_type,
1623
+ _headers,
1624
+ _host_index,
1625
+ ) -> RequestSerialized:
1626
+
1627
+ _host = None
1628
+
1629
+ _collection_formats: Dict[str, str] = {
1630
+ }
1631
+
1632
+ _path_params: Dict[str, str] = {}
1633
+ _query_params: List[Tuple[str, str]] = []
1634
+ _header_params: Dict[str, Optional[str]] = _headers or {}
1635
+ _form_params: List[Tuple[str, str]] = []
1636
+ _files: Dict[
1637
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
1638
+ ] = {}
1639
+ _body_params: Optional[bytes] = None
1640
+
1641
+ # process the path parameters
1642
+ # process the query parameters
1643
+ # process the header parameters
1644
+ # process the form parameters
1645
+ # process the body parameter
1646
+ if rag_payload is not None:
1647
+ _body_params = rag_payload
1648
+
1649
+
1650
+ # set the HTTP header `Accept`
1651
+ if 'Accept' not in _header_params:
1652
+ _header_params['Accept'] = self.api_client.select_header_accept(
1653
+ [
1654
+ 'application/json'
1655
+ ]
1656
+ )
1657
+
1658
+ # set the HTTP header `Content-Type`
1659
+ if _content_type:
1660
+ _header_params['Content-Type'] = _content_type
1661
+ else:
1662
+ _default_content_type = (
1663
+ self.api_client.select_header_content_type(
1664
+ [
1665
+ 'application/json'
1666
+ ]
1667
+ )
1668
+ )
1669
+ if _default_content_type is not None:
1670
+ _header_params['Content-Type'] = _default_content_type
1671
+
1672
+ # authentication setting
1673
+ _auth_settings: List[str] = [
1674
+ 'QAnswer-Api-Key',
1675
+ 'Bearer token'
1676
+ ]
1677
+
1678
+ return self.api_client.param_serialize(
1679
+ method='POST',
1680
+ resource_path='/backend/api/tasks/chat',
1681
+ path_params=_path_params,
1682
+ query_params=_query_params,
1683
+ header_params=_header_params,
1684
+ body=_body_params,
1685
+ post_params=_form_params,
1686
+ files=_files,
1687
+ auth_settings=_auth_settings,
1688
+ collection_formats=_collection_formats,
1689
+ _host=_host,
1690
+ _request_auth=_request_auth
1691
+ )
1692
+
1693
+
1694
+
1695
+
1696
+ @validate_call
1697
+ def get_chat_aggregations(
1698
+ self,
1699
+ get_aggregations_payload: GetAggregationsPayload,
1700
+ _request_timeout: Union[
1701
+ None,
1702
+ Annotated[StrictFloat, Field(gt=0)],
1703
+ Tuple[
1704
+ Annotated[StrictFloat, Field(gt=0)],
1705
+ Annotated[StrictFloat, Field(gt=0)]
1706
+ ]
1707
+ ] = None,
1708
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1709
+ _content_type: Optional[StrictStr] = None,
1710
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1711
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1712
+ ) -> List[AggregationsGroup]:
1713
+ """Get Chat Aggregations
1714
+
1715
+
1716
+ :param get_aggregations_payload: (required)
1717
+ :type get_aggregations_payload: GetAggregationsPayload
1718
+ :param _request_timeout: timeout setting for this request. If one
1719
+ number provided, it will be total request
1720
+ timeout. It can also be a pair (tuple) of
1721
+ (connection, read) timeouts.
1722
+ :type _request_timeout: int, tuple(int, int), optional
1723
+ :param _request_auth: set to override the auth_settings for an a single
1724
+ request; this effectively ignores the
1725
+ authentication in the spec for a single request.
1726
+ :type _request_auth: dict, optional
1727
+ :param _content_type: force content-type for the request.
1728
+ :type _content_type: str, Optional
1729
+ :param _headers: set to override the headers for a single
1730
+ request; this effectively ignores the headers
1731
+ in the spec for a single request.
1732
+ :type _headers: dict, optional
1733
+ :param _host_index: set to override the host_index for a single
1734
+ request; this effectively ignores the host_index
1735
+ in the spec for a single request.
1736
+ :type _host_index: int, optional
1737
+ :return: Returns the result object.
1738
+ """ # noqa: E501
1739
+
1740
+ _param = self._get_chat_aggregations_serialize(
1741
+ get_aggregations_payload=get_aggregations_payload,
1742
+ _request_auth=_request_auth,
1743
+ _content_type=_content_type,
1744
+ _headers=_headers,
1745
+ _host_index=_host_index
1746
+ )
1747
+
1748
+ _response_types_map: Dict[str, Optional[str]] = {
1749
+ '200': "List[AggregationsGroup]",
1750
+ '422': "HTTPValidationError",
1751
+ }
1752
+ response_data = self.api_client.call_api(
1753
+ *_param,
1754
+ _request_timeout=_request_timeout
1755
+ )
1756
+ response_data.read()
1757
+ return self.api_client.response_deserialize(
1758
+ response_data=response_data,
1759
+ response_types_map=_response_types_map,
1760
+ ).data
1761
+
1762
+
1763
+ @validate_call
1764
+ def get_chat_aggregations_with_http_info(
1765
+ self,
1766
+ get_aggregations_payload: GetAggregationsPayload,
1767
+ _request_timeout: Union[
1768
+ None,
1769
+ Annotated[StrictFloat, Field(gt=0)],
1770
+ Tuple[
1771
+ Annotated[StrictFloat, Field(gt=0)],
1772
+ Annotated[StrictFloat, Field(gt=0)]
1773
+ ]
1774
+ ] = None,
1775
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1776
+ _content_type: Optional[StrictStr] = None,
1777
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1778
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1779
+ ) -> ApiResponse[List[AggregationsGroup]]:
1780
+ """Get Chat Aggregations
1781
+
1782
+
1783
+ :param get_aggregations_payload: (required)
1784
+ :type get_aggregations_payload: GetAggregationsPayload
1785
+ :param _request_timeout: timeout setting for this request. If one
1786
+ number provided, it will be total request
1787
+ timeout. It can also be a pair (tuple) of
1788
+ (connection, read) timeouts.
1789
+ :type _request_timeout: int, tuple(int, int), optional
1790
+ :param _request_auth: set to override the auth_settings for an a single
1791
+ request; this effectively ignores the
1792
+ authentication in the spec for a single request.
1793
+ :type _request_auth: dict, optional
1794
+ :param _content_type: force content-type for the request.
1795
+ :type _content_type: str, Optional
1796
+ :param _headers: set to override the headers for a single
1797
+ request; this effectively ignores the headers
1798
+ in the spec for a single request.
1799
+ :type _headers: dict, optional
1800
+ :param _host_index: set to override the host_index for a single
1801
+ request; this effectively ignores the host_index
1802
+ in the spec for a single request.
1803
+ :type _host_index: int, optional
1804
+ :return: Returns the result object.
1805
+ """ # noqa: E501
1806
+
1807
+ _param = self._get_chat_aggregations_serialize(
1808
+ get_aggregations_payload=get_aggregations_payload,
1809
+ _request_auth=_request_auth,
1810
+ _content_type=_content_type,
1811
+ _headers=_headers,
1812
+ _host_index=_host_index
1813
+ )
1814
+
1815
+ _response_types_map: Dict[str, Optional[str]] = {
1816
+ '200': "List[AggregationsGroup]",
1817
+ '422': "HTTPValidationError",
1818
+ }
1819
+ response_data = self.api_client.call_api(
1820
+ *_param,
1821
+ _request_timeout=_request_timeout
1822
+ )
1823
+ response_data.read()
1824
+ return self.api_client.response_deserialize(
1825
+ response_data=response_data,
1826
+ response_types_map=_response_types_map,
1827
+ )
1828
+
1829
+
1830
+ @validate_call
1831
+ def get_chat_aggregations_without_preload_content(
1832
+ self,
1833
+ get_aggregations_payload: GetAggregationsPayload,
1834
+ _request_timeout: Union[
1835
+ None,
1836
+ Annotated[StrictFloat, Field(gt=0)],
1837
+ Tuple[
1838
+ Annotated[StrictFloat, Field(gt=0)],
1839
+ Annotated[StrictFloat, Field(gt=0)]
1840
+ ]
1841
+ ] = None,
1842
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1843
+ _content_type: Optional[StrictStr] = None,
1844
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1845
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1846
+ ) -> RESTResponseType:
1847
+ """Get Chat Aggregations
1848
+
1849
+
1850
+ :param get_aggregations_payload: (required)
1851
+ :type get_aggregations_payload: GetAggregationsPayload
1852
+ :param _request_timeout: timeout setting for this request. If one
1853
+ number provided, it will be total request
1854
+ timeout. It can also be a pair (tuple) of
1855
+ (connection, read) timeouts.
1856
+ :type _request_timeout: int, tuple(int, int), optional
1857
+ :param _request_auth: set to override the auth_settings for an a single
1858
+ request; this effectively ignores the
1859
+ authentication in the spec for a single request.
1860
+ :type _request_auth: dict, optional
1861
+ :param _content_type: force content-type for the request.
1862
+ :type _content_type: str, Optional
1863
+ :param _headers: set to override the headers for a single
1864
+ request; this effectively ignores the headers
1865
+ in the spec for a single request.
1866
+ :type _headers: dict, optional
1867
+ :param _host_index: set to override the host_index for a single
1868
+ request; this effectively ignores the host_index
1869
+ in the spec for a single request.
1870
+ :type _host_index: int, optional
1871
+ :return: Returns the result object.
1872
+ """ # noqa: E501
1873
+
1874
+ _param = self._get_chat_aggregations_serialize(
1875
+ get_aggregations_payload=get_aggregations_payload,
1876
+ _request_auth=_request_auth,
1877
+ _content_type=_content_type,
1878
+ _headers=_headers,
1879
+ _host_index=_host_index
1880
+ )
1881
+
1882
+ _response_types_map: Dict[str, Optional[str]] = {
1883
+ '200': "List[AggregationsGroup]",
1884
+ '422': "HTTPValidationError",
1885
+ }
1886
+ response_data = self.api_client.call_api(
1887
+ *_param,
1888
+ _request_timeout=_request_timeout
1889
+ )
1890
+ return response_data.response
1891
+
1892
+
1893
+ def _get_chat_aggregations_serialize(
1894
+ self,
1895
+ get_aggregations_payload,
1896
+ _request_auth,
1897
+ _content_type,
1898
+ _headers,
1899
+ _host_index,
1900
+ ) -> RequestSerialized:
1901
+
1902
+ _host = None
1903
+
1904
+ _collection_formats: Dict[str, str] = {
1905
+ }
1906
+
1907
+ _path_params: Dict[str, str] = {}
1908
+ _query_params: List[Tuple[str, str]] = []
1909
+ _header_params: Dict[str, Optional[str]] = _headers or {}
1910
+ _form_params: List[Tuple[str, str]] = []
1911
+ _files: Dict[
1912
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
1913
+ ] = {}
1914
+ _body_params: Optional[bytes] = None
1915
+
1916
+ # process the path parameters
1917
+ # process the query parameters
1918
+ # process the header parameters
1919
+ # process the form parameters
1920
+ # process the body parameter
1921
+ if get_aggregations_payload is not None:
1922
+ _body_params = get_aggregations_payload
1923
+
1924
+
1925
+ # set the HTTP header `Accept`
1926
+ if 'Accept' not in _header_params:
1927
+ _header_params['Accept'] = self.api_client.select_header_accept(
1928
+ [
1929
+ 'application/json'
1930
+ ]
1931
+ )
1932
+
1933
+ # set the HTTP header `Content-Type`
1934
+ if _content_type:
1935
+ _header_params['Content-Type'] = _content_type
1936
+ else:
1937
+ _default_content_type = (
1938
+ self.api_client.select_header_content_type(
1939
+ [
1940
+ 'application/json'
1941
+ ]
1942
+ )
1943
+ )
1944
+ if _default_content_type is not None:
1945
+ _header_params['Content-Type'] = _default_content_type
1946
+
1947
+ # authentication setting
1948
+ _auth_settings: List[str] = [
1949
+ 'QAnswer-Api-Key',
1950
+ 'Bearer token'
1951
+ ]
1952
+
1953
+ return self.api_client.param_serialize(
1954
+ method='POST',
1955
+ resource_path='/backend/api/tasks/chat/aggregations',
1956
+ path_params=_path_params,
1957
+ query_params=_query_params,
1958
+ header_params=_header_params,
1959
+ body=_body_params,
1960
+ post_params=_form_params,
1961
+ files=_files,
1962
+ auth_settings=_auth_settings,
1963
+ collection_formats=_collection_formats,
1964
+ _host=_host,
1965
+ _request_auth=_request_auth
1966
+ )
1967
+
1968
+
1969
+
1970
+
1971
+ @validate_call
1972
+ def get_chat_available_aggregations(
1973
+ self,
1974
+ username: Annotated[StrictStr, Field(description="Username")],
1975
+ dataset: Annotated[StrictStr, Field(description="Dataset")],
1976
+ _request_timeout: Union[
1977
+ None,
1978
+ Annotated[StrictFloat, Field(gt=0)],
1979
+ Tuple[
1980
+ Annotated[StrictFloat, Field(gt=0)],
1981
+ Annotated[StrictFloat, Field(gt=0)]
1982
+ ]
1983
+ ] = None,
1984
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1985
+ _content_type: Optional[StrictStr] = None,
1986
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1987
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1988
+ ) -> List[AvailableAggregation]:
1989
+ """Get Chat Available Aggregations
1990
+
1991
+
1992
+ :param username: Username (required)
1993
+ :type username: str
1994
+ :param dataset: Dataset (required)
1995
+ :type dataset: str
1996
+ :param _request_timeout: timeout setting for this request. If one
1997
+ number provided, it will be total request
1998
+ timeout. It can also be a pair (tuple) of
1999
+ (connection, read) timeouts.
2000
+ :type _request_timeout: int, tuple(int, int), optional
2001
+ :param _request_auth: set to override the auth_settings for an a single
2002
+ request; this effectively ignores the
2003
+ authentication in the spec for a single request.
2004
+ :type _request_auth: dict, optional
2005
+ :param _content_type: force content-type for the request.
2006
+ :type _content_type: str, Optional
2007
+ :param _headers: set to override the headers for a single
2008
+ request; this effectively ignores the headers
2009
+ in the spec for a single request.
2010
+ :type _headers: dict, optional
2011
+ :param _host_index: set to override the host_index for a single
2012
+ request; this effectively ignores the host_index
2013
+ in the spec for a single request.
2014
+ :type _host_index: int, optional
2015
+ :return: Returns the result object.
2016
+ """ # noqa: E501
2017
+
2018
+ _param = self._get_chat_available_aggregations_serialize(
2019
+ username=username,
2020
+ dataset=dataset,
2021
+ _request_auth=_request_auth,
2022
+ _content_type=_content_type,
2023
+ _headers=_headers,
2024
+ _host_index=_host_index
2025
+ )
2026
+
2027
+ _response_types_map: Dict[str, Optional[str]] = {
2028
+ '200': "List[AvailableAggregation]",
2029
+ '422': "HTTPValidationError",
2030
+ }
2031
+ response_data = self.api_client.call_api(
2032
+ *_param,
2033
+ _request_timeout=_request_timeout
2034
+ )
2035
+ response_data.read()
2036
+ return self.api_client.response_deserialize(
2037
+ response_data=response_data,
2038
+ response_types_map=_response_types_map,
2039
+ ).data
2040
+
2041
+
2042
+ @validate_call
2043
+ def get_chat_available_aggregations_with_http_info(
2044
+ self,
2045
+ username: Annotated[StrictStr, Field(description="Username")],
2046
+ dataset: Annotated[StrictStr, Field(description="Dataset")],
2047
+ _request_timeout: Union[
2048
+ None,
2049
+ Annotated[StrictFloat, Field(gt=0)],
2050
+ Tuple[
2051
+ Annotated[StrictFloat, Field(gt=0)],
2052
+ Annotated[StrictFloat, Field(gt=0)]
2053
+ ]
2054
+ ] = None,
2055
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
2056
+ _content_type: Optional[StrictStr] = None,
2057
+ _headers: Optional[Dict[StrictStr, Any]] = None,
2058
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2059
+ ) -> ApiResponse[List[AvailableAggregation]]:
2060
+ """Get Chat Available Aggregations
2061
+
2062
+
2063
+ :param username: Username (required)
2064
+ :type username: str
2065
+ :param dataset: Dataset (required)
2066
+ :type dataset: str
2067
+ :param _request_timeout: timeout setting for this request. If one
2068
+ number provided, it will be total request
2069
+ timeout. It can also be a pair (tuple) of
2070
+ (connection, read) timeouts.
2071
+ :type _request_timeout: int, tuple(int, int), optional
2072
+ :param _request_auth: set to override the auth_settings for an a single
2073
+ request; this effectively ignores the
2074
+ authentication in the spec for a single request.
2075
+ :type _request_auth: dict, optional
2076
+ :param _content_type: force content-type for the request.
2077
+ :type _content_type: str, Optional
2078
+ :param _headers: set to override the headers for a single
2079
+ request; this effectively ignores the headers
2080
+ in the spec for a single request.
2081
+ :type _headers: dict, optional
2082
+ :param _host_index: set to override the host_index for a single
2083
+ request; this effectively ignores the host_index
2084
+ in the spec for a single request.
2085
+ :type _host_index: int, optional
2086
+ :return: Returns the result object.
2087
+ """ # noqa: E501
2088
+
2089
+ _param = self._get_chat_available_aggregations_serialize(
2090
+ username=username,
2091
+ dataset=dataset,
2092
+ _request_auth=_request_auth,
2093
+ _content_type=_content_type,
2094
+ _headers=_headers,
2095
+ _host_index=_host_index
2096
+ )
2097
+
2098
+ _response_types_map: Dict[str, Optional[str]] = {
2099
+ '200': "List[AvailableAggregation]",
2100
+ '422': "HTTPValidationError",
2101
+ }
2102
+ response_data = self.api_client.call_api(
2103
+ *_param,
2104
+ _request_timeout=_request_timeout
2105
+ )
2106
+ response_data.read()
2107
+ return self.api_client.response_deserialize(
2108
+ response_data=response_data,
2109
+ response_types_map=_response_types_map,
2110
+ )
2111
+
2112
+
2113
+ @validate_call
2114
+ def get_chat_available_aggregations_without_preload_content(
2115
+ self,
2116
+ username: Annotated[StrictStr, Field(description="Username")],
2117
+ dataset: Annotated[StrictStr, Field(description="Dataset")],
2118
+ _request_timeout: Union[
2119
+ None,
2120
+ Annotated[StrictFloat, Field(gt=0)],
2121
+ Tuple[
2122
+ Annotated[StrictFloat, Field(gt=0)],
2123
+ Annotated[StrictFloat, Field(gt=0)]
2124
+ ]
2125
+ ] = None,
2126
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
2127
+ _content_type: Optional[StrictStr] = None,
2128
+ _headers: Optional[Dict[StrictStr, Any]] = None,
2129
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2130
+ ) -> RESTResponseType:
2131
+ """Get Chat Available Aggregations
2132
+
2133
+
2134
+ :param username: Username (required)
2135
+ :type username: str
2136
+ :param dataset: Dataset (required)
2137
+ :type dataset: str
2138
+ :param _request_timeout: timeout setting for this request. If one
2139
+ number provided, it will be total request
2140
+ timeout. It can also be a pair (tuple) of
2141
+ (connection, read) timeouts.
2142
+ :type _request_timeout: int, tuple(int, int), optional
2143
+ :param _request_auth: set to override the auth_settings for an a single
2144
+ request; this effectively ignores the
2145
+ authentication in the spec for a single request.
2146
+ :type _request_auth: dict, optional
2147
+ :param _content_type: force content-type for the request.
2148
+ :type _content_type: str, Optional
2149
+ :param _headers: set to override the headers for a single
2150
+ request; this effectively ignores the headers
2151
+ in the spec for a single request.
2152
+ :type _headers: dict, optional
2153
+ :param _host_index: set to override the host_index for a single
2154
+ request; this effectively ignores the host_index
2155
+ in the spec for a single request.
2156
+ :type _host_index: int, optional
2157
+ :return: Returns the result object.
2158
+ """ # noqa: E501
2159
+
2160
+ _param = self._get_chat_available_aggregations_serialize(
2161
+ username=username,
2162
+ dataset=dataset,
2163
+ _request_auth=_request_auth,
2164
+ _content_type=_content_type,
2165
+ _headers=_headers,
2166
+ _host_index=_host_index
2167
+ )
2168
+
2169
+ _response_types_map: Dict[str, Optional[str]] = {
2170
+ '200': "List[AvailableAggregation]",
2171
+ '422': "HTTPValidationError",
2172
+ }
2173
+ response_data = self.api_client.call_api(
2174
+ *_param,
2175
+ _request_timeout=_request_timeout
2176
+ )
2177
+ return response_data.response
2178
+
2179
+
2180
+ def _get_chat_available_aggregations_serialize(
2181
+ self,
2182
+ username,
2183
+ dataset,
2184
+ _request_auth,
2185
+ _content_type,
2186
+ _headers,
2187
+ _host_index,
2188
+ ) -> RequestSerialized:
2189
+
2190
+ _host = None
2191
+
2192
+ _collection_formats: Dict[str, str] = {
2193
+ }
2194
+
2195
+ _path_params: Dict[str, str] = {}
2196
+ _query_params: List[Tuple[str, str]] = []
2197
+ _header_params: Dict[str, Optional[str]] = _headers or {}
2198
+ _form_params: List[Tuple[str, str]] = []
2199
+ _files: Dict[
2200
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
2201
+ ] = {}
2202
+ _body_params: Optional[bytes] = None
2203
+
2204
+ # process the path parameters
2205
+ # process the query parameters
2206
+ if username is not None:
2207
+
2208
+ _query_params.append(('username', username))
2209
+
2210
+ if dataset is not None:
2211
+
2212
+ _query_params.append(('dataset', dataset))
2213
+
2214
+ # process the header parameters
2215
+ # process the form parameters
2216
+ # process the body parameter
2217
+
2218
+
2219
+ # set the HTTP header `Accept`
2220
+ if 'Accept' not in _header_params:
2221
+ _header_params['Accept'] = self.api_client.select_header_accept(
2222
+ [
2223
+ 'application/json'
2224
+ ]
2225
+ )
2226
+
2227
+
2228
+ # authentication setting
2229
+ _auth_settings: List[str] = [
2230
+ 'QAnswer-Api-Key',
2231
+ 'Bearer token'
2232
+ ]
2233
+
2234
+ return self.api_client.param_serialize(
2235
+ method='GET',
2236
+ resource_path='/backend/api/tasks/chat/available-aggregations',
2237
+ path_params=_path_params,
2238
+ query_params=_query_params,
2239
+ header_params=_header_params,
2240
+ body=_body_params,
2241
+ post_params=_form_params,
2242
+ files=_files,
2243
+ auth_settings=_auth_settings,
2244
+ collection_formats=_collection_formats,
2245
+ _host=_host,
2246
+ _request_auth=_request_auth
2247
+ )
2248
+
2249
+
2250
+
2251
+
2252
+ @validate_call
2253
+ def get_suggested_questions(
2254
+ self,
2255
+ username: Annotated[StrictStr, Field(description="Username")],
2256
+ dataset: Annotated[StrictStr, Field(description="Dataset")],
2257
+ task_name: Annotated[Optional[StrictStr], Field(description="Task name for which to suggest questions")] = None,
2258
+ lang: Annotated[Optional[StrictStr], Field(description="Language for question suggestions. Use \"auto\" to default to the dataset language.")] = None,
2259
+ limit: Annotated[Optional[Annotated[int, Field(le=10, strict=True, ge=1)]], Field(description="Maximum number of suggested follow-up questions to return.")] = None,
2260
+ current_question: Annotated[Optional[StrictStr], Field(description="Most recent user question to bias the follow-up suggestions.")] = None,
2261
+ _request_timeout: Union[
2262
+ None,
2263
+ Annotated[StrictFloat, Field(gt=0)],
2264
+ Tuple[
2265
+ Annotated[StrictFloat, Field(gt=0)],
2266
+ Annotated[StrictFloat, Field(gt=0)]
2267
+ ]
2268
+ ] = None,
2269
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
2270
+ _content_type: Optional[StrictStr] = None,
2271
+ _headers: Optional[Dict[StrictStr, Any]] = None,
2272
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2273
+ ) -> QuestionSuggestionResponse:
2274
+ """Suggest Questions
2275
+
2276
+
2277
+ :param username: Username (required)
2278
+ :type username: str
2279
+ :param dataset: Dataset (required)
2280
+ :type dataset: str
2281
+ :param task_name: Task name for which to suggest questions
2282
+ :type task_name: str
2283
+ :param lang: Language for question suggestions. Use \"auto\" to default to the dataset language.
2284
+ :type lang: str
2285
+ :param limit: Maximum number of suggested follow-up questions to return.
2286
+ :type limit: int
2287
+ :param current_question: Most recent user question to bias the follow-up suggestions.
2288
+ :type current_question: str
2289
+ :param _request_timeout: timeout setting for this request. If one
2290
+ number provided, it will be total request
2291
+ timeout. It can also be a pair (tuple) of
2292
+ (connection, read) timeouts.
2293
+ :type _request_timeout: int, tuple(int, int), optional
2294
+ :param _request_auth: set to override the auth_settings for an a single
2295
+ request; this effectively ignores the
2296
+ authentication in the spec for a single request.
2297
+ :type _request_auth: dict, optional
2298
+ :param _content_type: force content-type for the request.
2299
+ :type _content_type: str, Optional
2300
+ :param _headers: set to override the headers for a single
2301
+ request; this effectively ignores the headers
2302
+ in the spec for a single request.
2303
+ :type _headers: dict, optional
2304
+ :param _host_index: set to override the host_index for a single
2305
+ request; this effectively ignores the host_index
2306
+ in the spec for a single request.
2307
+ :type _host_index: int, optional
2308
+ :return: Returns the result object.
2309
+ """ # noqa: E501
2310
+
2311
+ _param = self._get_suggested_questions_serialize(
2312
+ username=username,
2313
+ dataset=dataset,
2314
+ task_name=task_name,
2315
+ lang=lang,
2316
+ limit=limit,
2317
+ current_question=current_question,
2318
+ _request_auth=_request_auth,
2319
+ _content_type=_content_type,
2320
+ _headers=_headers,
2321
+ _host_index=_host_index
2322
+ )
2323
+
2324
+ _response_types_map: Dict[str, Optional[str]] = {
2325
+ '200': "QuestionSuggestionResponse",
2326
+ '422': "HTTPValidationError",
2327
+ }
2328
+ response_data = self.api_client.call_api(
2329
+ *_param,
2330
+ _request_timeout=_request_timeout
2331
+ )
2332
+ response_data.read()
2333
+ return self.api_client.response_deserialize(
2334
+ response_data=response_data,
2335
+ response_types_map=_response_types_map,
2336
+ ).data
2337
+
2338
+
2339
+ @validate_call
2340
+ def get_suggested_questions_with_http_info(
2341
+ self,
2342
+ username: Annotated[StrictStr, Field(description="Username")],
2343
+ dataset: Annotated[StrictStr, Field(description="Dataset")],
2344
+ task_name: Annotated[Optional[StrictStr], Field(description="Task name for which to suggest questions")] = None,
2345
+ lang: Annotated[Optional[StrictStr], Field(description="Language for question suggestions. Use \"auto\" to default to the dataset language.")] = None,
2346
+ limit: Annotated[Optional[Annotated[int, Field(le=10, strict=True, ge=1)]], Field(description="Maximum number of suggested follow-up questions to return.")] = None,
2347
+ current_question: Annotated[Optional[StrictStr], Field(description="Most recent user question to bias the follow-up suggestions.")] = None,
2348
+ _request_timeout: Union[
2349
+ None,
2350
+ Annotated[StrictFloat, Field(gt=0)],
2351
+ Tuple[
2352
+ Annotated[StrictFloat, Field(gt=0)],
2353
+ Annotated[StrictFloat, Field(gt=0)]
2354
+ ]
2355
+ ] = None,
2356
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
2357
+ _content_type: Optional[StrictStr] = None,
2358
+ _headers: Optional[Dict[StrictStr, Any]] = None,
2359
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2360
+ ) -> ApiResponse[QuestionSuggestionResponse]:
2361
+ """Suggest Questions
2362
+
2363
+
2364
+ :param username: Username (required)
2365
+ :type username: str
2366
+ :param dataset: Dataset (required)
2367
+ :type dataset: str
2368
+ :param task_name: Task name for which to suggest questions
2369
+ :type task_name: str
2370
+ :param lang: Language for question suggestions. Use \"auto\" to default to the dataset language.
2371
+ :type lang: str
2372
+ :param limit: Maximum number of suggested follow-up questions to return.
2373
+ :type limit: int
2374
+ :param current_question: Most recent user question to bias the follow-up suggestions.
2375
+ :type current_question: str
2376
+ :param _request_timeout: timeout setting for this request. If one
2377
+ number provided, it will be total request
2378
+ timeout. It can also be a pair (tuple) of
2379
+ (connection, read) timeouts.
2380
+ :type _request_timeout: int, tuple(int, int), optional
2381
+ :param _request_auth: set to override the auth_settings for an a single
2382
+ request; this effectively ignores the
2383
+ authentication in the spec for a single request.
2384
+ :type _request_auth: dict, optional
2385
+ :param _content_type: force content-type for the request.
2386
+ :type _content_type: str, Optional
2387
+ :param _headers: set to override the headers for a single
2388
+ request; this effectively ignores the headers
2389
+ in the spec for a single request.
2390
+ :type _headers: dict, optional
2391
+ :param _host_index: set to override the host_index for a single
2392
+ request; this effectively ignores the host_index
2393
+ in the spec for a single request.
2394
+ :type _host_index: int, optional
2395
+ :return: Returns the result object.
2396
+ """ # noqa: E501
2397
+
2398
+ _param = self._get_suggested_questions_serialize(
2399
+ username=username,
2400
+ dataset=dataset,
2401
+ task_name=task_name,
2402
+ lang=lang,
2403
+ limit=limit,
2404
+ current_question=current_question,
2405
+ _request_auth=_request_auth,
2406
+ _content_type=_content_type,
2407
+ _headers=_headers,
2408
+ _host_index=_host_index
2409
+ )
2410
+
2411
+ _response_types_map: Dict[str, Optional[str]] = {
2412
+ '200': "QuestionSuggestionResponse",
2413
+ '422': "HTTPValidationError",
2414
+ }
2415
+ response_data = self.api_client.call_api(
2416
+ *_param,
2417
+ _request_timeout=_request_timeout
2418
+ )
2419
+ response_data.read()
2420
+ return self.api_client.response_deserialize(
2421
+ response_data=response_data,
2422
+ response_types_map=_response_types_map,
2423
+ )
2424
+
2425
+
2426
+ @validate_call
2427
+ def get_suggested_questions_without_preload_content(
2428
+ self,
2429
+ username: Annotated[StrictStr, Field(description="Username")],
2430
+ dataset: Annotated[StrictStr, Field(description="Dataset")],
2431
+ task_name: Annotated[Optional[StrictStr], Field(description="Task name for which to suggest questions")] = None,
2432
+ lang: Annotated[Optional[StrictStr], Field(description="Language for question suggestions. Use \"auto\" to default to the dataset language.")] = None,
2433
+ limit: Annotated[Optional[Annotated[int, Field(le=10, strict=True, ge=1)]], Field(description="Maximum number of suggested follow-up questions to return.")] = None,
2434
+ current_question: Annotated[Optional[StrictStr], Field(description="Most recent user question to bias the follow-up suggestions.")] = None,
2435
+ _request_timeout: Union[
2436
+ None,
2437
+ Annotated[StrictFloat, Field(gt=0)],
2438
+ Tuple[
2439
+ Annotated[StrictFloat, Field(gt=0)],
2440
+ Annotated[StrictFloat, Field(gt=0)]
2441
+ ]
2442
+ ] = None,
2443
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
2444
+ _content_type: Optional[StrictStr] = None,
2445
+ _headers: Optional[Dict[StrictStr, Any]] = None,
2446
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2447
+ ) -> RESTResponseType:
2448
+ """Suggest Questions
2449
+
2450
+
2451
+ :param username: Username (required)
2452
+ :type username: str
2453
+ :param dataset: Dataset (required)
2454
+ :type dataset: str
2455
+ :param task_name: Task name for which to suggest questions
2456
+ :type task_name: str
2457
+ :param lang: Language for question suggestions. Use \"auto\" to default to the dataset language.
2458
+ :type lang: str
2459
+ :param limit: Maximum number of suggested follow-up questions to return.
2460
+ :type limit: int
2461
+ :param current_question: Most recent user question to bias the follow-up suggestions.
2462
+ :type current_question: str
2463
+ :param _request_timeout: timeout setting for this request. If one
2464
+ number provided, it will be total request
2465
+ timeout. It can also be a pair (tuple) of
2466
+ (connection, read) timeouts.
2467
+ :type _request_timeout: int, tuple(int, int), optional
2468
+ :param _request_auth: set to override the auth_settings for an a single
2469
+ request; this effectively ignores the
2470
+ authentication in the spec for a single request.
2471
+ :type _request_auth: dict, optional
2472
+ :param _content_type: force content-type for the request.
2473
+ :type _content_type: str, Optional
2474
+ :param _headers: set to override the headers for a single
2475
+ request; this effectively ignores the headers
2476
+ in the spec for a single request.
2477
+ :type _headers: dict, optional
2478
+ :param _host_index: set to override the host_index for a single
2479
+ request; this effectively ignores the host_index
2480
+ in the spec for a single request.
2481
+ :type _host_index: int, optional
2482
+ :return: Returns the result object.
2483
+ """ # noqa: E501
2484
+
2485
+ _param = self._get_suggested_questions_serialize(
2486
+ username=username,
2487
+ dataset=dataset,
2488
+ task_name=task_name,
2489
+ lang=lang,
2490
+ limit=limit,
2491
+ current_question=current_question,
2492
+ _request_auth=_request_auth,
2493
+ _content_type=_content_type,
2494
+ _headers=_headers,
2495
+ _host_index=_host_index
2496
+ )
2497
+
2498
+ _response_types_map: Dict[str, Optional[str]] = {
2499
+ '200': "QuestionSuggestionResponse",
2500
+ '422': "HTTPValidationError",
2501
+ }
2502
+ response_data = self.api_client.call_api(
2503
+ *_param,
2504
+ _request_timeout=_request_timeout
2505
+ )
2506
+ return response_data.response
2507
+
2508
+
2509
+ def _get_suggested_questions_serialize(
2510
+ self,
2511
+ username,
2512
+ dataset,
2513
+ task_name,
2514
+ lang,
2515
+ limit,
2516
+ current_question,
2517
+ _request_auth,
2518
+ _content_type,
2519
+ _headers,
2520
+ _host_index,
2521
+ ) -> RequestSerialized:
2522
+
2523
+ _host = None
2524
+
2525
+ _collection_formats: Dict[str, str] = {
2526
+ }
2527
+
2528
+ _path_params: Dict[str, str] = {}
2529
+ _query_params: List[Tuple[str, str]] = []
2530
+ _header_params: Dict[str, Optional[str]] = _headers or {}
2531
+ _form_params: List[Tuple[str, str]] = []
2532
+ _files: Dict[
2533
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
2534
+ ] = {}
2535
+ _body_params: Optional[bytes] = None
2536
+
2537
+ # process the path parameters
2538
+ # process the query parameters
2539
+ if username is not None:
2540
+
2541
+ _query_params.append(('username', username))
2542
+
2543
+ if dataset is not None:
2544
+
2545
+ _query_params.append(('dataset', dataset))
2546
+
2547
+ if task_name is not None:
2548
+
2549
+ _query_params.append(('task_name', task_name))
2550
+
2551
+ if lang is not None:
2552
+
2553
+ _query_params.append(('lang', lang))
2554
+
2555
+ if limit is not None:
2556
+
2557
+ _query_params.append(('limit', limit))
2558
+
2559
+ if current_question is not None:
2560
+
2561
+ _query_params.append(('current_question', current_question))
2562
+
2563
+ # process the header parameters
2564
+ # process the form parameters
2565
+ # process the body parameter
2566
+
2567
+
2568
+ # set the HTTP header `Accept`
2569
+ if 'Accept' not in _header_params:
2570
+ _header_params['Accept'] = self.api_client.select_header_accept(
2571
+ [
2572
+ 'application/json'
2573
+ ]
2574
+ )
2575
+
2576
+
2577
+ # authentication setting
2578
+ _auth_settings: List[str] = [
2579
+ 'QAnswer-Api-Key',
2580
+ 'Bearer token'
2581
+ ]
2582
+
2583
+ return self.api_client.param_serialize(
2584
+ method='GET',
2585
+ resource_path='/backend/api/tasks/chat/suggest-questions',
2586
+ path_params=_path_params,
2587
+ query_params=_query_params,
2588
+ header_params=_header_params,
2589
+ body=_body_params,
2590
+ post_params=_form_params,
2591
+ files=_files,
2592
+ auth_settings=_auth_settings,
2593
+ collection_formats=_collection_formats,
2594
+ _host=_host,
2595
+ _request_auth=_request_auth
2596
+ )
2597
+
2598
+