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