qanswer-sdk 0.1.0.dev0__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (618) hide show
  1. qanswer_sdk/__init__.py +1256 -0
  2. qanswer_sdk/api/__init__.py +63 -0
  3. qanswer_sdk/api/admin_api.py +7893 -0
  4. qanswer_sdk/api/ai_assistant_access_rights_api.py +5881 -0
  5. qanswer_sdk/api/ai_assistant_api.py +11047 -0
  6. qanswer_sdk/api/anthropic_compatible_api.py +311 -0
  7. qanswer_sdk/api/auto_complete_api.py +612 -0
  8. qanswer_sdk/api/bot_slack_api.py +1015 -0
  9. qanswer_sdk/api/branding_api.py +5733 -0
  10. qanswer_sdk/api/bulk_reindex_api.py +2029 -0
  11. qanswer_sdk/api/chatbot_api.py +1102 -0
  12. qanswer_sdk/api/connector_audio_api.py +3469 -0
  13. qanswer_sdk/api/connector_document_api.py +2685 -0
  14. qanswer_sdk/api/connector_e_consilium_api.py +333 -0
  15. qanswer_sdk/api/connector_e_consilium_search_index_api_api.py +1231 -0
  16. qanswer_sdk/api/connector_google_drive_api.py +2175 -0
  17. qanswer_sdk/api/connector_imapapi_api.py +1866 -0
  18. qanswer_sdk/api/connector_one_drive_api.py +1579 -0
  19. qanswer_sdk/api/connector_onenote_api.py +1596 -0
  20. qanswer_sdk/api/connector_pinecone_api.py +893 -0
  21. qanswer_sdk/api/connector_publication_office_api_api.py +1230 -0
  22. qanswer_sdk/api/connector_qn_a_api.py +1521 -0
  23. qanswer_sdk/api/connector_rdf_answer_api.py +1454 -0
  24. qanswer_sdk/api/connector_rdf_api.py +5090 -0
  25. qanswer_sdk/api/connector_sharepoint_api.py +3926 -0
  26. qanswer_sdk/api/connector_websearch_api.py +332 -0
  27. qanswer_sdk/api/connector_website_api.py +3108 -0
  28. qanswer_sdk/api/connector_x_wiki_api_api.py +1278 -0
  29. qanswer_sdk/api/connectors_api.py +6946 -0
  30. qanswer_sdk/api/connectors_data_api.py +5903 -0
  31. qanswer_sdk/api/conversation_logs_api.py +14228 -0
  32. qanswer_sdk/api/dataset_config_api.py +4016 -0
  33. qanswer_sdk/api/debug_api.py +278 -0
  34. qanswer_sdk/api/default_api.py +763 -0
  35. qanswer_sdk/api/frontend_config_api.py +270 -0
  36. qanswer_sdk/api/health_check_api_api.py +278 -0
  37. qanswer_sdk/api/mcp_api.py +10758 -0
  38. qanswer_sdk/api/metadata_api.py +1309 -0
  39. qanswer_sdk/api/notifications_api.py +1842 -0
  40. qanswer_sdk/api/o_auth2_api.py +648 -0
  41. qanswer_sdk/api/open_ai_compatible_api.py +1093 -0
  42. qanswer_sdk/api/payment_api.py +1854 -0
  43. qanswer_sdk/api/retention_policy_api.py +4404 -0
  44. qanswer_sdk/api/socket_api.py +4706 -0
  45. qanswer_sdk/api/speech_to_text_api.py +968 -0
  46. qanswer_sdk/api/task_ai_excel_api.py +3749 -0
  47. qanswer_sdk/api/task_chat_api.py +2079 -0
  48. qanswer_sdk/api/task_entity_linking_api.py +315 -0
  49. qanswer_sdk/api/task_rdf_linker_api.py +4407 -0
  50. qanswer_sdk/api/task_rdf_sparql_endpoint_api.py +3355 -0
  51. qanswer_sdk/api/task_rdf_text_linker_api.py +1513 -0
  52. qanswer_sdk/api/task_report_copilot_api.py +7355 -0
  53. qanswer_sdk/api/task_search_api.py +2142 -0
  54. qanswer_sdk/api/task_text2sparql_api.py +947 -0
  55. qanswer_sdk/api/task_text_classification_api.py +592 -0
  56. qanswer_sdk/api/tasks_api.py +26394 -0
  57. qanswer_sdk/api/tool_embedder_api.py +5532 -0
  58. qanswer_sdk/api/tool_llm_api.py +6364 -0
  59. qanswer_sdk/api/unit_organizations_api.py +8600 -0
  60. qanswer_sdk/api/unit_teams_api.py +4492 -0
  61. qanswer_sdk/api/unit_user_api.py +12759 -0
  62. qanswer_sdk/api_client.py +804 -0
  63. qanswer_sdk/api_response.py +21 -0
  64. qanswer_sdk/configuration.py +614 -0
  65. qanswer_sdk/exceptions.py +216 -0
  66. qanswer_sdk/models/__init__.py +562 -0
  67. qanswer_sdk/models/access_audio_spans_response_model.py +91 -0
  68. qanswer_sdk/models/access_pdf_payload_model.py +102 -0
  69. qanswer_sdk/models/access_type.py +42 -0
  70. qanswer_sdk/models/access_type_shared.py +38 -0
  71. qanswer_sdk/models/add_qn_a_request.py +103 -0
  72. qanswer_sdk/models/add_synonyms.py +93 -0
  73. qanswer_sdk/models/add_synonyms_resp.py +89 -0
  74. qanswer_sdk/models/admin_overall_stats_response.py +105 -0
  75. qanswer_sdk/models/admin_user_overall_stats.py +99 -0
  76. qanswer_sdk/models/advanced_o_auth2_mcp_authentication_config.py +95 -0
  77. qanswer_sdk/models/aggregate.py +93 -0
  78. qanswer_sdk/models/aggregation.py +110 -0
  79. qanswer_sdk/models/aggregation_type.py +41 -0
  80. qanswer_sdk/models/aggregations_group.py +102 -0
  81. qanswer_sdk/models/ai_assistant_clone_response.py +91 -0
  82. qanswer_sdk/models/ai_assistant_dto.py +113 -0
  83. qanswer_sdk/models/ai_assistant_filter_dto.py +113 -0
  84. qanswer_sdk/models/ai_assistant_list.py +101 -0
  85. qanswer_sdk/models/ai_assistant_share_response.py +93 -0
  86. qanswer_sdk/models/ai_assistant_shared_access.py +95 -0
  87. qanswer_sdk/models/ai_excel_entity_result.py +97 -0
  88. qanswer_sdk/models/ai_excel_entity_search_payload.py +95 -0
  89. qanswer_sdk/models/ai_excel_entity_search_response.py +103 -0
  90. qanswer_sdk/models/ai_excel_global_settings.py +95 -0
  91. qanswer_sdk/models/ai_excel_global_settings_request.py +95 -0
  92. qanswer_sdk/models/ai_excel_task_settings.py +119 -0
  93. qanswer_sdk/models/ai_excel_task_update.py +119 -0
  94. qanswer_sdk/models/ai_excel_template_create.py +119 -0
  95. qanswer_sdk/models/ai_excel_template_read.py +121 -0
  96. qanswer_sdk/models/ai_excel_template_settings_request.py +91 -0
  97. qanswer_sdk/models/ai_excel_template_update.py +125 -0
  98. qanswer_sdk/models/ai_excel_templates_search_request.py +104 -0
  99. qanswer_sdk/models/ai_excel_templates_search_response.py +101 -0
  100. qanswer_sdk/models/allowed_extension.py +53 -0
  101. qanswer_sdk/models/allowed_file_extensions.py +88 -0
  102. qanswer_sdk/models/api_key_header_type.py +39 -0
  103. qanswer_sdk/models/api_key_mcp_authentication_config.py +98 -0
  104. qanswer_sdk/models/applied_filter_type.py +37 -0
  105. qanswer_sdk/models/applied_metadata_filter.py +97 -0
  106. qanswer_sdk/models/apply_template_task_settings_to_slots_response.py +89 -0
  107. qanswer_sdk/models/assistant_category_color_definition.py +89 -0
  108. qanswer_sdk/models/assistant_category_color_item.py +89 -0
  109. qanswer_sdk/models/assistant_category_colors_update_payload.py +95 -0
  110. qanswer_sdk/models/assistant_category_count.py +91 -0
  111. qanswer_sdk/models/assistant_message_stop.py +93 -0
  112. qanswer_sdk/models/assistant_retention_response.py +97 -0
  113. qanswer_sdk/models/assistant_task.py +43 -0
  114. qanswer_sdk/models/assistant_template_with_tools_selection_dto.py +123 -0
  115. qanswer_sdk/models/audio_allowed_file_extensions.py +87 -0
  116. qanswer_sdk/models/audio_format.py +37 -0
  117. qanswer_sdk/models/audio_segment.py +95 -0
  118. qanswer_sdk/models/audio_segment_update_payload.py +97 -0
  119. qanswer_sdk/models/audio_segment_update_response.py +91 -0
  120. qanswer_sdk/models/audio_speaker_update_payload.py +99 -0
  121. qanswer_sdk/models/audio_speaker_update_response.py +91 -0
  122. qanswer_sdk/models/audio_transcription_list_response.py +101 -0
  123. qanswer_sdk/models/audio_transcription_mode.py +37 -0
  124. qanswer_sdk/models/audio_transcription_record.py +101 -0
  125. qanswer_sdk/models/audio_transcription_status.py +39 -0
  126. qanswer_sdk/models/audio_upload_response.py +91 -0
  127. qanswer_sdk/models/audio_word_segment.py +93 -0
  128. qanswer_sdk/models/audio_word_span_change.py +94 -0
  129. qanswer_sdk/models/audio_word_span_update_payload.py +104 -0
  130. qanswer_sdk/models/audio_word_span_update_response.py +91 -0
  131. qanswer_sdk/models/audio_word_update_payload.py +100 -0
  132. qanswer_sdk/models/audio_word_update_response.py +91 -0
  133. qanswer_sdk/models/auth_link_response.py +91 -0
  134. qanswer_sdk/models/auto_bot_description_request.py +89 -0
  135. qanswer_sdk/models/auto_bot_description_response.py +87 -0
  136. qanswer_sdk/models/available_aggregation.py +92 -0
  137. qanswer_sdk/models/available_connectors_response.py +92 -0
  138. qanswer_sdk/models/available_logs_visibility_policy.py +91 -0
  139. qanswer_sdk/models/available_space_quota_for_dataset.py +95 -0
  140. qanswer_sdk/models/available_storage_preference.py +91 -0
  141. qanswer_sdk/models/base_connectors_response.py +89 -0
  142. qanswer_sdk/models/base_conversation_response.py +89 -0
  143. qanswer_sdk/models/base_feedback_response.py +89 -0
  144. qanswer_sdk/models/bot_answer_length.py +38 -0
  145. qanswer_sdk/models/branding_app_title.py +87 -0
  146. qanswer_sdk/models/branding_system_message.py +87 -0
  147. qanswer_sdk/models/bulk_reindex_counts_by_type.py +89 -0
  148. qanswer_sdk/models/bulk_reindex_item_status.py +41 -0
  149. qanswer_sdk/models/bulk_reindex_job_detail_dto.py +103 -0
  150. qanswer_sdk/models/bulk_reindex_job_dto.py +125 -0
  151. qanswer_sdk/models/bulk_reindex_job_item_dto.py +113 -0
  152. qanswer_sdk/models/bulk_reindex_job_item_sort_by.py +40 -0
  153. qanswer_sdk/models/bulk_reindex_job_status.py +41 -0
  154. qanswer_sdk/models/bulk_reindex_jobs_list_response.py +97 -0
  155. qanswer_sdk/models/bulk_reindex_preview_counts.py +99 -0
  156. qanswer_sdk/models/bulk_reindex_preview_request.py +91 -0
  157. qanswer_sdk/models/bulk_reindex_preview_response.py +102 -0
  158. qanswer_sdk/models/bulk_reindex_skip_reason.py +40 -0
  159. qanswer_sdk/models/bulk_reindex_sort_order.py +37 -0
  160. qanswer_sdk/models/bulk_reindex_submit_request.py +94 -0
  161. qanswer_sdk/models/bulk_update_tool_selections_request.py +87 -0
  162. qanswer_sdk/models/capability_type.py +37 -0
  163. qanswer_sdk/models/cell.py +89 -0
  164. qanswer_sdk/models/change_password.py +89 -0
  165. qanswer_sdk/models/change_password_admin.py +89 -0
  166. qanswer_sdk/models/change_role.py +90 -0
  167. qanswer_sdk/models/chat_task_settings.py +141 -0
  168. qanswer_sdk/models/chat_task_settings_update_payload.py +95 -0
  169. qanswer_sdk/models/chat_task_update.py +139 -0
  170. qanswer_sdk/models/chatbot_chat_payload.py +150 -0
  171. qanswer_sdk/models/chatbot_default_settings_response.py +95 -0
  172. qanswer_sdk/models/chatbot_llm_dto.py +120 -0
  173. qanswer_sdk/models/chatbot_response.py +143 -0
  174. qanswer_sdk/models/chatbot_setting_dto.py +99 -0
  175. qanswer_sdk/models/chatbot_setting_request.py +91 -0
  176. qanswer_sdk/models/class_info.py +89 -0
  177. qanswer_sdk/models/config.py +228 -0
  178. qanswer_sdk/models/config1.py +138 -0
  179. qanswer_sdk/models/connector_config_list_response.py +99 -0
  180. qanswer_sdk/models/connector_config_model.py +96 -0
  181. qanswer_sdk/models/connector_config_patch_payload.py +93 -0
  182. qanswer_sdk/models/connector_config_response.py +95 -0
  183. qanswer_sdk/models/connector_config_sync_response.py +93 -0
  184. qanswer_sdk/models/connector_config_type.py +37 -0
  185. qanswer_sdk/models/connector_model.py +114 -0
  186. qanswer_sdk/models/connector_type.py +51 -0
  187. qanswer_sdk/models/connector_type_dto.py +92 -0
  188. qanswer_sdk/models/connector_type_list_dto.py +95 -0
  189. qanswer_sdk/models/content_item.py +106 -0
  190. qanswer_sdk/models/content_item_type.py +39 -0
  191. qanswer_sdk/models/conversation_aggregations_request.py +107 -0
  192. qanswer_sdk/models/conversation_message.py +230 -0
  193. qanswer_sdk/models/conversation_message_error_key.py +52 -0
  194. qanswer_sdk/models/conversation_message_search_result.py +112 -0
  195. qanswer_sdk/models/conversation_model.py +144 -0
  196. qanswer_sdk/models/conversation_overall_stats.py +97 -0
  197. qanswer_sdk/models/conversation_overall_stats_response.py +95 -0
  198. qanswer_sdk/models/conversation_retention_response.py +91 -0
  199. qanswer_sdk/models/conversation_statistics.py +95 -0
  200. qanswer_sdk/models/conversation_update.py +93 -0
  201. qanswer_sdk/models/conversation_users_stats.py +99 -0
  202. qanswer_sdk/models/conversation_users_stats_response.py +99 -0
  203. qanswer_sdk/models/coordinates.py +89 -0
  204. qanswer_sdk/models/cost_summary_dto.py +99 -0
  205. qanswer_sdk/models/create_connector_request.py +95 -0
  206. qanswer_sdk/models/create_connector_response.py +95 -0
  207. qanswer_sdk/models/create_imap_connector_request.py +105 -0
  208. qanswer_sdk/models/create_pinecone_connector_request.py +97 -0
  209. qanswer_sdk/models/create_sharepoint_connector_from_certificate_request.py +105 -0
  210. qanswer_sdk/models/create_sharepoint_connector_request.py +103 -0
  211. qanswer_sdk/models/create_x_wiki_connector_request.py +103 -0
  212. qanswer_sdk/models/credits_info_dto.py +95 -0
  213. qanswer_sdk/models/credits_info_global_dto.py +97 -0
  214. qanswer_sdk/models/currency.py +38 -0
  215. qanswer_sdk/models/data.py +211 -0
  216. qanswer_sdk/models/data_filling_mode.py +39 -0
  217. qanswer_sdk/models/data_storage_preference.py +38 -0
  218. qanswer_sdk/models/dataset_config_request.py +138 -0
  219. qanswer_sdk/models/dataset_default_values_model.py +129 -0
  220. qanswer_sdk/models/dataset_detail.py +128 -0
  221. qanswer_sdk/models/dataset_detail_kg.py +88 -0
  222. qanswer_sdk/models/dataset_schema.py +193 -0
  223. qanswer_sdk/models/dataset_type.py +38 -0
  224. qanswer_sdk/models/dataset_update_object.py +185 -0
  225. qanswer_sdk/models/dataset_users_response.py +87 -0
  226. qanswer_sdk/models/default_prompt.py +100 -0
  227. qanswer_sdk/models/delete_connector_model.py +90 -0
  228. qanswer_sdk/models/delete_connector_request.py +99 -0
  229. qanswer_sdk/models/delete_connectors_response.py +89 -0
  230. qanswer_sdk/models/delete_files_status_response.py +91 -0
  231. qanswer_sdk/models/delete_index.py +91 -0
  232. qanswer_sdk/models/delete_index_resp.py +89 -0
  233. qanswer_sdk/models/delete_qn_a_pair_request.py +95 -0
  234. qanswer_sdk/models/delete_qn_a_pair_response.py +89 -0
  235. qanswer_sdk/models/delete_synonym.py +93 -0
  236. qanswer_sdk/models/delete_synonym_resp.py +89 -0
  237. qanswer_sdk/models/delete_synonyms.py +91 -0
  238. qanswer_sdk/models/diarization_queue_status.py +99 -0
  239. qanswer_sdk/models/document_content_response.py +91 -0
  240. qanswer_sdk/models/document_content_update_model.py +99 -0
  241. qanswer_sdk/models/document_file_delete_by_connector_model.py +101 -0
  242. qanswer_sdk/models/document_file_delete_by_id_model.py +91 -0
  243. qanswer_sdk/models/document_parsing_task_settings.py +124 -0
  244. qanswer_sdk/models/document_parsing_task_settings_update_payload.py +95 -0
  245. qanswer_sdk/models/document_parsing_task_update.py +121 -0
  246. qanswer_sdk/models/document_status_group.py +39 -0
  247. qanswer_sdk/models/document_status_response.py +89 -0
  248. qanswer_sdk/models/dummy_error.py +89 -0
  249. qanswer_sdk/models/duplicate_ai_excel_template_request.py +97 -0
  250. qanswer_sdk/models/duplicate_ai_excel_template_response.py +87 -0
  251. qanswer_sdk/models/duplicate_report_template_payload.py +97 -0
  252. qanswer_sdk/models/duplicate_report_template_response.py +87 -0
  253. qanswer_sdk/models/e_consilium_connector_config.py +108 -0
  254. qanswer_sdk/models/e_consilium_search_index_search_response.py +113 -0
  255. qanswer_sdk/models/econsilium_file_metadata.py +105 -0
  256. qanswer_sdk/models/econsilium_search_index_add_payload.py +107 -0
  257. qanswer_sdk/models/econsilium_search_index_additional_fields.py +103 -0
  258. qanswer_sdk/models/effective_retention_dto.py +95 -0
  259. qanswer_sdk/models/email_folder.py +91 -0
  260. qanswer_sdk/models/email_request.py +87 -0
  261. qanswer_sdk/models/embedder_cost_filter.py +112 -0
  262. qanswer_sdk/models/embedder_cost_list.py +101 -0
  263. qanswer_sdk/models/embedder_create_dto.py +143 -0
  264. qanswer_sdk/models/embedder_detailed_dto.py +163 -0
  265. qanswer_sdk/models/embedder_dto.py +103 -0
  266. qanswer_sdk/models/embedder_list_dto.py +101 -0
  267. qanswer_sdk/models/embedder_ref.py +95 -0
  268. qanswer_sdk/models/embedder_update_dto.py +135 -0
  269. qanswer_sdk/models/embedding_endpoint_import_failure.py +89 -0
  270. qanswer_sdk/models/embedding_endpoint_import_response.py +99 -0
  271. qanswer_sdk/models/embedding_endpoint_modality.py +37 -0
  272. qanswer_sdk/models/embedding_endpoint_validation_response.py +90 -0
  273. qanswer_sdk/models/embedding_provider.py +44 -0
  274. qanswer_sdk/models/enable_enhanced_context_payload.py +91 -0
  275. qanswer_sdk/models/enable_enhanced_context_response.py +87 -0
  276. qanswer_sdk/models/endpoint_status.py +38 -0
  277. qanswer_sdk/models/entity_description_dto.py +93 -0
  278. qanswer_sdk/models/entity_linking_payload.py +97 -0
  279. qanswer_sdk/models/entity_linking_response.py +97 -0
  280. qanswer_sdk/models/entity_model_in_linking.py +95 -0
  281. qanswer_sdk/models/es_meta_data.py +92 -0
  282. qanswer_sdk/models/es_meta_data_value.py +87 -0
  283. qanswer_sdk/models/evaluate_feedback_response.py +109 -0
  284. qanswer_sdk/models/evaluate_single_feedback_response.py +97 -0
  285. qanswer_sdk/models/extra_body.py +91 -0
  286. qanswer_sdk/models/extract_hyper_links_payload.py +100 -0
  287. qanswer_sdk/models/extract_robot_links_payload.py +88 -0
  288. qanswer_sdk/models/extract_robot_links_response.py +88 -0
  289. qanswer_sdk/models/extraction_strategy.py +38 -0
  290. qanswer_sdk/models/fact.py +96 -0
  291. qanswer_sdk/models/feedback_evaluation_history_entries_response.py +101 -0
  292. qanswer_sdk/models/feedback_evaluation_history_entry_model.py +105 -0
  293. qanswer_sdk/models/feedback_model.py +132 -0
  294. qanswer_sdk/models/feedback_response.py +95 -0
  295. qanswer_sdk/models/feedback_update.py +105 -0
  296. qanswer_sdk/models/file_acl_principal.py +99 -0
  297. qanswer_sdk/models/file_acl_response.py +101 -0
  298. qanswer_sdk/models/file_es_meta_data.py +116 -0
  299. qanswer_sdk/models/file_failure_reason.py +49 -0
  300. qanswer_sdk/models/file_folder_model.py +117 -0
  301. qanswer_sdk/models/file_model.py +124 -0
  302. qanswer_sdk/models/file_status.py +43 -0
  303. qanswer_sdk/models/file_type.py +37 -0
  304. qanswer_sdk/models/file_upload_payload.py +107 -0
  305. qanswer_sdk/models/files_by_connector_model.py +89 -0
  306. qanswer_sdk/models/g_drive_connector_info.py +96 -0
  307. qanswer_sdk/models/g_drive_download_by_ids.py +89 -0
  308. qanswer_sdk/models/g_drive_download_request.py +103 -0
  309. qanswer_sdk/models/g_drive_refresh_request.py +91 -0
  310. qanswer_sdk/models/generation_params.py +89 -0
  311. qanswer_sdk/models/get_connector_by_id_response.py +91 -0
  312. qanswer_sdk/models/get_conversation_response.py +95 -0
  313. qanswer_sdk/models/global_config_dto.py +155 -0
  314. qanswer_sdk/models/google_drive_connector_config.py +110 -0
  315. qanswer_sdk/models/guardrail_endpoint.py +112 -0
  316. qanswer_sdk/models/guardrail_mode.py +38 -0
  317. qanswer_sdk/models/highlight_audio_payload_model.py +100 -0
  318. qanswer_sdk/models/http_validation_error.py +95 -0
  319. qanswer_sdk/models/iframe_strategy.py +38 -0
  320. qanswer_sdk/models/image_url_detail.py +38 -0
  321. qanswer_sdk/models/imap_add_payload.py +105 -0
  322. qanswer_sdk/models/imap_additional_fields.py +101 -0
  323. qanswer_sdk/models/imap_file_metadata.py +108 -0
  324. qanswer_sdk/models/imap_search_response.py +113 -0
  325. qanswer_sdk/models/index_config.py +89 -0
  326. qanswer_sdk/models/install_response.py +89 -0
  327. qanswer_sdk/models/interface_origin.py +47 -0
  328. qanswer_sdk/models/ip2_geo_response.py +91 -0
  329. qanswer_sdk/models/is_enabled_response.py +87 -0
  330. qanswer_sdk/models/jwt_authentication_response.py +93 -0
  331. qanswer_sdk/models/label.py +89 -0
  332. qanswer_sdk/models/labeled_node.py +89 -0
  333. qanswer_sdk/models/language.py +38 -0
  334. qanswer_sdk/models/last_updated_template_conversation_id_response.py +87 -0
  335. qanswer_sdk/models/link.py +99 -0
  336. qanswer_sdk/models/link_extraction_response.py +97 -0
  337. qanswer_sdk/models/link_result_paginated.py +97 -0
  338. qanswer_sdk/models/linked_entity_model_in_linking.py +99 -0
  339. qanswer_sdk/models/linker.py +103 -0
  340. qanswer_sdk/models/linking_result.py +95 -0
  341. qanswer_sdk/models/links.py +99 -0
  342. qanswer_sdk/models/list_connectors_response.py +95 -0
  343. qanswer_sdk/models/list_conversation_response.py +105 -0
  344. qanswer_sdk/models/list_feedback_response.py +105 -0
  345. qanswer_sdk/models/list_files_connector_response.py +107 -0
  346. qanswer_sdk/models/list_socket_events.py +88 -0
  347. qanswer_sdk/models/list_synonyms_model.py +95 -0
  348. qanswer_sdk/models/llm_context_ranges.py +93 -0
  349. qanswer_sdk/models/llm_cost_filter.py +112 -0
  350. qanswer_sdk/models/llm_cost_list.py +101 -0
  351. qanswer_sdk/models/llm_create_dto.py +177 -0
  352. qanswer_sdk/models/llm_detailed_dto.py +198 -0
  353. qanswer_sdk/models/llm_dto.py +120 -0
  354. qanswer_sdk/models/llm_endpoint.py +179 -0
  355. qanswer_sdk/models/llm_endpoint_default_prompts.py +93 -0
  356. qanswer_sdk/models/llm_endpoint_import_failure.py +89 -0
  357. qanswer_sdk/models/llm_endpoint_import_response.py +99 -0
  358. qanswer_sdk/models/llm_endpoint_modality.py +37 -0
  359. qanswer_sdk/models/llm_endpoint_provider.py +44 -0
  360. qanswer_sdk/models/llm_endpoint_read.py +179 -0
  361. qanswer_sdk/models/llm_endpoint_validation_response.py +90 -0
  362. qanswer_sdk/models/llm_health_response.py +89 -0
  363. qanswer_sdk/models/llm_list_detailed_dto.py +101 -0
  364. qanswer_sdk/models/llm_list_dto.py +101 -0
  365. qanswer_sdk/models/llm_update_dto.py +174 -0
  366. qanswer_sdk/models/location_details.py +97 -0
  367. qanswer_sdk/models/log_stats_request.py +100 -0
  368. qanswer_sdk/models/login_request.py +89 -0
  369. qanswer_sdk/models/logs_visibility_policy.py +38 -0
  370. qanswer_sdk/models/logs_visibility_policy_payload.py +92 -0
  371. qanswer_sdk/models/logs_visibility_policy_response.py +92 -0
  372. qanswer_sdk/models/mcp_auth_field_definition.py +98 -0
  373. qanswer_sdk/models/mcp_auth_field_type.py +37 -0
  374. qanswer_sdk/models/mcp_authentication_type.py +39 -0
  375. qanswer_sdk/models/mcp_connection.py +108 -0
  376. qanswer_sdk/models/mcp_connection_create.py +100 -0
  377. qanswer_sdk/models/mcp_server.py +146 -0
  378. qanswer_sdk/models/mcp_server_create.py +116 -0
  379. qanswer_sdk/models/mcp_server_type.py +37 -0
  380. qanswer_sdk/models/mcp_server_update.py +114 -0
  381. qanswer_sdk/models/mcp_tool_dto.py +131 -0
  382. qanswer_sdk/models/mcp_tool_info.py +95 -0
  383. qanswer_sdk/models/mcp_tool_selection_source.py +37 -0
  384. qanswer_sdk/models/mcp_tool_sync_action.py +39 -0
  385. qanswer_sdk/models/mcp_tool_sync_diff.py +94 -0
  386. qanswer_sdk/models/mcp_tool_sync_preview.py +95 -0
  387. qanswer_sdk/models/mcp_tool_update.py +91 -0
  388. qanswer_sdk/models/mcp_transport.py +37 -0
  389. qanswer_sdk/models/mcp_visibility.py +38 -0
  390. qanswer_sdk/models/mcpo_auth2_authorize_body.py +105 -0
  391. qanswer_sdk/models/mcpo_auth2_initiating_origin.py +42 -0
  392. qanswer_sdk/models/message_role.py +38 -0
  393. qanswer_sdk/models/messages_stats_per_day_response.py +99 -0
  394. qanswer_sdk/models/microsoft_connector_config.py +110 -0
  395. qanswer_sdk/models/modify_connector_request.py +98 -0
  396. qanswer_sdk/models/modify_file_display_name_request.py +97 -0
  397. qanswer_sdk/models/notification_dto.py +114 -0
  398. qanswer_sdk/models/notification_filter.py +107 -0
  399. qanswer_sdk/models/notification_list_dto.py +101 -0
  400. qanswer_sdk/models/notification_payload_add_to_org_dto.py +87 -0
  401. qanswer_sdk/models/notification_payload_add_to_team_dto.py +89 -0
  402. qanswer_sdk/models/notification_payload_ai_assistant_shared_dto.py +100 -0
  403. qanswer_sdk/models/notification_payload_conversation_shared_dto.py +96 -0
  404. qanswer_sdk/models/notification_payload_human_takeover_requested_dto.py +89 -0
  405. qanswer_sdk/models/notification_payload_quota_reaching_dto.py +91 -0
  406. qanswer_sdk/models/notification_read_dto.py +89 -0
  407. qanswer_sdk/models/notification_type.py +44 -0
  408. qanswer_sdk/models/o_auth_redirect_response.py +89 -0
  409. qanswer_sdk/models/o_auth_service_dto.py +89 -0
  410. qanswer_sdk/models/one_drive_download_by_ids.py +89 -0
  411. qanswer_sdk/models/one_drive_download_request.py +103 -0
  412. qanswer_sdk/models/one_note_download_by_ids.py +91 -0
  413. qanswer_sdk/models/one_note_download_request.py +103 -0
  414. qanswer_sdk/models/org_llm_detailed_dto.py +105 -0
  415. qanswer_sdk/models/org_llm_features_dto.py +89 -0
  416. qanswer_sdk/models/org_role.py +37 -0
  417. qanswer_sdk/models/org_user_profile_dto.py +210 -0
  418. qanswer_sdk/models/org_user_profile_list_dto.py +101 -0
  419. qanswer_sdk/models/organization_admin_dto.py +97 -0
  420. qanswer_sdk/models/organization_creation_dto.py +91 -0
  421. qanswer_sdk/models/organization_dto.py +93 -0
  422. qanswer_sdk/models/organization_list_dto.py +101 -0
  423. qanswer_sdk/models/organization_user_dto.py +101 -0
  424. qanswer_sdk/models/organization_user_list_dto.py +101 -0
  425. qanswer_sdk/models/paginated_report_templates.py +101 -0
  426. qanswer_sdk/models/password.py +89 -0
  427. qanswer_sdk/models/pinecone_index_model.py +91 -0
  428. qanswer_sdk/models/plan_dto.py +108 -0
  429. qanswer_sdk/models/predicted_class.py +89 -0
  430. qanswer_sdk/models/prepare_synonyms_upload_resp.py +99 -0
  431. qanswer_sdk/models/prepared_synonym_group.py +87 -0
  432. qanswer_sdk/models/pricing_plan.py +51 -0
  433. qanswer_sdk/models/pricing_type.py +38 -0
  434. qanswer_sdk/models/prompt_type.py +49 -0
  435. qanswer_sdk/models/provider.py +87 -0
  436. qanswer_sdk/models/publication_add_payload.py +105 -0
  437. qanswer_sdk/models/publication_file_metadata.py +105 -0
  438. qanswer_sdk/models/publication_office_additional_fields.py +111 -0
  439. qanswer_sdk/models/publication_office_connector_config.py +112 -0
  440. qanswer_sdk/models/publication_search_index_search_response.py +113 -0
  441. qanswer_sdk/models/qa_context.py +129 -0
  442. qanswer_sdk/models/qa_context_display_type.py +44 -0
  443. qanswer_sdk/models/qa_contexts.py +106 -0
  444. qanswer_sdk/models/qa_table.py +100 -0
  445. qanswer_sdk/models/qn_a_pair_model.py +103 -0
  446. qanswer_sdk/models/qn_a_pair_response.py +95 -0
  447. qanswer_sdk/models/rag_payload.py +185 -0
  448. qanswer_sdk/models/rag_response.py +147 -0
  449. qanswer_sdk/models/rdf_entity_linker_response.py +99 -0
  450. qanswer_sdk/models/rdf_linked_entity.py +97 -0
  451. qanswer_sdk/models/reasoning_effort.py +39 -0
  452. qanswer_sdk/models/reference_model.py +99 -0
  453. qanswer_sdk/models/refresh_frequency.py +39 -0
  454. qanswer_sdk/models/refresh_token_request.py +87 -0
  455. qanswer_sdk/models/refresh_website_connector_links_payload.py +96 -0
  456. qanswer_sdk/models/refresh_website_connector_payload.py +94 -0
  457. qanswer_sdk/models/register_pinecone_connector_request.py +95 -0
  458. qanswer_sdk/models/report_copilot_generation_from_slots_ack.py +91 -0
  459. qanswer_sdk/models/report_copilot_generation_from_slots_payload.py +95 -0
  460. qanswer_sdk/models/report_copilot_refinement_payload.py +106 -0
  461. qanswer_sdk/models/report_copilot_refinement_response.py +87 -0
  462. qanswer_sdk/models/report_copilot_slot_feedback_update.py +95 -0
  463. qanswer_sdk/models/report_copilot_slot_feedback_update_response.py +95 -0
  464. qanswer_sdk/models/report_copilot_slot_task_settings.py +121 -0
  465. qanswer_sdk/models/report_copilot_slot_task_settings_update.py +121 -0
  466. qanswer_sdk/models/report_copilot_task_settings.py +119 -0
  467. qanswer_sdk/models/report_copilot_task_settings_update_payload.py +95 -0
  468. qanswer_sdk/models/report_copilot_task_update.py +119 -0
  469. qanswer_sdk/models/report_template.py +155 -0
  470. qanswer_sdk/models/report_template_create_payload.py +132 -0
  471. qanswer_sdk/models/report_template_image_upload_response.py +87 -0
  472. qanswer_sdk/models/report_template_simplified.py +116 -0
  473. qanswer_sdk/models/report_template_simplified_payload.py +91 -0
  474. qanswer_sdk/models/report_template_task_settings_update_payload.py +91 -0
  475. qanswer_sdk/models/report_template_update_payload.py +136 -0
  476. qanswer_sdk/models/report_templates_search_payload.py +106 -0
  477. qanswer_sdk/models/reset_password.py +87 -0
  478. qanswer_sdk/models/response_audit_model.py +99 -0
  479. qanswer_sdk/models/response_audit_stats_response.py +101 -0
  480. qanswer_sdk/models/response_get_dummy_union_connector_config_model_api_connectors_config_dummy_models_union_get.py +228 -0
  481. qanswer_sdk/models/retention_policy_dto.py +106 -0
  482. qanswer_sdk/models/retention_policy_update.py +101 -0
  483. qanswer_sdk/models/retention_preview_response.py +92 -0
  484. qanswer_sdk/models/retention_run_progress_event.py +98 -0
  485. qanswer_sdk/models/retention_run_status_response.py +91 -0
  486. qanswer_sdk/models/retention_scope_type.py +38 -0
  487. qanswer_sdk/models/retention_sweep_result.py +89 -0
  488. qanswer_sdk/models/retention_unit.py +38 -0
  489. qanswer_sdk/models/retreive_all_synonyms_resp.py +99 -0
  490. qanswer_sdk/models/retry_params.py +89 -0
  491. qanswer_sdk/models/return_type.py +38 -0
  492. qanswer_sdk/models/role.py +90 -0
  493. qanswer_sdk/models/role_name.py +37 -0
  494. qanswer_sdk/models/scrolling_strategy.py +37 -0
  495. qanswer_sdk/models/search_conversation_messages_response.py +105 -0
  496. qanswer_sdk/models/search_document_response.py +107 -0
  497. qanswer_sdk/models/search_index_payload.py +114 -0
  498. qanswer_sdk/models/search_metadata_filter.py +94 -0
  499. qanswer_sdk/models/search_payload.py +150 -0
  500. qanswer_sdk/models/search_response.py +120 -0
  501. qanswer_sdk/models/search_synonyms_resp.py +91 -0
  502. qanswer_sdk/models/search_task_settings.py +135 -0
  503. qanswer_sdk/models/search_task_settings_update_payload.py +95 -0
  504. qanswer_sdk/models/search_task_update.py +133 -0
  505. qanswer_sdk/models/sender_type.py +38 -0
  506. qanswer_sdk/models/serve_pdf200_response.py +87 -0
  507. qanswer_sdk/models/share_point_connector_settings.py +99 -0
  508. qanswer_sdk/models/share_point_download_by_ids.py +99 -0
  509. qanswer_sdk/models/share_point_download_request.py +103 -0
  510. qanswer_sdk/models/shared_by.py +38 -0
  511. qanswer_sdk/models/shared_entity_type.py +38 -0
  512. qanswer_sdk/models/shared_organization_access_dto.py +116 -0
  513. qanswer_sdk/models/shared_team_access_dto.py +116 -0
  514. qanswer_sdk/models/shared_user.py +90 -0
  515. qanswer_sdk/models/sign_out_request.py +87 -0
  516. qanswer_sdk/models/sign_up_request.py +99 -0
  517. qanswer_sdk/models/slot.py +153 -0
  518. qanswer_sdk/models/slot_history_entry.py +119 -0
  519. qanswer_sdk/models/slot_in_prompt.py +91 -0
  520. qanswer_sdk/models/slot_info_with_latest_version.py +95 -0
  521. qanswer_sdk/models/slot_update.py +133 -0
  522. qanswer_sdk/models/socker_join_user.py +91 -0
  523. qanswer_sdk/models/socket_audio_transcription_status.py +102 -0
  524. qanswer_sdk/models/socket_conversation_message.py +245 -0
  525. qanswer_sdk/models/socket_dataset_reindexing_status.py +97 -0
  526. qanswer_sdk/models/socket_events_q_answer.py +55 -0
  527. qanswer_sdk/models/socket_feedback_evaluation_progress.py +108 -0
  528. qanswer_sdk/models/socket_file_metadata.py +194 -0
  529. qanswer_sdk/models/socket_file_status_batch.py +103 -0
  530. qanswer_sdk/models/socket_file_status_item.py +99 -0
  531. qanswer_sdk/models/socket_join_conversation.py +97 -0
  532. qanswer_sdk/models/socket_join_dataset.py +93 -0
  533. qanswer_sdk/models/socket_message_status.py +40 -0
  534. qanswer_sdk/models/socket_notification.py +109 -0
  535. qanswer_sdk/models/socket_report_continuation_response.py +100 -0
  536. qanswer_sdk/models/socket_report_copilot_generation_from_slots_response.py +116 -0
  537. qanswer_sdk/models/socket_report_copilot_generation_from_template_response.py +116 -0
  538. qanswer_sdk/models/socket_report_copilot_refinement_response.py +102 -0
  539. qanswer_sdk/models/socket_speech2_text_response.py +122 -0
  540. qanswer_sdk/models/socket_stop_conversation.py +97 -0
  541. qanswer_sdk/models/source.py +125 -0
  542. qanswer_sdk/models/source_metadata.py +109 -0
  543. qanswer_sdk/models/speech2_text_response.py +110 -0
  544. qanswer_sdk/models/stat_per_date.py +89 -0
  545. qanswer_sdk/models/status_response.py +89 -0
  546. qanswer_sdk/models/storage_active_status.py +37 -0
  547. qanswer_sdk/models/subscription_response.py +92 -0
  548. qanswer_sdk/models/subscription_status.py +39 -0
  549. qanswer_sdk/models/suggested_replies.py +87 -0
  550. qanswer_sdk/models/suggestion_list_response.py +87 -0
  551. qanswer_sdk/models/summa_server.py +101 -0
  552. qanswer_sdk/models/task_category.py +61 -0
  553. qanswer_sdk/models/task_name.py +43 -0
  554. qanswer_sdk/models/team_admin_dto.py +95 -0
  555. qanswer_sdk/models/team_creation_dto.py +89 -0
  556. qanswer_sdk/models/team_dto.py +93 -0
  557. qanswer_sdk/models/team_list_dto.py +101 -0
  558. qanswer_sdk/models/team_list_dto_teams_inner.py +149 -0
  559. qanswer_sdk/models/team_role.py +37 -0
  560. qanswer_sdk/models/team_with_count_dto.py +95 -0
  561. qanswer_sdk/models/teams_bot_auth_type.py +38 -0
  562. qanswer_sdk/models/teams_bot_registration_dto.py +107 -0
  563. qanswer_sdk/models/teams_bot_registration_upsert_dto.py +105 -0
  564. qanswer_sdk/models/template_clip_structure.py +114 -0
  565. qanswer_sdk/models/template_toggle_request.py +93 -0
  566. qanswer_sdk/models/terms_bucket.py +107 -0
  567. qanswer_sdk/models/test_imap_connection_payload.py +95 -0
  568. qanswer_sdk/models/text2_sparql_payload.py +187 -0
  569. qanswer_sdk/models/text2_sparql_task_settings.py +119 -0
  570. qanswer_sdk/models/text2_sparql_task_settings_update_payload.py +95 -0
  571. qanswer_sdk/models/text2_sparql_task_update.py +119 -0
  572. qanswer_sdk/models/text_classification_payload.py +99 -0
  573. qanswer_sdk/models/text_classification_response.py +87 -0
  574. qanswer_sdk/models/text_classification_v2_payload.py +99 -0
  575. qanswer_sdk/models/text_classification_v2_response.py +95 -0
  576. qanswer_sdk/models/thinking_block.py +91 -0
  577. qanswer_sdk/models/tool_selection.py +89 -0
  578. qanswer_sdk/models/total_stat.py +96 -0
  579. qanswer_sdk/models/ui_mappings.py +141 -0
  580. qanswer_sdk/models/update_file_es_meta_data.py +116 -0
  581. qanswer_sdk/models/update_metadata_model.py +97 -0
  582. qanswer_sdk/models/update_qn_a_pair_request.py +101 -0
  583. qanswer_sdk/models/update_qn_a_pair_response.py +89 -0
  584. qanswer_sdk/models/update_synonyms.py +95 -0
  585. qanswer_sdk/models/update_synonyms_resp.py +89 -0
  586. qanswer_sdk/models/upload_metadata.py +115 -0
  587. qanswer_sdk/models/user_credits_config_dto.py +99 -0
  588. qanswer_sdk/models/user_credits_dto.py +106 -0
  589. qanswer_sdk/models/user_dataset_api_key_dto.py +120 -0
  590. qanswer_sdk/models/user_dataset_mcp_tool_selection_dto.py +100 -0
  591. qanswer_sdk/models/user_dto.py +91 -0
  592. qanswer_sdk/models/user_identity_availability.py +87 -0
  593. qanswer_sdk/models/user_info_dto.py +95 -0
  594. qanswer_sdk/models/user_list_dto.py +101 -0
  595. qanswer_sdk/models/user_log_dto.py +102 -0
  596. qanswer_sdk/models/user_logs_list_dto.py +97 -0
  597. qanswer_sdk/models/user_mcp_tool_selection_dto.py +107 -0
  598. qanswer_sdk/models/user_oauth_token_dto.py +96 -0
  599. qanswer_sdk/models/user_profile_dto.py +199 -0
  600. qanswer_sdk/models/user_profile_list_dto.py +101 -0
  601. qanswer_sdk/models/user_team_dto.py +94 -0
  602. qanswer_sdk/models/validation_error.py +108 -0
  603. qanswer_sdk/models/validation_error_loc_inner.py +138 -0
  604. qanswer_sdk/models/warn_visibility.py +40 -0
  605. qanswer_sdk/models/websearch_connector_config.py +102 -0
  606. qanswer_sdk/models/websearch_scraping_site.py +91 -0
  607. qanswer_sdk/models/website_add_payload.py +102 -0
  608. qanswer_sdk/models/website_connector_config.py +102 -0
  609. qanswer_sdk/models/website_connector_settings.py +123 -0
  610. qanswer_sdk/models/widget_configs.py +109 -0
  611. qanswer_sdk/models/x_wiki_add_request.py +97 -0
  612. qanswer_sdk/models/x_wiki_download_by_ids.py +89 -0
  613. qanswer_sdk/py.typed +0 -0
  614. qanswer_sdk/rest.py +258 -0
  615. qanswer_sdk-0.1.0.dev0.dist-info/METADATA +252 -0
  616. qanswer_sdk-0.1.0.dev0.dist-info/RECORD +618 -0
  617. qanswer_sdk-0.1.0.dev0.dist-info/WHEEL +5 -0
  618. qanswer_sdk-0.1.0.dev0.dist-info/top_level.txt +1 -0
@@ -0,0 +1,1454 @@
1
+ # coding: utf-8
2
+
3
+ """
4
+ free-text-client
5
+
6
+ QAnswer 2.0 API
7
+
8
+ The version of the OpenAPI document: 2.0.0
9
+ Generated by OpenAPI Generator (https://openapi-generator.tech)
10
+
11
+ Do not edit the class manually.
12
+ """ # noqa: E501
13
+
14
+ import warnings
15
+ from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt
16
+ from typing import Any, Dict, List, Optional, Tuple, Union
17
+ from typing_extensions import Annotated
18
+
19
+ from pydantic import Field, StrictInt, StrictStr
20
+ from typing import Any, Optional
21
+ from typing_extensions import Annotated
22
+ from qanswer_sdk.models.qa_contexts import QaContexts
23
+ from qanswer_sdk.models.summa_server import SummaServer
24
+
25
+ from qanswer_sdk.api_client import ApiClient, RequestSerialized
26
+ from qanswer_sdk.api_response import ApiResponse
27
+ from qanswer_sdk.rest import RESTResponseType
28
+
29
+
30
+ class ConnectorRDFAnswerApi:
31
+ """NOTE: This class is auto generated by OpenAPI Generator
32
+ Ref: https://openapi-generator.tech
33
+
34
+ Do not edit the class manually.
35
+ """
36
+
37
+ def __init__(self, api_client=None) -> None:
38
+ if api_client is None:
39
+ api_client = ApiClient.get_default()
40
+ self.api_client = api_client
41
+
42
+
43
+ @validate_call
44
+ def answer_context(
45
+ self,
46
+ username: StrictStr,
47
+ kb: StrictStr,
48
+ sparql_query: StrictStr,
49
+ lang: Optional[StrictStr] = None,
50
+ timeout: Optional[StrictInt] = None,
51
+ q_answer_api_key: Annotated[Optional[StrictStr], Field(description="Optional QAnswer API key")] = None,
52
+ _request_timeout: Union[
53
+ None,
54
+ Annotated[StrictFloat, Field(gt=0)],
55
+ Tuple[
56
+ Annotated[StrictFloat, Field(gt=0)],
57
+ Annotated[StrictFloat, Field(gt=0)]
58
+ ]
59
+ ] = None,
60
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
61
+ _content_type: Optional[StrictStr] = None,
62
+ _headers: Optional[Dict[StrictStr, Any]] = None,
63
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
64
+ ) -> QaContexts:
65
+ """Given a SPARQL query returns all information about the answer entities like label, description, images ...
66
+
67
+
68
+ :param username: (required)
69
+ :type username: str
70
+ :param kb: (required)
71
+ :type kb: str
72
+ :param sparql_query: (required)
73
+ :type sparql_query: str
74
+ :param lang:
75
+ :type lang: str
76
+ :param timeout:
77
+ :type timeout: int
78
+ :param q_answer_api_key: Optional QAnswer API key
79
+ :type q_answer_api_key: str
80
+ :param _request_timeout: timeout setting for this request. If one
81
+ number provided, it will be total request
82
+ timeout. It can also be a pair (tuple) of
83
+ (connection, read) timeouts.
84
+ :type _request_timeout: int, tuple(int, int), optional
85
+ :param _request_auth: set to override the auth_settings for an a single
86
+ request; this effectively ignores the
87
+ authentication in the spec for a single request.
88
+ :type _request_auth: dict, optional
89
+ :param _content_type: force content-type for the request.
90
+ :type _content_type: str, Optional
91
+ :param _headers: set to override the headers for a single
92
+ request; this effectively ignores the headers
93
+ in the spec for a single request.
94
+ :type _headers: dict, optional
95
+ :param _host_index: set to override the host_index for a single
96
+ request; this effectively ignores the host_index
97
+ in the spec for a single request.
98
+ :type _host_index: int, optional
99
+ :return: Returns the result object.
100
+ """ # noqa: E501
101
+
102
+ _param = self._answer_context_serialize(
103
+ username=username,
104
+ kb=kb,
105
+ sparql_query=sparql_query,
106
+ lang=lang,
107
+ timeout=timeout,
108
+ q_answer_api_key=q_answer_api_key,
109
+ _request_auth=_request_auth,
110
+ _content_type=_content_type,
111
+ _headers=_headers,
112
+ _host_index=_host_index
113
+ )
114
+
115
+ _response_types_map: Dict[str, Optional[str]] = {
116
+ '200': "QaContexts",
117
+ '422': "HTTPValidationError",
118
+ }
119
+ response_data = self.api_client.call_api(
120
+ *_param,
121
+ _request_timeout=_request_timeout
122
+ )
123
+ response_data.read()
124
+ return self.api_client.response_deserialize(
125
+ response_data=response_data,
126
+ response_types_map=_response_types_map,
127
+ ).data
128
+
129
+
130
+ @validate_call
131
+ def answer_context_with_http_info(
132
+ self,
133
+ username: StrictStr,
134
+ kb: StrictStr,
135
+ sparql_query: StrictStr,
136
+ lang: Optional[StrictStr] = None,
137
+ timeout: Optional[StrictInt] = None,
138
+ q_answer_api_key: Annotated[Optional[StrictStr], Field(description="Optional QAnswer API key")] = None,
139
+ _request_timeout: Union[
140
+ None,
141
+ Annotated[StrictFloat, Field(gt=0)],
142
+ Tuple[
143
+ Annotated[StrictFloat, Field(gt=0)],
144
+ Annotated[StrictFloat, Field(gt=0)]
145
+ ]
146
+ ] = None,
147
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
148
+ _content_type: Optional[StrictStr] = None,
149
+ _headers: Optional[Dict[StrictStr, Any]] = None,
150
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
151
+ ) -> ApiResponse[QaContexts]:
152
+ """Given a SPARQL query returns all information about the answer entities like label, description, images ...
153
+
154
+
155
+ :param username: (required)
156
+ :type username: str
157
+ :param kb: (required)
158
+ :type kb: str
159
+ :param sparql_query: (required)
160
+ :type sparql_query: str
161
+ :param lang:
162
+ :type lang: str
163
+ :param timeout:
164
+ :type timeout: int
165
+ :param q_answer_api_key: Optional QAnswer API key
166
+ :type q_answer_api_key: str
167
+ :param _request_timeout: timeout setting for this request. If one
168
+ number provided, it will be total request
169
+ timeout. It can also be a pair (tuple) of
170
+ (connection, read) timeouts.
171
+ :type _request_timeout: int, tuple(int, int), optional
172
+ :param _request_auth: set to override the auth_settings for an a single
173
+ request; this effectively ignores the
174
+ authentication in the spec for a single request.
175
+ :type _request_auth: dict, optional
176
+ :param _content_type: force content-type for the request.
177
+ :type _content_type: str, Optional
178
+ :param _headers: set to override the headers for a single
179
+ request; this effectively ignores the headers
180
+ in the spec for a single request.
181
+ :type _headers: dict, optional
182
+ :param _host_index: set to override the host_index for a single
183
+ request; this effectively ignores the host_index
184
+ in the spec for a single request.
185
+ :type _host_index: int, optional
186
+ :return: Returns the result object.
187
+ """ # noqa: E501
188
+
189
+ _param = self._answer_context_serialize(
190
+ username=username,
191
+ kb=kb,
192
+ sparql_query=sparql_query,
193
+ lang=lang,
194
+ timeout=timeout,
195
+ q_answer_api_key=q_answer_api_key,
196
+ _request_auth=_request_auth,
197
+ _content_type=_content_type,
198
+ _headers=_headers,
199
+ _host_index=_host_index
200
+ )
201
+
202
+ _response_types_map: Dict[str, Optional[str]] = {
203
+ '200': "QaContexts",
204
+ '422': "HTTPValidationError",
205
+ }
206
+ response_data = self.api_client.call_api(
207
+ *_param,
208
+ _request_timeout=_request_timeout
209
+ )
210
+ response_data.read()
211
+ return self.api_client.response_deserialize(
212
+ response_data=response_data,
213
+ response_types_map=_response_types_map,
214
+ )
215
+
216
+
217
+ @validate_call
218
+ def answer_context_without_preload_content(
219
+ self,
220
+ username: StrictStr,
221
+ kb: StrictStr,
222
+ sparql_query: StrictStr,
223
+ lang: Optional[StrictStr] = None,
224
+ timeout: Optional[StrictInt] = None,
225
+ q_answer_api_key: Annotated[Optional[StrictStr], Field(description="Optional QAnswer API key")] = None,
226
+ _request_timeout: Union[
227
+ None,
228
+ Annotated[StrictFloat, Field(gt=0)],
229
+ Tuple[
230
+ Annotated[StrictFloat, Field(gt=0)],
231
+ Annotated[StrictFloat, Field(gt=0)]
232
+ ]
233
+ ] = None,
234
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
235
+ _content_type: Optional[StrictStr] = None,
236
+ _headers: Optional[Dict[StrictStr, Any]] = None,
237
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
238
+ ) -> RESTResponseType:
239
+ """Given a SPARQL query returns all information about the answer entities like label, description, images ...
240
+
241
+
242
+ :param username: (required)
243
+ :type username: str
244
+ :param kb: (required)
245
+ :type kb: str
246
+ :param sparql_query: (required)
247
+ :type sparql_query: str
248
+ :param lang:
249
+ :type lang: str
250
+ :param timeout:
251
+ :type timeout: int
252
+ :param q_answer_api_key: Optional QAnswer API key
253
+ :type q_answer_api_key: str
254
+ :param _request_timeout: timeout setting for this request. If one
255
+ number provided, it will be total request
256
+ timeout. It can also be a pair (tuple) of
257
+ (connection, read) timeouts.
258
+ :type _request_timeout: int, tuple(int, int), optional
259
+ :param _request_auth: set to override the auth_settings for an a single
260
+ request; this effectively ignores the
261
+ authentication in the spec for a single request.
262
+ :type _request_auth: dict, optional
263
+ :param _content_type: force content-type for the request.
264
+ :type _content_type: str, Optional
265
+ :param _headers: set to override the headers for a single
266
+ request; this effectively ignores the headers
267
+ in the spec for a single request.
268
+ :type _headers: dict, optional
269
+ :param _host_index: set to override the host_index for a single
270
+ request; this effectively ignores the host_index
271
+ in the spec for a single request.
272
+ :type _host_index: int, optional
273
+ :return: Returns the result object.
274
+ """ # noqa: E501
275
+
276
+ _param = self._answer_context_serialize(
277
+ username=username,
278
+ kb=kb,
279
+ sparql_query=sparql_query,
280
+ lang=lang,
281
+ timeout=timeout,
282
+ q_answer_api_key=q_answer_api_key,
283
+ _request_auth=_request_auth,
284
+ _content_type=_content_type,
285
+ _headers=_headers,
286
+ _host_index=_host_index
287
+ )
288
+
289
+ _response_types_map: Dict[str, Optional[str]] = {
290
+ '200': "QaContexts",
291
+ '422': "HTTPValidationError",
292
+ }
293
+ response_data = self.api_client.call_api(
294
+ *_param,
295
+ _request_timeout=_request_timeout
296
+ )
297
+ return response_data.response
298
+
299
+
300
+ def _answer_context_serialize(
301
+ self,
302
+ username,
303
+ kb,
304
+ sparql_query,
305
+ lang,
306
+ timeout,
307
+ q_answer_api_key,
308
+ _request_auth,
309
+ _content_type,
310
+ _headers,
311
+ _host_index,
312
+ ) -> RequestSerialized:
313
+
314
+ _host = None
315
+
316
+ _collection_formats: Dict[str, str] = {
317
+ }
318
+
319
+ _path_params: Dict[str, str] = {}
320
+ _query_params: List[Tuple[str, str]] = []
321
+ _header_params: Dict[str, Optional[str]] = _headers or {}
322
+ _form_params: List[Tuple[str, str]] = []
323
+ _files: Dict[
324
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
325
+ ] = {}
326
+ _body_params: Optional[bytes] = None
327
+
328
+ # process the path parameters
329
+ # process the query parameters
330
+ if username is not None:
331
+
332
+ _query_params.append(('username', username))
333
+
334
+ if kb is not None:
335
+
336
+ _query_params.append(('kb', kb))
337
+
338
+ if lang is not None:
339
+
340
+ _query_params.append(('lang', lang))
341
+
342
+ if sparql_query is not None:
343
+
344
+ _query_params.append(('sparqlQuery', sparql_query))
345
+
346
+ if timeout is not None:
347
+
348
+ _query_params.append(('timeout', timeout))
349
+
350
+ # process the header parameters
351
+ if q_answer_api_key is not None:
352
+ _header_params['QAnswer-Api-Key'] = q_answer_api_key
353
+ # process the form parameters
354
+ # process the body parameter
355
+
356
+
357
+ # set the HTTP header `Accept`
358
+ if 'Accept' not in _header_params:
359
+ _header_params['Accept'] = self.api_client.select_header_accept(
360
+ [
361
+ 'application/json'
362
+ ]
363
+ )
364
+
365
+
366
+ # authentication setting
367
+ _auth_settings: List[str] = [
368
+ 'QAnswer-Api-Key',
369
+ 'Bearer token'
370
+ ]
371
+
372
+ return self.api_client.param_serialize(
373
+ method='GET',
374
+ resource_path='/api/connectors/rdf/answer/context',
375
+ path_params=_path_params,
376
+ query_params=_query_params,
377
+ header_params=_header_params,
378
+ body=_body_params,
379
+ post_params=_form_params,
380
+ files=_files,
381
+ auth_settings=_auth_settings,
382
+ collection_formats=_collection_formats,
383
+ _host=_host,
384
+ _request_auth=_request_auth
385
+ )
386
+
387
+
388
+
389
+
390
+ @validate_call
391
+ def rdf(
392
+ self,
393
+ user: StrictStr,
394
+ dataset: StrictStr,
395
+ url: StrictStr,
396
+ language: Optional[StrictStr] = None,
397
+ accept: Optional[StrictStr] = None,
398
+ q_answer_api_key: Annotated[Optional[StrictStr], Field(description="Optional QAnswer API key")] = None,
399
+ _request_timeout: Union[
400
+ None,
401
+ Annotated[StrictFloat, Field(gt=0)],
402
+ Tuple[
403
+ Annotated[StrictFloat, Field(gt=0)],
404
+ Annotated[StrictFloat, Field(gt=0)]
405
+ ]
406
+ ] = None,
407
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
408
+ _content_type: Optional[StrictStr] = None,
409
+ _headers: Optional[Dict[StrictStr, Any]] = None,
410
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
411
+ ) -> object:
412
+ """Gets back the RDF content to render
413
+
414
+
415
+ :param user: (required)
416
+ :type user: str
417
+ :param dataset: (required)
418
+ :type dataset: str
419
+ :param url: (required)
420
+ :type url: str
421
+ :param language:
422
+ :type language: str
423
+ :param accept:
424
+ :type accept: str
425
+ :param q_answer_api_key: Optional QAnswer API key
426
+ :type q_answer_api_key: str
427
+ :param _request_timeout: timeout setting for this request. If one
428
+ number provided, it will be total request
429
+ timeout. It can also be a pair (tuple) of
430
+ (connection, read) timeouts.
431
+ :type _request_timeout: int, tuple(int, int), optional
432
+ :param _request_auth: set to override the auth_settings for an a single
433
+ request; this effectively ignores the
434
+ authentication in the spec for a single request.
435
+ :type _request_auth: dict, optional
436
+ :param _content_type: force content-type for the request.
437
+ :type _content_type: str, Optional
438
+ :param _headers: set to override the headers for a single
439
+ request; this effectively ignores the headers
440
+ in the spec for a single request.
441
+ :type _headers: dict, optional
442
+ :param _host_index: set to override the host_index for a single
443
+ request; this effectively ignores the host_index
444
+ in the spec for a single request.
445
+ :type _host_index: int, optional
446
+ :return: Returns the result object.
447
+ """ # noqa: E501
448
+
449
+ _param = self._rdf_serialize(
450
+ user=user,
451
+ dataset=dataset,
452
+ url=url,
453
+ language=language,
454
+ accept=accept,
455
+ q_answer_api_key=q_answer_api_key,
456
+ _request_auth=_request_auth,
457
+ _content_type=_content_type,
458
+ _headers=_headers,
459
+ _host_index=_host_index
460
+ )
461
+
462
+ _response_types_map: Dict[str, Optional[str]] = {
463
+ '200': "object",
464
+ '422': "HTTPValidationError",
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
+ ).data
475
+
476
+
477
+ @validate_call
478
+ def rdf_with_http_info(
479
+ self,
480
+ user: StrictStr,
481
+ dataset: StrictStr,
482
+ url: StrictStr,
483
+ language: Optional[StrictStr] = None,
484
+ accept: Optional[StrictStr] = None,
485
+ q_answer_api_key: Annotated[Optional[StrictStr], Field(description="Optional QAnswer API key")] = None,
486
+ _request_timeout: Union[
487
+ None,
488
+ Annotated[StrictFloat, Field(gt=0)],
489
+ Tuple[
490
+ Annotated[StrictFloat, Field(gt=0)],
491
+ Annotated[StrictFloat, Field(gt=0)]
492
+ ]
493
+ ] = None,
494
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
495
+ _content_type: Optional[StrictStr] = None,
496
+ _headers: Optional[Dict[StrictStr, Any]] = None,
497
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
498
+ ) -> ApiResponse[object]:
499
+ """Gets back the RDF content to render
500
+
501
+
502
+ :param user: (required)
503
+ :type user: str
504
+ :param dataset: (required)
505
+ :type dataset: str
506
+ :param url: (required)
507
+ :type url: str
508
+ :param language:
509
+ :type language: str
510
+ :param accept:
511
+ :type accept: str
512
+ :param q_answer_api_key: Optional QAnswer API key
513
+ :type q_answer_api_key: str
514
+ :param _request_timeout: timeout setting for this request. If one
515
+ number provided, it will be total request
516
+ timeout. It can also be a pair (tuple) of
517
+ (connection, read) timeouts.
518
+ :type _request_timeout: int, tuple(int, int), optional
519
+ :param _request_auth: set to override the auth_settings for an a single
520
+ request; this effectively ignores the
521
+ authentication in the spec for a single request.
522
+ :type _request_auth: dict, optional
523
+ :param _content_type: force content-type for the request.
524
+ :type _content_type: str, Optional
525
+ :param _headers: set to override the headers for a single
526
+ request; this effectively ignores the headers
527
+ in the spec for a single request.
528
+ :type _headers: dict, optional
529
+ :param _host_index: set to override the host_index for a single
530
+ request; this effectively ignores the host_index
531
+ in the spec for a single request.
532
+ :type _host_index: int, optional
533
+ :return: Returns the result object.
534
+ """ # noqa: E501
535
+
536
+ _param = self._rdf_serialize(
537
+ user=user,
538
+ dataset=dataset,
539
+ url=url,
540
+ language=language,
541
+ accept=accept,
542
+ q_answer_api_key=q_answer_api_key,
543
+ _request_auth=_request_auth,
544
+ _content_type=_content_type,
545
+ _headers=_headers,
546
+ _host_index=_host_index
547
+ )
548
+
549
+ _response_types_map: Dict[str, Optional[str]] = {
550
+ '200': "object",
551
+ '422': "HTTPValidationError",
552
+ }
553
+ response_data = self.api_client.call_api(
554
+ *_param,
555
+ _request_timeout=_request_timeout
556
+ )
557
+ response_data.read()
558
+ return self.api_client.response_deserialize(
559
+ response_data=response_data,
560
+ response_types_map=_response_types_map,
561
+ )
562
+
563
+
564
+ @validate_call
565
+ def rdf_without_preload_content(
566
+ self,
567
+ user: StrictStr,
568
+ dataset: StrictStr,
569
+ url: StrictStr,
570
+ language: Optional[StrictStr] = None,
571
+ accept: Optional[StrictStr] = None,
572
+ q_answer_api_key: Annotated[Optional[StrictStr], Field(description="Optional QAnswer API key")] = None,
573
+ _request_timeout: Union[
574
+ None,
575
+ Annotated[StrictFloat, Field(gt=0)],
576
+ Tuple[
577
+ Annotated[StrictFloat, Field(gt=0)],
578
+ Annotated[StrictFloat, Field(gt=0)]
579
+ ]
580
+ ] = None,
581
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
582
+ _content_type: Optional[StrictStr] = None,
583
+ _headers: Optional[Dict[StrictStr, Any]] = None,
584
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
585
+ ) -> RESTResponseType:
586
+ """Gets back the RDF content to render
587
+
588
+
589
+ :param user: (required)
590
+ :type user: str
591
+ :param dataset: (required)
592
+ :type dataset: str
593
+ :param url: (required)
594
+ :type url: str
595
+ :param language:
596
+ :type language: str
597
+ :param accept:
598
+ :type accept: str
599
+ :param q_answer_api_key: Optional QAnswer API key
600
+ :type q_answer_api_key: str
601
+ :param _request_timeout: timeout setting for this request. If one
602
+ number provided, it will be total request
603
+ timeout. It can also be a pair (tuple) of
604
+ (connection, read) timeouts.
605
+ :type _request_timeout: int, tuple(int, int), optional
606
+ :param _request_auth: set to override the auth_settings for an a single
607
+ request; this effectively ignores the
608
+ authentication in the spec for a single request.
609
+ :type _request_auth: dict, optional
610
+ :param _content_type: force content-type for the request.
611
+ :type _content_type: str, Optional
612
+ :param _headers: set to override the headers for a single
613
+ request; this effectively ignores the headers
614
+ in the spec for a single request.
615
+ :type _headers: dict, optional
616
+ :param _host_index: set to override the host_index for a single
617
+ request; this effectively ignores the host_index
618
+ in the spec for a single request.
619
+ :type _host_index: int, optional
620
+ :return: Returns the result object.
621
+ """ # noqa: E501
622
+
623
+ _param = self._rdf_serialize(
624
+ user=user,
625
+ dataset=dataset,
626
+ url=url,
627
+ language=language,
628
+ accept=accept,
629
+ q_answer_api_key=q_answer_api_key,
630
+ _request_auth=_request_auth,
631
+ _content_type=_content_type,
632
+ _headers=_headers,
633
+ _host_index=_host_index
634
+ )
635
+
636
+ _response_types_map: Dict[str, Optional[str]] = {
637
+ '200': "object",
638
+ '422': "HTTPValidationError",
639
+ }
640
+ response_data = self.api_client.call_api(
641
+ *_param,
642
+ _request_timeout=_request_timeout
643
+ )
644
+ return response_data.response
645
+
646
+
647
+ def _rdf_serialize(
648
+ self,
649
+ user,
650
+ dataset,
651
+ url,
652
+ language,
653
+ accept,
654
+ q_answer_api_key,
655
+ _request_auth,
656
+ _content_type,
657
+ _headers,
658
+ _host_index,
659
+ ) -> RequestSerialized:
660
+
661
+ _host = None
662
+
663
+ _collection_formats: Dict[str, str] = {
664
+ }
665
+
666
+ _path_params: Dict[str, str] = {}
667
+ _query_params: List[Tuple[str, str]] = []
668
+ _header_params: Dict[str, Optional[str]] = _headers or {}
669
+ _form_params: List[Tuple[str, str]] = []
670
+ _files: Dict[
671
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
672
+ ] = {}
673
+ _body_params: Optional[bytes] = None
674
+
675
+ # process the path parameters
676
+ if user is not None:
677
+ _path_params['user'] = user
678
+ if dataset is not None:
679
+ _path_params['dataset'] = dataset
680
+ # process the query parameters
681
+ if url is not None:
682
+
683
+ _query_params.append(('url', url))
684
+
685
+ if language is not None:
686
+
687
+ _query_params.append(('language', language))
688
+
689
+ # process the header parameters
690
+ if accept is not None:
691
+ _header_params['accept'] = accept
692
+ if q_answer_api_key is not None:
693
+ _header_params['QAnswer-Api-Key'] = q_answer_api_key
694
+ # process the form parameters
695
+ # process the body parameter
696
+
697
+
698
+ # set the HTTP header `Accept`
699
+ if 'Accept' not in _header_params:
700
+ _header_params['Accept'] = self.api_client.select_header_accept(
701
+ [
702
+ 'application/json'
703
+ ]
704
+ )
705
+
706
+
707
+ # authentication setting
708
+ _auth_settings: List[str] = [
709
+ 'QAnswer-Api-Key',
710
+ 'Bearer token'
711
+ ]
712
+
713
+ return self.api_client.param_serialize(
714
+ method='GET',
715
+ resource_path='/api/connectors/rdf/answer/browser/{user}/{dataset}/facet',
716
+ path_params=_path_params,
717
+ query_params=_query_params,
718
+ header_params=_header_params,
719
+ body=_body_params,
720
+ post_params=_form_params,
721
+ files=_files,
722
+ auth_settings=_auth_settings,
723
+ collection_formats=_collection_formats,
724
+ _host=_host,
725
+ _request_auth=_request_auth
726
+ )
727
+
728
+
729
+
730
+
731
+ @validate_call
732
+ def summa(
733
+ self,
734
+ dataset: StrictStr,
735
+ entity: StrictStr,
736
+ user: StrictStr,
737
+ top_k: Optional[StrictInt] = None,
738
+ language: Optional[StrictStr] = None,
739
+ q_answer_api_key: Annotated[Optional[StrictStr], Field(description="Optional QAnswer API key")] = None,
740
+ _request_timeout: Union[
741
+ None,
742
+ Annotated[StrictFloat, Field(gt=0)],
743
+ Tuple[
744
+ Annotated[StrictFloat, Field(gt=0)],
745
+ Annotated[StrictFloat, Field(gt=0)]
746
+ ]
747
+ ] = None,
748
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
749
+ _content_type: Optional[StrictStr] = None,
750
+ _headers: Optional[Dict[StrictStr, Any]] = None,
751
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
752
+ ) -> SummaServer:
753
+ """Generates summaries, i.e. most relevant top-k properties, for an item in a dataset
754
+
755
+
756
+ :param dataset: (required)
757
+ :type dataset: str
758
+ :param entity: (required)
759
+ :type entity: str
760
+ :param user: (required)
761
+ :type user: str
762
+ :param top_k:
763
+ :type top_k: int
764
+ :param language:
765
+ :type language: str
766
+ :param q_answer_api_key: Optional QAnswer API key
767
+ :type q_answer_api_key: str
768
+ :param _request_timeout: timeout setting for this request. If one
769
+ number provided, it will be total request
770
+ timeout. It can also be a pair (tuple) of
771
+ (connection, read) timeouts.
772
+ :type _request_timeout: int, tuple(int, int), optional
773
+ :param _request_auth: set to override the auth_settings for an a single
774
+ request; this effectively ignores the
775
+ authentication in the spec for a single request.
776
+ :type _request_auth: dict, optional
777
+ :param _content_type: force content-type for the request.
778
+ :type _content_type: str, Optional
779
+ :param _headers: set to override the headers for a single
780
+ request; this effectively ignores the headers
781
+ in the spec for a single request.
782
+ :type _headers: dict, optional
783
+ :param _host_index: set to override the host_index for a single
784
+ request; this effectively ignores the host_index
785
+ in the spec for a single request.
786
+ :type _host_index: int, optional
787
+ :return: Returns the result object.
788
+ """ # noqa: E501
789
+
790
+ _param = self._summa_serialize(
791
+ dataset=dataset,
792
+ entity=entity,
793
+ user=user,
794
+ top_k=top_k,
795
+ language=language,
796
+ q_answer_api_key=q_answer_api_key,
797
+ _request_auth=_request_auth,
798
+ _content_type=_content_type,
799
+ _headers=_headers,
800
+ _host_index=_host_index
801
+ )
802
+
803
+ _response_types_map: Dict[str, Optional[str]] = {
804
+ '200': "SummaServer",
805
+ '422': "HTTPValidationError",
806
+ }
807
+ response_data = self.api_client.call_api(
808
+ *_param,
809
+ _request_timeout=_request_timeout
810
+ )
811
+ response_data.read()
812
+ return self.api_client.response_deserialize(
813
+ response_data=response_data,
814
+ response_types_map=_response_types_map,
815
+ ).data
816
+
817
+
818
+ @validate_call
819
+ def summa_with_http_info(
820
+ self,
821
+ dataset: StrictStr,
822
+ entity: StrictStr,
823
+ user: StrictStr,
824
+ top_k: Optional[StrictInt] = None,
825
+ language: Optional[StrictStr] = None,
826
+ q_answer_api_key: Annotated[Optional[StrictStr], Field(description="Optional QAnswer API key")] = None,
827
+ _request_timeout: Union[
828
+ None,
829
+ Annotated[StrictFloat, Field(gt=0)],
830
+ Tuple[
831
+ Annotated[StrictFloat, Field(gt=0)],
832
+ Annotated[StrictFloat, Field(gt=0)]
833
+ ]
834
+ ] = None,
835
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
836
+ _content_type: Optional[StrictStr] = None,
837
+ _headers: Optional[Dict[StrictStr, Any]] = None,
838
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
839
+ ) -> ApiResponse[SummaServer]:
840
+ """Generates summaries, i.e. most relevant top-k properties, for an item in a dataset
841
+
842
+
843
+ :param dataset: (required)
844
+ :type dataset: str
845
+ :param entity: (required)
846
+ :type entity: str
847
+ :param user: (required)
848
+ :type user: str
849
+ :param top_k:
850
+ :type top_k: int
851
+ :param language:
852
+ :type language: str
853
+ :param q_answer_api_key: Optional QAnswer API key
854
+ :type q_answer_api_key: str
855
+ :param _request_timeout: timeout setting for this request. If one
856
+ number provided, it will be total request
857
+ timeout. It can also be a pair (tuple) of
858
+ (connection, read) timeouts.
859
+ :type _request_timeout: int, tuple(int, int), optional
860
+ :param _request_auth: set to override the auth_settings for an a single
861
+ request; this effectively ignores the
862
+ authentication in the spec for a single request.
863
+ :type _request_auth: dict, optional
864
+ :param _content_type: force content-type for the request.
865
+ :type _content_type: str, Optional
866
+ :param _headers: set to override the headers for a single
867
+ request; this effectively ignores the headers
868
+ in the spec for a single request.
869
+ :type _headers: dict, optional
870
+ :param _host_index: set to override the host_index for a single
871
+ request; this effectively ignores the host_index
872
+ in the spec for a single request.
873
+ :type _host_index: int, optional
874
+ :return: Returns the result object.
875
+ """ # noqa: E501
876
+
877
+ _param = self._summa_serialize(
878
+ dataset=dataset,
879
+ entity=entity,
880
+ user=user,
881
+ top_k=top_k,
882
+ language=language,
883
+ q_answer_api_key=q_answer_api_key,
884
+ _request_auth=_request_auth,
885
+ _content_type=_content_type,
886
+ _headers=_headers,
887
+ _host_index=_host_index
888
+ )
889
+
890
+ _response_types_map: Dict[str, Optional[str]] = {
891
+ '200': "SummaServer",
892
+ '422': "HTTPValidationError",
893
+ }
894
+ response_data = self.api_client.call_api(
895
+ *_param,
896
+ _request_timeout=_request_timeout
897
+ )
898
+ response_data.read()
899
+ return self.api_client.response_deserialize(
900
+ response_data=response_data,
901
+ response_types_map=_response_types_map,
902
+ )
903
+
904
+
905
+ @validate_call
906
+ def summa_without_preload_content(
907
+ self,
908
+ dataset: StrictStr,
909
+ entity: StrictStr,
910
+ user: StrictStr,
911
+ top_k: Optional[StrictInt] = None,
912
+ language: Optional[StrictStr] = None,
913
+ q_answer_api_key: Annotated[Optional[StrictStr], Field(description="Optional QAnswer API key")] = None,
914
+ _request_timeout: Union[
915
+ None,
916
+ Annotated[StrictFloat, Field(gt=0)],
917
+ Tuple[
918
+ Annotated[StrictFloat, Field(gt=0)],
919
+ Annotated[StrictFloat, Field(gt=0)]
920
+ ]
921
+ ] = None,
922
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
923
+ _content_type: Optional[StrictStr] = None,
924
+ _headers: Optional[Dict[StrictStr, Any]] = None,
925
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
926
+ ) -> RESTResponseType:
927
+ """Generates summaries, i.e. most relevant top-k properties, for an item in a dataset
928
+
929
+
930
+ :param dataset: (required)
931
+ :type dataset: str
932
+ :param entity: (required)
933
+ :type entity: str
934
+ :param user: (required)
935
+ :type user: str
936
+ :param top_k:
937
+ :type top_k: int
938
+ :param language:
939
+ :type language: str
940
+ :param q_answer_api_key: Optional QAnswer API key
941
+ :type q_answer_api_key: str
942
+ :param _request_timeout: timeout setting for this request. If one
943
+ number provided, it will be total request
944
+ timeout. It can also be a pair (tuple) of
945
+ (connection, read) timeouts.
946
+ :type _request_timeout: int, tuple(int, int), optional
947
+ :param _request_auth: set to override the auth_settings for an a single
948
+ request; this effectively ignores the
949
+ authentication in the spec for a single request.
950
+ :type _request_auth: dict, optional
951
+ :param _content_type: force content-type for the request.
952
+ :type _content_type: str, Optional
953
+ :param _headers: set to override the headers for a single
954
+ request; this effectively ignores the headers
955
+ in the spec for a single request.
956
+ :type _headers: dict, optional
957
+ :param _host_index: set to override the host_index for a single
958
+ request; this effectively ignores the host_index
959
+ in the spec for a single request.
960
+ :type _host_index: int, optional
961
+ :return: Returns the result object.
962
+ """ # noqa: E501
963
+
964
+ _param = self._summa_serialize(
965
+ dataset=dataset,
966
+ entity=entity,
967
+ user=user,
968
+ top_k=top_k,
969
+ language=language,
970
+ q_answer_api_key=q_answer_api_key,
971
+ _request_auth=_request_auth,
972
+ _content_type=_content_type,
973
+ _headers=_headers,
974
+ _host_index=_host_index
975
+ )
976
+
977
+ _response_types_map: Dict[str, Optional[str]] = {
978
+ '200': "SummaServer",
979
+ '422': "HTTPValidationError",
980
+ }
981
+ response_data = self.api_client.call_api(
982
+ *_param,
983
+ _request_timeout=_request_timeout
984
+ )
985
+ return response_data.response
986
+
987
+
988
+ def _summa_serialize(
989
+ self,
990
+ dataset,
991
+ entity,
992
+ user,
993
+ top_k,
994
+ language,
995
+ q_answer_api_key,
996
+ _request_auth,
997
+ _content_type,
998
+ _headers,
999
+ _host_index,
1000
+ ) -> RequestSerialized:
1001
+
1002
+ _host = None
1003
+
1004
+ _collection_formats: Dict[str, str] = {
1005
+ }
1006
+
1007
+ _path_params: Dict[str, str] = {}
1008
+ _query_params: List[Tuple[str, str]] = []
1009
+ _header_params: Dict[str, Optional[str]] = _headers or {}
1010
+ _form_params: List[Tuple[str, str]] = []
1011
+ _files: Dict[
1012
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
1013
+ ] = {}
1014
+ _body_params: Optional[bytes] = None
1015
+
1016
+ # process the path parameters
1017
+ if dataset is not None:
1018
+ _path_params['dataset'] = dataset
1019
+ # process the query parameters
1020
+ if entity is not None:
1021
+
1022
+ _query_params.append(('entity', entity))
1023
+
1024
+ if user is not None:
1025
+
1026
+ _query_params.append(('user', user))
1027
+
1028
+ if top_k is not None:
1029
+
1030
+ _query_params.append(('topK', top_k))
1031
+
1032
+ if language is not None:
1033
+
1034
+ _query_params.append(('language', language))
1035
+
1036
+ # process the header parameters
1037
+ if q_answer_api_key is not None:
1038
+ _header_params['QAnswer-Api-Key'] = q_answer_api_key
1039
+ # process the form parameters
1040
+ # process the body parameter
1041
+
1042
+
1043
+ # set the HTTP header `Accept`
1044
+ if 'Accept' not in _header_params:
1045
+ _header_params['Accept'] = self.api_client.select_header_accept(
1046
+ [
1047
+ 'application/json'
1048
+ ]
1049
+ )
1050
+
1051
+
1052
+ # authentication setting
1053
+ _auth_settings: List[str] = [
1054
+ 'QAnswer-Api-Key',
1055
+ 'Bearer token'
1056
+ ]
1057
+
1058
+ return self.api_client.param_serialize(
1059
+ method='GET',
1060
+ resource_path='/api/connectors/rdf/answer/summaserver/{dataset}',
1061
+ path_params=_path_params,
1062
+ query_params=_query_params,
1063
+ header_params=_header_params,
1064
+ body=_body_params,
1065
+ post_params=_form_params,
1066
+ files=_files,
1067
+ auth_settings=_auth_settings,
1068
+ collection_formats=_collection_formats,
1069
+ _host=_host,
1070
+ _request_auth=_request_auth
1071
+ )
1072
+
1073
+
1074
+
1075
+
1076
+ @validate_call
1077
+ def table_context(
1078
+ self,
1079
+ sparql_query: StrictStr,
1080
+ lang: Optional[StrictStr] = None,
1081
+ kb: Optional[StrictStr] = None,
1082
+ limit: Optional[StrictInt] = None,
1083
+ offset: Optional[StrictInt] = None,
1084
+ username: Optional[StrictStr] = None,
1085
+ timeout: Optional[StrictInt] = None,
1086
+ q_answer_api_key: Annotated[Optional[StrictStr], Field(description="Optional QAnswer API key")] = None,
1087
+ _request_timeout: Union[
1088
+ None,
1089
+ Annotated[StrictFloat, Field(gt=0)],
1090
+ Tuple[
1091
+ Annotated[StrictFloat, Field(gt=0)],
1092
+ Annotated[StrictFloat, Field(gt=0)]
1093
+ ]
1094
+ ] = None,
1095
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1096
+ _content_type: Optional[StrictStr] = None,
1097
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1098
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1099
+ ) -> object:
1100
+ """Given a SPARQL query returns the information about the answer entities in the form of a table.
1101
+
1102
+
1103
+ :param sparql_query: (required)
1104
+ :type sparql_query: str
1105
+ :param lang:
1106
+ :type lang: str
1107
+ :param kb:
1108
+ :type kb: str
1109
+ :param limit:
1110
+ :type limit: int
1111
+ :param offset:
1112
+ :type offset: int
1113
+ :param username:
1114
+ :type username: str
1115
+ :param timeout:
1116
+ :type timeout: int
1117
+ :param q_answer_api_key: Optional QAnswer API key
1118
+ :type q_answer_api_key: str
1119
+ :param _request_timeout: timeout setting for this request. If one
1120
+ number provided, it will be total request
1121
+ timeout. It can also be a pair (tuple) of
1122
+ (connection, read) timeouts.
1123
+ :type _request_timeout: int, tuple(int, int), optional
1124
+ :param _request_auth: set to override the auth_settings for an a single
1125
+ request; this effectively ignores the
1126
+ authentication in the spec for a single request.
1127
+ :type _request_auth: dict, optional
1128
+ :param _content_type: force content-type for the request.
1129
+ :type _content_type: str, Optional
1130
+ :param _headers: set to override the headers for a single
1131
+ request; this effectively ignores the headers
1132
+ in the spec for a single request.
1133
+ :type _headers: dict, optional
1134
+ :param _host_index: set to override the host_index for a single
1135
+ request; this effectively ignores the host_index
1136
+ in the spec for a single request.
1137
+ :type _host_index: int, optional
1138
+ :return: Returns the result object.
1139
+ """ # noqa: E501
1140
+
1141
+ _param = self._table_context_serialize(
1142
+ sparql_query=sparql_query,
1143
+ lang=lang,
1144
+ kb=kb,
1145
+ limit=limit,
1146
+ offset=offset,
1147
+ username=username,
1148
+ timeout=timeout,
1149
+ q_answer_api_key=q_answer_api_key,
1150
+ _request_auth=_request_auth,
1151
+ _content_type=_content_type,
1152
+ _headers=_headers,
1153
+ _host_index=_host_index
1154
+ )
1155
+
1156
+ _response_types_map: Dict[str, Optional[str]] = {
1157
+ '200': "object",
1158
+ '422': "HTTPValidationError",
1159
+ }
1160
+ response_data = self.api_client.call_api(
1161
+ *_param,
1162
+ _request_timeout=_request_timeout
1163
+ )
1164
+ response_data.read()
1165
+ return self.api_client.response_deserialize(
1166
+ response_data=response_data,
1167
+ response_types_map=_response_types_map,
1168
+ ).data
1169
+
1170
+
1171
+ @validate_call
1172
+ def table_context_with_http_info(
1173
+ self,
1174
+ sparql_query: StrictStr,
1175
+ lang: Optional[StrictStr] = None,
1176
+ kb: Optional[StrictStr] = None,
1177
+ limit: Optional[StrictInt] = None,
1178
+ offset: Optional[StrictInt] = None,
1179
+ username: Optional[StrictStr] = None,
1180
+ timeout: Optional[StrictInt] = None,
1181
+ q_answer_api_key: Annotated[Optional[StrictStr], Field(description="Optional QAnswer API key")] = None,
1182
+ _request_timeout: Union[
1183
+ None,
1184
+ Annotated[StrictFloat, Field(gt=0)],
1185
+ Tuple[
1186
+ Annotated[StrictFloat, Field(gt=0)],
1187
+ Annotated[StrictFloat, Field(gt=0)]
1188
+ ]
1189
+ ] = None,
1190
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1191
+ _content_type: Optional[StrictStr] = None,
1192
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1193
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1194
+ ) -> ApiResponse[object]:
1195
+ """Given a SPARQL query returns the information about the answer entities in the form of a table.
1196
+
1197
+
1198
+ :param sparql_query: (required)
1199
+ :type sparql_query: str
1200
+ :param lang:
1201
+ :type lang: str
1202
+ :param kb:
1203
+ :type kb: str
1204
+ :param limit:
1205
+ :type limit: int
1206
+ :param offset:
1207
+ :type offset: int
1208
+ :param username:
1209
+ :type username: str
1210
+ :param timeout:
1211
+ :type timeout: int
1212
+ :param q_answer_api_key: Optional QAnswer API key
1213
+ :type q_answer_api_key: str
1214
+ :param _request_timeout: timeout setting for this request. If one
1215
+ number provided, it will be total request
1216
+ timeout. It can also be a pair (tuple) of
1217
+ (connection, read) timeouts.
1218
+ :type _request_timeout: int, tuple(int, int), optional
1219
+ :param _request_auth: set to override the auth_settings for an a single
1220
+ request; this effectively ignores the
1221
+ authentication in the spec for a single request.
1222
+ :type _request_auth: dict, optional
1223
+ :param _content_type: force content-type for the request.
1224
+ :type _content_type: str, Optional
1225
+ :param _headers: set to override the headers for a single
1226
+ request; this effectively ignores the headers
1227
+ in the spec for a single request.
1228
+ :type _headers: dict, optional
1229
+ :param _host_index: set to override the host_index for a single
1230
+ request; this effectively ignores the host_index
1231
+ in the spec for a single request.
1232
+ :type _host_index: int, optional
1233
+ :return: Returns the result object.
1234
+ """ # noqa: E501
1235
+
1236
+ _param = self._table_context_serialize(
1237
+ sparql_query=sparql_query,
1238
+ lang=lang,
1239
+ kb=kb,
1240
+ limit=limit,
1241
+ offset=offset,
1242
+ username=username,
1243
+ timeout=timeout,
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': "object",
1253
+ '422': "HTTPValidationError",
1254
+ }
1255
+ response_data = self.api_client.call_api(
1256
+ *_param,
1257
+ _request_timeout=_request_timeout
1258
+ )
1259
+ response_data.read()
1260
+ return self.api_client.response_deserialize(
1261
+ response_data=response_data,
1262
+ response_types_map=_response_types_map,
1263
+ )
1264
+
1265
+
1266
+ @validate_call
1267
+ def table_context_without_preload_content(
1268
+ self,
1269
+ sparql_query: StrictStr,
1270
+ lang: Optional[StrictStr] = None,
1271
+ kb: Optional[StrictStr] = None,
1272
+ limit: Optional[StrictInt] = None,
1273
+ offset: Optional[StrictInt] = None,
1274
+ username: Optional[StrictStr] = None,
1275
+ timeout: Optional[StrictInt] = None,
1276
+ q_answer_api_key: Annotated[Optional[StrictStr], Field(description="Optional QAnswer API key")] = None,
1277
+ _request_timeout: Union[
1278
+ None,
1279
+ Annotated[StrictFloat, Field(gt=0)],
1280
+ Tuple[
1281
+ Annotated[StrictFloat, Field(gt=0)],
1282
+ Annotated[StrictFloat, Field(gt=0)]
1283
+ ]
1284
+ ] = None,
1285
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1286
+ _content_type: Optional[StrictStr] = None,
1287
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1288
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1289
+ ) -> RESTResponseType:
1290
+ """Given a SPARQL query returns the information about the answer entities in the form of a table.
1291
+
1292
+
1293
+ :param sparql_query: (required)
1294
+ :type sparql_query: str
1295
+ :param lang:
1296
+ :type lang: str
1297
+ :param kb:
1298
+ :type kb: str
1299
+ :param limit:
1300
+ :type limit: int
1301
+ :param offset:
1302
+ :type offset: int
1303
+ :param username:
1304
+ :type username: str
1305
+ :param timeout:
1306
+ :type timeout: int
1307
+ :param q_answer_api_key: Optional QAnswer API key
1308
+ :type q_answer_api_key: str
1309
+ :param _request_timeout: timeout setting for this request. If one
1310
+ number provided, it will be total request
1311
+ timeout. It can also be a pair (tuple) of
1312
+ (connection, read) timeouts.
1313
+ :type _request_timeout: int, tuple(int, int), optional
1314
+ :param _request_auth: set to override the auth_settings for an a single
1315
+ request; this effectively ignores the
1316
+ authentication in the spec for a single request.
1317
+ :type _request_auth: dict, optional
1318
+ :param _content_type: force content-type for the request.
1319
+ :type _content_type: str, Optional
1320
+ :param _headers: set to override the headers for a single
1321
+ request; this effectively ignores the headers
1322
+ in the spec for a single request.
1323
+ :type _headers: dict, optional
1324
+ :param _host_index: set to override the host_index for a single
1325
+ request; this effectively ignores the host_index
1326
+ in the spec for a single request.
1327
+ :type _host_index: int, optional
1328
+ :return: Returns the result object.
1329
+ """ # noqa: E501
1330
+
1331
+ _param = self._table_context_serialize(
1332
+ sparql_query=sparql_query,
1333
+ lang=lang,
1334
+ kb=kb,
1335
+ limit=limit,
1336
+ offset=offset,
1337
+ username=username,
1338
+ timeout=timeout,
1339
+ q_answer_api_key=q_answer_api_key,
1340
+ _request_auth=_request_auth,
1341
+ _content_type=_content_type,
1342
+ _headers=_headers,
1343
+ _host_index=_host_index
1344
+ )
1345
+
1346
+ _response_types_map: Dict[str, Optional[str]] = {
1347
+ '200': "object",
1348
+ '422': "HTTPValidationError",
1349
+ }
1350
+ response_data = self.api_client.call_api(
1351
+ *_param,
1352
+ _request_timeout=_request_timeout
1353
+ )
1354
+ return response_data.response
1355
+
1356
+
1357
+ def _table_context_serialize(
1358
+ self,
1359
+ sparql_query,
1360
+ lang,
1361
+ kb,
1362
+ limit,
1363
+ offset,
1364
+ username,
1365
+ timeout,
1366
+ q_answer_api_key,
1367
+ _request_auth,
1368
+ _content_type,
1369
+ _headers,
1370
+ _host_index,
1371
+ ) -> RequestSerialized:
1372
+
1373
+ _host = None
1374
+
1375
+ _collection_formats: Dict[str, str] = {
1376
+ }
1377
+
1378
+ _path_params: Dict[str, str] = {}
1379
+ _query_params: List[Tuple[str, str]] = []
1380
+ _header_params: Dict[str, Optional[str]] = _headers or {}
1381
+ _form_params: List[Tuple[str, str]] = []
1382
+ _files: Dict[
1383
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
1384
+ ] = {}
1385
+ _body_params: Optional[bytes] = None
1386
+
1387
+ # process the path parameters
1388
+ # process the query parameters
1389
+ if lang is not None:
1390
+
1391
+ _query_params.append(('lang', lang))
1392
+
1393
+ if kb is not None:
1394
+
1395
+ _query_params.append(('kb', kb))
1396
+
1397
+ if sparql_query is not None:
1398
+
1399
+ _query_params.append(('sparqlQuery', sparql_query))
1400
+
1401
+ if limit is not None:
1402
+
1403
+ _query_params.append(('limit', limit))
1404
+
1405
+ if offset is not None:
1406
+
1407
+ _query_params.append(('offset', offset))
1408
+
1409
+ if username is not None:
1410
+
1411
+ _query_params.append(('username', username))
1412
+
1413
+ if timeout is not None:
1414
+
1415
+ _query_params.append(('timeout', timeout))
1416
+
1417
+ # process the header parameters
1418
+ if q_answer_api_key is not None:
1419
+ _header_params['QAnswer-Api-Key'] = q_answer_api_key
1420
+ # process the form parameters
1421
+ # process the body parameter
1422
+
1423
+
1424
+ # set the HTTP header `Accept`
1425
+ if 'Accept' not in _header_params:
1426
+ _header_params['Accept'] = self.api_client.select_header_accept(
1427
+ [
1428
+ 'application/json'
1429
+ ]
1430
+ )
1431
+
1432
+
1433
+ # authentication setting
1434
+ _auth_settings: List[str] = [
1435
+ 'QAnswer-Api-Key',
1436
+ 'Bearer token'
1437
+ ]
1438
+
1439
+ return self.api_client.param_serialize(
1440
+ method='GET',
1441
+ resource_path='/api/connectors/rdf/answer/table',
1442
+ path_params=_path_params,
1443
+ query_params=_query_params,
1444
+ header_params=_header_params,
1445
+ body=_body_params,
1446
+ post_params=_form_params,
1447
+ files=_files,
1448
+ auth_settings=_auth_settings,
1449
+ collection_formats=_collection_formats,
1450
+ _host=_host,
1451
+ _request_auth=_request_auth
1452
+ )
1453
+
1454
+