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,1497 @@
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 StrictInt, StrictStr
20
+ from typing import Optional
21
+ from qanswer_sdk.models.available_connectors_response import AvailableConnectorsResponse
22
+ from qanswer_sdk.models.base_connectors_response import BaseConnectorsResponse
23
+ from qanswer_sdk.models.delete_connector_request import DeleteConnectorRequest
24
+ from qanswer_sdk.models.delete_connectors_response import DeleteConnectorsResponse
25
+ from qanswer_sdk.models.get_connector_by_id_response import GetConnectorByIdResponse
26
+ from qanswer_sdk.models.list_connectors_response import ListConnectorsResponse
27
+ from qanswer_sdk.models.modify_connector_request import ModifyConnectorRequest
28
+
29
+ from qanswer_sdk.api_client import ApiClient, RequestSerialized
30
+ from qanswer_sdk.api_response import ApiResponse
31
+ from qanswer_sdk.rest import RESTResponseType
32
+
33
+
34
+ class ConnectorsApi:
35
+ """NOTE: This class is auto generated by OpenAPI Generator
36
+ Ref: https://openapi-generator.tech
37
+
38
+ Do not edit the class manually.
39
+ """
40
+
41
+ def __init__(self, api_client=None) -> None:
42
+ if api_client is None:
43
+ api_client = ApiClient.get_default()
44
+ self.api_client = api_client
45
+
46
+
47
+ @validate_call
48
+ def delete2(
49
+ self,
50
+ delete_connector_request: DeleteConnectorRequest,
51
+ q_answer_api_key: Optional[StrictStr] = None,
52
+ _request_timeout: Union[
53
+ None,
54
+ Annotated[StrictFloat, Field(gt=0)],
55
+ Tuple[
56
+ Annotated[StrictFloat, Field(gt=0)],
57
+ Annotated[StrictFloat, Field(gt=0)]
58
+ ]
59
+ ] = None,
60
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
61
+ _content_type: Optional[StrictStr] = None,
62
+ _headers: Optional[Dict[StrictStr, Any]] = None,
63
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
64
+ ) -> DeleteConnectorsResponse:
65
+ """delete2
66
+
67
+
68
+ :param delete_connector_request: (required)
69
+ :type delete_connector_request: DeleteConnectorRequest
70
+ :param q_answer_api_key:
71
+ :type q_answer_api_key: str
72
+ :param _request_timeout: timeout setting for this request. If one
73
+ number provided, it will be total request
74
+ timeout. It can also be a pair (tuple) of
75
+ (connection, read) timeouts.
76
+ :type _request_timeout: int, tuple(int, int), optional
77
+ :param _request_auth: set to override the auth_settings for an a single
78
+ request; this effectively ignores the
79
+ authentication in the spec for a single request.
80
+ :type _request_auth: dict, optional
81
+ :param _content_type: force content-type for the request.
82
+ :type _content_type: str, Optional
83
+ :param _headers: set to override the headers for a single
84
+ request; this effectively ignores the headers
85
+ in the spec for a single request.
86
+ :type _headers: dict, optional
87
+ :param _host_index: set to override the host_index for a single
88
+ request; this effectively ignores the host_index
89
+ in the spec for a single request.
90
+ :type _host_index: int, optional
91
+ :return: Returns the result object.
92
+ """ # noqa: E501
93
+
94
+ _param = self._delete2_serialize(
95
+ delete_connector_request=delete_connector_request,
96
+ q_answer_api_key=q_answer_api_key,
97
+ _request_auth=_request_auth,
98
+ _content_type=_content_type,
99
+ _headers=_headers,
100
+ _host_index=_host_index
101
+ )
102
+
103
+ _response_types_map: Dict[str, Optional[str]] = {
104
+ '200': "DeleteConnectorsResponse",
105
+ }
106
+ response_data = self.api_client.call_api(
107
+ *_param,
108
+ _request_timeout=_request_timeout
109
+ )
110
+ response_data.read()
111
+ return self.api_client.response_deserialize(
112
+ response_data=response_data,
113
+ response_types_map=_response_types_map,
114
+ ).data
115
+
116
+
117
+ @validate_call
118
+ def delete2_with_http_info(
119
+ self,
120
+ delete_connector_request: DeleteConnectorRequest,
121
+ q_answer_api_key: Optional[StrictStr] = None,
122
+ _request_timeout: Union[
123
+ None,
124
+ Annotated[StrictFloat, Field(gt=0)],
125
+ Tuple[
126
+ Annotated[StrictFloat, Field(gt=0)],
127
+ Annotated[StrictFloat, Field(gt=0)]
128
+ ]
129
+ ] = None,
130
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
131
+ _content_type: Optional[StrictStr] = None,
132
+ _headers: Optional[Dict[StrictStr, Any]] = None,
133
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
134
+ ) -> ApiResponse[DeleteConnectorsResponse]:
135
+ """delete2
136
+
137
+
138
+ :param delete_connector_request: (required)
139
+ :type delete_connector_request: DeleteConnectorRequest
140
+ :param q_answer_api_key:
141
+ :type q_answer_api_key: str
142
+ :param _request_timeout: timeout setting for this request. If one
143
+ number provided, it will be total request
144
+ timeout. It can also be a pair (tuple) of
145
+ (connection, read) timeouts.
146
+ :type _request_timeout: int, tuple(int, int), optional
147
+ :param _request_auth: set to override the auth_settings for an a single
148
+ request; this effectively ignores the
149
+ authentication in the spec for a single request.
150
+ :type _request_auth: dict, optional
151
+ :param _content_type: force content-type for the request.
152
+ :type _content_type: str, Optional
153
+ :param _headers: set to override the headers for a single
154
+ request; this effectively ignores the headers
155
+ in the spec for a single request.
156
+ :type _headers: dict, optional
157
+ :param _host_index: set to override the host_index for a single
158
+ request; this effectively ignores the host_index
159
+ in the spec for a single request.
160
+ :type _host_index: int, optional
161
+ :return: Returns the result object.
162
+ """ # noqa: E501
163
+
164
+ _param = self._delete2_serialize(
165
+ delete_connector_request=delete_connector_request,
166
+ q_answer_api_key=q_answer_api_key,
167
+ _request_auth=_request_auth,
168
+ _content_type=_content_type,
169
+ _headers=_headers,
170
+ _host_index=_host_index
171
+ )
172
+
173
+ _response_types_map: Dict[str, Optional[str]] = {
174
+ '200': "DeleteConnectorsResponse",
175
+ }
176
+ response_data = self.api_client.call_api(
177
+ *_param,
178
+ _request_timeout=_request_timeout
179
+ )
180
+ response_data.read()
181
+ return self.api_client.response_deserialize(
182
+ response_data=response_data,
183
+ response_types_map=_response_types_map,
184
+ )
185
+
186
+
187
+ @validate_call
188
+ def delete2_without_preload_content(
189
+ self,
190
+ delete_connector_request: DeleteConnectorRequest,
191
+ q_answer_api_key: Optional[StrictStr] = None,
192
+ _request_timeout: Union[
193
+ None,
194
+ Annotated[StrictFloat, Field(gt=0)],
195
+ Tuple[
196
+ Annotated[StrictFloat, Field(gt=0)],
197
+ Annotated[StrictFloat, Field(gt=0)]
198
+ ]
199
+ ] = None,
200
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
201
+ _content_type: Optional[StrictStr] = None,
202
+ _headers: Optional[Dict[StrictStr, Any]] = None,
203
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
204
+ ) -> RESTResponseType:
205
+ """delete2
206
+
207
+
208
+ :param delete_connector_request: (required)
209
+ :type delete_connector_request: DeleteConnectorRequest
210
+ :param q_answer_api_key:
211
+ :type q_answer_api_key: str
212
+ :param _request_timeout: timeout setting for this request. If one
213
+ number provided, it will be total request
214
+ timeout. It can also be a pair (tuple) of
215
+ (connection, read) timeouts.
216
+ :type _request_timeout: int, tuple(int, int), optional
217
+ :param _request_auth: set to override the auth_settings for an a single
218
+ request; this effectively ignores the
219
+ authentication in the spec for a single request.
220
+ :type _request_auth: dict, optional
221
+ :param _content_type: force content-type for the request.
222
+ :type _content_type: str, Optional
223
+ :param _headers: set to override the headers for a single
224
+ request; this effectively ignores the headers
225
+ in the spec for a single request.
226
+ :type _headers: dict, optional
227
+ :param _host_index: set to override the host_index for a single
228
+ request; this effectively ignores the host_index
229
+ in the spec for a single request.
230
+ :type _host_index: int, optional
231
+ :return: Returns the result object.
232
+ """ # noqa: E501
233
+
234
+ _param = self._delete2_serialize(
235
+ delete_connector_request=delete_connector_request,
236
+ q_answer_api_key=q_answer_api_key,
237
+ _request_auth=_request_auth,
238
+ _content_type=_content_type,
239
+ _headers=_headers,
240
+ _host_index=_host_index
241
+ )
242
+
243
+ _response_types_map: Dict[str, Optional[str]] = {
244
+ '200': "DeleteConnectorsResponse",
245
+ }
246
+ response_data = self.api_client.call_api(
247
+ *_param,
248
+ _request_timeout=_request_timeout
249
+ )
250
+ return response_data.response
251
+
252
+
253
+ def _delete2_serialize(
254
+ self,
255
+ delete_connector_request,
256
+ q_answer_api_key,
257
+ _request_auth,
258
+ _content_type,
259
+ _headers,
260
+ _host_index,
261
+ ) -> RequestSerialized:
262
+
263
+ _host = None
264
+
265
+ _collection_formats: Dict[str, str] = {
266
+ }
267
+
268
+ _path_params: Dict[str, str] = {}
269
+ _query_params: List[Tuple[str, str]] = []
270
+ _header_params: Dict[str, Optional[str]] = _headers or {}
271
+ _form_params: List[Tuple[str, str]] = []
272
+ _files: Dict[
273
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
274
+ ] = {}
275
+ _body_params: Optional[bytes] = None
276
+
277
+ # process the path parameters
278
+ # process the query parameters
279
+ # process the header parameters
280
+ if q_answer_api_key is not None:
281
+ _header_params['QAnswer-Api-Key'] = q_answer_api_key
282
+ # process the form parameters
283
+ # process the body parameter
284
+ if delete_connector_request is not None:
285
+ _body_params = delete_connector_request
286
+
287
+
288
+ # set the HTTP header `Accept`
289
+ if 'Accept' not in _header_params:
290
+ _header_params['Accept'] = self.api_client.select_header_accept(
291
+ [
292
+ '*/*'
293
+ ]
294
+ )
295
+
296
+ # set the HTTP header `Content-Type`
297
+ if _content_type:
298
+ _header_params['Content-Type'] = _content_type
299
+ else:
300
+ _default_content_type = (
301
+ self.api_client.select_header_content_type(
302
+ [
303
+ 'application/json'
304
+ ]
305
+ )
306
+ )
307
+ if _default_content_type is not None:
308
+ _header_params['Content-Type'] = _default_content_type
309
+
310
+ # authentication setting
311
+ _auth_settings: List[str] = [
312
+ 'QAnswer-Api-Key',
313
+ 'Bearer'
314
+ ]
315
+
316
+ return self.api_client.param_serialize(
317
+ method='DELETE',
318
+ resource_path='/api/connectors/delete',
319
+ path_params=_path_params,
320
+ query_params=_query_params,
321
+ header_params=_header_params,
322
+ body=_body_params,
323
+ post_params=_form_params,
324
+ files=_files,
325
+ auth_settings=_auth_settings,
326
+ collection_formats=_collection_formats,
327
+ _host=_host,
328
+ _request_auth=_request_auth
329
+ )
330
+
331
+
332
+
333
+
334
+ @validate_call
335
+ def get2(
336
+ self,
337
+ username: StrictStr,
338
+ dataset: StrictStr,
339
+ connector_type: Optional[StrictStr] = None,
340
+ conversation_id: Optional[StrictStr] = None,
341
+ q_answer_api_key: Optional[StrictStr] = None,
342
+ _request_timeout: Union[
343
+ None,
344
+ Annotated[StrictFloat, Field(gt=0)],
345
+ Tuple[
346
+ Annotated[StrictFloat, Field(gt=0)],
347
+ Annotated[StrictFloat, Field(gt=0)]
348
+ ]
349
+ ] = None,
350
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
351
+ _content_type: Optional[StrictStr] = None,
352
+ _headers: Optional[Dict[StrictStr, Any]] = None,
353
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
354
+ ) -> ListConnectorsResponse:
355
+ """get2
356
+
357
+
358
+ :param username: (required)
359
+ :type username: str
360
+ :param dataset: (required)
361
+ :type dataset: str
362
+ :param connector_type:
363
+ :type connector_type: str
364
+ :param conversation_id:
365
+ :type conversation_id: str
366
+ :param q_answer_api_key:
367
+ :type q_answer_api_key: str
368
+ :param _request_timeout: timeout setting for this request. If one
369
+ number provided, it will be total request
370
+ timeout. It can also be a pair (tuple) of
371
+ (connection, read) timeouts.
372
+ :type _request_timeout: int, tuple(int, int), optional
373
+ :param _request_auth: set to override the auth_settings for an a single
374
+ request; this effectively ignores the
375
+ authentication in the spec for a single request.
376
+ :type _request_auth: dict, optional
377
+ :param _content_type: force content-type for the request.
378
+ :type _content_type: str, Optional
379
+ :param _headers: set to override the headers for a single
380
+ request; this effectively ignores the headers
381
+ in the spec for a single request.
382
+ :type _headers: dict, optional
383
+ :param _host_index: set to override the host_index for a single
384
+ request; this effectively ignores the host_index
385
+ in the spec for a single request.
386
+ :type _host_index: int, optional
387
+ :return: Returns the result object.
388
+ """ # noqa: E501
389
+
390
+ _param = self._get2_serialize(
391
+ username=username,
392
+ dataset=dataset,
393
+ connector_type=connector_type,
394
+ conversation_id=conversation_id,
395
+ q_answer_api_key=q_answer_api_key,
396
+ _request_auth=_request_auth,
397
+ _content_type=_content_type,
398
+ _headers=_headers,
399
+ _host_index=_host_index
400
+ )
401
+
402
+ _response_types_map: Dict[str, Optional[str]] = {
403
+ '200': "ListConnectorsResponse",
404
+ }
405
+ response_data = self.api_client.call_api(
406
+ *_param,
407
+ _request_timeout=_request_timeout
408
+ )
409
+ response_data.read()
410
+ return self.api_client.response_deserialize(
411
+ response_data=response_data,
412
+ response_types_map=_response_types_map,
413
+ ).data
414
+
415
+
416
+ @validate_call
417
+ def get2_with_http_info(
418
+ self,
419
+ username: StrictStr,
420
+ dataset: StrictStr,
421
+ connector_type: Optional[StrictStr] = None,
422
+ conversation_id: Optional[StrictStr] = None,
423
+ q_answer_api_key: Optional[StrictStr] = None,
424
+ _request_timeout: Union[
425
+ None,
426
+ Annotated[StrictFloat, Field(gt=0)],
427
+ Tuple[
428
+ Annotated[StrictFloat, Field(gt=0)],
429
+ Annotated[StrictFloat, Field(gt=0)]
430
+ ]
431
+ ] = None,
432
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
433
+ _content_type: Optional[StrictStr] = None,
434
+ _headers: Optional[Dict[StrictStr, Any]] = None,
435
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
436
+ ) -> ApiResponse[ListConnectorsResponse]:
437
+ """get2
438
+
439
+
440
+ :param username: (required)
441
+ :type username: str
442
+ :param dataset: (required)
443
+ :type dataset: str
444
+ :param connector_type:
445
+ :type connector_type: str
446
+ :param conversation_id:
447
+ :type conversation_id: str
448
+ :param q_answer_api_key:
449
+ :type q_answer_api_key: str
450
+ :param _request_timeout: timeout setting for this request. If one
451
+ number provided, it will be total request
452
+ timeout. It can also be a pair (tuple) of
453
+ (connection, read) timeouts.
454
+ :type _request_timeout: int, tuple(int, int), optional
455
+ :param _request_auth: set to override the auth_settings for an a single
456
+ request; this effectively ignores the
457
+ authentication in the spec for a single request.
458
+ :type _request_auth: dict, optional
459
+ :param _content_type: force content-type for the request.
460
+ :type _content_type: str, Optional
461
+ :param _headers: set to override the headers for a single
462
+ request; this effectively ignores the headers
463
+ in the spec for a single request.
464
+ :type _headers: dict, optional
465
+ :param _host_index: set to override the host_index for a single
466
+ request; this effectively ignores the host_index
467
+ in the spec for a single request.
468
+ :type _host_index: int, optional
469
+ :return: Returns the result object.
470
+ """ # noqa: E501
471
+
472
+ _param = self._get2_serialize(
473
+ username=username,
474
+ dataset=dataset,
475
+ connector_type=connector_type,
476
+ conversation_id=conversation_id,
477
+ q_answer_api_key=q_answer_api_key,
478
+ _request_auth=_request_auth,
479
+ _content_type=_content_type,
480
+ _headers=_headers,
481
+ _host_index=_host_index
482
+ )
483
+
484
+ _response_types_map: Dict[str, Optional[str]] = {
485
+ '200': "ListConnectorsResponse",
486
+ }
487
+ response_data = self.api_client.call_api(
488
+ *_param,
489
+ _request_timeout=_request_timeout
490
+ )
491
+ response_data.read()
492
+ return self.api_client.response_deserialize(
493
+ response_data=response_data,
494
+ response_types_map=_response_types_map,
495
+ )
496
+
497
+
498
+ @validate_call
499
+ def get2_without_preload_content(
500
+ self,
501
+ username: StrictStr,
502
+ dataset: StrictStr,
503
+ connector_type: Optional[StrictStr] = None,
504
+ conversation_id: Optional[StrictStr] = None,
505
+ q_answer_api_key: Optional[StrictStr] = None,
506
+ _request_timeout: Union[
507
+ None,
508
+ Annotated[StrictFloat, Field(gt=0)],
509
+ Tuple[
510
+ Annotated[StrictFloat, Field(gt=0)],
511
+ Annotated[StrictFloat, Field(gt=0)]
512
+ ]
513
+ ] = None,
514
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
515
+ _content_type: Optional[StrictStr] = None,
516
+ _headers: Optional[Dict[StrictStr, Any]] = None,
517
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
518
+ ) -> RESTResponseType:
519
+ """get2
520
+
521
+
522
+ :param username: (required)
523
+ :type username: str
524
+ :param dataset: (required)
525
+ :type dataset: str
526
+ :param connector_type:
527
+ :type connector_type: str
528
+ :param conversation_id:
529
+ :type conversation_id: str
530
+ :param q_answer_api_key:
531
+ :type q_answer_api_key: str
532
+ :param _request_timeout: timeout setting for this request. If one
533
+ number provided, it will be total request
534
+ timeout. It can also be a pair (tuple) of
535
+ (connection, read) timeouts.
536
+ :type _request_timeout: int, tuple(int, int), optional
537
+ :param _request_auth: set to override the auth_settings for an a single
538
+ request; this effectively ignores the
539
+ authentication in the spec for a single request.
540
+ :type _request_auth: dict, optional
541
+ :param _content_type: force content-type for the request.
542
+ :type _content_type: str, Optional
543
+ :param _headers: set to override the headers for a single
544
+ request; this effectively ignores the headers
545
+ in the spec for a single request.
546
+ :type _headers: dict, optional
547
+ :param _host_index: set to override the host_index for a single
548
+ request; this effectively ignores the host_index
549
+ in the spec for a single request.
550
+ :type _host_index: int, optional
551
+ :return: Returns the result object.
552
+ """ # noqa: E501
553
+
554
+ _param = self._get2_serialize(
555
+ username=username,
556
+ dataset=dataset,
557
+ connector_type=connector_type,
558
+ conversation_id=conversation_id,
559
+ q_answer_api_key=q_answer_api_key,
560
+ _request_auth=_request_auth,
561
+ _content_type=_content_type,
562
+ _headers=_headers,
563
+ _host_index=_host_index
564
+ )
565
+
566
+ _response_types_map: Dict[str, Optional[str]] = {
567
+ '200': "ListConnectorsResponse",
568
+ }
569
+ response_data = self.api_client.call_api(
570
+ *_param,
571
+ _request_timeout=_request_timeout
572
+ )
573
+ return response_data.response
574
+
575
+
576
+ def _get2_serialize(
577
+ self,
578
+ username,
579
+ dataset,
580
+ connector_type,
581
+ conversation_id,
582
+ q_answer_api_key,
583
+ _request_auth,
584
+ _content_type,
585
+ _headers,
586
+ _host_index,
587
+ ) -> RequestSerialized:
588
+
589
+ _host = None
590
+
591
+ _collection_formats: Dict[str, str] = {
592
+ }
593
+
594
+ _path_params: Dict[str, str] = {}
595
+ _query_params: List[Tuple[str, str]] = []
596
+ _header_params: Dict[str, Optional[str]] = _headers or {}
597
+ _form_params: List[Tuple[str, str]] = []
598
+ _files: Dict[
599
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
600
+ ] = {}
601
+ _body_params: Optional[bytes] = None
602
+
603
+ # process the path parameters
604
+ # process the query parameters
605
+ if username is not None:
606
+
607
+ _query_params.append(('username', username))
608
+
609
+ if dataset is not None:
610
+
611
+ _query_params.append(('dataset', dataset))
612
+
613
+ if connector_type is not None:
614
+
615
+ _query_params.append(('connector_type', connector_type))
616
+
617
+ if conversation_id is not None:
618
+
619
+ _query_params.append(('conversation_id', conversation_id))
620
+
621
+ # process the header parameters
622
+ if q_answer_api_key is not None:
623
+ _header_params['QAnswer-Api-Key'] = q_answer_api_key
624
+ # process the form parameters
625
+ # process the body parameter
626
+
627
+
628
+ # set the HTTP header `Accept`
629
+ if 'Accept' not in _header_params:
630
+ _header_params['Accept'] = self.api_client.select_header_accept(
631
+ [
632
+ '*/*'
633
+ ]
634
+ )
635
+
636
+
637
+ # authentication setting
638
+ _auth_settings: List[str] = [
639
+ 'QAnswer-Api-Key',
640
+ 'Bearer'
641
+ ]
642
+
643
+ return self.api_client.param_serialize(
644
+ method='GET',
645
+ resource_path='/api/connectors/list',
646
+ path_params=_path_params,
647
+ query_params=_query_params,
648
+ header_params=_header_params,
649
+ body=_body_params,
650
+ post_params=_form_params,
651
+ files=_files,
652
+ auth_settings=_auth_settings,
653
+ collection_formats=_collection_formats,
654
+ _host=_host,
655
+ _request_auth=_request_auth
656
+ )
657
+
658
+
659
+
660
+
661
+ @validate_call
662
+ def get_available_connectors(
663
+ self,
664
+ _request_timeout: Union[
665
+ None,
666
+ Annotated[StrictFloat, Field(gt=0)],
667
+ Tuple[
668
+ Annotated[StrictFloat, Field(gt=0)],
669
+ Annotated[StrictFloat, Field(gt=0)]
670
+ ]
671
+ ] = None,
672
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
673
+ _content_type: Optional[StrictStr] = None,
674
+ _headers: Optional[Dict[StrictStr, Any]] = None,
675
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
676
+ ) -> AvailableConnectorsResponse:
677
+ """get_available_connectors
678
+
679
+
680
+ :param _request_timeout: timeout setting for this request. If one
681
+ number provided, it will be total request
682
+ timeout. It can also be a pair (tuple) of
683
+ (connection, read) timeouts.
684
+ :type _request_timeout: int, tuple(int, int), optional
685
+ :param _request_auth: set to override the auth_settings for an a single
686
+ request; this effectively ignores the
687
+ authentication in the spec for a single request.
688
+ :type _request_auth: dict, optional
689
+ :param _content_type: force content-type for the request.
690
+ :type _content_type: str, Optional
691
+ :param _headers: set to override the headers for a single
692
+ request; this effectively ignores the headers
693
+ in the spec for a single request.
694
+ :type _headers: dict, optional
695
+ :param _host_index: set to override the host_index for a single
696
+ request; this effectively ignores the host_index
697
+ in the spec for a single request.
698
+ :type _host_index: int, optional
699
+ :return: Returns the result object.
700
+ """ # noqa: E501
701
+
702
+ _param = self._get_available_connectors_serialize(
703
+ _request_auth=_request_auth,
704
+ _content_type=_content_type,
705
+ _headers=_headers,
706
+ _host_index=_host_index
707
+ )
708
+
709
+ _response_types_map: Dict[str, Optional[str]] = {
710
+ '200': "AvailableConnectorsResponse",
711
+ }
712
+ response_data = self.api_client.call_api(
713
+ *_param,
714
+ _request_timeout=_request_timeout
715
+ )
716
+ response_data.read()
717
+ return self.api_client.response_deserialize(
718
+ response_data=response_data,
719
+ response_types_map=_response_types_map,
720
+ ).data
721
+
722
+
723
+ @validate_call
724
+ def get_available_connectors_with_http_info(
725
+ self,
726
+ _request_timeout: Union[
727
+ None,
728
+ Annotated[StrictFloat, Field(gt=0)],
729
+ Tuple[
730
+ Annotated[StrictFloat, Field(gt=0)],
731
+ Annotated[StrictFloat, Field(gt=0)]
732
+ ]
733
+ ] = None,
734
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
735
+ _content_type: Optional[StrictStr] = None,
736
+ _headers: Optional[Dict[StrictStr, Any]] = None,
737
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
738
+ ) -> ApiResponse[AvailableConnectorsResponse]:
739
+ """get_available_connectors
740
+
741
+
742
+ :param _request_timeout: timeout setting for this request. If one
743
+ number provided, it will be total request
744
+ timeout. It can also be a pair (tuple) of
745
+ (connection, read) timeouts.
746
+ :type _request_timeout: int, tuple(int, int), optional
747
+ :param _request_auth: set to override the auth_settings for an a single
748
+ request; this effectively ignores the
749
+ authentication in the spec for a single request.
750
+ :type _request_auth: dict, optional
751
+ :param _content_type: force content-type for the request.
752
+ :type _content_type: str, Optional
753
+ :param _headers: set to override the headers for a single
754
+ request; this effectively ignores the headers
755
+ in the spec for a single request.
756
+ :type _headers: dict, optional
757
+ :param _host_index: set to override the host_index for a single
758
+ request; this effectively ignores the host_index
759
+ in the spec for a single request.
760
+ :type _host_index: int, optional
761
+ :return: Returns the result object.
762
+ """ # noqa: E501
763
+
764
+ _param = self._get_available_connectors_serialize(
765
+ _request_auth=_request_auth,
766
+ _content_type=_content_type,
767
+ _headers=_headers,
768
+ _host_index=_host_index
769
+ )
770
+
771
+ _response_types_map: Dict[str, Optional[str]] = {
772
+ '200': "AvailableConnectorsResponse",
773
+ }
774
+ response_data = self.api_client.call_api(
775
+ *_param,
776
+ _request_timeout=_request_timeout
777
+ )
778
+ response_data.read()
779
+ return self.api_client.response_deserialize(
780
+ response_data=response_data,
781
+ response_types_map=_response_types_map,
782
+ )
783
+
784
+
785
+ @validate_call
786
+ def get_available_connectors_without_preload_content(
787
+ self,
788
+ _request_timeout: Union[
789
+ None,
790
+ Annotated[StrictFloat, Field(gt=0)],
791
+ Tuple[
792
+ Annotated[StrictFloat, Field(gt=0)],
793
+ Annotated[StrictFloat, Field(gt=0)]
794
+ ]
795
+ ] = None,
796
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
797
+ _content_type: Optional[StrictStr] = None,
798
+ _headers: Optional[Dict[StrictStr, Any]] = None,
799
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
800
+ ) -> RESTResponseType:
801
+ """get_available_connectors
802
+
803
+
804
+ :param _request_timeout: timeout setting for this request. If one
805
+ number provided, it will be total request
806
+ timeout. It can also be a pair (tuple) of
807
+ (connection, read) timeouts.
808
+ :type _request_timeout: int, tuple(int, int), optional
809
+ :param _request_auth: set to override the auth_settings for an a single
810
+ request; this effectively ignores the
811
+ authentication in the spec for a single request.
812
+ :type _request_auth: dict, optional
813
+ :param _content_type: force content-type for the request.
814
+ :type _content_type: str, Optional
815
+ :param _headers: set to override the headers for a single
816
+ request; this effectively ignores the headers
817
+ in the spec for a single request.
818
+ :type _headers: dict, optional
819
+ :param _host_index: set to override the host_index for a single
820
+ request; this effectively ignores the host_index
821
+ in the spec for a single request.
822
+ :type _host_index: int, optional
823
+ :return: Returns the result object.
824
+ """ # noqa: E501
825
+
826
+ _param = self._get_available_connectors_serialize(
827
+ _request_auth=_request_auth,
828
+ _content_type=_content_type,
829
+ _headers=_headers,
830
+ _host_index=_host_index
831
+ )
832
+
833
+ _response_types_map: Dict[str, Optional[str]] = {
834
+ '200': "AvailableConnectorsResponse",
835
+ }
836
+ response_data = self.api_client.call_api(
837
+ *_param,
838
+ _request_timeout=_request_timeout
839
+ )
840
+ return response_data.response
841
+
842
+
843
+ def _get_available_connectors_serialize(
844
+ self,
845
+ _request_auth,
846
+ _content_type,
847
+ _headers,
848
+ _host_index,
849
+ ) -> RequestSerialized:
850
+
851
+ _host = None
852
+
853
+ _collection_formats: Dict[str, str] = {
854
+ }
855
+
856
+ _path_params: Dict[str, str] = {}
857
+ _query_params: List[Tuple[str, str]] = []
858
+ _header_params: Dict[str, Optional[str]] = _headers or {}
859
+ _form_params: List[Tuple[str, str]] = []
860
+ _files: Dict[
861
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
862
+ ] = {}
863
+ _body_params: Optional[bytes] = None
864
+
865
+ # process the path parameters
866
+ # process the query parameters
867
+ # process the header parameters
868
+ # process the form parameters
869
+ # process the body parameter
870
+
871
+
872
+ # set the HTTP header `Accept`
873
+ if 'Accept' not in _header_params:
874
+ _header_params['Accept'] = self.api_client.select_header_accept(
875
+ [
876
+ '*/*'
877
+ ]
878
+ )
879
+
880
+
881
+ # authentication setting
882
+ _auth_settings: List[str] = [
883
+ 'QAnswer-Api-Key',
884
+ 'Bearer'
885
+ ]
886
+
887
+ return self.api_client.param_serialize(
888
+ method='GET',
889
+ resource_path='/api/connectors/available',
890
+ path_params=_path_params,
891
+ query_params=_query_params,
892
+ header_params=_header_params,
893
+ body=_body_params,
894
+ post_params=_form_params,
895
+ files=_files,
896
+ auth_settings=_auth_settings,
897
+ collection_formats=_collection_formats,
898
+ _host=_host,
899
+ _request_auth=_request_auth
900
+ )
901
+
902
+
903
+
904
+
905
+ @validate_call
906
+ def get_connector_by_id(
907
+ self,
908
+ connector_id: StrictInt,
909
+ username: StrictStr,
910
+ dataset: StrictStr,
911
+ q_answer_api_key: Optional[StrictStr] = None,
912
+ _request_timeout: Union[
913
+ None,
914
+ Annotated[StrictFloat, Field(gt=0)],
915
+ Tuple[
916
+ Annotated[StrictFloat, Field(gt=0)],
917
+ Annotated[StrictFloat, Field(gt=0)]
918
+ ]
919
+ ] = None,
920
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
921
+ _content_type: Optional[StrictStr] = None,
922
+ _headers: Optional[Dict[StrictStr, Any]] = None,
923
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
924
+ ) -> GetConnectorByIdResponse:
925
+ """get_connector_by_id
926
+
927
+
928
+ :param connector_id: (required)
929
+ :type connector_id: int
930
+ :param username: (required)
931
+ :type username: str
932
+ :param dataset: (required)
933
+ :type dataset: str
934
+ :param q_answer_api_key:
935
+ :type q_answer_api_key: str
936
+ :param _request_timeout: timeout setting for this request. If one
937
+ number provided, it will be total request
938
+ timeout. It can also be a pair (tuple) of
939
+ (connection, read) timeouts.
940
+ :type _request_timeout: int, tuple(int, int), optional
941
+ :param _request_auth: set to override the auth_settings for an a single
942
+ request; this effectively ignores the
943
+ authentication in the spec for a single request.
944
+ :type _request_auth: dict, optional
945
+ :param _content_type: force content-type for the request.
946
+ :type _content_type: str, Optional
947
+ :param _headers: set to override the headers for a single
948
+ request; this effectively ignores the headers
949
+ in the spec for a single request.
950
+ :type _headers: dict, optional
951
+ :param _host_index: set to override the host_index for a single
952
+ request; this effectively ignores the host_index
953
+ in the spec for a single request.
954
+ :type _host_index: int, optional
955
+ :return: Returns the result object.
956
+ """ # noqa: E501
957
+
958
+ _param = self._get_connector_by_id_serialize(
959
+ connector_id=connector_id,
960
+ username=username,
961
+ dataset=dataset,
962
+ q_answer_api_key=q_answer_api_key,
963
+ _request_auth=_request_auth,
964
+ _content_type=_content_type,
965
+ _headers=_headers,
966
+ _host_index=_host_index
967
+ )
968
+
969
+ _response_types_map: Dict[str, Optional[str]] = {
970
+ '200': "GetConnectorByIdResponse",
971
+ }
972
+ response_data = self.api_client.call_api(
973
+ *_param,
974
+ _request_timeout=_request_timeout
975
+ )
976
+ response_data.read()
977
+ return self.api_client.response_deserialize(
978
+ response_data=response_data,
979
+ response_types_map=_response_types_map,
980
+ ).data
981
+
982
+
983
+ @validate_call
984
+ def get_connector_by_id_with_http_info(
985
+ self,
986
+ connector_id: StrictInt,
987
+ username: StrictStr,
988
+ dataset: StrictStr,
989
+ q_answer_api_key: Optional[StrictStr] = None,
990
+ _request_timeout: Union[
991
+ None,
992
+ Annotated[StrictFloat, Field(gt=0)],
993
+ Tuple[
994
+ Annotated[StrictFloat, Field(gt=0)],
995
+ Annotated[StrictFloat, Field(gt=0)]
996
+ ]
997
+ ] = None,
998
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
999
+ _content_type: Optional[StrictStr] = None,
1000
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1001
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1002
+ ) -> ApiResponse[GetConnectorByIdResponse]:
1003
+ """get_connector_by_id
1004
+
1005
+
1006
+ :param connector_id: (required)
1007
+ :type connector_id: int
1008
+ :param username: (required)
1009
+ :type username: str
1010
+ :param dataset: (required)
1011
+ :type dataset: str
1012
+ :param q_answer_api_key:
1013
+ :type q_answer_api_key: str
1014
+ :param _request_timeout: timeout setting for this request. If one
1015
+ number provided, it will be total request
1016
+ timeout. It can also be a pair (tuple) of
1017
+ (connection, read) timeouts.
1018
+ :type _request_timeout: int, tuple(int, int), optional
1019
+ :param _request_auth: set to override the auth_settings for an a single
1020
+ request; this effectively ignores the
1021
+ authentication in the spec for a single request.
1022
+ :type _request_auth: dict, optional
1023
+ :param _content_type: force content-type for the request.
1024
+ :type _content_type: str, Optional
1025
+ :param _headers: set to override the headers for a single
1026
+ request; this effectively ignores the headers
1027
+ in the spec for a single request.
1028
+ :type _headers: dict, optional
1029
+ :param _host_index: set to override the host_index for a single
1030
+ request; this effectively ignores the host_index
1031
+ in the spec for a single request.
1032
+ :type _host_index: int, optional
1033
+ :return: Returns the result object.
1034
+ """ # noqa: E501
1035
+
1036
+ _param = self._get_connector_by_id_serialize(
1037
+ connector_id=connector_id,
1038
+ username=username,
1039
+ dataset=dataset,
1040
+ q_answer_api_key=q_answer_api_key,
1041
+ _request_auth=_request_auth,
1042
+ _content_type=_content_type,
1043
+ _headers=_headers,
1044
+ _host_index=_host_index
1045
+ )
1046
+
1047
+ _response_types_map: Dict[str, Optional[str]] = {
1048
+ '200': "GetConnectorByIdResponse",
1049
+ }
1050
+ response_data = self.api_client.call_api(
1051
+ *_param,
1052
+ _request_timeout=_request_timeout
1053
+ )
1054
+ response_data.read()
1055
+ return self.api_client.response_deserialize(
1056
+ response_data=response_data,
1057
+ response_types_map=_response_types_map,
1058
+ )
1059
+
1060
+
1061
+ @validate_call
1062
+ def get_connector_by_id_without_preload_content(
1063
+ self,
1064
+ connector_id: StrictInt,
1065
+ username: StrictStr,
1066
+ dataset: StrictStr,
1067
+ q_answer_api_key: Optional[StrictStr] = None,
1068
+ _request_timeout: Union[
1069
+ None,
1070
+ Annotated[StrictFloat, Field(gt=0)],
1071
+ Tuple[
1072
+ Annotated[StrictFloat, Field(gt=0)],
1073
+ Annotated[StrictFloat, Field(gt=0)]
1074
+ ]
1075
+ ] = None,
1076
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1077
+ _content_type: Optional[StrictStr] = None,
1078
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1079
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1080
+ ) -> RESTResponseType:
1081
+ """get_connector_by_id
1082
+
1083
+
1084
+ :param connector_id: (required)
1085
+ :type connector_id: int
1086
+ :param username: (required)
1087
+ :type username: str
1088
+ :param dataset: (required)
1089
+ :type dataset: str
1090
+ :param q_answer_api_key:
1091
+ :type q_answer_api_key: str
1092
+ :param _request_timeout: timeout setting for this request. If one
1093
+ number provided, it will be total request
1094
+ timeout. It can also be a pair (tuple) of
1095
+ (connection, read) timeouts.
1096
+ :type _request_timeout: int, tuple(int, int), optional
1097
+ :param _request_auth: set to override the auth_settings for an a single
1098
+ request; this effectively ignores the
1099
+ authentication in the spec for a single request.
1100
+ :type _request_auth: dict, optional
1101
+ :param _content_type: force content-type for the request.
1102
+ :type _content_type: str, Optional
1103
+ :param _headers: set to override the headers for a single
1104
+ request; this effectively ignores the headers
1105
+ in the spec for a single request.
1106
+ :type _headers: dict, optional
1107
+ :param _host_index: set to override the host_index for a single
1108
+ request; this effectively ignores the host_index
1109
+ in the spec for a single request.
1110
+ :type _host_index: int, optional
1111
+ :return: Returns the result object.
1112
+ """ # noqa: E501
1113
+
1114
+ _param = self._get_connector_by_id_serialize(
1115
+ connector_id=connector_id,
1116
+ username=username,
1117
+ dataset=dataset,
1118
+ q_answer_api_key=q_answer_api_key,
1119
+ _request_auth=_request_auth,
1120
+ _content_type=_content_type,
1121
+ _headers=_headers,
1122
+ _host_index=_host_index
1123
+ )
1124
+
1125
+ _response_types_map: Dict[str, Optional[str]] = {
1126
+ '200': "GetConnectorByIdResponse",
1127
+ }
1128
+ response_data = self.api_client.call_api(
1129
+ *_param,
1130
+ _request_timeout=_request_timeout
1131
+ )
1132
+ return response_data.response
1133
+
1134
+
1135
+ def _get_connector_by_id_serialize(
1136
+ self,
1137
+ connector_id,
1138
+ username,
1139
+ dataset,
1140
+ q_answer_api_key,
1141
+ _request_auth,
1142
+ _content_type,
1143
+ _headers,
1144
+ _host_index,
1145
+ ) -> RequestSerialized:
1146
+
1147
+ _host = None
1148
+
1149
+ _collection_formats: Dict[str, str] = {
1150
+ }
1151
+
1152
+ _path_params: Dict[str, str] = {}
1153
+ _query_params: List[Tuple[str, str]] = []
1154
+ _header_params: Dict[str, Optional[str]] = _headers or {}
1155
+ _form_params: List[Tuple[str, str]] = []
1156
+ _files: Dict[
1157
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
1158
+ ] = {}
1159
+ _body_params: Optional[bytes] = None
1160
+
1161
+ # process the path parameters
1162
+ if connector_id is not None:
1163
+ _path_params['connectorId'] = connector_id
1164
+ # process the query parameters
1165
+ if username is not None:
1166
+
1167
+ _query_params.append(('username', username))
1168
+
1169
+ if dataset is not None:
1170
+
1171
+ _query_params.append(('dataset', dataset))
1172
+
1173
+ # process the header parameters
1174
+ if q_answer_api_key is not None:
1175
+ _header_params['QAnswer-Api-Key'] = q_answer_api_key
1176
+ # process the form parameters
1177
+ # process the body parameter
1178
+
1179
+
1180
+ # set the HTTP header `Accept`
1181
+ if 'Accept' not in _header_params:
1182
+ _header_params['Accept'] = self.api_client.select_header_accept(
1183
+ [
1184
+ '*/*'
1185
+ ]
1186
+ )
1187
+
1188
+
1189
+ # authentication setting
1190
+ _auth_settings: List[str] = [
1191
+ 'QAnswer-Api-Key',
1192
+ 'Bearer'
1193
+ ]
1194
+
1195
+ return self.api_client.param_serialize(
1196
+ method='GET',
1197
+ resource_path='/api/connectors/{connectorId}',
1198
+ path_params=_path_params,
1199
+ query_params=_query_params,
1200
+ header_params=_header_params,
1201
+ body=_body_params,
1202
+ post_params=_form_params,
1203
+ files=_files,
1204
+ auth_settings=_auth_settings,
1205
+ collection_formats=_collection_formats,
1206
+ _host=_host,
1207
+ _request_auth=_request_auth
1208
+ )
1209
+
1210
+
1211
+
1212
+
1213
+ @validate_call
1214
+ def modify_connector_name(
1215
+ self,
1216
+ modify_connector_request: ModifyConnectorRequest,
1217
+ q_answer_api_key: Optional[StrictStr] = None,
1218
+ _request_timeout: Union[
1219
+ None,
1220
+ Annotated[StrictFloat, Field(gt=0)],
1221
+ Tuple[
1222
+ Annotated[StrictFloat, Field(gt=0)],
1223
+ Annotated[StrictFloat, Field(gt=0)]
1224
+ ]
1225
+ ] = None,
1226
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1227
+ _content_type: Optional[StrictStr] = None,
1228
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1229
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1230
+ ) -> BaseConnectorsResponse:
1231
+ """modify_connector_name
1232
+
1233
+
1234
+ :param modify_connector_request: (required)
1235
+ :type modify_connector_request: ModifyConnectorRequest
1236
+ :param q_answer_api_key:
1237
+ :type q_answer_api_key: str
1238
+ :param _request_timeout: timeout setting for this request. If one
1239
+ number provided, it will be total request
1240
+ timeout. It can also be a pair (tuple) of
1241
+ (connection, read) timeouts.
1242
+ :type _request_timeout: int, tuple(int, int), optional
1243
+ :param _request_auth: set to override the auth_settings for an a single
1244
+ request; this effectively ignores the
1245
+ authentication in the spec for a single request.
1246
+ :type _request_auth: dict, optional
1247
+ :param _content_type: force content-type for the request.
1248
+ :type _content_type: str, Optional
1249
+ :param _headers: set to override the headers for a single
1250
+ request; this effectively ignores the headers
1251
+ in the spec for a single request.
1252
+ :type _headers: dict, optional
1253
+ :param _host_index: set to override the host_index for a single
1254
+ request; this effectively ignores the host_index
1255
+ in the spec for a single request.
1256
+ :type _host_index: int, optional
1257
+ :return: Returns the result object.
1258
+ """ # noqa: E501
1259
+
1260
+ _param = self._modify_connector_name_serialize(
1261
+ modify_connector_request=modify_connector_request,
1262
+ q_answer_api_key=q_answer_api_key,
1263
+ _request_auth=_request_auth,
1264
+ _content_type=_content_type,
1265
+ _headers=_headers,
1266
+ _host_index=_host_index
1267
+ )
1268
+
1269
+ _response_types_map: Dict[str, Optional[str]] = {
1270
+ '200': "BaseConnectorsResponse",
1271
+ }
1272
+ response_data = self.api_client.call_api(
1273
+ *_param,
1274
+ _request_timeout=_request_timeout
1275
+ )
1276
+ response_data.read()
1277
+ return self.api_client.response_deserialize(
1278
+ response_data=response_data,
1279
+ response_types_map=_response_types_map,
1280
+ ).data
1281
+
1282
+
1283
+ @validate_call
1284
+ def modify_connector_name_with_http_info(
1285
+ self,
1286
+ modify_connector_request: ModifyConnectorRequest,
1287
+ q_answer_api_key: Optional[StrictStr] = None,
1288
+ _request_timeout: Union[
1289
+ None,
1290
+ Annotated[StrictFloat, Field(gt=0)],
1291
+ Tuple[
1292
+ Annotated[StrictFloat, Field(gt=0)],
1293
+ Annotated[StrictFloat, Field(gt=0)]
1294
+ ]
1295
+ ] = None,
1296
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1297
+ _content_type: Optional[StrictStr] = None,
1298
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1299
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1300
+ ) -> ApiResponse[BaseConnectorsResponse]:
1301
+ """modify_connector_name
1302
+
1303
+
1304
+ :param modify_connector_request: (required)
1305
+ :type modify_connector_request: ModifyConnectorRequest
1306
+ :param q_answer_api_key:
1307
+ :type q_answer_api_key: str
1308
+ :param _request_timeout: timeout setting for this request. If one
1309
+ number provided, it will be total request
1310
+ timeout. It can also be a pair (tuple) of
1311
+ (connection, read) timeouts.
1312
+ :type _request_timeout: int, tuple(int, int), optional
1313
+ :param _request_auth: set to override the auth_settings for an a single
1314
+ request; this effectively ignores the
1315
+ authentication in the spec for a single request.
1316
+ :type _request_auth: dict, optional
1317
+ :param _content_type: force content-type for the request.
1318
+ :type _content_type: str, Optional
1319
+ :param _headers: set to override the headers for a single
1320
+ request; this effectively ignores the headers
1321
+ in the spec for a single request.
1322
+ :type _headers: dict, optional
1323
+ :param _host_index: set to override the host_index for a single
1324
+ request; this effectively ignores the host_index
1325
+ in the spec for a single request.
1326
+ :type _host_index: int, optional
1327
+ :return: Returns the result object.
1328
+ """ # noqa: E501
1329
+
1330
+ _param = self._modify_connector_name_serialize(
1331
+ modify_connector_request=modify_connector_request,
1332
+ q_answer_api_key=q_answer_api_key,
1333
+ _request_auth=_request_auth,
1334
+ _content_type=_content_type,
1335
+ _headers=_headers,
1336
+ _host_index=_host_index
1337
+ )
1338
+
1339
+ _response_types_map: Dict[str, Optional[str]] = {
1340
+ '200': "BaseConnectorsResponse",
1341
+ }
1342
+ response_data = self.api_client.call_api(
1343
+ *_param,
1344
+ _request_timeout=_request_timeout
1345
+ )
1346
+ response_data.read()
1347
+ return self.api_client.response_deserialize(
1348
+ response_data=response_data,
1349
+ response_types_map=_response_types_map,
1350
+ )
1351
+
1352
+
1353
+ @validate_call
1354
+ def modify_connector_name_without_preload_content(
1355
+ self,
1356
+ modify_connector_request: ModifyConnectorRequest,
1357
+ q_answer_api_key: Optional[StrictStr] = None,
1358
+ _request_timeout: Union[
1359
+ None,
1360
+ Annotated[StrictFloat, Field(gt=0)],
1361
+ Tuple[
1362
+ Annotated[StrictFloat, Field(gt=0)],
1363
+ Annotated[StrictFloat, Field(gt=0)]
1364
+ ]
1365
+ ] = None,
1366
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1367
+ _content_type: Optional[StrictStr] = None,
1368
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1369
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1370
+ ) -> RESTResponseType:
1371
+ """modify_connector_name
1372
+
1373
+
1374
+ :param modify_connector_request: (required)
1375
+ :type modify_connector_request: ModifyConnectorRequest
1376
+ :param q_answer_api_key:
1377
+ :type q_answer_api_key: str
1378
+ :param _request_timeout: timeout setting for this request. If one
1379
+ number provided, it will be total request
1380
+ timeout. It can also be a pair (tuple) of
1381
+ (connection, read) timeouts.
1382
+ :type _request_timeout: int, tuple(int, int), optional
1383
+ :param _request_auth: set to override the auth_settings for an a single
1384
+ request; this effectively ignores the
1385
+ authentication in the spec for a single request.
1386
+ :type _request_auth: dict, optional
1387
+ :param _content_type: force content-type for the request.
1388
+ :type _content_type: str, Optional
1389
+ :param _headers: set to override the headers for a single
1390
+ request; this effectively ignores the headers
1391
+ in the spec for a single request.
1392
+ :type _headers: dict, optional
1393
+ :param _host_index: set to override the host_index for a single
1394
+ request; this effectively ignores the host_index
1395
+ in the spec for a single request.
1396
+ :type _host_index: int, optional
1397
+ :return: Returns the result object.
1398
+ """ # noqa: E501
1399
+
1400
+ _param = self._modify_connector_name_serialize(
1401
+ modify_connector_request=modify_connector_request,
1402
+ q_answer_api_key=q_answer_api_key,
1403
+ _request_auth=_request_auth,
1404
+ _content_type=_content_type,
1405
+ _headers=_headers,
1406
+ _host_index=_host_index
1407
+ )
1408
+
1409
+ _response_types_map: Dict[str, Optional[str]] = {
1410
+ '200': "BaseConnectorsResponse",
1411
+ }
1412
+ response_data = self.api_client.call_api(
1413
+ *_param,
1414
+ _request_timeout=_request_timeout
1415
+ )
1416
+ return response_data.response
1417
+
1418
+
1419
+ def _modify_connector_name_serialize(
1420
+ self,
1421
+ modify_connector_request,
1422
+ q_answer_api_key,
1423
+ _request_auth,
1424
+ _content_type,
1425
+ _headers,
1426
+ _host_index,
1427
+ ) -> RequestSerialized:
1428
+
1429
+ _host = None
1430
+
1431
+ _collection_formats: Dict[str, str] = {
1432
+ }
1433
+
1434
+ _path_params: Dict[str, str] = {}
1435
+ _query_params: List[Tuple[str, str]] = []
1436
+ _header_params: Dict[str, Optional[str]] = _headers or {}
1437
+ _form_params: List[Tuple[str, str]] = []
1438
+ _files: Dict[
1439
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
1440
+ ] = {}
1441
+ _body_params: Optional[bytes] = None
1442
+
1443
+ # process the path parameters
1444
+ # process the query parameters
1445
+ # process the header parameters
1446
+ if q_answer_api_key is not None:
1447
+ _header_params['QAnswer-Api-Key'] = q_answer_api_key
1448
+ # process the form parameters
1449
+ # process the body parameter
1450
+ if modify_connector_request is not None:
1451
+ _body_params = modify_connector_request
1452
+
1453
+
1454
+ # set the HTTP header `Accept`
1455
+ if 'Accept' not in _header_params:
1456
+ _header_params['Accept'] = self.api_client.select_header_accept(
1457
+ [
1458
+ '*/*'
1459
+ ]
1460
+ )
1461
+
1462
+ # set the HTTP header `Content-Type`
1463
+ if _content_type:
1464
+ _header_params['Content-Type'] = _content_type
1465
+ else:
1466
+ _default_content_type = (
1467
+ self.api_client.select_header_content_type(
1468
+ [
1469
+ 'application/json'
1470
+ ]
1471
+ )
1472
+ )
1473
+ if _default_content_type is not None:
1474
+ _header_params['Content-Type'] = _default_content_type
1475
+
1476
+ # authentication setting
1477
+ _auth_settings: List[str] = [
1478
+ 'QAnswer-Api-Key',
1479
+ 'Bearer'
1480
+ ]
1481
+
1482
+ return self.api_client.param_serialize(
1483
+ method='PUT',
1484
+ resource_path='/api/connectors/modify',
1485
+ path_params=_path_params,
1486
+ query_params=_query_params,
1487
+ header_params=_header_params,
1488
+ body=_body_params,
1489
+ post_params=_form_params,
1490
+ files=_files,
1491
+ auth_settings=_auth_settings,
1492
+ collection_formats=_collection_formats,
1493
+ _host=_host,
1494
+ _request_auth=_request_auth
1495
+ )
1496
+
1497
+