qanswer_sdk 3.1193.0__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (346) hide show
  1. qanswer_sdk/__init__.py +366 -0
  2. qanswer_sdk/api/__init__.py +47 -0
  3. qanswer_sdk/api/admin_api.py +11207 -0
  4. qanswer_sdk/api/ai_assistant_access_rights_api.py +5331 -0
  5. qanswer_sdk/api/ai_assistant_api.py +4377 -0
  6. qanswer_sdk/api/bot_slack_api.py +814 -0
  7. qanswer_sdk/api/chat_completion_api.py +309 -0
  8. qanswer_sdk/api/chatbot_api.py +1091 -0
  9. qanswer_sdk/api/connector_document_api.py +1406 -0
  10. qanswer_sdk/api/connector_e_consilium_api.py +326 -0
  11. qanswer_sdk/api/connector_e_consilium_search_index_connector_api.py +1215 -0
  12. qanswer_sdk/api/connector_google_drive_api.py +1870 -0
  13. qanswer_sdk/api/connector_one_drive_api.py +1559 -0
  14. qanswer_sdk/api/connector_onenote_api.py +1576 -0
  15. qanswer_sdk/api/connector_pinecone_api.py +892 -0
  16. qanswer_sdk/api/connector_publication_office_controller_api.py +1215 -0
  17. qanswer_sdk/api/connector_qn_a_api.py +1538 -0
  18. qanswer_sdk/api/connector_rdf_answer_api.py +1445 -0
  19. qanswer_sdk/api/connector_rdf_api.py +5318 -0
  20. qanswer_sdk/api/connector_sharepoint_api.py +2584 -0
  21. qanswer_sdk/api/connector_websearch_api.py +326 -0
  22. qanswer_sdk/api/connector_website_api.py +2068 -0
  23. qanswer_sdk/api/connectors_api.py +1497 -0
  24. qanswer_sdk/api/connectors_data_api.py +3697 -0
  25. qanswer_sdk/api/conversation_logs_api.py +6668 -0
  26. qanswer_sdk/api/dataset_config_api.py +2178 -0
  27. qanswer_sdk/api/debug_api.py +282 -0
  28. qanswer_sdk/api/llm_api.py +563 -0
  29. qanswer_sdk/api/llm_consumption_controller_api.py +310 -0
  30. qanswer_sdk/api/organizations_teams_api.py +8465 -0
  31. qanswer_sdk/api/payment_api.py +1546 -0
  32. qanswer_sdk/api/socket_api.py +2975 -0
  33. qanswer_sdk/api/speech_to_text_api.py +734 -0
  34. qanswer_sdk/api/tag_api.py +2396 -0
  35. qanswer_sdk/api/task_chat_api.py +2064 -0
  36. qanswer_sdk/api/task_rdf_linker_api.py +4382 -0
  37. qanswer_sdk/api/task_rdf_sparql_endpoint_api.py +3522 -0
  38. qanswer_sdk/api/task_rdf_text_linker_api.py +1346 -0
  39. qanswer_sdk/api/task_relation_extraction_api.py +2977 -0
  40. qanswer_sdk/api/task_report_copilot_api.py +2980 -0
  41. qanswer_sdk/api/task_search_api.py +1784 -0
  42. qanswer_sdk/api/task_sparql2text_api.py +326 -0
  43. qanswer_sdk/api/task_text2sparql_api.py +908 -0
  44. qanswer_sdk/api/task_text_classification_api.py +914 -0
  45. qanswer_sdk/api/user_api.py +7098 -0
  46. qanswer_sdk/api_client.py +797 -0
  47. qanswer_sdk/api_response.py +21 -0
  48. qanswer_sdk/configuration.py +487 -0
  49. qanswer_sdk/exceptions.py +199 -0
  50. qanswer_sdk/models/__init__.py +307 -0
  51. qanswer_sdk/models/access_pdf_payload_model.py +109 -0
  52. qanswer_sdk/models/add_qn_a_request.py +103 -0
  53. qanswer_sdk/models/add_synonyms.py +91 -0
  54. qanswer_sdk/models/add_synonyms_resp.py +89 -0
  55. qanswer_sdk/models/aggregate.py +97 -0
  56. qanswer_sdk/models/aggregation.py +112 -0
  57. qanswer_sdk/models/aggregations_group.py +102 -0
  58. qanswer_sdk/models/ai_assistant_dto.py +103 -0
  59. qanswer_sdk/models/ai_assistant_shared_access.py +113 -0
  60. qanswer_sdk/models/allowed_file_extensions.py +98 -0
  61. qanswer_sdk/models/api_response.py +87 -0
  62. qanswer_sdk/models/applied_metadata_filter.py +98 -0
  63. qanswer_sdk/models/assistant_message_stop.py +93 -0
  64. qanswer_sdk/models/auth_link_response.py +91 -0
  65. qanswer_sdk/models/autocompletion_config.py +93 -0
  66. qanswer_sdk/models/available_connectors_response.py +99 -0
  67. qanswer_sdk/models/available_embedding_models_response.py +95 -0
  68. qanswer_sdk/models/available_endpoints_response.py +95 -0
  69. qanswer_sdk/models/available_logs_visibility_policy.py +103 -0
  70. qanswer_sdk/models/available_space_quota_for_dataset.py +91 -0
  71. qanswer_sdk/models/available_storage_preference.py +103 -0
  72. qanswer_sdk/models/base_connectors_response.py +89 -0
  73. qanswer_sdk/models/base_conversation_response.py +89 -0
  74. qanswer_sdk/models/base_feedback_response.py +89 -0
  75. qanswer_sdk/models/branding_data.py +87 -0
  76. qanswer_sdk/models/cell.py +89 -0
  77. qanswer_sdk/models/change_password.py +89 -0
  78. qanswer_sdk/models/change_password_admin.py +89 -0
  79. qanswer_sdk/models/change_role.py +96 -0
  80. qanswer_sdk/models/chat_task_settings.py +135 -0
  81. qanswer_sdk/models/chat_task_settings_update_payload.py +95 -0
  82. qanswer_sdk/models/chat_task_update.py +129 -0
  83. qanswer_sdk/models/chatbot_chat_payload.py +115 -0
  84. qanswer_sdk/models/chatbot_conversation_model.py +141 -0
  85. qanswer_sdk/models/chatbot_response.py +119 -0
  86. qanswer_sdk/models/check_mode_response.py +100 -0
  87. qanswer_sdk/models/class_info.py +89 -0
  88. qanswer_sdk/models/connector_model.py +112 -0
  89. qanswer_sdk/models/content_item.py +130 -0
  90. qanswer_sdk/models/conversation_message.py +186 -0
  91. qanswer_sdk/models/conversation_model.py +131 -0
  92. qanswer_sdk/models/conversation_statistics.py +95 -0
  93. qanswer_sdk/models/conversation_update.py +93 -0
  94. qanswer_sdk/models/conversation_users_stats.py +99 -0
  95. qanswer_sdk/models/conversation_users_stats_response.py +99 -0
  96. qanswer_sdk/models/coordinates.py +89 -0
  97. qanswer_sdk/models/cost_summary.py +99 -0
  98. qanswer_sdk/models/create_connector_request.py +93 -0
  99. qanswer_sdk/models/create_connector_response.py +95 -0
  100. qanswer_sdk/models/create_pinecone_connector_request.py +95 -0
  101. qanswer_sdk/models/create_sharepoint_connector_from_certificate_request.py +103 -0
  102. qanswer_sdk/models/create_sharepoint_connector_request.py +101 -0
  103. qanswer_sdk/models/dataset_config_request.py +187 -0
  104. qanswer_sdk/models/dataset_default_values_model.py +141 -0
  105. qanswer_sdk/models/dataset_description.py +91 -0
  106. qanswer_sdk/models/dataset_detail.py +133 -0
  107. qanswer_sdk/models/dataset_detail_kg.py +158 -0
  108. qanswer_sdk/models/dataset_schema.py +207 -0
  109. qanswer_sdk/models/dataset_update_object.py +195 -0
  110. qanswer_sdk/models/dataset_users_response.py +87 -0
  111. qanswer_sdk/models/default_prompt.py +106 -0
  112. qanswer_sdk/models/delete_connector_model.py +96 -0
  113. qanswer_sdk/models/delete_connector_request.py +99 -0
  114. qanswer_sdk/models/delete_connectors_response.py +91 -0
  115. qanswer_sdk/models/delete_qn_a_pair_request.py +95 -0
  116. qanswer_sdk/models/delete_qn_a_pair_response.py +89 -0
  117. qanswer_sdk/models/delete_synonym.py +91 -0
  118. qanswer_sdk/models/delete_synonym_resp.py +89 -0
  119. qanswer_sdk/models/diarization_segment.py +93 -0
  120. qanswer_sdk/models/document_content_response.py +91 -0
  121. qanswer_sdk/models/document_content_update_model.py +95 -0
  122. qanswer_sdk/models/document_file_delete_by_connector_model.py +99 -0
  123. qanswer_sdk/models/document_metadata.py +107 -0
  124. qanswer_sdk/models/document_metadata_list_wrapper.py +95 -0
  125. qanswer_sdk/models/document_status_response.py +89 -0
  126. qanswer_sdk/models/e_consilium_search_index_search_response.py +113 -0
  127. qanswer_sdk/models/econsilium_file_metadata.py +105 -0
  128. qanswer_sdk/models/econsilium_search_index_add_payload.py +105 -0
  129. qanswer_sdk/models/econsilium_search_index_additional_fields.py +101 -0
  130. qanswer_sdk/models/email_request.py +87 -0
  131. qanswer_sdk/models/embedding_endpoint.py +139 -0
  132. qanswer_sdk/models/embedding_endpoint_create.py +137 -0
  133. qanswer_sdk/models/embedding_endpoint_update.py +131 -0
  134. qanswer_sdk/models/embedding_endpoint_validation_response.py +96 -0
  135. qanswer_sdk/models/embedding_model.py +96 -0
  136. qanswer_sdk/models/entity.py +97 -0
  137. qanswer_sdk/models/entity_linker_response.py +99 -0
  138. qanswer_sdk/models/entity_model.py +99 -0
  139. qanswer_sdk/models/extra_body.py +91 -0
  140. qanswer_sdk/models/extract_hyper_links_payload.py +102 -0
  141. qanswer_sdk/models/extract_robot_links_payload.py +88 -0
  142. qanswer_sdk/models/extract_robot_links_response.py +88 -0
  143. qanswer_sdk/models/fact.py +96 -0
  144. qanswer_sdk/models/feedback_model.py +107 -0
  145. qanswer_sdk/models/feedback_update.py +103 -0
  146. qanswer_sdk/models/file_es_meta_data.py +89 -0
  147. qanswer_sdk/models/file_folder_model.py +113 -0
  148. qanswer_sdk/models/file_model.py +134 -0
  149. qanswer_sdk/models/files_by_connector_model.py +89 -0
  150. qanswer_sdk/models/format_return.py +87 -0
  151. qanswer_sdk/models/g_drive_connector_info.py +95 -0
  152. qanswer_sdk/models/g_drive_download_by_ids.py +89 -0
  153. qanswer_sdk/models/g_drive_download_request.py +101 -0
  154. qanswer_sdk/models/generation_params.py +89 -0
  155. qanswer_sdk/models/get_connector_by_id_response.py +91 -0
  156. qanswer_sdk/models/get_conversation_response.py +95 -0
  157. qanswer_sdk/models/guardrail_endpoint.py +121 -0
  158. qanswer_sdk/models/has_lucene_index_result.py +87 -0
  159. qanswer_sdk/models/index_config.py +95 -0
  160. qanswer_sdk/models/install_response.py +89 -0
  161. qanswer_sdk/models/is_enabled_response.py +87 -0
  162. qanswer_sdk/models/is_merging_result.py +87 -0
  163. qanswer_sdk/models/json_nullable_file_failure_reason.py +87 -0
  164. qanswer_sdk/models/json_nullable_source_metadata.py +87 -0
  165. qanswer_sdk/models/jwt_authentication_response.py +93 -0
  166. qanswer_sdk/models/label.py +89 -0
  167. qanswer_sdk/models/labeled_node.py +89 -0
  168. qanswer_sdk/models/link.py +103 -0
  169. qanswer_sdk/models/link_extraction_response.py +97 -0
  170. qanswer_sdk/models/link_result_paginated.py +97 -0
  171. qanswer_sdk/models/linker.py +103 -0
  172. qanswer_sdk/models/linking_result.py +95 -0
  173. qanswer_sdk/models/links.py +99 -0
  174. qanswer_sdk/models/list_chatbot_conversation_response.py +105 -0
  175. qanswer_sdk/models/list_connectors_response.py +95 -0
  176. qanswer_sdk/models/list_conversation_response.py +105 -0
  177. qanswer_sdk/models/list_feedback_response.py +105 -0
  178. qanswer_sdk/models/list_files_connector_response.py +101 -0
  179. qanswer_sdk/models/list_socket_events.py +95 -0
  180. qanswer_sdk/models/list_synonyms_model.py +89 -0
  181. qanswer_sdk/models/llm_context_ranges_response.py +93 -0
  182. qanswer_sdk/models/llm_cost.py +108 -0
  183. qanswer_sdk/models/llm_details.py +111 -0
  184. qanswer_sdk/models/llm_endpoint.py +167 -0
  185. qanswer_sdk/models/llm_endpoint_create.py +165 -0
  186. qanswer_sdk/models/llm_endpoint_default_prompts.py +93 -0
  187. qanswer_sdk/models/llm_endpoint_update.py +163 -0
  188. qanswer_sdk/models/llm_endpoint_validation_response.py +96 -0
  189. qanswer_sdk/models/login_request.py +89 -0
  190. qanswer_sdk/models/logo.py +89 -0
  191. qanswer_sdk/models/lucene_index_request_result.py +87 -0
  192. qanswer_sdk/models/merge_request_result.py +87 -0
  193. qanswer_sdk/models/messages_stats_per_day_response.py +99 -0
  194. qanswer_sdk/models/modify_connector_request.py +111 -0
  195. qanswer_sdk/models/o_auth_service.py +89 -0
  196. qanswer_sdk/models/one_drive_download_by_ids.py +89 -0
  197. qanswer_sdk/models/one_drive_download_request.py +101 -0
  198. qanswer_sdk/models/one_note_download_by_ids.py +91 -0
  199. qanswer_sdk/models/one_note_download_request.py +101 -0
  200. qanswer_sdk/models/organization.py +93 -0
  201. qanswer_sdk/models/organization_creation.py +91 -0
  202. qanswer_sdk/models/organization_filter.py +87 -0
  203. qanswer_sdk/models/organization_shared.py +105 -0
  204. qanswer_sdk/models/page_organization.py +123 -0
  205. qanswer_sdk/models/page_team_with_count.py +123 -0
  206. qanswer_sdk/models/pageable.py +92 -0
  207. qanswer_sdk/models/pageable_object.py +101 -0
  208. qanswer_sdk/models/password.py +89 -0
  209. qanswer_sdk/models/pinecone_index_model.py +91 -0
  210. qanswer_sdk/models/plan.py +123 -0
  211. qanswer_sdk/models/predicted_class.py +89 -0
  212. qanswer_sdk/models/prompt_token_count_details.py +99 -0
  213. qanswer_sdk/models/provider.py +87 -0
  214. qanswer_sdk/models/publication_add_payload.py +103 -0
  215. qanswer_sdk/models/publication_file_metadata.py +105 -0
  216. qanswer_sdk/models/publication_office_additional_fields.py +111 -0
  217. qanswer_sdk/models/publication_search_index_search_response.py +113 -0
  218. qanswer_sdk/models/qa_context.py +129 -0
  219. qanswer_sdk/models/qa_contexts.py +116 -0
  220. qanswer_sdk/models/qa_metadata_payload.py +123 -0
  221. qanswer_sdk/models/qa_table.py +102 -0
  222. qanswer_sdk/models/qn_a_pair_model.py +103 -0
  223. qanswer_sdk/models/qn_a_pair_response.py +95 -0
  224. qanswer_sdk/models/question_completion.py +89 -0
  225. qanswer_sdk/models/rag_params.py +89 -0
  226. qanswer_sdk/models/rag_payload.py +154 -0
  227. qanswer_sdk/models/rag_response.py +150 -0
  228. qanswer_sdk/models/ranker_config.py +93 -0
  229. qanswer_sdk/models/reference_model.py +95 -0
  230. qanswer_sdk/models/refresh_token_request.py +87 -0
  231. qanswer_sdk/models/refresh_website_connector_payload.py +94 -0
  232. qanswer_sdk/models/register_pinecone_connector_request.py +95 -0
  233. qanswer_sdk/models/relation_extraction_configuration.py +105 -0
  234. qanswer_sdk/models/relation_extraction_payload.py +111 -0
  235. qanswer_sdk/models/relation_extraction_result.py +101 -0
  236. qanswer_sdk/models/relation_extraction_schema.py +101 -0
  237. qanswer_sdk/models/relation_extraction_task_settings.py +123 -0
  238. qanswer_sdk/models/relation_extraction_task_settings_update_payload.py +95 -0
  239. qanswer_sdk/models/relation_extraction_task_update.py +117 -0
  240. qanswer_sdk/models/relation_extraction_template_payload.py +97 -0
  241. qanswer_sdk/models/relation_extraction_template_update_payload.py +95 -0
  242. qanswer_sdk/models/relation_model.py +89 -0
  243. qanswer_sdk/models/report_copilot_create_payload.py +103 -0
  244. qanswer_sdk/models/report_copilot_export_template_as_docx_payload_simplified.py +91 -0
  245. qanswer_sdk/models/report_copilot_generation_from_slots_payload.py +95 -0
  246. qanswer_sdk/models/report_copilot_generation_from_slots_response.py +95 -0
  247. qanswer_sdk/models/report_copilot_refinement_payload.py +104 -0
  248. qanswer_sdk/models/report_copilot_refinement_response.py +87 -0
  249. qanswer_sdk/models/report_copilot_slot_task_settings.py +125 -0
  250. qanswer_sdk/models/report_copilot_slot_task_update.py +119 -0
  251. qanswer_sdk/models/report_copilot_task_settings.py +123 -0
  252. qanswer_sdk/models/report_copilot_task_settings_update_payload.py +95 -0
  253. qanswer_sdk/models/report_copilot_task_update.py +117 -0
  254. qanswer_sdk/models/report_copilot_template.py +107 -0
  255. qanswer_sdk/models/report_copilot_template_simplified.py +95 -0
  256. qanswer_sdk/models/report_copilot_update_payload.py +101 -0
  257. qanswer_sdk/models/reset_password.py +87 -0
  258. qanswer_sdk/models/response_audit_model.py +99 -0
  259. qanswer_sdk/models/response_audit_stats_response.py +101 -0
  260. qanswer_sdk/models/retreive_all_synonyms_resp.py +99 -0
  261. qanswer_sdk/models/retry_params.py +89 -0
  262. qanswer_sdk/models/role.py +99 -0
  263. qanswer_sdk/models/search_document_response.py +105 -0
  264. qanswer_sdk/models/search_index_payload.py +114 -0
  265. qanswer_sdk/models/search_metadata_filter.py +89 -0
  266. qanswer_sdk/models/search_payload.py +124 -0
  267. qanswer_sdk/models/search_response.py +113 -0
  268. qanswer_sdk/models/search_task_settings.py +131 -0
  269. qanswer_sdk/models/search_task_settings_update_payload.py +95 -0
  270. qanswer_sdk/models/search_task_update.py +123 -0
  271. qanswer_sdk/models/set_logo1_request.py +87 -0
  272. qanswer_sdk/models/share_point_download_by_ids.py +99 -0
  273. qanswer_sdk/models/share_point_download_request.py +101 -0
  274. qanswer_sdk/models/shared_organization_access.py +109 -0
  275. qanswer_sdk/models/shared_team_access.py +107 -0
  276. qanswer_sdk/models/shared_user.py +99 -0
  277. qanswer_sdk/models/sign_up_request.py +96 -0
  278. qanswer_sdk/models/signout_request.py +87 -0
  279. qanswer_sdk/models/slot.py +138 -0
  280. qanswer_sdk/models/slot_in_prompt.py +91 -0
  281. qanswer_sdk/models/slot_update.py +138 -0
  282. qanswer_sdk/models/socket_conversation_message.py +207 -0
  283. qanswer_sdk/models/socket_data_extraction.py +109 -0
  284. qanswer_sdk/models/socket_file_metadata.py +172 -0
  285. qanswer_sdk/models/socket_join_conversation.py +97 -0
  286. qanswer_sdk/models/socket_join_dataset.py +93 -0
  287. qanswer_sdk/models/socket_report_continuation_response.py +106 -0
  288. qanswer_sdk/models/socket_report_copilot_generation_from_slots_response.py +120 -0
  289. qanswer_sdk/models/socket_report_copilot_refinement_response.py +108 -0
  290. qanswer_sdk/models/socket_speech2_text_response.py +99 -0
  291. qanswer_sdk/models/socket_stop_conversation.py +97 -0
  292. qanswer_sdk/models/sort_object.py +91 -0
  293. qanswer_sdk/models/source.py +125 -0
  294. qanswer_sdk/models/sparql2_text_payload.py +97 -0
  295. qanswer_sdk/models/speech2_text_response.py +87 -0
  296. qanswer_sdk/models/speech2_text_with_diarization_response.py +106 -0
  297. qanswer_sdk/models/stat_per_date.py +89 -0
  298. qanswer_sdk/models/status_response.py +89 -0
  299. qanswer_sdk/models/subject_model.py +91 -0
  300. qanswer_sdk/models/suggestion_list_response.py +87 -0
  301. qanswer_sdk/models/summa_server.py +101 -0
  302. qanswer_sdk/models/tag_payload.py +87 -0
  303. qanswer_sdk/models/tag_qa_list_payload.py +100 -0
  304. qanswer_sdk/models/tag_qa_payload.py +91 -0
  305. qanswer_sdk/models/team.py +93 -0
  306. qanswer_sdk/models/team_creation.py +89 -0
  307. qanswer_sdk/models/team_filter.py +91 -0
  308. qanswer_sdk/models/team_shared.py +105 -0
  309. qanswer_sdk/models/team_with_count.py +95 -0
  310. qanswer_sdk/models/terms_bucket.py +89 -0
  311. qanswer_sdk/models/text2_sparql_payload.py +156 -0
  312. qanswer_sdk/models/text2_sparql_task_settings.py +123 -0
  313. qanswer_sdk/models/text2_sparql_task_settings_update_payload.py +95 -0
  314. qanswer_sdk/models/text2_sparql_task_update.py +117 -0
  315. qanswer_sdk/models/text_classification_payload.py +99 -0
  316. qanswer_sdk/models/text_classification_response.py +87 -0
  317. qanswer_sdk/models/text_classification_v2_payload.py +99 -0
  318. qanswer_sdk/models/text_classification_v2_response.py +95 -0
  319. qanswer_sdk/models/total_stat.py +96 -0
  320. qanswer_sdk/models/ui_mappings.py +141 -0
  321. qanswer_sdk/models/update_metadata_model.py +95 -0
  322. qanswer_sdk/models/update_qn_a_pair_request.py +101 -0
  323. qanswer_sdk/models/update_qn_a_pair_response.py +89 -0
  324. qanswer_sdk/models/update_synonyms.py +93 -0
  325. qanswer_sdk/models/update_synonyms_resp.py +89 -0
  326. qanswer_sdk/models/uri_mapping.py +89 -0
  327. qanswer_sdk/models/user.py +91 -0
  328. qanswer_sdk/models/user_chatbot_setting_payload.py +106 -0
  329. qanswer_sdk/models/user_chatbot_setting_response.py +105 -0
  330. qanswer_sdk/models/user_dataset.py +144 -0
  331. qanswer_sdk/models/user_dataset_api_key.py +116 -0
  332. qanswer_sdk/models/user_filter.py +101 -0
  333. qanswer_sdk/models/user_identity_availability.py +87 -0
  334. qanswer_sdk/models/user_list_dto.py +101 -0
  335. qanswer_sdk/models/user_oauth_token.py +96 -0
  336. qanswer_sdk/models/user_profile.py +184 -0
  337. qanswer_sdk/models/user_profile_list_dto.py +101 -0
  338. qanswer_sdk/models/user_profile_paginated.py +101 -0
  339. qanswer_sdk/models/website_add_payload.py +98 -0
  340. qanswer_sdk/models/website_connector_settings.py +160 -0
  341. qanswer_sdk/models/widget_configs.py +105 -0
  342. qanswer_sdk/py.typed +0 -0
  343. qanswer_sdk/rest.py +257 -0
  344. qanswer_sdk-3.1193.0.dist-info/METADATA +125 -0
  345. qanswer_sdk-3.1193.0.dist-info/RECORD +346 -0
  346. qanswer_sdk-3.1193.0.dist-info/WHEEL +4 -0
@@ -0,0 +1,1406 @@
1
+ # coding: utf-8
2
+
3
+ """
4
+ QAnswer: Api Documentation
5
+
6
+ APIs provided by QAnswer
7
+
8
+ The version of the OpenAPI document: 1.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 StrictBool, StrictBytes, StrictInt, StrictStr
20
+ from typing import 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.status_response import StatusResponse
25
+
26
+ from qanswer_sdk.api_client import ApiClient, RequestSerialized
27
+ from qanswer_sdk.api_response import ApiResponse
28
+ from qanswer_sdk.rest import RESTResponseType
29
+
30
+
31
+ class ConnectorDocumentApi:
32
+ """NOTE: This class is auto generated by OpenAPI Generator
33
+ Ref: https://openapi-generator.tech
34
+
35
+ Do not edit the class manually.
36
+ """
37
+
38
+ def __init__(self, api_client=None) -> None:
39
+ if api_client is None:
40
+ api_client = ApiClient.get_default()
41
+ self.api_client = api_client
42
+
43
+
44
+ @validate_call
45
+ def document_connector_add_documents(
46
+ self,
47
+ username: StrictStr,
48
+ dataset: StrictStr,
49
+ file: List[Union[StrictBytes, StrictStr, Tuple[StrictStr, StrictBytes]]],
50
+ connector_id: Optional[StrictInt] = None,
51
+ q_answer_api_key: Optional[StrictStr] = None,
52
+ metadata: Optional[DocumentMetadataListWrapper] = None,
53
+ _request_timeout: Union[
54
+ None,
55
+ Annotated[StrictFloat, Field(gt=0)],
56
+ Tuple[
57
+ Annotated[StrictFloat, Field(gt=0)],
58
+ Annotated[StrictFloat, Field(gt=0)]
59
+ ]
60
+ ] = None,
61
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
62
+ _content_type: Optional[StrictStr] = None,
63
+ _headers: Optional[Dict[StrictStr, Any]] = None,
64
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
65
+ ) -> StatusResponse:
66
+ """document_connector_add_documents
67
+
68
+
69
+ :param username: (required)
70
+ :type username: str
71
+ :param dataset: (required)
72
+ :type dataset: str
73
+ :param file: (required)
74
+ :type file: List[bytearray]
75
+ :param connector_id:
76
+ :type connector_id: int
77
+ :param q_answer_api_key:
78
+ :type q_answer_api_key: str
79
+ :param metadata:
80
+ :type metadata: DocumentMetadataListWrapper
81
+ :param _request_timeout: timeout setting for this request. If one
82
+ number provided, it will be total request
83
+ timeout. It can also be a pair (tuple) of
84
+ (connection, read) timeouts.
85
+ :type _request_timeout: int, tuple(int, int), optional
86
+ :param _request_auth: set to override the auth_settings for an a single
87
+ request; this effectively ignores the
88
+ authentication in the spec for a single request.
89
+ :type _request_auth: dict, optional
90
+ :param _content_type: force content-type for the request.
91
+ :type _content_type: str, Optional
92
+ :param _headers: set to override the headers for a single
93
+ request; this effectively ignores the headers
94
+ in the spec for a single request.
95
+ :type _headers: dict, optional
96
+ :param _host_index: set to override the host_index for a single
97
+ request; this effectively ignores the host_index
98
+ in the spec for a single request.
99
+ :type _host_index: int, optional
100
+ :return: Returns the result object.
101
+ """ # noqa: E501
102
+
103
+ _param = self._document_connector_add_documents_serialize(
104
+ username=username,
105
+ dataset=dataset,
106
+ file=file,
107
+ connector_id=connector_id,
108
+ q_answer_api_key=q_answer_api_key,
109
+ metadata=metadata,
110
+ _request_auth=_request_auth,
111
+ _content_type=_content_type,
112
+ _headers=_headers,
113
+ _host_index=_host_index
114
+ )
115
+
116
+ _response_types_map: Dict[str, Optional[str]] = {
117
+ '200': "StatusResponse",
118
+ }
119
+ response_data = self.api_client.call_api(
120
+ *_param,
121
+ _request_timeout=_request_timeout
122
+ )
123
+ response_data.read()
124
+ return self.api_client.response_deserialize(
125
+ response_data=response_data,
126
+ response_types_map=_response_types_map,
127
+ ).data
128
+
129
+
130
+ @validate_call
131
+ def document_connector_add_documents_with_http_info(
132
+ self,
133
+ username: StrictStr,
134
+ dataset: StrictStr,
135
+ file: List[Union[StrictBytes, StrictStr, Tuple[StrictStr, StrictBytes]]],
136
+ connector_id: Optional[StrictInt] = None,
137
+ q_answer_api_key: Optional[StrictStr] = None,
138
+ metadata: Optional[DocumentMetadataListWrapper] = None,
139
+ _request_timeout: Union[
140
+ None,
141
+ Annotated[StrictFloat, Field(gt=0)],
142
+ Tuple[
143
+ Annotated[StrictFloat, Field(gt=0)],
144
+ Annotated[StrictFloat, Field(gt=0)]
145
+ ]
146
+ ] = None,
147
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
148
+ _content_type: Optional[StrictStr] = None,
149
+ _headers: Optional[Dict[StrictStr, Any]] = None,
150
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
151
+ ) -> ApiResponse[StatusResponse]:
152
+ """document_connector_add_documents
153
+
154
+
155
+ :param username: (required)
156
+ :type username: str
157
+ :param dataset: (required)
158
+ :type dataset: str
159
+ :param file: (required)
160
+ :type file: List[bytearray]
161
+ :param connector_id:
162
+ :type connector_id: int
163
+ :param q_answer_api_key:
164
+ :type q_answer_api_key: str
165
+ :param metadata:
166
+ :type metadata: DocumentMetadataListWrapper
167
+ :param _request_timeout: timeout setting for this request. If one
168
+ number provided, it will be total request
169
+ timeout. It can also be a pair (tuple) of
170
+ (connection, read) timeouts.
171
+ :type _request_timeout: int, tuple(int, int), optional
172
+ :param _request_auth: set to override the auth_settings for an a single
173
+ request; this effectively ignores the
174
+ authentication in the spec for a single request.
175
+ :type _request_auth: dict, optional
176
+ :param _content_type: force content-type for the request.
177
+ :type _content_type: str, Optional
178
+ :param _headers: set to override the headers for a single
179
+ request; this effectively ignores the headers
180
+ in the spec for a single request.
181
+ :type _headers: dict, optional
182
+ :param _host_index: set to override the host_index for a single
183
+ request; this effectively ignores the host_index
184
+ in the spec for a single request.
185
+ :type _host_index: int, optional
186
+ :return: Returns the result object.
187
+ """ # noqa: E501
188
+
189
+ _param = self._document_connector_add_documents_serialize(
190
+ username=username,
191
+ dataset=dataset,
192
+ file=file,
193
+ connector_id=connector_id,
194
+ q_answer_api_key=q_answer_api_key,
195
+ metadata=metadata,
196
+ _request_auth=_request_auth,
197
+ _content_type=_content_type,
198
+ _headers=_headers,
199
+ _host_index=_host_index
200
+ )
201
+
202
+ _response_types_map: Dict[str, Optional[str]] = {
203
+ '200': "StatusResponse",
204
+ }
205
+ response_data = self.api_client.call_api(
206
+ *_param,
207
+ _request_timeout=_request_timeout
208
+ )
209
+ response_data.read()
210
+ return self.api_client.response_deserialize(
211
+ response_data=response_data,
212
+ response_types_map=_response_types_map,
213
+ )
214
+
215
+
216
+ @validate_call
217
+ def document_connector_add_documents_without_preload_content(
218
+ self,
219
+ username: StrictStr,
220
+ dataset: StrictStr,
221
+ file: List[Union[StrictBytes, StrictStr, Tuple[StrictStr, StrictBytes]]],
222
+ connector_id: Optional[StrictInt] = None,
223
+ q_answer_api_key: Optional[StrictStr] = None,
224
+ metadata: Optional[DocumentMetadataListWrapper] = None,
225
+ _request_timeout: Union[
226
+ None,
227
+ Annotated[StrictFloat, Field(gt=0)],
228
+ Tuple[
229
+ Annotated[StrictFloat, Field(gt=0)],
230
+ Annotated[StrictFloat, Field(gt=0)]
231
+ ]
232
+ ] = None,
233
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
234
+ _content_type: Optional[StrictStr] = None,
235
+ _headers: Optional[Dict[StrictStr, Any]] = None,
236
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
237
+ ) -> RESTResponseType:
238
+ """document_connector_add_documents
239
+
240
+
241
+ :param username: (required)
242
+ :type username: str
243
+ :param dataset: (required)
244
+ :type dataset: str
245
+ :param file: (required)
246
+ :type file: List[bytearray]
247
+ :param connector_id:
248
+ :type connector_id: int
249
+ :param q_answer_api_key:
250
+ :type q_answer_api_key: str
251
+ :param metadata:
252
+ :type metadata: DocumentMetadataListWrapper
253
+ :param _request_timeout: timeout setting for this request. If one
254
+ number provided, it will be total request
255
+ timeout. It can also be a pair (tuple) of
256
+ (connection, read) timeouts.
257
+ :type _request_timeout: int, tuple(int, int), optional
258
+ :param _request_auth: set to override the auth_settings for an a single
259
+ request; this effectively ignores the
260
+ authentication in the spec for a single request.
261
+ :type _request_auth: dict, optional
262
+ :param _content_type: force content-type for the request.
263
+ :type _content_type: str, Optional
264
+ :param _headers: set to override the headers for a single
265
+ request; this effectively ignores the headers
266
+ in the spec for a single request.
267
+ :type _headers: dict, optional
268
+ :param _host_index: set to override the host_index for a single
269
+ request; this effectively ignores the host_index
270
+ in the spec for a single request.
271
+ :type _host_index: int, optional
272
+ :return: Returns the result object.
273
+ """ # noqa: E501
274
+
275
+ _param = self._document_connector_add_documents_serialize(
276
+ username=username,
277
+ dataset=dataset,
278
+ file=file,
279
+ connector_id=connector_id,
280
+ q_answer_api_key=q_answer_api_key,
281
+ metadata=metadata,
282
+ _request_auth=_request_auth,
283
+ _content_type=_content_type,
284
+ _headers=_headers,
285
+ _host_index=_host_index
286
+ )
287
+
288
+ _response_types_map: Dict[str, Optional[str]] = {
289
+ '200': "StatusResponse",
290
+ }
291
+ response_data = self.api_client.call_api(
292
+ *_param,
293
+ _request_timeout=_request_timeout
294
+ )
295
+ return response_data.response
296
+
297
+
298
+ def _document_connector_add_documents_serialize(
299
+ self,
300
+ username,
301
+ dataset,
302
+ file,
303
+ connector_id,
304
+ q_answer_api_key,
305
+ metadata,
306
+ _request_auth,
307
+ _content_type,
308
+ _headers,
309
+ _host_index,
310
+ ) -> RequestSerialized:
311
+
312
+ _host = None
313
+
314
+ _collection_formats: Dict[str, str] = {
315
+ 'file': 'csv',
316
+ }
317
+
318
+ _path_params: Dict[str, str] = {}
319
+ _query_params: List[Tuple[str, str]] = []
320
+ _header_params: Dict[str, Optional[str]] = _headers or {}
321
+ _form_params: List[Tuple[str, str]] = []
322
+ _files: Dict[
323
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
324
+ ] = {}
325
+ _body_params: Optional[bytes] = None
326
+
327
+ # process the path parameters
328
+ # process the query parameters
329
+ if username is not None:
330
+
331
+ _query_params.append(('username', username))
332
+
333
+ if dataset is not None:
334
+
335
+ _query_params.append(('dataset', dataset))
336
+
337
+ if connector_id is not None:
338
+
339
+ _query_params.append(('connector_id', connector_id))
340
+
341
+ # process the header parameters
342
+ if q_answer_api_key is not None:
343
+ _header_params['QAnswer-Api-Key'] = q_answer_api_key
344
+ # process the form parameters
345
+ if file is not None:
346
+ _files['file'] = file
347
+ if metadata is not None:
348
+ _form_params.append(('metadata', metadata))
349
+ # process the body parameter
350
+
351
+
352
+ # set the HTTP header `Accept`
353
+ if 'Accept' not in _header_params:
354
+ _header_params['Accept'] = self.api_client.select_header_accept(
355
+ [
356
+ '*/*'
357
+ ]
358
+ )
359
+
360
+ # set the HTTP header `Content-Type`
361
+ if _content_type:
362
+ _header_params['Content-Type'] = _content_type
363
+ else:
364
+ _default_content_type = (
365
+ self.api_client.select_header_content_type(
366
+ [
367
+ 'multipart/form-data'
368
+ ]
369
+ )
370
+ )
371
+ if _default_content_type is not None:
372
+ _header_params['Content-Type'] = _default_content_type
373
+
374
+ # authentication setting
375
+ _auth_settings: List[str] = [
376
+ 'QAnswer-Api-Key',
377
+ 'Bearer'
378
+ ]
379
+
380
+ return self.api_client.param_serialize(
381
+ method='POST',
382
+ resource_path='/api/connectors/document/add',
383
+ path_params=_path_params,
384
+ query_params=_query_params,
385
+ header_params=_header_params,
386
+ body=_body_params,
387
+ post_params=_form_params,
388
+ files=_files,
389
+ auth_settings=_auth_settings,
390
+ collection_formats=_collection_formats,
391
+ _host=_host,
392
+ _request_auth=_request_auth
393
+ )
394
+
395
+
396
+
397
+
398
+ @validate_call
399
+ def document_connector_add_documents_doc(
400
+ self,
401
+ username: StrictStr,
402
+ dataset: StrictStr,
403
+ file: Union[StrictBytes, StrictStr, Tuple[StrictStr, StrictBytes]],
404
+ connector_id: Optional[StrictInt] = None,
405
+ q_answer_api_key: Optional[StrictStr] = None,
406
+ metadata: Optional[DocumentMetadataListWrapper] = None,
407
+ _request_timeout: Union[
408
+ None,
409
+ Annotated[StrictFloat, Field(gt=0)],
410
+ Tuple[
411
+ Annotated[StrictFloat, Field(gt=0)],
412
+ Annotated[StrictFloat, Field(gt=0)]
413
+ ]
414
+ ] = None,
415
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
416
+ _content_type: Optional[StrictStr] = None,
417
+ _headers: Optional[Dict[StrictStr, Any]] = None,
418
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
419
+ ) -> StatusResponse:
420
+ """This route is for documentation only; use /api/connectors/document/add in production.
421
+
422
+
423
+ :param username: (required)
424
+ :type username: str
425
+ :param dataset: (required)
426
+ :type dataset: str
427
+ :param file: (required)
428
+ :type file: bytearray
429
+ :param connector_id:
430
+ :type connector_id: int
431
+ :param q_answer_api_key:
432
+ :type q_answer_api_key: str
433
+ :param metadata:
434
+ :type metadata: DocumentMetadataListWrapper
435
+ :param _request_timeout: timeout setting for this request. If one
436
+ number provided, it will be total request
437
+ timeout. It can also be a pair (tuple) of
438
+ (connection, read) timeouts.
439
+ :type _request_timeout: int, tuple(int, int), optional
440
+ :param _request_auth: set to override the auth_settings for an a single
441
+ request; this effectively ignores the
442
+ authentication in the spec for a single request.
443
+ :type _request_auth: dict, optional
444
+ :param _content_type: force content-type for the request.
445
+ :type _content_type: str, Optional
446
+ :param _headers: set to override the headers for a single
447
+ request; this effectively ignores the headers
448
+ in the spec for a single request.
449
+ :type _headers: dict, optional
450
+ :param _host_index: set to override the host_index for a single
451
+ request; this effectively ignores the host_index
452
+ in the spec for a single request.
453
+ :type _host_index: int, optional
454
+ :return: Returns the result object.
455
+ """ # noqa: E501
456
+
457
+ _param = self._document_connector_add_documents_doc_serialize(
458
+ username=username,
459
+ dataset=dataset,
460
+ file=file,
461
+ connector_id=connector_id,
462
+ q_answer_api_key=q_answer_api_key,
463
+ metadata=metadata,
464
+ _request_auth=_request_auth,
465
+ _content_type=_content_type,
466
+ _headers=_headers,
467
+ _host_index=_host_index
468
+ )
469
+
470
+ _response_types_map: Dict[str, Optional[str]] = {
471
+ '200': "StatusResponse",
472
+ }
473
+ response_data = self.api_client.call_api(
474
+ *_param,
475
+ _request_timeout=_request_timeout
476
+ )
477
+ response_data.read()
478
+ return self.api_client.response_deserialize(
479
+ response_data=response_data,
480
+ response_types_map=_response_types_map,
481
+ ).data
482
+
483
+
484
+ @validate_call
485
+ def document_connector_add_documents_doc_with_http_info(
486
+ self,
487
+ username: StrictStr,
488
+ dataset: StrictStr,
489
+ file: Union[StrictBytes, StrictStr, Tuple[StrictStr, StrictBytes]],
490
+ connector_id: Optional[StrictInt] = None,
491
+ q_answer_api_key: Optional[StrictStr] = None,
492
+ metadata: Optional[DocumentMetadataListWrapper] = None,
493
+ _request_timeout: Union[
494
+ None,
495
+ Annotated[StrictFloat, Field(gt=0)],
496
+ Tuple[
497
+ Annotated[StrictFloat, Field(gt=0)],
498
+ Annotated[StrictFloat, Field(gt=0)]
499
+ ]
500
+ ] = None,
501
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
502
+ _content_type: Optional[StrictStr] = None,
503
+ _headers: Optional[Dict[StrictStr, Any]] = None,
504
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
505
+ ) -> ApiResponse[StatusResponse]:
506
+ """This route is for documentation only; use /api/connectors/document/add in production.
507
+
508
+
509
+ :param username: (required)
510
+ :type username: str
511
+ :param dataset: (required)
512
+ :type dataset: str
513
+ :param file: (required)
514
+ :type file: bytearray
515
+ :param connector_id:
516
+ :type connector_id: int
517
+ :param q_answer_api_key:
518
+ :type q_answer_api_key: str
519
+ :param metadata:
520
+ :type metadata: DocumentMetadataListWrapper
521
+ :param _request_timeout: timeout setting for this request. If one
522
+ number provided, it will be total request
523
+ timeout. It can also be a pair (tuple) of
524
+ (connection, read) timeouts.
525
+ :type _request_timeout: int, tuple(int, int), optional
526
+ :param _request_auth: set to override the auth_settings for an a single
527
+ request; this effectively ignores the
528
+ authentication in the spec for a single request.
529
+ :type _request_auth: dict, optional
530
+ :param _content_type: force content-type for the request.
531
+ :type _content_type: str, Optional
532
+ :param _headers: set to override the headers for a single
533
+ request; this effectively ignores the headers
534
+ in the spec for a single request.
535
+ :type _headers: dict, optional
536
+ :param _host_index: set to override the host_index for a single
537
+ request; this effectively ignores the host_index
538
+ in the spec for a single request.
539
+ :type _host_index: int, optional
540
+ :return: Returns the result object.
541
+ """ # noqa: E501
542
+
543
+ _param = self._document_connector_add_documents_doc_serialize(
544
+ username=username,
545
+ dataset=dataset,
546
+ file=file,
547
+ connector_id=connector_id,
548
+ q_answer_api_key=q_answer_api_key,
549
+ metadata=metadata,
550
+ _request_auth=_request_auth,
551
+ _content_type=_content_type,
552
+ _headers=_headers,
553
+ _host_index=_host_index
554
+ )
555
+
556
+ _response_types_map: Dict[str, Optional[str]] = {
557
+ '200': "StatusResponse",
558
+ }
559
+ response_data = self.api_client.call_api(
560
+ *_param,
561
+ _request_timeout=_request_timeout
562
+ )
563
+ response_data.read()
564
+ return self.api_client.response_deserialize(
565
+ response_data=response_data,
566
+ response_types_map=_response_types_map,
567
+ )
568
+
569
+
570
+ @validate_call
571
+ def document_connector_add_documents_doc_without_preload_content(
572
+ self,
573
+ username: StrictStr,
574
+ dataset: StrictStr,
575
+ file: Union[StrictBytes, StrictStr, Tuple[StrictStr, StrictBytes]],
576
+ connector_id: Optional[StrictInt] = None,
577
+ q_answer_api_key: Optional[StrictStr] = None,
578
+ metadata: Optional[DocumentMetadataListWrapper] = None,
579
+ _request_timeout: Union[
580
+ None,
581
+ Annotated[StrictFloat, Field(gt=0)],
582
+ Tuple[
583
+ Annotated[StrictFloat, Field(gt=0)],
584
+ Annotated[StrictFloat, Field(gt=0)]
585
+ ]
586
+ ] = None,
587
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
588
+ _content_type: Optional[StrictStr] = None,
589
+ _headers: Optional[Dict[StrictStr, Any]] = None,
590
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
591
+ ) -> RESTResponseType:
592
+ """This route is for documentation only; use /api/connectors/document/add in production.
593
+
594
+
595
+ :param username: (required)
596
+ :type username: str
597
+ :param dataset: (required)
598
+ :type dataset: str
599
+ :param file: (required)
600
+ :type file: bytearray
601
+ :param connector_id:
602
+ :type connector_id: int
603
+ :param q_answer_api_key:
604
+ :type q_answer_api_key: str
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
+ file=file,
633
+ connector_id=connector_id,
634
+ q_answer_api_key=q_answer_api_key,
635
+ metadata=metadata,
636
+ _request_auth=_request_auth,
637
+ _content_type=_content_type,
638
+ _headers=_headers,
639
+ _host_index=_host_index
640
+ )
641
+
642
+ _response_types_map: Dict[str, Optional[str]] = {
643
+ '200': "StatusResponse",
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
+ file,
657
+ connector_id,
658
+ q_answer_api_key,
659
+ metadata,
660
+ _request_auth,
661
+ _content_type,
662
+ _headers,
663
+ _host_index,
664
+ ) -> RequestSerialized:
665
+
666
+ _host = None
667
+
668
+ _collection_formats: Dict[str, str] = {
669
+ }
670
+
671
+ _path_params: Dict[str, str] = {}
672
+ _query_params: List[Tuple[str, str]] = []
673
+ _header_params: Dict[str, Optional[str]] = _headers or {}
674
+ _form_params: List[Tuple[str, str]] = []
675
+ _files: Dict[
676
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
677
+ ] = {}
678
+ _body_params: Optional[bytes] = None
679
+
680
+ # process the path parameters
681
+ # process the query parameters
682
+ if username is not None:
683
+
684
+ _query_params.append(('username', username))
685
+
686
+ if dataset is not None:
687
+
688
+ _query_params.append(('dataset', dataset))
689
+
690
+ if connector_id is not None:
691
+
692
+ _query_params.append(('connector_id', connector_id))
693
+
694
+ # process the header parameters
695
+ if q_answer_api_key is not None:
696
+ _header_params['QAnswer-Api-Key'] = q_answer_api_key
697
+ # process the form parameters
698
+ if file is not None:
699
+ _files['file'] = file
700
+ if metadata is not None:
701
+ _form_params.append(('metadata', metadata))
702
+ # process the body parameter
703
+
704
+
705
+ # set the HTTP header `Accept`
706
+ if 'Accept' not in _header_params:
707
+ _header_params['Accept'] = self.api_client.select_header_accept(
708
+ [
709
+ '*/*'
710
+ ]
711
+ )
712
+
713
+ # set the HTTP header `Content-Type`
714
+ if _content_type:
715
+ _header_params['Content-Type'] = _content_type
716
+ else:
717
+ _default_content_type = (
718
+ self.api_client.select_header_content_type(
719
+ [
720
+ 'multipart/form-data'
721
+ ]
722
+ )
723
+ )
724
+ if _default_content_type is not None:
725
+ _header_params['Content-Type'] = _default_content_type
726
+
727
+ # authentication setting
728
+ _auth_settings: List[str] = [
729
+ 'QAnswer-Api-Key',
730
+ 'Bearer'
731
+ ]
732
+
733
+ return self.api_client.param_serialize(
734
+ method='POST',
735
+ resource_path='/api/connectors/document/doc/add',
736
+ path_params=_path_params,
737
+ query_params=_query_params,
738
+ header_params=_header_params,
739
+ body=_body_params,
740
+ post_params=_form_params,
741
+ files=_files,
742
+ auth_settings=_auth_settings,
743
+ collection_formats=_collection_formats,
744
+ _host=_host,
745
+ _request_auth=_request_auth
746
+ )
747
+
748
+
749
+
750
+
751
+ @validate_call
752
+ def document_connector_add_documents_sync(
753
+ self,
754
+ username: StrictStr,
755
+ dataset: StrictStr,
756
+ file: List[Union[StrictBytes, StrictStr, Tuple[StrictStr, StrictBytes]]],
757
+ connector_id: Optional[StrictInt] = None,
758
+ convert_to_pdf: Optional[StrictBool] = None,
759
+ q_answer_api_key: Optional[StrictStr] = None,
760
+ metadata: Optional[DocumentMetadataListWrapper] = None,
761
+ _request_timeout: Union[
762
+ None,
763
+ Annotated[StrictFloat, Field(gt=0)],
764
+ Tuple[
765
+ Annotated[StrictFloat, Field(gt=0)],
766
+ Annotated[StrictFloat, Field(gt=0)]
767
+ ]
768
+ ] = None,
769
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
770
+ _content_type: Optional[StrictStr] = None,
771
+ _headers: Optional[Dict[StrictStr, Any]] = None,
772
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
773
+ ) -> StatusResponse:
774
+ """document_connector_add_documents_sync
775
+
776
+
777
+ :param username: (required)
778
+ :type username: str
779
+ :param dataset: (required)
780
+ :type dataset: str
781
+ :param file: (required)
782
+ :type file: List[bytearray]
783
+ :param connector_id:
784
+ :type connector_id: int
785
+ :param convert_to_pdf:
786
+ :type convert_to_pdf: bool
787
+ :param q_answer_api_key:
788
+ :type q_answer_api_key: str
789
+ :param metadata:
790
+ :type metadata: DocumentMetadataListWrapper
791
+ :param _request_timeout: timeout setting for this request. If one
792
+ number provided, it will be total request
793
+ timeout. It can also be a pair (tuple) of
794
+ (connection, read) timeouts.
795
+ :type _request_timeout: int, tuple(int, int), optional
796
+ :param _request_auth: set to override the auth_settings for an a single
797
+ request; this effectively ignores the
798
+ authentication in the spec for a single request.
799
+ :type _request_auth: dict, optional
800
+ :param _content_type: force content-type for the request.
801
+ :type _content_type: str, Optional
802
+ :param _headers: set to override the headers for a single
803
+ request; this effectively ignores the headers
804
+ in the spec for a single request.
805
+ :type _headers: dict, optional
806
+ :param _host_index: set to override the host_index for a single
807
+ request; this effectively ignores the host_index
808
+ in the spec for a single request.
809
+ :type _host_index: int, optional
810
+ :return: Returns the result object.
811
+ """ # noqa: E501
812
+
813
+ _param = self._document_connector_add_documents_sync_serialize(
814
+ username=username,
815
+ dataset=dataset,
816
+ file=file,
817
+ connector_id=connector_id,
818
+ convert_to_pdf=convert_to_pdf,
819
+ q_answer_api_key=q_answer_api_key,
820
+ metadata=metadata,
821
+ _request_auth=_request_auth,
822
+ _content_type=_content_type,
823
+ _headers=_headers,
824
+ _host_index=_host_index
825
+ )
826
+
827
+ _response_types_map: Dict[str, Optional[str]] = {
828
+ '200': "StatusResponse",
829
+ }
830
+ response_data = self.api_client.call_api(
831
+ *_param,
832
+ _request_timeout=_request_timeout
833
+ )
834
+ response_data.read()
835
+ return self.api_client.response_deserialize(
836
+ response_data=response_data,
837
+ response_types_map=_response_types_map,
838
+ ).data
839
+
840
+
841
+ @validate_call
842
+ def document_connector_add_documents_sync_with_http_info(
843
+ self,
844
+ username: StrictStr,
845
+ dataset: StrictStr,
846
+ file: List[Union[StrictBytes, StrictStr, Tuple[StrictStr, StrictBytes]]],
847
+ connector_id: Optional[StrictInt] = None,
848
+ convert_to_pdf: Optional[StrictBool] = None,
849
+ q_answer_api_key: Optional[StrictStr] = None,
850
+ metadata: Optional[DocumentMetadataListWrapper] = None,
851
+ _request_timeout: Union[
852
+ None,
853
+ Annotated[StrictFloat, Field(gt=0)],
854
+ Tuple[
855
+ Annotated[StrictFloat, Field(gt=0)],
856
+ Annotated[StrictFloat, Field(gt=0)]
857
+ ]
858
+ ] = None,
859
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
860
+ _content_type: Optional[StrictStr] = None,
861
+ _headers: Optional[Dict[StrictStr, Any]] = None,
862
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
863
+ ) -> ApiResponse[StatusResponse]:
864
+ """document_connector_add_documents_sync
865
+
866
+
867
+ :param username: (required)
868
+ :type username: str
869
+ :param dataset: (required)
870
+ :type dataset: str
871
+ :param file: (required)
872
+ :type file: List[bytearray]
873
+ :param connector_id:
874
+ :type connector_id: int
875
+ :param convert_to_pdf:
876
+ :type convert_to_pdf: bool
877
+ :param q_answer_api_key:
878
+ :type q_answer_api_key: str
879
+ :param metadata:
880
+ :type metadata: DocumentMetadataListWrapper
881
+ :param _request_timeout: timeout setting for this request. If one
882
+ number provided, it will be total request
883
+ timeout. It can also be a pair (tuple) of
884
+ (connection, read) timeouts.
885
+ :type _request_timeout: int, tuple(int, int), optional
886
+ :param _request_auth: set to override the auth_settings for an a single
887
+ request; this effectively ignores the
888
+ authentication in the spec for a single request.
889
+ :type _request_auth: dict, optional
890
+ :param _content_type: force content-type for the request.
891
+ :type _content_type: str, Optional
892
+ :param _headers: set to override the headers for a single
893
+ request; this effectively ignores the headers
894
+ in the spec for a single request.
895
+ :type _headers: dict, optional
896
+ :param _host_index: set to override the host_index for a single
897
+ request; this effectively ignores the host_index
898
+ in the spec for a single request.
899
+ :type _host_index: int, optional
900
+ :return: Returns the result object.
901
+ """ # noqa: E501
902
+
903
+ _param = self._document_connector_add_documents_sync_serialize(
904
+ username=username,
905
+ dataset=dataset,
906
+ file=file,
907
+ connector_id=connector_id,
908
+ convert_to_pdf=convert_to_pdf,
909
+ q_answer_api_key=q_answer_api_key,
910
+ metadata=metadata,
911
+ _request_auth=_request_auth,
912
+ _content_type=_content_type,
913
+ _headers=_headers,
914
+ _host_index=_host_index
915
+ )
916
+
917
+ _response_types_map: Dict[str, Optional[str]] = {
918
+ '200': "StatusResponse",
919
+ }
920
+ response_data = self.api_client.call_api(
921
+ *_param,
922
+ _request_timeout=_request_timeout
923
+ )
924
+ response_data.read()
925
+ return self.api_client.response_deserialize(
926
+ response_data=response_data,
927
+ response_types_map=_response_types_map,
928
+ )
929
+
930
+
931
+ @validate_call
932
+ def document_connector_add_documents_sync_without_preload_content(
933
+ self,
934
+ username: StrictStr,
935
+ dataset: StrictStr,
936
+ file: List[Union[StrictBytes, StrictStr, Tuple[StrictStr, StrictBytes]]],
937
+ connector_id: Optional[StrictInt] = None,
938
+ convert_to_pdf: Optional[StrictBool] = None,
939
+ q_answer_api_key: Optional[StrictStr] = None,
940
+ metadata: Optional[DocumentMetadataListWrapper] = None,
941
+ _request_timeout: Union[
942
+ None,
943
+ Annotated[StrictFloat, Field(gt=0)],
944
+ Tuple[
945
+ Annotated[StrictFloat, Field(gt=0)],
946
+ Annotated[StrictFloat, Field(gt=0)]
947
+ ]
948
+ ] = None,
949
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
950
+ _content_type: Optional[StrictStr] = None,
951
+ _headers: Optional[Dict[StrictStr, Any]] = None,
952
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
953
+ ) -> RESTResponseType:
954
+ """document_connector_add_documents_sync
955
+
956
+
957
+ :param username: (required)
958
+ :type username: str
959
+ :param dataset: (required)
960
+ :type dataset: str
961
+ :param file: (required)
962
+ :type file: List[bytearray]
963
+ :param connector_id:
964
+ :type connector_id: int
965
+ :param convert_to_pdf:
966
+ :type convert_to_pdf: bool
967
+ :param q_answer_api_key:
968
+ :type q_answer_api_key: str
969
+ :param metadata:
970
+ :type metadata: DocumentMetadataListWrapper
971
+ :param _request_timeout: timeout setting for this request. If one
972
+ number provided, it will be total request
973
+ timeout. It can also be a pair (tuple) of
974
+ (connection, read) timeouts.
975
+ :type _request_timeout: int, tuple(int, int), optional
976
+ :param _request_auth: set to override the auth_settings for an a single
977
+ request; this effectively ignores the
978
+ authentication in the spec for a single request.
979
+ :type _request_auth: dict, optional
980
+ :param _content_type: force content-type for the request.
981
+ :type _content_type: str, Optional
982
+ :param _headers: set to override the headers for a single
983
+ request; this effectively ignores the headers
984
+ in the spec for a single request.
985
+ :type _headers: dict, optional
986
+ :param _host_index: set to override the host_index for a single
987
+ request; this effectively ignores the host_index
988
+ in the spec for a single request.
989
+ :type _host_index: int, optional
990
+ :return: Returns the result object.
991
+ """ # noqa: E501
992
+
993
+ _param = self._document_connector_add_documents_sync_serialize(
994
+ username=username,
995
+ dataset=dataset,
996
+ file=file,
997
+ connector_id=connector_id,
998
+ convert_to_pdf=convert_to_pdf,
999
+ q_answer_api_key=q_answer_api_key,
1000
+ metadata=metadata,
1001
+ _request_auth=_request_auth,
1002
+ _content_type=_content_type,
1003
+ _headers=_headers,
1004
+ _host_index=_host_index
1005
+ )
1006
+
1007
+ _response_types_map: Dict[str, Optional[str]] = {
1008
+ '200': "StatusResponse",
1009
+ }
1010
+ response_data = self.api_client.call_api(
1011
+ *_param,
1012
+ _request_timeout=_request_timeout
1013
+ )
1014
+ return response_data.response
1015
+
1016
+
1017
+ def _document_connector_add_documents_sync_serialize(
1018
+ self,
1019
+ username,
1020
+ dataset,
1021
+ file,
1022
+ connector_id,
1023
+ convert_to_pdf,
1024
+ q_answer_api_key,
1025
+ metadata,
1026
+ _request_auth,
1027
+ _content_type,
1028
+ _headers,
1029
+ _host_index,
1030
+ ) -> RequestSerialized:
1031
+
1032
+ _host = None
1033
+
1034
+ _collection_formats: Dict[str, str] = {
1035
+ 'file': 'csv',
1036
+ }
1037
+
1038
+ _path_params: Dict[str, str] = {}
1039
+ _query_params: List[Tuple[str, str]] = []
1040
+ _header_params: Dict[str, Optional[str]] = _headers or {}
1041
+ _form_params: List[Tuple[str, str]] = []
1042
+ _files: Dict[
1043
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
1044
+ ] = {}
1045
+ _body_params: Optional[bytes] = None
1046
+
1047
+ # process the path parameters
1048
+ # process the query parameters
1049
+ if username is not None:
1050
+
1051
+ _query_params.append(('username', username))
1052
+
1053
+ if dataset is not None:
1054
+
1055
+ _query_params.append(('dataset', dataset))
1056
+
1057
+ if connector_id is not None:
1058
+
1059
+ _query_params.append(('connector_id', connector_id))
1060
+
1061
+ if convert_to_pdf is not None:
1062
+
1063
+ _query_params.append(('convert_to_pdf', convert_to_pdf))
1064
+
1065
+ # process the header parameters
1066
+ if q_answer_api_key is not None:
1067
+ _header_params['QAnswer-Api-Key'] = q_answer_api_key
1068
+ # process the form parameters
1069
+ if file is not None:
1070
+ _files['file'] = file
1071
+ if metadata is not None:
1072
+ _form_params.append(('metadata', metadata))
1073
+ # process the body parameter
1074
+
1075
+
1076
+ # set the HTTP header `Accept`
1077
+ if 'Accept' not in _header_params:
1078
+ _header_params['Accept'] = self.api_client.select_header_accept(
1079
+ [
1080
+ '*/*'
1081
+ ]
1082
+ )
1083
+
1084
+ # set the HTTP header `Content-Type`
1085
+ if _content_type:
1086
+ _header_params['Content-Type'] = _content_type
1087
+ else:
1088
+ _default_content_type = (
1089
+ self.api_client.select_header_content_type(
1090
+ [
1091
+ 'multipart/form-data'
1092
+ ]
1093
+ )
1094
+ )
1095
+ if _default_content_type is not None:
1096
+ _header_params['Content-Type'] = _default_content_type
1097
+
1098
+ # authentication setting
1099
+ _auth_settings: List[str] = [
1100
+ 'QAnswer-Api-Key',
1101
+ 'Bearer'
1102
+ ]
1103
+
1104
+ return self.api_client.param_serialize(
1105
+ method='POST',
1106
+ resource_path='/api/connectors/document/add-async',
1107
+ path_params=_path_params,
1108
+ query_params=_query_params,
1109
+ header_params=_header_params,
1110
+ body=_body_params,
1111
+ post_params=_form_params,
1112
+ files=_files,
1113
+ auth_settings=_auth_settings,
1114
+ collection_formats=_collection_formats,
1115
+ _host=_host,
1116
+ _request_auth=_request_auth
1117
+ )
1118
+
1119
+
1120
+
1121
+
1122
+ @validate_call
1123
+ def document_connector_create_connector(
1124
+ self,
1125
+ create_connector_request: CreateConnectorRequest,
1126
+ q_answer_api_key: Optional[StrictStr] = None,
1127
+ _request_timeout: Union[
1128
+ None,
1129
+ Annotated[StrictFloat, Field(gt=0)],
1130
+ Tuple[
1131
+ Annotated[StrictFloat, Field(gt=0)],
1132
+ Annotated[StrictFloat, Field(gt=0)]
1133
+ ]
1134
+ ] = None,
1135
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1136
+ _content_type: Optional[StrictStr] = None,
1137
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1138
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1139
+ ) -> CreateConnectorResponse:
1140
+ """document_connector_create_connector
1141
+
1142
+
1143
+ :param create_connector_request: (required)
1144
+ :type create_connector_request: CreateConnectorRequest
1145
+ :param q_answer_api_key:
1146
+ :type q_answer_api_key: str
1147
+ :param _request_timeout: timeout setting for this request. If one
1148
+ number provided, it will be total request
1149
+ timeout. It can also be a pair (tuple) of
1150
+ (connection, read) timeouts.
1151
+ :type _request_timeout: int, tuple(int, int), optional
1152
+ :param _request_auth: set to override the auth_settings for an a single
1153
+ request; this effectively ignores the
1154
+ authentication in the spec for a single request.
1155
+ :type _request_auth: dict, optional
1156
+ :param _content_type: force content-type for the request.
1157
+ :type _content_type: str, Optional
1158
+ :param _headers: set to override the headers for a single
1159
+ request; this effectively ignores the headers
1160
+ in the spec for a single request.
1161
+ :type _headers: dict, optional
1162
+ :param _host_index: set to override the host_index for a single
1163
+ request; this effectively ignores the host_index
1164
+ in the spec for a single request.
1165
+ :type _host_index: int, optional
1166
+ :return: Returns the result object.
1167
+ """ # noqa: E501
1168
+
1169
+ _param = self._document_connector_create_connector_serialize(
1170
+ create_connector_request=create_connector_request,
1171
+ q_answer_api_key=q_answer_api_key,
1172
+ _request_auth=_request_auth,
1173
+ _content_type=_content_type,
1174
+ _headers=_headers,
1175
+ _host_index=_host_index
1176
+ )
1177
+
1178
+ _response_types_map: Dict[str, Optional[str]] = {
1179
+ '200': "CreateConnectorResponse",
1180
+ }
1181
+ response_data = self.api_client.call_api(
1182
+ *_param,
1183
+ _request_timeout=_request_timeout
1184
+ )
1185
+ response_data.read()
1186
+ return self.api_client.response_deserialize(
1187
+ response_data=response_data,
1188
+ response_types_map=_response_types_map,
1189
+ ).data
1190
+
1191
+
1192
+ @validate_call
1193
+ def document_connector_create_connector_with_http_info(
1194
+ self,
1195
+ create_connector_request: CreateConnectorRequest,
1196
+ q_answer_api_key: Optional[StrictStr] = None,
1197
+ _request_timeout: Union[
1198
+ None,
1199
+ Annotated[StrictFloat, Field(gt=0)],
1200
+ Tuple[
1201
+ Annotated[StrictFloat, Field(gt=0)],
1202
+ Annotated[StrictFloat, Field(gt=0)]
1203
+ ]
1204
+ ] = None,
1205
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1206
+ _content_type: Optional[StrictStr] = None,
1207
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1208
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1209
+ ) -> ApiResponse[CreateConnectorResponse]:
1210
+ """document_connector_create_connector
1211
+
1212
+
1213
+ :param create_connector_request: (required)
1214
+ :type create_connector_request: CreateConnectorRequest
1215
+ :param q_answer_api_key:
1216
+ :type q_answer_api_key: str
1217
+ :param _request_timeout: timeout setting for this request. If one
1218
+ number provided, it will be total request
1219
+ timeout. It can also be a pair (tuple) of
1220
+ (connection, read) timeouts.
1221
+ :type _request_timeout: int, tuple(int, int), optional
1222
+ :param _request_auth: set to override the auth_settings for an a single
1223
+ request; this effectively ignores the
1224
+ authentication in the spec for a single request.
1225
+ :type _request_auth: dict, optional
1226
+ :param _content_type: force content-type for the request.
1227
+ :type _content_type: str, Optional
1228
+ :param _headers: set to override the headers for a single
1229
+ request; this effectively ignores the headers
1230
+ in the spec for a single request.
1231
+ :type _headers: dict, optional
1232
+ :param _host_index: set to override the host_index for a single
1233
+ request; this effectively ignores the host_index
1234
+ in the spec for a single request.
1235
+ :type _host_index: int, optional
1236
+ :return: Returns the result object.
1237
+ """ # noqa: E501
1238
+
1239
+ _param = self._document_connector_create_connector_serialize(
1240
+ create_connector_request=create_connector_request,
1241
+ q_answer_api_key=q_answer_api_key,
1242
+ _request_auth=_request_auth,
1243
+ _content_type=_content_type,
1244
+ _headers=_headers,
1245
+ _host_index=_host_index
1246
+ )
1247
+
1248
+ _response_types_map: Dict[str, Optional[str]] = {
1249
+ '200': "CreateConnectorResponse",
1250
+ }
1251
+ response_data = self.api_client.call_api(
1252
+ *_param,
1253
+ _request_timeout=_request_timeout
1254
+ )
1255
+ response_data.read()
1256
+ return self.api_client.response_deserialize(
1257
+ response_data=response_data,
1258
+ response_types_map=_response_types_map,
1259
+ )
1260
+
1261
+
1262
+ @validate_call
1263
+ def document_connector_create_connector_without_preload_content(
1264
+ self,
1265
+ create_connector_request: CreateConnectorRequest,
1266
+ q_answer_api_key: Optional[StrictStr] = None,
1267
+ _request_timeout: Union[
1268
+ None,
1269
+ Annotated[StrictFloat, Field(gt=0)],
1270
+ Tuple[
1271
+ Annotated[StrictFloat, Field(gt=0)],
1272
+ Annotated[StrictFloat, Field(gt=0)]
1273
+ ]
1274
+ ] = None,
1275
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1276
+ _content_type: Optional[StrictStr] = None,
1277
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1278
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1279
+ ) -> RESTResponseType:
1280
+ """document_connector_create_connector
1281
+
1282
+
1283
+ :param create_connector_request: (required)
1284
+ :type create_connector_request: CreateConnectorRequest
1285
+ :param q_answer_api_key:
1286
+ :type q_answer_api_key: str
1287
+ :param _request_timeout: timeout setting for this request. If one
1288
+ number provided, it will be total request
1289
+ timeout. It can also be a pair (tuple) of
1290
+ (connection, read) timeouts.
1291
+ :type _request_timeout: int, tuple(int, int), optional
1292
+ :param _request_auth: set to override the auth_settings for an a single
1293
+ request; this effectively ignores the
1294
+ authentication in the spec for a single request.
1295
+ :type _request_auth: dict, optional
1296
+ :param _content_type: force content-type for the request.
1297
+ :type _content_type: str, Optional
1298
+ :param _headers: set to override the headers for a single
1299
+ request; this effectively ignores the headers
1300
+ in the spec for a single request.
1301
+ :type _headers: dict, optional
1302
+ :param _host_index: set to override the host_index for a single
1303
+ request; this effectively ignores the host_index
1304
+ in the spec for a single request.
1305
+ :type _host_index: int, optional
1306
+ :return: Returns the result object.
1307
+ """ # noqa: E501
1308
+
1309
+ _param = self._document_connector_create_connector_serialize(
1310
+ create_connector_request=create_connector_request,
1311
+ q_answer_api_key=q_answer_api_key,
1312
+ _request_auth=_request_auth,
1313
+ _content_type=_content_type,
1314
+ _headers=_headers,
1315
+ _host_index=_host_index
1316
+ )
1317
+
1318
+ _response_types_map: Dict[str, Optional[str]] = {
1319
+ '200': "CreateConnectorResponse",
1320
+ }
1321
+ response_data = self.api_client.call_api(
1322
+ *_param,
1323
+ _request_timeout=_request_timeout
1324
+ )
1325
+ return response_data.response
1326
+
1327
+
1328
+ def _document_connector_create_connector_serialize(
1329
+ self,
1330
+ create_connector_request,
1331
+ q_answer_api_key,
1332
+ _request_auth,
1333
+ _content_type,
1334
+ _headers,
1335
+ _host_index,
1336
+ ) -> RequestSerialized:
1337
+
1338
+ _host = None
1339
+
1340
+ _collection_formats: Dict[str, str] = {
1341
+ }
1342
+
1343
+ _path_params: Dict[str, str] = {}
1344
+ _query_params: List[Tuple[str, str]] = []
1345
+ _header_params: Dict[str, Optional[str]] = _headers or {}
1346
+ _form_params: List[Tuple[str, str]] = []
1347
+ _files: Dict[
1348
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
1349
+ ] = {}
1350
+ _body_params: Optional[bytes] = None
1351
+
1352
+ # process the path parameters
1353
+ # process the query parameters
1354
+ # process the header parameters
1355
+ if q_answer_api_key is not None:
1356
+ _header_params['QAnswer-Api-Key'] = q_answer_api_key
1357
+ # process the form parameters
1358
+ # process the body parameter
1359
+ if create_connector_request is not None:
1360
+ _body_params = create_connector_request
1361
+
1362
+
1363
+ # set the HTTP header `Accept`
1364
+ if 'Accept' not in _header_params:
1365
+ _header_params['Accept'] = self.api_client.select_header_accept(
1366
+ [
1367
+ '*/*'
1368
+ ]
1369
+ )
1370
+
1371
+ # set the HTTP header `Content-Type`
1372
+ if _content_type:
1373
+ _header_params['Content-Type'] = _content_type
1374
+ else:
1375
+ _default_content_type = (
1376
+ self.api_client.select_header_content_type(
1377
+ [
1378
+ 'application/json'
1379
+ ]
1380
+ )
1381
+ )
1382
+ if _default_content_type is not None:
1383
+ _header_params['Content-Type'] = _default_content_type
1384
+
1385
+ # authentication setting
1386
+ _auth_settings: List[str] = [
1387
+ 'QAnswer-Api-Key',
1388
+ 'Bearer'
1389
+ ]
1390
+
1391
+ return self.api_client.param_serialize(
1392
+ method='POST',
1393
+ resource_path='/api/connectors/document/create',
1394
+ path_params=_path_params,
1395
+ query_params=_query_params,
1396
+ header_params=_header_params,
1397
+ body=_body_params,
1398
+ post_params=_form_params,
1399
+ files=_files,
1400
+ auth_settings=_auth_settings,
1401
+ collection_formats=_collection_formats,
1402
+ _host=_host,
1403
+ _request_auth=_request_auth
1404
+ )
1405
+
1406
+