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

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