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