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,1990 @@
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 StrictBytes, StrictInt, StrictStr
20
+ from typing import Any, List, Optional, Tuple, Union
21
+ from qanswer_sdk.models.create_connector_request import CreateConnectorRequest
22
+ from qanswer_sdk.models.create_connector_response import CreateConnectorResponse
23
+ from qanswer_sdk.models.document_metadata_list_wrapper import DocumentMetadataListWrapper
24
+ from qanswer_sdk.models.file_upload_payload import FileUploadPayload
25
+ from qanswer_sdk.models.status_response import StatusResponse
26
+
27
+ from qanswer_sdk.api_client import ApiClient, RequestSerialized
28
+ from qanswer_sdk.api_response import ApiResponse
29
+ from qanswer_sdk.rest import RESTResponseType
30
+
31
+
32
+ class ConnectorDocumentApi:
33
+ """NOTE: This class is auto generated by OpenAPI Generator
34
+ Ref: https://openapi-generator.tech
35
+
36
+ Do not edit the class manually.
37
+ """
38
+
39
+ def __init__(self, api_client=None) -> None:
40
+ if api_client is None:
41
+ api_client = ApiClient.get_default()
42
+ self.api_client = api_client
43
+
44
+
45
+ @validate_call
46
+ def document_connector_add_documents(
47
+ self,
48
+ username: StrictStr,
49
+ dataset: StrictStr,
50
+ file: List[Union[StrictBytes, StrictStr, Tuple[StrictStr, StrictBytes]]],
51
+ connector_id: Optional[StrictInt] = None,
52
+ conversation_id: Optional[StrictStr] = None,
53
+ metadata: Optional[DocumentMetadataListWrapper] = None,
54
+ _request_timeout: Union[
55
+ None,
56
+ Annotated[StrictFloat, Field(gt=0)],
57
+ Tuple[
58
+ Annotated[StrictFloat, Field(gt=0)],
59
+ Annotated[StrictFloat, Field(gt=0)]
60
+ ]
61
+ ] = None,
62
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
63
+ _content_type: Optional[StrictStr] = None,
64
+ _headers: Optional[Dict[StrictStr, Any]] = None,
65
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
66
+ ) -> StatusResponse:
67
+ """Add Documents
68
+
69
+ Add Documents
70
+
71
+ :param username: (required)
72
+ :type username: str
73
+ :param dataset: (required)
74
+ :type dataset: str
75
+ :param file: (required)
76
+ :type file: List[bytearray]
77
+ :param connector_id:
78
+ :type connector_id: int
79
+ :param conversation_id:
80
+ :type conversation_id: str
81
+ :param metadata:
82
+ :type metadata: DocumentMetadataListWrapper
83
+ :param _request_timeout: timeout setting for this request. If one
84
+ number provided, it will be total request
85
+ timeout. It can also be a pair (tuple) of
86
+ (connection, read) timeouts.
87
+ :type _request_timeout: int, tuple(int, int), optional
88
+ :param _request_auth: set to override the auth_settings for an a single
89
+ request; this effectively ignores the
90
+ authentication in the spec for a single request.
91
+ :type _request_auth: dict, optional
92
+ :param _content_type: force content-type for the request.
93
+ :type _content_type: str, Optional
94
+ :param _headers: set to override the headers for a single
95
+ request; this effectively ignores the headers
96
+ in the spec for a single request.
97
+ :type _headers: dict, optional
98
+ :param _host_index: set to override the host_index for a single
99
+ request; this effectively ignores the host_index
100
+ in the spec for a single request.
101
+ :type _host_index: int, optional
102
+ :return: Returns the result object.
103
+ """ # noqa: E501
104
+
105
+ _param = self._document_connector_add_documents_serialize(
106
+ username=username,
107
+ dataset=dataset,
108
+ file=file,
109
+ connector_id=connector_id,
110
+ conversation_id=conversation_id,
111
+ metadata=metadata,
112
+ _request_auth=_request_auth,
113
+ _content_type=_content_type,
114
+ _headers=_headers,
115
+ _host_index=_host_index
116
+ )
117
+
118
+ _response_types_map: Dict[str, Optional[str]] = {
119
+ '200': "StatusResponse",
120
+ '422': "HTTPValidationError",
121
+ }
122
+ response_data = self.api_client.call_api(
123
+ *_param,
124
+ _request_timeout=_request_timeout
125
+ )
126
+ response_data.read()
127
+ return self.api_client.response_deserialize(
128
+ response_data=response_data,
129
+ response_types_map=_response_types_map,
130
+ ).data
131
+
132
+
133
+ @validate_call
134
+ def document_connector_add_documents_with_http_info(
135
+ self,
136
+ username: StrictStr,
137
+ dataset: StrictStr,
138
+ file: List[Union[StrictBytes, StrictStr, Tuple[StrictStr, StrictBytes]]],
139
+ connector_id: Optional[StrictInt] = None,
140
+ conversation_id: Optional[StrictStr] = None,
141
+ metadata: Optional[DocumentMetadataListWrapper] = None,
142
+ _request_timeout: Union[
143
+ None,
144
+ Annotated[StrictFloat, Field(gt=0)],
145
+ Tuple[
146
+ Annotated[StrictFloat, Field(gt=0)],
147
+ Annotated[StrictFloat, Field(gt=0)]
148
+ ]
149
+ ] = None,
150
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
151
+ _content_type: Optional[StrictStr] = None,
152
+ _headers: Optional[Dict[StrictStr, Any]] = None,
153
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
154
+ ) -> ApiResponse[StatusResponse]:
155
+ """Add Documents
156
+
157
+ Add Documents
158
+
159
+ :param username: (required)
160
+ :type username: str
161
+ :param dataset: (required)
162
+ :type dataset: str
163
+ :param file: (required)
164
+ :type file: List[bytearray]
165
+ :param connector_id:
166
+ :type connector_id: int
167
+ :param conversation_id:
168
+ :type conversation_id: str
169
+ :param metadata:
170
+ :type metadata: DocumentMetadataListWrapper
171
+ :param _request_timeout: timeout setting for this request. If one
172
+ number provided, it will be total request
173
+ timeout. It can also be a pair (tuple) of
174
+ (connection, read) timeouts.
175
+ :type _request_timeout: int, tuple(int, int), optional
176
+ :param _request_auth: set to override the auth_settings for an a single
177
+ request; this effectively ignores the
178
+ authentication in the spec for a single request.
179
+ :type _request_auth: dict, optional
180
+ :param _content_type: force content-type for the request.
181
+ :type _content_type: str, Optional
182
+ :param _headers: set to override the headers for a single
183
+ request; this effectively ignores the headers
184
+ in the spec for a single request.
185
+ :type _headers: dict, optional
186
+ :param _host_index: set to override the host_index for a single
187
+ request; this effectively ignores the host_index
188
+ in the spec for a single request.
189
+ :type _host_index: int, optional
190
+ :return: Returns the result object.
191
+ """ # noqa: E501
192
+
193
+ _param = self._document_connector_add_documents_serialize(
194
+ username=username,
195
+ dataset=dataset,
196
+ file=file,
197
+ connector_id=connector_id,
198
+ conversation_id=conversation_id,
199
+ metadata=metadata,
200
+ _request_auth=_request_auth,
201
+ _content_type=_content_type,
202
+ _headers=_headers,
203
+ _host_index=_host_index
204
+ )
205
+
206
+ _response_types_map: Dict[str, Optional[str]] = {
207
+ '200': "StatusResponse",
208
+ '422': "HTTPValidationError",
209
+ }
210
+ response_data = self.api_client.call_api(
211
+ *_param,
212
+ _request_timeout=_request_timeout
213
+ )
214
+ response_data.read()
215
+ return self.api_client.response_deserialize(
216
+ response_data=response_data,
217
+ response_types_map=_response_types_map,
218
+ )
219
+
220
+
221
+ @validate_call
222
+ def document_connector_add_documents_without_preload_content(
223
+ self,
224
+ username: StrictStr,
225
+ dataset: StrictStr,
226
+ file: List[Union[StrictBytes, StrictStr, Tuple[StrictStr, StrictBytes]]],
227
+ connector_id: Optional[StrictInt] = None,
228
+ conversation_id: Optional[StrictStr] = None,
229
+ metadata: Optional[DocumentMetadataListWrapper] = None,
230
+ _request_timeout: Union[
231
+ None,
232
+ Annotated[StrictFloat, Field(gt=0)],
233
+ Tuple[
234
+ Annotated[StrictFloat, Field(gt=0)],
235
+ Annotated[StrictFloat, Field(gt=0)]
236
+ ]
237
+ ] = None,
238
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
239
+ _content_type: Optional[StrictStr] = None,
240
+ _headers: Optional[Dict[StrictStr, Any]] = None,
241
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
242
+ ) -> RESTResponseType:
243
+ """Add Documents
244
+
245
+ Add Documents
246
+
247
+ :param username: (required)
248
+ :type username: str
249
+ :param dataset: (required)
250
+ :type dataset: str
251
+ :param file: (required)
252
+ :type file: List[bytearray]
253
+ :param connector_id:
254
+ :type connector_id: int
255
+ :param conversation_id:
256
+ :type conversation_id: str
257
+ :param metadata:
258
+ :type metadata: DocumentMetadataListWrapper
259
+ :param _request_timeout: timeout setting for this request. If one
260
+ number provided, it will be total request
261
+ timeout. It can also be a pair (tuple) of
262
+ (connection, read) timeouts.
263
+ :type _request_timeout: int, tuple(int, int), optional
264
+ :param _request_auth: set to override the auth_settings for an a single
265
+ request; this effectively ignores the
266
+ authentication in the spec for a single request.
267
+ :type _request_auth: dict, optional
268
+ :param _content_type: force content-type for the request.
269
+ :type _content_type: str, Optional
270
+ :param _headers: set to override the headers for a single
271
+ request; this effectively ignores the headers
272
+ in the spec for a single request.
273
+ :type _headers: dict, optional
274
+ :param _host_index: set to override the host_index for a single
275
+ request; this effectively ignores the host_index
276
+ in the spec for a single request.
277
+ :type _host_index: int, optional
278
+ :return: Returns the result object.
279
+ """ # noqa: E501
280
+
281
+ _param = self._document_connector_add_documents_serialize(
282
+ username=username,
283
+ dataset=dataset,
284
+ file=file,
285
+ connector_id=connector_id,
286
+ conversation_id=conversation_id,
287
+ metadata=metadata,
288
+ _request_auth=_request_auth,
289
+ _content_type=_content_type,
290
+ _headers=_headers,
291
+ _host_index=_host_index
292
+ )
293
+
294
+ _response_types_map: Dict[str, Optional[str]] = {
295
+ '200': "StatusResponse",
296
+ '422': "HTTPValidationError",
297
+ }
298
+ response_data = self.api_client.call_api(
299
+ *_param,
300
+ _request_timeout=_request_timeout
301
+ )
302
+ return response_data.response
303
+
304
+
305
+ def _document_connector_add_documents_serialize(
306
+ self,
307
+ username,
308
+ dataset,
309
+ file,
310
+ connector_id,
311
+ conversation_id,
312
+ metadata,
313
+ _request_auth,
314
+ _content_type,
315
+ _headers,
316
+ _host_index,
317
+ ) -> RequestSerialized:
318
+
319
+ _host = None
320
+
321
+ _collection_formats: Dict[str, str] = {
322
+ 'file': 'csv',
323
+ }
324
+
325
+ _path_params: Dict[str, str] = {}
326
+ _query_params: List[Tuple[str, str]] = []
327
+ _header_params: Dict[str, Optional[str]] = _headers or {}
328
+ _form_params: List[Tuple[str, str]] = []
329
+ _files: Dict[
330
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
331
+ ] = {}
332
+ _body_params: Optional[bytes] = None
333
+
334
+ # process the path parameters
335
+ # process the query parameters
336
+ if username is not None:
337
+
338
+ _query_params.append(('username', username))
339
+
340
+ if dataset is not None:
341
+
342
+ _query_params.append(('dataset', dataset))
343
+
344
+ if connector_id is not None:
345
+
346
+ _query_params.append(('connector_id', connector_id))
347
+
348
+ if conversation_id is not None:
349
+
350
+ _query_params.append(('conversationId', conversation_id))
351
+
352
+ # process the header parameters
353
+ # process the form parameters
354
+ if file is not None:
355
+ _files['file'] = file
356
+ if metadata is not None:
357
+ _form_params.append(('metadata', metadata))
358
+ # process the body parameter
359
+
360
+
361
+ # set the HTTP header `Accept`
362
+ if 'Accept' not in _header_params:
363
+ _header_params['Accept'] = self.api_client.select_header_accept(
364
+ [
365
+ 'application/json'
366
+ ]
367
+ )
368
+
369
+ # set the HTTP header `Content-Type`
370
+ if _content_type:
371
+ _header_params['Content-Type'] = _content_type
372
+ else:
373
+ _default_content_type = (
374
+ self.api_client.select_header_content_type(
375
+ [
376
+ 'multipart/form-data'
377
+ ]
378
+ )
379
+ )
380
+ if _default_content_type is not None:
381
+ _header_params['Content-Type'] = _default_content_type
382
+
383
+ # authentication setting
384
+ _auth_settings: List[str] = [
385
+ 'QAnswer-Api-Key',
386
+ 'Bearer token'
387
+ ]
388
+
389
+ return self.api_client.param_serialize(
390
+ method='POST',
391
+ resource_path='/backend/api/connectors/document/add',
392
+ path_params=_path_params,
393
+ query_params=_query_params,
394
+ header_params=_header_params,
395
+ body=_body_params,
396
+ post_params=_form_params,
397
+ files=_files,
398
+ auth_settings=_auth_settings,
399
+ collection_formats=_collection_formats,
400
+ _host=_host,
401
+ _request_auth=_request_auth
402
+ )
403
+
404
+
405
+
406
+
407
+ @validate_call
408
+ def document_connector_add_documents_doc(
409
+ self,
410
+ username: StrictStr,
411
+ dataset: StrictStr,
412
+ connector_id: StrictInt,
413
+ file: Union[StrictBytes, StrictStr, Tuple[StrictStr, StrictBytes]],
414
+ metadata: Optional[DocumentMetadataListWrapper] = None,
415
+ _request_timeout: Union[
416
+ None,
417
+ Annotated[StrictFloat, Field(gt=0)],
418
+ Tuple[
419
+ Annotated[StrictFloat, Field(gt=0)],
420
+ Annotated[StrictFloat, Field(gt=0)]
421
+ ]
422
+ ] = None,
423
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
424
+ _content_type: Optional[StrictStr] = None,
425
+ _headers: Optional[Dict[StrictStr, Any]] = None,
426
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
427
+ ) -> object:
428
+ """Add Documents Doc
429
+
430
+
431
+ :param username: (required)
432
+ :type username: str
433
+ :param dataset: (required)
434
+ :type dataset: str
435
+ :param connector_id: (required)
436
+ :type connector_id: int
437
+ :param file: (required)
438
+ :type file: bytearray
439
+ :param metadata:
440
+ :type metadata: DocumentMetadataListWrapper
441
+ :param _request_timeout: timeout setting for this request. If one
442
+ number provided, it will be total request
443
+ timeout. It can also be a pair (tuple) of
444
+ (connection, read) timeouts.
445
+ :type _request_timeout: int, tuple(int, int), optional
446
+ :param _request_auth: set to override the auth_settings for an a single
447
+ request; this effectively ignores the
448
+ authentication in the spec for a single request.
449
+ :type _request_auth: dict, optional
450
+ :param _content_type: force content-type for the request.
451
+ :type _content_type: str, Optional
452
+ :param _headers: set to override the headers for a single
453
+ request; this effectively ignores the headers
454
+ in the spec for a single request.
455
+ :type _headers: dict, optional
456
+ :param _host_index: set to override the host_index for a single
457
+ request; this effectively ignores the host_index
458
+ in the spec for a single request.
459
+ :type _host_index: int, optional
460
+ :return: Returns the result object.
461
+ """ # noqa: E501
462
+
463
+ _param = self._document_connector_add_documents_doc_serialize(
464
+ username=username,
465
+ dataset=dataset,
466
+ connector_id=connector_id,
467
+ file=file,
468
+ metadata=metadata,
469
+ _request_auth=_request_auth,
470
+ _content_type=_content_type,
471
+ _headers=_headers,
472
+ _host_index=_host_index
473
+ )
474
+
475
+ _response_types_map: Dict[str, Optional[str]] = {
476
+ '200': "object",
477
+ '422': "HTTPValidationError",
478
+ }
479
+ response_data = self.api_client.call_api(
480
+ *_param,
481
+ _request_timeout=_request_timeout
482
+ )
483
+ response_data.read()
484
+ return self.api_client.response_deserialize(
485
+ response_data=response_data,
486
+ response_types_map=_response_types_map,
487
+ ).data
488
+
489
+
490
+ @validate_call
491
+ def document_connector_add_documents_doc_with_http_info(
492
+ self,
493
+ username: StrictStr,
494
+ dataset: StrictStr,
495
+ connector_id: StrictInt,
496
+ file: Union[StrictBytes, StrictStr, Tuple[StrictStr, StrictBytes]],
497
+ metadata: Optional[DocumentMetadataListWrapper] = None,
498
+ _request_timeout: Union[
499
+ None,
500
+ Annotated[StrictFloat, Field(gt=0)],
501
+ Tuple[
502
+ Annotated[StrictFloat, Field(gt=0)],
503
+ Annotated[StrictFloat, Field(gt=0)]
504
+ ]
505
+ ] = None,
506
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
507
+ _content_type: Optional[StrictStr] = None,
508
+ _headers: Optional[Dict[StrictStr, Any]] = None,
509
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
510
+ ) -> ApiResponse[object]:
511
+ """Add Documents Doc
512
+
513
+
514
+ :param username: (required)
515
+ :type username: str
516
+ :param dataset: (required)
517
+ :type dataset: str
518
+ :param connector_id: (required)
519
+ :type connector_id: int
520
+ :param file: (required)
521
+ :type file: bytearray
522
+ :param metadata:
523
+ :type metadata: DocumentMetadataListWrapper
524
+ :param _request_timeout: timeout setting for this request. If one
525
+ number provided, it will be total request
526
+ timeout. It can also be a pair (tuple) of
527
+ (connection, read) timeouts.
528
+ :type _request_timeout: int, tuple(int, int), optional
529
+ :param _request_auth: set to override the auth_settings for an a single
530
+ request; this effectively ignores the
531
+ authentication in the spec for a single request.
532
+ :type _request_auth: dict, optional
533
+ :param _content_type: force content-type for the request.
534
+ :type _content_type: str, Optional
535
+ :param _headers: set to override the headers for a single
536
+ request; this effectively ignores the headers
537
+ in the spec for a single request.
538
+ :type _headers: dict, optional
539
+ :param _host_index: set to override the host_index for a single
540
+ request; this effectively ignores the host_index
541
+ in the spec for a single request.
542
+ :type _host_index: int, optional
543
+ :return: Returns the result object.
544
+ """ # noqa: E501
545
+
546
+ _param = self._document_connector_add_documents_doc_serialize(
547
+ username=username,
548
+ dataset=dataset,
549
+ connector_id=connector_id,
550
+ file=file,
551
+ metadata=metadata,
552
+ _request_auth=_request_auth,
553
+ _content_type=_content_type,
554
+ _headers=_headers,
555
+ _host_index=_host_index
556
+ )
557
+
558
+ _response_types_map: Dict[str, Optional[str]] = {
559
+ '200': "object",
560
+ '422': "HTTPValidationError",
561
+ }
562
+ response_data = self.api_client.call_api(
563
+ *_param,
564
+ _request_timeout=_request_timeout
565
+ )
566
+ response_data.read()
567
+ return self.api_client.response_deserialize(
568
+ response_data=response_data,
569
+ response_types_map=_response_types_map,
570
+ )
571
+
572
+
573
+ @validate_call
574
+ def document_connector_add_documents_doc_without_preload_content(
575
+ self,
576
+ username: StrictStr,
577
+ dataset: StrictStr,
578
+ connector_id: StrictInt,
579
+ file: Union[StrictBytes, StrictStr, Tuple[StrictStr, StrictBytes]],
580
+ metadata: Optional[DocumentMetadataListWrapper] = None,
581
+ _request_timeout: Union[
582
+ None,
583
+ Annotated[StrictFloat, Field(gt=0)],
584
+ Tuple[
585
+ Annotated[StrictFloat, Field(gt=0)],
586
+ Annotated[StrictFloat, Field(gt=0)]
587
+ ]
588
+ ] = None,
589
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
590
+ _content_type: Optional[StrictStr] = None,
591
+ _headers: Optional[Dict[StrictStr, Any]] = None,
592
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
593
+ ) -> RESTResponseType:
594
+ """Add Documents Doc
595
+
596
+
597
+ :param username: (required)
598
+ :type username: str
599
+ :param dataset: (required)
600
+ :type dataset: str
601
+ :param connector_id: (required)
602
+ :type connector_id: int
603
+ :param file: (required)
604
+ :type file: bytearray
605
+ :param metadata:
606
+ :type metadata: DocumentMetadataListWrapper
607
+ :param _request_timeout: timeout setting for this request. If one
608
+ number provided, it will be total request
609
+ timeout. It can also be a pair (tuple) of
610
+ (connection, read) timeouts.
611
+ :type _request_timeout: int, tuple(int, int), optional
612
+ :param _request_auth: set to override the auth_settings for an a single
613
+ request; this effectively ignores the
614
+ authentication in the spec for a single request.
615
+ :type _request_auth: dict, optional
616
+ :param _content_type: force content-type for the request.
617
+ :type _content_type: str, Optional
618
+ :param _headers: set to override the headers for a single
619
+ request; this effectively ignores the headers
620
+ in the spec for a single request.
621
+ :type _headers: dict, optional
622
+ :param _host_index: set to override the host_index for a single
623
+ request; this effectively ignores the host_index
624
+ in the spec for a single request.
625
+ :type _host_index: int, optional
626
+ :return: Returns the result object.
627
+ """ # noqa: E501
628
+
629
+ _param = self._document_connector_add_documents_doc_serialize(
630
+ username=username,
631
+ dataset=dataset,
632
+ connector_id=connector_id,
633
+ file=file,
634
+ metadata=metadata,
635
+ _request_auth=_request_auth,
636
+ _content_type=_content_type,
637
+ _headers=_headers,
638
+ _host_index=_host_index
639
+ )
640
+
641
+ _response_types_map: Dict[str, Optional[str]] = {
642
+ '200': "object",
643
+ '422': "HTTPValidationError",
644
+ }
645
+ response_data = self.api_client.call_api(
646
+ *_param,
647
+ _request_timeout=_request_timeout
648
+ )
649
+ return response_data.response
650
+
651
+
652
+ def _document_connector_add_documents_doc_serialize(
653
+ self,
654
+ username,
655
+ dataset,
656
+ connector_id,
657
+ file,
658
+ metadata,
659
+ _request_auth,
660
+ _content_type,
661
+ _headers,
662
+ _host_index,
663
+ ) -> RequestSerialized:
664
+
665
+ _host = None
666
+
667
+ _collection_formats: Dict[str, str] = {
668
+ }
669
+
670
+ _path_params: Dict[str, str] = {}
671
+ _query_params: List[Tuple[str, str]] = []
672
+ _header_params: Dict[str, Optional[str]] = _headers or {}
673
+ _form_params: List[Tuple[str, str]] = []
674
+ _files: Dict[
675
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
676
+ ] = {}
677
+ _body_params: Optional[bytes] = None
678
+
679
+ # process the path parameters
680
+ # process the query parameters
681
+ if username is not None:
682
+
683
+ _query_params.append(('username', username))
684
+
685
+ if dataset is not None:
686
+
687
+ _query_params.append(('dataset', dataset))
688
+
689
+ if connector_id is not None:
690
+
691
+ _query_params.append(('connector_id', connector_id))
692
+
693
+ # process the header parameters
694
+ # process the form parameters
695
+ if file is not None:
696
+ _files['file'] = file
697
+ if metadata is not None:
698
+ _form_params.append(('metadata', metadata))
699
+ # process the body parameter
700
+
701
+
702
+ # set the HTTP header `Accept`
703
+ if 'Accept' not in _header_params:
704
+ _header_params['Accept'] = self.api_client.select_header_accept(
705
+ [
706
+ 'application/json'
707
+ ]
708
+ )
709
+
710
+ # set the HTTP header `Content-Type`
711
+ if _content_type:
712
+ _header_params['Content-Type'] = _content_type
713
+ else:
714
+ _default_content_type = (
715
+ self.api_client.select_header_content_type(
716
+ [
717
+ 'multipart/form-data'
718
+ ]
719
+ )
720
+ )
721
+ if _default_content_type is not None:
722
+ _header_params['Content-Type'] = _default_content_type
723
+
724
+ # authentication setting
725
+ _auth_settings: List[str] = [
726
+ 'QAnswer-Api-Key',
727
+ 'Bearer token'
728
+ ]
729
+
730
+ return self.api_client.param_serialize(
731
+ method='POST',
732
+ resource_path='/backend/api/connectors/document/doc/add',
733
+ path_params=_path_params,
734
+ query_params=_query_params,
735
+ header_params=_header_params,
736
+ body=_body_params,
737
+ post_params=_form_params,
738
+ files=_files,
739
+ auth_settings=_auth_settings,
740
+ collection_formats=_collection_formats,
741
+ _host=_host,
742
+ _request_auth=_request_auth
743
+ )
744
+
745
+
746
+
747
+
748
+ @validate_call
749
+ def document_connector_add_documents_load_test(
750
+ self,
751
+ data: FileUploadPayload,
752
+ files: List[Union[StrictBytes, StrictStr, Tuple[StrictStr, StrictBytes]]],
753
+ _request_timeout: Union[
754
+ None,
755
+ Annotated[StrictFloat, Field(gt=0)],
756
+ Tuple[
757
+ Annotated[StrictFloat, Field(gt=0)],
758
+ Annotated[StrictFloat, Field(gt=0)]
759
+ ]
760
+ ] = None,
761
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
762
+ _content_type: Optional[StrictStr] = None,
763
+ _headers: Optional[Dict[StrictStr, Any]] = None,
764
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
765
+ ) -> StatusResponse:
766
+ """Add Documents Load Test
767
+
768
+ Add Documents Synchronously
769
+
770
+ :param data: (required)
771
+ :type data: FileUploadPayload
772
+ :param files: (required)
773
+ :type files: List[bytearray]
774
+ :param _request_timeout: timeout setting for this request. If one
775
+ number provided, it will be total request
776
+ timeout. It can also be a pair (tuple) of
777
+ (connection, read) timeouts.
778
+ :type _request_timeout: int, tuple(int, int), optional
779
+ :param _request_auth: set to override the auth_settings for an a single
780
+ request; this effectively ignores the
781
+ authentication in the spec for a single request.
782
+ :type _request_auth: dict, optional
783
+ :param _content_type: force content-type for the request.
784
+ :type _content_type: str, Optional
785
+ :param _headers: set to override the headers for a single
786
+ request; this effectively ignores the headers
787
+ in the spec for a single request.
788
+ :type _headers: dict, optional
789
+ :param _host_index: set to override the host_index for a single
790
+ request; this effectively ignores the host_index
791
+ in the spec for a single request.
792
+ :type _host_index: int, optional
793
+ :return: Returns the result object.
794
+ """ # noqa: E501
795
+
796
+ _param = self._document_connector_add_documents_load_test_serialize(
797
+ data=data,
798
+ files=files,
799
+ _request_auth=_request_auth,
800
+ _content_type=_content_type,
801
+ _headers=_headers,
802
+ _host_index=_host_index
803
+ )
804
+
805
+ _response_types_map: Dict[str, Optional[str]] = {
806
+ '200': "StatusResponse",
807
+ '422': "HTTPValidationError",
808
+ }
809
+ response_data = self.api_client.call_api(
810
+ *_param,
811
+ _request_timeout=_request_timeout
812
+ )
813
+ response_data.read()
814
+ return self.api_client.response_deserialize(
815
+ response_data=response_data,
816
+ response_types_map=_response_types_map,
817
+ ).data
818
+
819
+
820
+ @validate_call
821
+ def document_connector_add_documents_load_test_with_http_info(
822
+ self,
823
+ data: FileUploadPayload,
824
+ files: List[Union[StrictBytes, StrictStr, Tuple[StrictStr, StrictBytes]]],
825
+ _request_timeout: Union[
826
+ None,
827
+ Annotated[StrictFloat, Field(gt=0)],
828
+ Tuple[
829
+ Annotated[StrictFloat, Field(gt=0)],
830
+ Annotated[StrictFloat, Field(gt=0)]
831
+ ]
832
+ ] = None,
833
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
834
+ _content_type: Optional[StrictStr] = None,
835
+ _headers: Optional[Dict[StrictStr, Any]] = None,
836
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
837
+ ) -> ApiResponse[StatusResponse]:
838
+ """Add Documents Load Test
839
+
840
+ Add Documents Synchronously
841
+
842
+ :param data: (required)
843
+ :type data: FileUploadPayload
844
+ :param files: (required)
845
+ :type files: List[bytearray]
846
+ :param _request_timeout: timeout setting for this request. If one
847
+ number provided, it will be total request
848
+ timeout. It can also be a pair (tuple) of
849
+ (connection, read) timeouts.
850
+ :type _request_timeout: int, tuple(int, int), optional
851
+ :param _request_auth: set to override the auth_settings for an a single
852
+ request; this effectively ignores the
853
+ authentication in the spec for a single request.
854
+ :type _request_auth: dict, optional
855
+ :param _content_type: force content-type for the request.
856
+ :type _content_type: str, Optional
857
+ :param _headers: set to override the headers for a single
858
+ request; this effectively ignores the headers
859
+ in the spec for a single request.
860
+ :type _headers: dict, optional
861
+ :param _host_index: set to override the host_index for a single
862
+ request; this effectively ignores the host_index
863
+ in the spec for a single request.
864
+ :type _host_index: int, optional
865
+ :return: Returns the result object.
866
+ """ # noqa: E501
867
+
868
+ _param = self._document_connector_add_documents_load_test_serialize(
869
+ data=data,
870
+ files=files,
871
+ _request_auth=_request_auth,
872
+ _content_type=_content_type,
873
+ _headers=_headers,
874
+ _host_index=_host_index
875
+ )
876
+
877
+ _response_types_map: Dict[str, Optional[str]] = {
878
+ '200': "StatusResponse",
879
+ '422': "HTTPValidationError",
880
+ }
881
+ response_data = self.api_client.call_api(
882
+ *_param,
883
+ _request_timeout=_request_timeout
884
+ )
885
+ response_data.read()
886
+ return self.api_client.response_deserialize(
887
+ response_data=response_data,
888
+ response_types_map=_response_types_map,
889
+ )
890
+
891
+
892
+ @validate_call
893
+ def document_connector_add_documents_load_test_without_preload_content(
894
+ self,
895
+ data: FileUploadPayload,
896
+ files: List[Union[StrictBytes, StrictStr, Tuple[StrictStr, StrictBytes]]],
897
+ _request_timeout: Union[
898
+ None,
899
+ Annotated[StrictFloat, Field(gt=0)],
900
+ Tuple[
901
+ Annotated[StrictFloat, Field(gt=0)],
902
+ Annotated[StrictFloat, Field(gt=0)]
903
+ ]
904
+ ] = None,
905
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
906
+ _content_type: Optional[StrictStr] = None,
907
+ _headers: Optional[Dict[StrictStr, Any]] = None,
908
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
909
+ ) -> RESTResponseType:
910
+ """Add Documents Load Test
911
+
912
+ Add Documents Synchronously
913
+
914
+ :param data: (required)
915
+ :type data: FileUploadPayload
916
+ :param files: (required)
917
+ :type files: List[bytearray]
918
+ :param _request_timeout: timeout setting for this request. If one
919
+ number provided, it will be total request
920
+ timeout. It can also be a pair (tuple) of
921
+ (connection, read) timeouts.
922
+ :type _request_timeout: int, tuple(int, int), optional
923
+ :param _request_auth: set to override the auth_settings for an a single
924
+ request; this effectively ignores the
925
+ authentication in the spec for a single request.
926
+ :type _request_auth: dict, optional
927
+ :param _content_type: force content-type for the request.
928
+ :type _content_type: str, Optional
929
+ :param _headers: set to override the headers for a single
930
+ request; this effectively ignores the headers
931
+ in the spec for a single request.
932
+ :type _headers: dict, optional
933
+ :param _host_index: set to override the host_index for a single
934
+ request; this effectively ignores the host_index
935
+ in the spec for a single request.
936
+ :type _host_index: int, optional
937
+ :return: Returns the result object.
938
+ """ # noqa: E501
939
+
940
+ _param = self._document_connector_add_documents_load_test_serialize(
941
+ data=data,
942
+ files=files,
943
+ _request_auth=_request_auth,
944
+ _content_type=_content_type,
945
+ _headers=_headers,
946
+ _host_index=_host_index
947
+ )
948
+
949
+ _response_types_map: Dict[str, Optional[str]] = {
950
+ '200': "StatusResponse",
951
+ '422': "HTTPValidationError",
952
+ }
953
+ response_data = self.api_client.call_api(
954
+ *_param,
955
+ _request_timeout=_request_timeout
956
+ )
957
+ return response_data.response
958
+
959
+
960
+ def _document_connector_add_documents_load_test_serialize(
961
+ self,
962
+ data,
963
+ files,
964
+ _request_auth,
965
+ _content_type,
966
+ _headers,
967
+ _host_index,
968
+ ) -> RequestSerialized:
969
+
970
+ _host = None
971
+
972
+ _collection_formats: Dict[str, str] = {
973
+ 'files': 'csv',
974
+ }
975
+
976
+ _path_params: Dict[str, str] = {}
977
+ _query_params: List[Tuple[str, str]] = []
978
+ _header_params: Dict[str, Optional[str]] = _headers or {}
979
+ _form_params: List[Tuple[str, str]] = []
980
+ _files: Dict[
981
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
982
+ ] = {}
983
+ _body_params: Optional[bytes] = None
984
+
985
+ # process the path parameters
986
+ # process the query parameters
987
+ # process the header parameters
988
+ # process the form parameters
989
+ if data is not None:
990
+ _form_params.append(('data', data))
991
+ if files is not None:
992
+ _files['files'] = files
993
+ # process the body parameter
994
+
995
+
996
+ # set the HTTP header `Accept`
997
+ if 'Accept' not in _header_params:
998
+ _header_params['Accept'] = self.api_client.select_header_accept(
999
+ [
1000
+ 'application/json'
1001
+ ]
1002
+ )
1003
+
1004
+ # set the HTTP header `Content-Type`
1005
+ if _content_type:
1006
+ _header_params['Content-Type'] = _content_type
1007
+ else:
1008
+ _default_content_type = (
1009
+ self.api_client.select_header_content_type(
1010
+ [
1011
+ 'multipart/form-data'
1012
+ ]
1013
+ )
1014
+ )
1015
+ if _default_content_type is not None:
1016
+ _header_params['Content-Type'] = _default_content_type
1017
+
1018
+ # authentication setting
1019
+ _auth_settings: List[str] = [
1020
+ 'QAnswer-Api-Key',
1021
+ 'Bearer token'
1022
+ ]
1023
+
1024
+ return self.api_client.param_serialize(
1025
+ method='POST',
1026
+ resource_path='/backend/api/connectors/document/add-async-loadtest',
1027
+ path_params=_path_params,
1028
+ query_params=_query_params,
1029
+ header_params=_header_params,
1030
+ body=_body_params,
1031
+ post_params=_form_params,
1032
+ files=_files,
1033
+ auth_settings=_auth_settings,
1034
+ collection_formats=_collection_formats,
1035
+ _host=_host,
1036
+ _request_auth=_request_auth
1037
+ )
1038
+
1039
+
1040
+
1041
+
1042
+ @validate_call
1043
+ def document_connector_add_documents_sync(
1044
+ self,
1045
+ data: FileUploadPayload,
1046
+ files: List[Union[StrictBytes, StrictStr, Tuple[StrictStr, StrictBytes]]],
1047
+ _request_timeout: Union[
1048
+ None,
1049
+ Annotated[StrictFloat, Field(gt=0)],
1050
+ Tuple[
1051
+ Annotated[StrictFloat, Field(gt=0)],
1052
+ Annotated[StrictFloat, Field(gt=0)]
1053
+ ]
1054
+ ] = None,
1055
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1056
+ _content_type: Optional[StrictStr] = None,
1057
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1058
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1059
+ ) -> StatusResponse:
1060
+ """Add Documents Sync
1061
+
1062
+ Add Documents Synchronously
1063
+
1064
+ :param data: (required)
1065
+ :type data: FileUploadPayload
1066
+ :param files: (required)
1067
+ :type files: List[bytearray]
1068
+ :param _request_timeout: timeout setting for this request. If one
1069
+ number provided, it will be total request
1070
+ timeout. It can also be a pair (tuple) of
1071
+ (connection, read) timeouts.
1072
+ :type _request_timeout: int, tuple(int, int), optional
1073
+ :param _request_auth: set to override the auth_settings for an a single
1074
+ request; this effectively ignores the
1075
+ authentication in the spec for a single request.
1076
+ :type _request_auth: dict, optional
1077
+ :param _content_type: force content-type for the request.
1078
+ :type _content_type: str, Optional
1079
+ :param _headers: set to override the headers for a single
1080
+ request; this effectively ignores the headers
1081
+ in the spec for a single request.
1082
+ :type _headers: dict, optional
1083
+ :param _host_index: set to override the host_index for a single
1084
+ request; this effectively ignores the host_index
1085
+ in the spec for a single request.
1086
+ :type _host_index: int, optional
1087
+ :return: Returns the result object.
1088
+ """ # noqa: E501
1089
+
1090
+ _param = self._document_connector_add_documents_sync_serialize(
1091
+ data=data,
1092
+ files=files,
1093
+ _request_auth=_request_auth,
1094
+ _content_type=_content_type,
1095
+ _headers=_headers,
1096
+ _host_index=_host_index
1097
+ )
1098
+
1099
+ _response_types_map: Dict[str, Optional[str]] = {
1100
+ '200': "StatusResponse",
1101
+ '422': "HTTPValidationError",
1102
+ }
1103
+ response_data = self.api_client.call_api(
1104
+ *_param,
1105
+ _request_timeout=_request_timeout
1106
+ )
1107
+ response_data.read()
1108
+ return self.api_client.response_deserialize(
1109
+ response_data=response_data,
1110
+ response_types_map=_response_types_map,
1111
+ ).data
1112
+
1113
+
1114
+ @validate_call
1115
+ def document_connector_add_documents_sync_with_http_info(
1116
+ self,
1117
+ data: FileUploadPayload,
1118
+ files: List[Union[StrictBytes, StrictStr, Tuple[StrictStr, StrictBytes]]],
1119
+ _request_timeout: Union[
1120
+ None,
1121
+ Annotated[StrictFloat, Field(gt=0)],
1122
+ Tuple[
1123
+ Annotated[StrictFloat, Field(gt=0)],
1124
+ Annotated[StrictFloat, Field(gt=0)]
1125
+ ]
1126
+ ] = None,
1127
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1128
+ _content_type: Optional[StrictStr] = None,
1129
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1130
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1131
+ ) -> ApiResponse[StatusResponse]:
1132
+ """Add Documents Sync
1133
+
1134
+ Add Documents Synchronously
1135
+
1136
+ :param data: (required)
1137
+ :type data: FileUploadPayload
1138
+ :param files: (required)
1139
+ :type files: List[bytearray]
1140
+ :param _request_timeout: timeout setting for this request. If one
1141
+ number provided, it will be total request
1142
+ timeout. It can also be a pair (tuple) of
1143
+ (connection, read) timeouts.
1144
+ :type _request_timeout: int, tuple(int, int), optional
1145
+ :param _request_auth: set to override the auth_settings for an a single
1146
+ request; this effectively ignores the
1147
+ authentication in the spec for a single request.
1148
+ :type _request_auth: dict, optional
1149
+ :param _content_type: force content-type for the request.
1150
+ :type _content_type: str, Optional
1151
+ :param _headers: set to override the headers for a single
1152
+ request; this effectively ignores the headers
1153
+ in the spec for a single request.
1154
+ :type _headers: dict, optional
1155
+ :param _host_index: set to override the host_index for a single
1156
+ request; this effectively ignores the host_index
1157
+ in the spec for a single request.
1158
+ :type _host_index: int, optional
1159
+ :return: Returns the result object.
1160
+ """ # noqa: E501
1161
+
1162
+ _param = self._document_connector_add_documents_sync_serialize(
1163
+ data=data,
1164
+ files=files,
1165
+ _request_auth=_request_auth,
1166
+ _content_type=_content_type,
1167
+ _headers=_headers,
1168
+ _host_index=_host_index
1169
+ )
1170
+
1171
+ _response_types_map: Dict[str, Optional[str]] = {
1172
+ '200': "StatusResponse",
1173
+ '422': "HTTPValidationError",
1174
+ }
1175
+ response_data = self.api_client.call_api(
1176
+ *_param,
1177
+ _request_timeout=_request_timeout
1178
+ )
1179
+ response_data.read()
1180
+ return self.api_client.response_deserialize(
1181
+ response_data=response_data,
1182
+ response_types_map=_response_types_map,
1183
+ )
1184
+
1185
+
1186
+ @validate_call
1187
+ def document_connector_add_documents_sync_without_preload_content(
1188
+ self,
1189
+ data: FileUploadPayload,
1190
+ files: List[Union[StrictBytes, StrictStr, Tuple[StrictStr, StrictBytes]]],
1191
+ _request_timeout: Union[
1192
+ None,
1193
+ Annotated[StrictFloat, Field(gt=0)],
1194
+ Tuple[
1195
+ Annotated[StrictFloat, Field(gt=0)],
1196
+ Annotated[StrictFloat, Field(gt=0)]
1197
+ ]
1198
+ ] = None,
1199
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1200
+ _content_type: Optional[StrictStr] = None,
1201
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1202
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1203
+ ) -> RESTResponseType:
1204
+ """Add Documents Sync
1205
+
1206
+ Add Documents Synchronously
1207
+
1208
+ :param data: (required)
1209
+ :type data: FileUploadPayload
1210
+ :param files: (required)
1211
+ :type files: List[bytearray]
1212
+ :param _request_timeout: timeout setting for this request. If one
1213
+ number provided, it will be total request
1214
+ timeout. It can also be a pair (tuple) of
1215
+ (connection, read) timeouts.
1216
+ :type _request_timeout: int, tuple(int, int), optional
1217
+ :param _request_auth: set to override the auth_settings for an a single
1218
+ request; this effectively ignores the
1219
+ authentication in the spec for a single request.
1220
+ :type _request_auth: dict, optional
1221
+ :param _content_type: force content-type for the request.
1222
+ :type _content_type: str, Optional
1223
+ :param _headers: set to override the headers for a single
1224
+ request; this effectively ignores the headers
1225
+ in the spec for a single request.
1226
+ :type _headers: dict, optional
1227
+ :param _host_index: set to override the host_index for a single
1228
+ request; this effectively ignores the host_index
1229
+ in the spec for a single request.
1230
+ :type _host_index: int, optional
1231
+ :return: Returns the result object.
1232
+ """ # noqa: E501
1233
+
1234
+ _param = self._document_connector_add_documents_sync_serialize(
1235
+ data=data,
1236
+ files=files,
1237
+ _request_auth=_request_auth,
1238
+ _content_type=_content_type,
1239
+ _headers=_headers,
1240
+ _host_index=_host_index
1241
+ )
1242
+
1243
+ _response_types_map: Dict[str, Optional[str]] = {
1244
+ '200': "StatusResponse",
1245
+ '422': "HTTPValidationError",
1246
+ }
1247
+ response_data = self.api_client.call_api(
1248
+ *_param,
1249
+ _request_timeout=_request_timeout
1250
+ )
1251
+ return response_data.response
1252
+
1253
+
1254
+ def _document_connector_add_documents_sync_serialize(
1255
+ self,
1256
+ data,
1257
+ files,
1258
+ _request_auth,
1259
+ _content_type,
1260
+ _headers,
1261
+ _host_index,
1262
+ ) -> RequestSerialized:
1263
+
1264
+ _host = None
1265
+
1266
+ _collection_formats: Dict[str, str] = {
1267
+ 'files': 'csv',
1268
+ }
1269
+
1270
+ _path_params: Dict[str, str] = {}
1271
+ _query_params: List[Tuple[str, str]] = []
1272
+ _header_params: Dict[str, Optional[str]] = _headers or {}
1273
+ _form_params: List[Tuple[str, str]] = []
1274
+ _files: Dict[
1275
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
1276
+ ] = {}
1277
+ _body_params: Optional[bytes] = None
1278
+
1279
+ # process the path parameters
1280
+ # process the query parameters
1281
+ # process the header parameters
1282
+ # process the form parameters
1283
+ if data is not None:
1284
+ _form_params.append(('data', data))
1285
+ if files is not None:
1286
+ _files['files'] = files
1287
+ # process the body parameter
1288
+
1289
+
1290
+ # set the HTTP header `Accept`
1291
+ if 'Accept' not in _header_params:
1292
+ _header_params['Accept'] = self.api_client.select_header_accept(
1293
+ [
1294
+ 'application/json'
1295
+ ]
1296
+ )
1297
+
1298
+ # set the HTTP header `Content-Type`
1299
+ if _content_type:
1300
+ _header_params['Content-Type'] = _content_type
1301
+ else:
1302
+ _default_content_type = (
1303
+ self.api_client.select_header_content_type(
1304
+ [
1305
+ 'multipart/form-data'
1306
+ ]
1307
+ )
1308
+ )
1309
+ if _default_content_type is not None:
1310
+ _header_params['Content-Type'] = _default_content_type
1311
+
1312
+ # authentication setting
1313
+ _auth_settings: List[str] = [
1314
+ 'QAnswer-Api-Key',
1315
+ 'Bearer token'
1316
+ ]
1317
+
1318
+ return self.api_client.param_serialize(
1319
+ method='POST',
1320
+ resource_path='/backend/api/connectors/document/add-async',
1321
+ path_params=_path_params,
1322
+ query_params=_query_params,
1323
+ header_params=_header_params,
1324
+ body=_body_params,
1325
+ post_params=_form_params,
1326
+ files=_files,
1327
+ auth_settings=_auth_settings,
1328
+ collection_formats=_collection_formats,
1329
+ _host=_host,
1330
+ _request_auth=_request_auth
1331
+ )
1332
+
1333
+
1334
+
1335
+
1336
+ @validate_call
1337
+ def document_connector_create_connector(
1338
+ self,
1339
+ create_connector_request: CreateConnectorRequest,
1340
+ _request_timeout: Union[
1341
+ None,
1342
+ Annotated[StrictFloat, Field(gt=0)],
1343
+ Tuple[
1344
+ Annotated[StrictFloat, Field(gt=0)],
1345
+ Annotated[StrictFloat, Field(gt=0)]
1346
+ ]
1347
+ ] = None,
1348
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1349
+ _content_type: Optional[StrictStr] = None,
1350
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1351
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1352
+ ) -> CreateConnectorResponse:
1353
+ """Create Document Connector
1354
+
1355
+ Create Document Connector
1356
+
1357
+ :param create_connector_request: (required)
1358
+ :type create_connector_request: CreateConnectorRequest
1359
+ :param _request_timeout: timeout setting for this request. If one
1360
+ number provided, it will be total request
1361
+ timeout. It can also be a pair (tuple) of
1362
+ (connection, read) timeouts.
1363
+ :type _request_timeout: int, tuple(int, int), optional
1364
+ :param _request_auth: set to override the auth_settings for an a single
1365
+ request; this effectively ignores the
1366
+ authentication in the spec for a single request.
1367
+ :type _request_auth: dict, optional
1368
+ :param _content_type: force content-type for the request.
1369
+ :type _content_type: str, Optional
1370
+ :param _headers: set to override the headers for a single
1371
+ request; this effectively ignores the headers
1372
+ in the spec for a single request.
1373
+ :type _headers: dict, optional
1374
+ :param _host_index: set to override the host_index for a single
1375
+ request; this effectively ignores the host_index
1376
+ in the spec for a single request.
1377
+ :type _host_index: int, optional
1378
+ :return: Returns the result object.
1379
+ """ # noqa: E501
1380
+
1381
+ _param = self._document_connector_create_connector_serialize(
1382
+ create_connector_request=create_connector_request,
1383
+ _request_auth=_request_auth,
1384
+ _content_type=_content_type,
1385
+ _headers=_headers,
1386
+ _host_index=_host_index
1387
+ )
1388
+
1389
+ _response_types_map: Dict[str, Optional[str]] = {
1390
+ '200': "CreateConnectorResponse",
1391
+ '422': "HTTPValidationError",
1392
+ }
1393
+ response_data = self.api_client.call_api(
1394
+ *_param,
1395
+ _request_timeout=_request_timeout
1396
+ )
1397
+ response_data.read()
1398
+ return self.api_client.response_deserialize(
1399
+ response_data=response_data,
1400
+ response_types_map=_response_types_map,
1401
+ ).data
1402
+
1403
+
1404
+ @validate_call
1405
+ def document_connector_create_connector_with_http_info(
1406
+ self,
1407
+ create_connector_request: CreateConnectorRequest,
1408
+ _request_timeout: Union[
1409
+ None,
1410
+ Annotated[StrictFloat, Field(gt=0)],
1411
+ Tuple[
1412
+ Annotated[StrictFloat, Field(gt=0)],
1413
+ Annotated[StrictFloat, Field(gt=0)]
1414
+ ]
1415
+ ] = None,
1416
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1417
+ _content_type: Optional[StrictStr] = None,
1418
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1419
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1420
+ ) -> ApiResponse[CreateConnectorResponse]:
1421
+ """Create Document Connector
1422
+
1423
+ Create Document Connector
1424
+
1425
+ :param create_connector_request: (required)
1426
+ :type create_connector_request: CreateConnectorRequest
1427
+ :param _request_timeout: timeout setting for this request. If one
1428
+ number provided, it will be total request
1429
+ timeout. It can also be a pair (tuple) of
1430
+ (connection, read) timeouts.
1431
+ :type _request_timeout: int, tuple(int, int), optional
1432
+ :param _request_auth: set to override the auth_settings for an a single
1433
+ request; this effectively ignores the
1434
+ authentication in the spec for a single request.
1435
+ :type _request_auth: dict, optional
1436
+ :param _content_type: force content-type for the request.
1437
+ :type _content_type: str, Optional
1438
+ :param _headers: set to override the headers for a single
1439
+ request; this effectively ignores the headers
1440
+ in the spec for a single request.
1441
+ :type _headers: dict, optional
1442
+ :param _host_index: set to override the host_index for a single
1443
+ request; this effectively ignores the host_index
1444
+ in the spec for a single request.
1445
+ :type _host_index: int, optional
1446
+ :return: Returns the result object.
1447
+ """ # noqa: E501
1448
+
1449
+ _param = self._document_connector_create_connector_serialize(
1450
+ create_connector_request=create_connector_request,
1451
+ _request_auth=_request_auth,
1452
+ _content_type=_content_type,
1453
+ _headers=_headers,
1454
+ _host_index=_host_index
1455
+ )
1456
+
1457
+ _response_types_map: Dict[str, Optional[str]] = {
1458
+ '200': "CreateConnectorResponse",
1459
+ '422': "HTTPValidationError",
1460
+ }
1461
+ response_data = self.api_client.call_api(
1462
+ *_param,
1463
+ _request_timeout=_request_timeout
1464
+ )
1465
+ response_data.read()
1466
+ return self.api_client.response_deserialize(
1467
+ response_data=response_data,
1468
+ response_types_map=_response_types_map,
1469
+ )
1470
+
1471
+
1472
+ @validate_call
1473
+ def document_connector_create_connector_without_preload_content(
1474
+ self,
1475
+ create_connector_request: CreateConnectorRequest,
1476
+ _request_timeout: Union[
1477
+ None,
1478
+ Annotated[StrictFloat, Field(gt=0)],
1479
+ Tuple[
1480
+ Annotated[StrictFloat, Field(gt=0)],
1481
+ Annotated[StrictFloat, Field(gt=0)]
1482
+ ]
1483
+ ] = None,
1484
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1485
+ _content_type: Optional[StrictStr] = None,
1486
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1487
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1488
+ ) -> RESTResponseType:
1489
+ """Create Document Connector
1490
+
1491
+ Create Document Connector
1492
+
1493
+ :param create_connector_request: (required)
1494
+ :type create_connector_request: CreateConnectorRequest
1495
+ :param _request_timeout: timeout setting for this request. If one
1496
+ number provided, it will be total request
1497
+ timeout. It can also be a pair (tuple) of
1498
+ (connection, read) timeouts.
1499
+ :type _request_timeout: int, tuple(int, int), optional
1500
+ :param _request_auth: set to override the auth_settings for an a single
1501
+ request; this effectively ignores the
1502
+ authentication in the spec for a single request.
1503
+ :type _request_auth: dict, optional
1504
+ :param _content_type: force content-type for the request.
1505
+ :type _content_type: str, Optional
1506
+ :param _headers: set to override the headers for a single
1507
+ request; this effectively ignores the headers
1508
+ in the spec for a single request.
1509
+ :type _headers: dict, optional
1510
+ :param _host_index: set to override the host_index for a single
1511
+ request; this effectively ignores the host_index
1512
+ in the spec for a single request.
1513
+ :type _host_index: int, optional
1514
+ :return: Returns the result object.
1515
+ """ # noqa: E501
1516
+
1517
+ _param = self._document_connector_create_connector_serialize(
1518
+ create_connector_request=create_connector_request,
1519
+ _request_auth=_request_auth,
1520
+ _content_type=_content_type,
1521
+ _headers=_headers,
1522
+ _host_index=_host_index
1523
+ )
1524
+
1525
+ _response_types_map: Dict[str, Optional[str]] = {
1526
+ '200': "CreateConnectorResponse",
1527
+ '422': "HTTPValidationError",
1528
+ }
1529
+ response_data = self.api_client.call_api(
1530
+ *_param,
1531
+ _request_timeout=_request_timeout
1532
+ )
1533
+ return response_data.response
1534
+
1535
+
1536
+ def _document_connector_create_connector_serialize(
1537
+ self,
1538
+ create_connector_request,
1539
+ _request_auth,
1540
+ _content_type,
1541
+ _headers,
1542
+ _host_index,
1543
+ ) -> RequestSerialized:
1544
+
1545
+ _host = None
1546
+
1547
+ _collection_formats: Dict[str, str] = {
1548
+ }
1549
+
1550
+ _path_params: Dict[str, str] = {}
1551
+ _query_params: List[Tuple[str, str]] = []
1552
+ _header_params: Dict[str, Optional[str]] = _headers or {}
1553
+ _form_params: List[Tuple[str, str]] = []
1554
+ _files: Dict[
1555
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
1556
+ ] = {}
1557
+ _body_params: Optional[bytes] = None
1558
+
1559
+ # process the path parameters
1560
+ # process the query parameters
1561
+ # process the header parameters
1562
+ # process the form parameters
1563
+ # process the body parameter
1564
+ if create_connector_request is not None:
1565
+ _body_params = create_connector_request
1566
+
1567
+
1568
+ # set the HTTP header `Accept`
1569
+ if 'Accept' not in _header_params:
1570
+ _header_params['Accept'] = self.api_client.select_header_accept(
1571
+ [
1572
+ 'application/json'
1573
+ ]
1574
+ )
1575
+
1576
+ # set the HTTP header `Content-Type`
1577
+ if _content_type:
1578
+ _header_params['Content-Type'] = _content_type
1579
+ else:
1580
+ _default_content_type = (
1581
+ self.api_client.select_header_content_type(
1582
+ [
1583
+ 'application/json'
1584
+ ]
1585
+ )
1586
+ )
1587
+ if _default_content_type is not None:
1588
+ _header_params['Content-Type'] = _default_content_type
1589
+
1590
+ # authentication setting
1591
+ _auth_settings: List[str] = [
1592
+ 'QAnswer-Api-Key',
1593
+ 'Bearer token'
1594
+ ]
1595
+
1596
+ return self.api_client.param_serialize(
1597
+ method='POST',
1598
+ resource_path='/backend/api/connectors/document/create',
1599
+ path_params=_path_params,
1600
+ query_params=_query_params,
1601
+ header_params=_header_params,
1602
+ body=_body_params,
1603
+ post_params=_form_params,
1604
+ files=_files,
1605
+ auth_settings=_auth_settings,
1606
+ collection_formats=_collection_formats,
1607
+ _host=_host,
1608
+ _request_auth=_request_auth
1609
+ )
1610
+
1611
+
1612
+
1613
+
1614
+ @validate_call
1615
+ def override_document_connector_file_by_file_id(
1616
+ self,
1617
+ username: StrictStr,
1618
+ dataset: StrictStr,
1619
+ file_id: StrictStr,
1620
+ file: List[Union[StrictBytes, StrictStr, Tuple[StrictStr, StrictBytes]]],
1621
+ connector_id: Optional[StrictInt] = None,
1622
+ conversation_id: Optional[StrictStr] = None,
1623
+ metadata: Optional[DocumentMetadataListWrapper] = None,
1624
+ _request_timeout: Union[
1625
+ None,
1626
+ Annotated[StrictFloat, Field(gt=0)],
1627
+ Tuple[
1628
+ Annotated[StrictFloat, Field(gt=0)],
1629
+ Annotated[StrictFloat, Field(gt=0)]
1630
+ ]
1631
+ ] = None,
1632
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1633
+ _content_type: Optional[StrictStr] = None,
1634
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1635
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1636
+ ) -> StatusResponse:
1637
+ """Override Document
1638
+
1639
+ Override an existing document with a newly uploaded file. * we will not perform in-place override, we will delete the existing file and add the new one ! file_id will be preserved in the new file
1640
+
1641
+ :param username: (required)
1642
+ :type username: str
1643
+ :param dataset: (required)
1644
+ :type dataset: str
1645
+ :param file_id: (required)
1646
+ :type file_id: str
1647
+ :param file: (required)
1648
+ :type file: List[bytearray]
1649
+ :param connector_id:
1650
+ :type connector_id: int
1651
+ :param conversation_id:
1652
+ :type conversation_id: str
1653
+ :param metadata:
1654
+ :type metadata: DocumentMetadataListWrapper
1655
+ :param _request_timeout: timeout setting for this request. If one
1656
+ number provided, it will be total request
1657
+ timeout. It can also be a pair (tuple) of
1658
+ (connection, read) timeouts.
1659
+ :type _request_timeout: int, tuple(int, int), optional
1660
+ :param _request_auth: set to override the auth_settings for an a single
1661
+ request; this effectively ignores the
1662
+ authentication in the spec for a single request.
1663
+ :type _request_auth: dict, optional
1664
+ :param _content_type: force content-type for the request.
1665
+ :type _content_type: str, Optional
1666
+ :param _headers: set to override the headers for a single
1667
+ request; this effectively ignores the headers
1668
+ in the spec for a single request.
1669
+ :type _headers: dict, optional
1670
+ :param _host_index: set to override the host_index for a single
1671
+ request; this effectively ignores the host_index
1672
+ in the spec for a single request.
1673
+ :type _host_index: int, optional
1674
+ :return: Returns the result object.
1675
+ """ # noqa: E501
1676
+
1677
+ _param = self._override_document_connector_file_by_file_id_serialize(
1678
+ username=username,
1679
+ dataset=dataset,
1680
+ file_id=file_id,
1681
+ file=file,
1682
+ connector_id=connector_id,
1683
+ conversation_id=conversation_id,
1684
+ metadata=metadata,
1685
+ _request_auth=_request_auth,
1686
+ _content_type=_content_type,
1687
+ _headers=_headers,
1688
+ _host_index=_host_index
1689
+ )
1690
+
1691
+ _response_types_map: Dict[str, Optional[str]] = {
1692
+ '200': "StatusResponse",
1693
+ '422': "HTTPValidationError",
1694
+ }
1695
+ response_data = self.api_client.call_api(
1696
+ *_param,
1697
+ _request_timeout=_request_timeout
1698
+ )
1699
+ response_data.read()
1700
+ return self.api_client.response_deserialize(
1701
+ response_data=response_data,
1702
+ response_types_map=_response_types_map,
1703
+ ).data
1704
+
1705
+
1706
+ @validate_call
1707
+ def override_document_connector_file_by_file_id_with_http_info(
1708
+ self,
1709
+ username: StrictStr,
1710
+ dataset: StrictStr,
1711
+ file_id: StrictStr,
1712
+ file: List[Union[StrictBytes, StrictStr, Tuple[StrictStr, StrictBytes]]],
1713
+ connector_id: Optional[StrictInt] = None,
1714
+ conversation_id: Optional[StrictStr] = None,
1715
+ metadata: Optional[DocumentMetadataListWrapper] = None,
1716
+ _request_timeout: Union[
1717
+ None,
1718
+ Annotated[StrictFloat, Field(gt=0)],
1719
+ Tuple[
1720
+ Annotated[StrictFloat, Field(gt=0)],
1721
+ Annotated[StrictFloat, Field(gt=0)]
1722
+ ]
1723
+ ] = None,
1724
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1725
+ _content_type: Optional[StrictStr] = None,
1726
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1727
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1728
+ ) -> ApiResponse[StatusResponse]:
1729
+ """Override Document
1730
+
1731
+ Override an existing document with a newly uploaded file. * we will not perform in-place override, we will delete the existing file and add the new one ! file_id will be preserved in the new file
1732
+
1733
+ :param username: (required)
1734
+ :type username: str
1735
+ :param dataset: (required)
1736
+ :type dataset: str
1737
+ :param file_id: (required)
1738
+ :type file_id: str
1739
+ :param file: (required)
1740
+ :type file: List[bytearray]
1741
+ :param connector_id:
1742
+ :type connector_id: int
1743
+ :param conversation_id:
1744
+ :type conversation_id: str
1745
+ :param metadata:
1746
+ :type metadata: DocumentMetadataListWrapper
1747
+ :param _request_timeout: timeout setting for this request. If one
1748
+ number provided, it will be total request
1749
+ timeout. It can also be a pair (tuple) of
1750
+ (connection, read) timeouts.
1751
+ :type _request_timeout: int, tuple(int, int), optional
1752
+ :param _request_auth: set to override the auth_settings for an a single
1753
+ request; this effectively ignores the
1754
+ authentication in the spec for a single request.
1755
+ :type _request_auth: dict, optional
1756
+ :param _content_type: force content-type for the request.
1757
+ :type _content_type: str, Optional
1758
+ :param _headers: set to override the headers for a single
1759
+ request; this effectively ignores the headers
1760
+ in the spec for a single request.
1761
+ :type _headers: dict, optional
1762
+ :param _host_index: set to override the host_index for a single
1763
+ request; this effectively ignores the host_index
1764
+ in the spec for a single request.
1765
+ :type _host_index: int, optional
1766
+ :return: Returns the result object.
1767
+ """ # noqa: E501
1768
+
1769
+ _param = self._override_document_connector_file_by_file_id_serialize(
1770
+ username=username,
1771
+ dataset=dataset,
1772
+ file_id=file_id,
1773
+ file=file,
1774
+ connector_id=connector_id,
1775
+ conversation_id=conversation_id,
1776
+ metadata=metadata,
1777
+ _request_auth=_request_auth,
1778
+ _content_type=_content_type,
1779
+ _headers=_headers,
1780
+ _host_index=_host_index
1781
+ )
1782
+
1783
+ _response_types_map: Dict[str, Optional[str]] = {
1784
+ '200': "StatusResponse",
1785
+ '422': "HTTPValidationError",
1786
+ }
1787
+ response_data = self.api_client.call_api(
1788
+ *_param,
1789
+ _request_timeout=_request_timeout
1790
+ )
1791
+ response_data.read()
1792
+ return self.api_client.response_deserialize(
1793
+ response_data=response_data,
1794
+ response_types_map=_response_types_map,
1795
+ )
1796
+
1797
+
1798
+ @validate_call
1799
+ def override_document_connector_file_by_file_id_without_preload_content(
1800
+ self,
1801
+ username: StrictStr,
1802
+ dataset: StrictStr,
1803
+ file_id: StrictStr,
1804
+ file: List[Union[StrictBytes, StrictStr, Tuple[StrictStr, StrictBytes]]],
1805
+ connector_id: Optional[StrictInt] = None,
1806
+ conversation_id: Optional[StrictStr] = None,
1807
+ metadata: Optional[DocumentMetadataListWrapper] = None,
1808
+ _request_timeout: Union[
1809
+ None,
1810
+ Annotated[StrictFloat, Field(gt=0)],
1811
+ Tuple[
1812
+ Annotated[StrictFloat, Field(gt=0)],
1813
+ Annotated[StrictFloat, Field(gt=0)]
1814
+ ]
1815
+ ] = None,
1816
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1817
+ _content_type: Optional[StrictStr] = None,
1818
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1819
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1820
+ ) -> RESTResponseType:
1821
+ """Override Document
1822
+
1823
+ Override an existing document with a newly uploaded file. * we will not perform in-place override, we will delete the existing file and add the new one ! file_id will be preserved in the new file
1824
+
1825
+ :param username: (required)
1826
+ :type username: str
1827
+ :param dataset: (required)
1828
+ :type dataset: str
1829
+ :param file_id: (required)
1830
+ :type file_id: str
1831
+ :param file: (required)
1832
+ :type file: List[bytearray]
1833
+ :param connector_id:
1834
+ :type connector_id: int
1835
+ :param conversation_id:
1836
+ :type conversation_id: str
1837
+ :param metadata:
1838
+ :type metadata: DocumentMetadataListWrapper
1839
+ :param _request_timeout: timeout setting for this request. If one
1840
+ number provided, it will be total request
1841
+ timeout. It can also be a pair (tuple) of
1842
+ (connection, read) timeouts.
1843
+ :type _request_timeout: int, tuple(int, int), optional
1844
+ :param _request_auth: set to override the auth_settings for an a single
1845
+ request; this effectively ignores the
1846
+ authentication in the spec for a single request.
1847
+ :type _request_auth: dict, optional
1848
+ :param _content_type: force content-type for the request.
1849
+ :type _content_type: str, Optional
1850
+ :param _headers: set to override the headers for a single
1851
+ request; this effectively ignores the headers
1852
+ in the spec for a single request.
1853
+ :type _headers: dict, optional
1854
+ :param _host_index: set to override the host_index for a single
1855
+ request; this effectively ignores the host_index
1856
+ in the spec for a single request.
1857
+ :type _host_index: int, optional
1858
+ :return: Returns the result object.
1859
+ """ # noqa: E501
1860
+
1861
+ _param = self._override_document_connector_file_by_file_id_serialize(
1862
+ username=username,
1863
+ dataset=dataset,
1864
+ file_id=file_id,
1865
+ file=file,
1866
+ connector_id=connector_id,
1867
+ conversation_id=conversation_id,
1868
+ metadata=metadata,
1869
+ _request_auth=_request_auth,
1870
+ _content_type=_content_type,
1871
+ _headers=_headers,
1872
+ _host_index=_host_index
1873
+ )
1874
+
1875
+ _response_types_map: Dict[str, Optional[str]] = {
1876
+ '200': "StatusResponse",
1877
+ '422': "HTTPValidationError",
1878
+ }
1879
+ response_data = self.api_client.call_api(
1880
+ *_param,
1881
+ _request_timeout=_request_timeout
1882
+ )
1883
+ return response_data.response
1884
+
1885
+
1886
+ def _override_document_connector_file_by_file_id_serialize(
1887
+ self,
1888
+ username,
1889
+ dataset,
1890
+ file_id,
1891
+ file,
1892
+ connector_id,
1893
+ conversation_id,
1894
+ metadata,
1895
+ _request_auth,
1896
+ _content_type,
1897
+ _headers,
1898
+ _host_index,
1899
+ ) -> RequestSerialized:
1900
+
1901
+ _host = None
1902
+
1903
+ _collection_formats: Dict[str, str] = {
1904
+ 'file': 'csv',
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
+ if username is not None:
1919
+
1920
+ _query_params.append(('username', username))
1921
+
1922
+ if dataset is not None:
1923
+
1924
+ _query_params.append(('dataset', dataset))
1925
+
1926
+ if connector_id is not None:
1927
+
1928
+ _query_params.append(('connector_id', connector_id))
1929
+
1930
+ if file_id is not None:
1931
+
1932
+ _query_params.append(('file_id', file_id))
1933
+
1934
+ if conversation_id is not None:
1935
+
1936
+ _query_params.append(('conversationId', conversation_id))
1937
+
1938
+ # process the header parameters
1939
+ # process the form parameters
1940
+ if file is not None:
1941
+ _files['file'] = file
1942
+ if metadata is not None:
1943
+ _form_params.append(('metadata', metadata))
1944
+ # process the body parameter
1945
+
1946
+
1947
+ # set the HTTP header `Accept`
1948
+ if 'Accept' not in _header_params:
1949
+ _header_params['Accept'] = self.api_client.select_header_accept(
1950
+ [
1951
+ 'application/json'
1952
+ ]
1953
+ )
1954
+
1955
+ # set the HTTP header `Content-Type`
1956
+ if _content_type:
1957
+ _header_params['Content-Type'] = _content_type
1958
+ else:
1959
+ _default_content_type = (
1960
+ self.api_client.select_header_content_type(
1961
+ [
1962
+ 'multipart/form-data'
1963
+ ]
1964
+ )
1965
+ )
1966
+ if _default_content_type is not None:
1967
+ _header_params['Content-Type'] = _default_content_type
1968
+
1969
+ # authentication setting
1970
+ _auth_settings: List[str] = [
1971
+ 'QAnswer-Api-Key',
1972
+ 'Bearer token'
1973
+ ]
1974
+
1975
+ return self.api_client.param_serialize(
1976
+ method='POST',
1977
+ resource_path='/backend/api/connectors/document/override',
1978
+ path_params=_path_params,
1979
+ query_params=_query_params,
1980
+ header_params=_header_params,
1981
+ body=_body_params,
1982
+ post_params=_form_params,
1983
+ files=_files,
1984
+ auth_settings=_auth_settings,
1985
+ collection_formats=_collection_formats,
1986
+ _host=_host,
1987
+ _request_auth=_request_auth
1988
+ )
1989
+
1990
+