qanswer_sdk 3.1193.0__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (346) hide show
  1. qanswer_sdk/__init__.py +366 -0
  2. qanswer_sdk/api/__init__.py +47 -0
  3. qanswer_sdk/api/admin_api.py +11207 -0
  4. qanswer_sdk/api/ai_assistant_access_rights_api.py +5331 -0
  5. qanswer_sdk/api/ai_assistant_api.py +4377 -0
  6. qanswer_sdk/api/bot_slack_api.py +814 -0
  7. qanswer_sdk/api/chat_completion_api.py +309 -0
  8. qanswer_sdk/api/chatbot_api.py +1091 -0
  9. qanswer_sdk/api/connector_document_api.py +1406 -0
  10. qanswer_sdk/api/connector_e_consilium_api.py +326 -0
  11. qanswer_sdk/api/connector_e_consilium_search_index_connector_api.py +1215 -0
  12. qanswer_sdk/api/connector_google_drive_api.py +1870 -0
  13. qanswer_sdk/api/connector_one_drive_api.py +1559 -0
  14. qanswer_sdk/api/connector_onenote_api.py +1576 -0
  15. qanswer_sdk/api/connector_pinecone_api.py +892 -0
  16. qanswer_sdk/api/connector_publication_office_controller_api.py +1215 -0
  17. qanswer_sdk/api/connector_qn_a_api.py +1538 -0
  18. qanswer_sdk/api/connector_rdf_answer_api.py +1445 -0
  19. qanswer_sdk/api/connector_rdf_api.py +5318 -0
  20. qanswer_sdk/api/connector_sharepoint_api.py +2584 -0
  21. qanswer_sdk/api/connector_websearch_api.py +326 -0
  22. qanswer_sdk/api/connector_website_api.py +2068 -0
  23. qanswer_sdk/api/connectors_api.py +1497 -0
  24. qanswer_sdk/api/connectors_data_api.py +3697 -0
  25. qanswer_sdk/api/conversation_logs_api.py +6668 -0
  26. qanswer_sdk/api/dataset_config_api.py +2178 -0
  27. qanswer_sdk/api/debug_api.py +282 -0
  28. qanswer_sdk/api/llm_api.py +563 -0
  29. qanswer_sdk/api/llm_consumption_controller_api.py +310 -0
  30. qanswer_sdk/api/organizations_teams_api.py +8465 -0
  31. qanswer_sdk/api/payment_api.py +1546 -0
  32. qanswer_sdk/api/socket_api.py +2975 -0
  33. qanswer_sdk/api/speech_to_text_api.py +734 -0
  34. qanswer_sdk/api/tag_api.py +2396 -0
  35. qanswer_sdk/api/task_chat_api.py +2064 -0
  36. qanswer_sdk/api/task_rdf_linker_api.py +4382 -0
  37. qanswer_sdk/api/task_rdf_sparql_endpoint_api.py +3522 -0
  38. qanswer_sdk/api/task_rdf_text_linker_api.py +1346 -0
  39. qanswer_sdk/api/task_relation_extraction_api.py +2977 -0
  40. qanswer_sdk/api/task_report_copilot_api.py +2980 -0
  41. qanswer_sdk/api/task_search_api.py +1784 -0
  42. qanswer_sdk/api/task_sparql2text_api.py +326 -0
  43. qanswer_sdk/api/task_text2sparql_api.py +908 -0
  44. qanswer_sdk/api/task_text_classification_api.py +914 -0
  45. qanswer_sdk/api/user_api.py +7098 -0
  46. qanswer_sdk/api_client.py +797 -0
  47. qanswer_sdk/api_response.py +21 -0
  48. qanswer_sdk/configuration.py +487 -0
  49. qanswer_sdk/exceptions.py +199 -0
  50. qanswer_sdk/models/__init__.py +307 -0
  51. qanswer_sdk/models/access_pdf_payload_model.py +109 -0
  52. qanswer_sdk/models/add_qn_a_request.py +103 -0
  53. qanswer_sdk/models/add_synonyms.py +91 -0
  54. qanswer_sdk/models/add_synonyms_resp.py +89 -0
  55. qanswer_sdk/models/aggregate.py +97 -0
  56. qanswer_sdk/models/aggregation.py +112 -0
  57. qanswer_sdk/models/aggregations_group.py +102 -0
  58. qanswer_sdk/models/ai_assistant_dto.py +103 -0
  59. qanswer_sdk/models/ai_assistant_shared_access.py +113 -0
  60. qanswer_sdk/models/allowed_file_extensions.py +98 -0
  61. qanswer_sdk/models/api_response.py +87 -0
  62. qanswer_sdk/models/applied_metadata_filter.py +98 -0
  63. qanswer_sdk/models/assistant_message_stop.py +93 -0
  64. qanswer_sdk/models/auth_link_response.py +91 -0
  65. qanswer_sdk/models/autocompletion_config.py +93 -0
  66. qanswer_sdk/models/available_connectors_response.py +99 -0
  67. qanswer_sdk/models/available_embedding_models_response.py +95 -0
  68. qanswer_sdk/models/available_endpoints_response.py +95 -0
  69. qanswer_sdk/models/available_logs_visibility_policy.py +103 -0
  70. qanswer_sdk/models/available_space_quota_for_dataset.py +91 -0
  71. qanswer_sdk/models/available_storage_preference.py +103 -0
  72. qanswer_sdk/models/base_connectors_response.py +89 -0
  73. qanswer_sdk/models/base_conversation_response.py +89 -0
  74. qanswer_sdk/models/base_feedback_response.py +89 -0
  75. qanswer_sdk/models/branding_data.py +87 -0
  76. qanswer_sdk/models/cell.py +89 -0
  77. qanswer_sdk/models/change_password.py +89 -0
  78. qanswer_sdk/models/change_password_admin.py +89 -0
  79. qanswer_sdk/models/change_role.py +96 -0
  80. qanswer_sdk/models/chat_task_settings.py +135 -0
  81. qanswer_sdk/models/chat_task_settings_update_payload.py +95 -0
  82. qanswer_sdk/models/chat_task_update.py +129 -0
  83. qanswer_sdk/models/chatbot_chat_payload.py +115 -0
  84. qanswer_sdk/models/chatbot_conversation_model.py +141 -0
  85. qanswer_sdk/models/chatbot_response.py +119 -0
  86. qanswer_sdk/models/check_mode_response.py +100 -0
  87. qanswer_sdk/models/class_info.py +89 -0
  88. qanswer_sdk/models/connector_model.py +112 -0
  89. qanswer_sdk/models/content_item.py +130 -0
  90. qanswer_sdk/models/conversation_message.py +186 -0
  91. qanswer_sdk/models/conversation_model.py +131 -0
  92. qanswer_sdk/models/conversation_statistics.py +95 -0
  93. qanswer_sdk/models/conversation_update.py +93 -0
  94. qanswer_sdk/models/conversation_users_stats.py +99 -0
  95. qanswer_sdk/models/conversation_users_stats_response.py +99 -0
  96. qanswer_sdk/models/coordinates.py +89 -0
  97. qanswer_sdk/models/cost_summary.py +99 -0
  98. qanswer_sdk/models/create_connector_request.py +93 -0
  99. qanswer_sdk/models/create_connector_response.py +95 -0
  100. qanswer_sdk/models/create_pinecone_connector_request.py +95 -0
  101. qanswer_sdk/models/create_sharepoint_connector_from_certificate_request.py +103 -0
  102. qanswer_sdk/models/create_sharepoint_connector_request.py +101 -0
  103. qanswer_sdk/models/dataset_config_request.py +187 -0
  104. qanswer_sdk/models/dataset_default_values_model.py +141 -0
  105. qanswer_sdk/models/dataset_description.py +91 -0
  106. qanswer_sdk/models/dataset_detail.py +133 -0
  107. qanswer_sdk/models/dataset_detail_kg.py +158 -0
  108. qanswer_sdk/models/dataset_schema.py +207 -0
  109. qanswer_sdk/models/dataset_update_object.py +195 -0
  110. qanswer_sdk/models/dataset_users_response.py +87 -0
  111. qanswer_sdk/models/default_prompt.py +106 -0
  112. qanswer_sdk/models/delete_connector_model.py +96 -0
  113. qanswer_sdk/models/delete_connector_request.py +99 -0
  114. qanswer_sdk/models/delete_connectors_response.py +91 -0
  115. qanswer_sdk/models/delete_qn_a_pair_request.py +95 -0
  116. qanswer_sdk/models/delete_qn_a_pair_response.py +89 -0
  117. qanswer_sdk/models/delete_synonym.py +91 -0
  118. qanswer_sdk/models/delete_synonym_resp.py +89 -0
  119. qanswer_sdk/models/diarization_segment.py +93 -0
  120. qanswer_sdk/models/document_content_response.py +91 -0
  121. qanswer_sdk/models/document_content_update_model.py +95 -0
  122. qanswer_sdk/models/document_file_delete_by_connector_model.py +99 -0
  123. qanswer_sdk/models/document_metadata.py +107 -0
  124. qanswer_sdk/models/document_metadata_list_wrapper.py +95 -0
  125. qanswer_sdk/models/document_status_response.py +89 -0
  126. qanswer_sdk/models/e_consilium_search_index_search_response.py +113 -0
  127. qanswer_sdk/models/econsilium_file_metadata.py +105 -0
  128. qanswer_sdk/models/econsilium_search_index_add_payload.py +105 -0
  129. qanswer_sdk/models/econsilium_search_index_additional_fields.py +101 -0
  130. qanswer_sdk/models/email_request.py +87 -0
  131. qanswer_sdk/models/embedding_endpoint.py +139 -0
  132. qanswer_sdk/models/embedding_endpoint_create.py +137 -0
  133. qanswer_sdk/models/embedding_endpoint_update.py +131 -0
  134. qanswer_sdk/models/embedding_endpoint_validation_response.py +96 -0
  135. qanswer_sdk/models/embedding_model.py +96 -0
  136. qanswer_sdk/models/entity.py +97 -0
  137. qanswer_sdk/models/entity_linker_response.py +99 -0
  138. qanswer_sdk/models/entity_model.py +99 -0
  139. qanswer_sdk/models/extra_body.py +91 -0
  140. qanswer_sdk/models/extract_hyper_links_payload.py +102 -0
  141. qanswer_sdk/models/extract_robot_links_payload.py +88 -0
  142. qanswer_sdk/models/extract_robot_links_response.py +88 -0
  143. qanswer_sdk/models/fact.py +96 -0
  144. qanswer_sdk/models/feedback_model.py +107 -0
  145. qanswer_sdk/models/feedback_update.py +103 -0
  146. qanswer_sdk/models/file_es_meta_data.py +89 -0
  147. qanswer_sdk/models/file_folder_model.py +113 -0
  148. qanswer_sdk/models/file_model.py +134 -0
  149. qanswer_sdk/models/files_by_connector_model.py +89 -0
  150. qanswer_sdk/models/format_return.py +87 -0
  151. qanswer_sdk/models/g_drive_connector_info.py +95 -0
  152. qanswer_sdk/models/g_drive_download_by_ids.py +89 -0
  153. qanswer_sdk/models/g_drive_download_request.py +101 -0
  154. qanswer_sdk/models/generation_params.py +89 -0
  155. qanswer_sdk/models/get_connector_by_id_response.py +91 -0
  156. qanswer_sdk/models/get_conversation_response.py +95 -0
  157. qanswer_sdk/models/guardrail_endpoint.py +121 -0
  158. qanswer_sdk/models/has_lucene_index_result.py +87 -0
  159. qanswer_sdk/models/index_config.py +95 -0
  160. qanswer_sdk/models/install_response.py +89 -0
  161. qanswer_sdk/models/is_enabled_response.py +87 -0
  162. qanswer_sdk/models/is_merging_result.py +87 -0
  163. qanswer_sdk/models/json_nullable_file_failure_reason.py +87 -0
  164. qanswer_sdk/models/json_nullable_source_metadata.py +87 -0
  165. qanswer_sdk/models/jwt_authentication_response.py +93 -0
  166. qanswer_sdk/models/label.py +89 -0
  167. qanswer_sdk/models/labeled_node.py +89 -0
  168. qanswer_sdk/models/link.py +103 -0
  169. qanswer_sdk/models/link_extraction_response.py +97 -0
  170. qanswer_sdk/models/link_result_paginated.py +97 -0
  171. qanswer_sdk/models/linker.py +103 -0
  172. qanswer_sdk/models/linking_result.py +95 -0
  173. qanswer_sdk/models/links.py +99 -0
  174. qanswer_sdk/models/list_chatbot_conversation_response.py +105 -0
  175. qanswer_sdk/models/list_connectors_response.py +95 -0
  176. qanswer_sdk/models/list_conversation_response.py +105 -0
  177. qanswer_sdk/models/list_feedback_response.py +105 -0
  178. qanswer_sdk/models/list_files_connector_response.py +101 -0
  179. qanswer_sdk/models/list_socket_events.py +95 -0
  180. qanswer_sdk/models/list_synonyms_model.py +89 -0
  181. qanswer_sdk/models/llm_context_ranges_response.py +93 -0
  182. qanswer_sdk/models/llm_cost.py +108 -0
  183. qanswer_sdk/models/llm_details.py +111 -0
  184. qanswer_sdk/models/llm_endpoint.py +167 -0
  185. qanswer_sdk/models/llm_endpoint_create.py +165 -0
  186. qanswer_sdk/models/llm_endpoint_default_prompts.py +93 -0
  187. qanswer_sdk/models/llm_endpoint_update.py +163 -0
  188. qanswer_sdk/models/llm_endpoint_validation_response.py +96 -0
  189. qanswer_sdk/models/login_request.py +89 -0
  190. qanswer_sdk/models/logo.py +89 -0
  191. qanswer_sdk/models/lucene_index_request_result.py +87 -0
  192. qanswer_sdk/models/merge_request_result.py +87 -0
  193. qanswer_sdk/models/messages_stats_per_day_response.py +99 -0
  194. qanswer_sdk/models/modify_connector_request.py +111 -0
  195. qanswer_sdk/models/o_auth_service.py +89 -0
  196. qanswer_sdk/models/one_drive_download_by_ids.py +89 -0
  197. qanswer_sdk/models/one_drive_download_request.py +101 -0
  198. qanswer_sdk/models/one_note_download_by_ids.py +91 -0
  199. qanswer_sdk/models/one_note_download_request.py +101 -0
  200. qanswer_sdk/models/organization.py +93 -0
  201. qanswer_sdk/models/organization_creation.py +91 -0
  202. qanswer_sdk/models/organization_filter.py +87 -0
  203. qanswer_sdk/models/organization_shared.py +105 -0
  204. qanswer_sdk/models/page_organization.py +123 -0
  205. qanswer_sdk/models/page_team_with_count.py +123 -0
  206. qanswer_sdk/models/pageable.py +92 -0
  207. qanswer_sdk/models/pageable_object.py +101 -0
  208. qanswer_sdk/models/password.py +89 -0
  209. qanswer_sdk/models/pinecone_index_model.py +91 -0
  210. qanswer_sdk/models/plan.py +123 -0
  211. qanswer_sdk/models/predicted_class.py +89 -0
  212. qanswer_sdk/models/prompt_token_count_details.py +99 -0
  213. qanswer_sdk/models/provider.py +87 -0
  214. qanswer_sdk/models/publication_add_payload.py +103 -0
  215. qanswer_sdk/models/publication_file_metadata.py +105 -0
  216. qanswer_sdk/models/publication_office_additional_fields.py +111 -0
  217. qanswer_sdk/models/publication_search_index_search_response.py +113 -0
  218. qanswer_sdk/models/qa_context.py +129 -0
  219. qanswer_sdk/models/qa_contexts.py +116 -0
  220. qanswer_sdk/models/qa_metadata_payload.py +123 -0
  221. qanswer_sdk/models/qa_table.py +102 -0
  222. qanswer_sdk/models/qn_a_pair_model.py +103 -0
  223. qanswer_sdk/models/qn_a_pair_response.py +95 -0
  224. qanswer_sdk/models/question_completion.py +89 -0
  225. qanswer_sdk/models/rag_params.py +89 -0
  226. qanswer_sdk/models/rag_payload.py +154 -0
  227. qanswer_sdk/models/rag_response.py +150 -0
  228. qanswer_sdk/models/ranker_config.py +93 -0
  229. qanswer_sdk/models/reference_model.py +95 -0
  230. qanswer_sdk/models/refresh_token_request.py +87 -0
  231. qanswer_sdk/models/refresh_website_connector_payload.py +94 -0
  232. qanswer_sdk/models/register_pinecone_connector_request.py +95 -0
  233. qanswer_sdk/models/relation_extraction_configuration.py +105 -0
  234. qanswer_sdk/models/relation_extraction_payload.py +111 -0
  235. qanswer_sdk/models/relation_extraction_result.py +101 -0
  236. qanswer_sdk/models/relation_extraction_schema.py +101 -0
  237. qanswer_sdk/models/relation_extraction_task_settings.py +123 -0
  238. qanswer_sdk/models/relation_extraction_task_settings_update_payload.py +95 -0
  239. qanswer_sdk/models/relation_extraction_task_update.py +117 -0
  240. qanswer_sdk/models/relation_extraction_template_payload.py +97 -0
  241. qanswer_sdk/models/relation_extraction_template_update_payload.py +95 -0
  242. qanswer_sdk/models/relation_model.py +89 -0
  243. qanswer_sdk/models/report_copilot_create_payload.py +103 -0
  244. qanswer_sdk/models/report_copilot_export_template_as_docx_payload_simplified.py +91 -0
  245. qanswer_sdk/models/report_copilot_generation_from_slots_payload.py +95 -0
  246. qanswer_sdk/models/report_copilot_generation_from_slots_response.py +95 -0
  247. qanswer_sdk/models/report_copilot_refinement_payload.py +104 -0
  248. qanswer_sdk/models/report_copilot_refinement_response.py +87 -0
  249. qanswer_sdk/models/report_copilot_slot_task_settings.py +125 -0
  250. qanswer_sdk/models/report_copilot_slot_task_update.py +119 -0
  251. qanswer_sdk/models/report_copilot_task_settings.py +123 -0
  252. qanswer_sdk/models/report_copilot_task_settings_update_payload.py +95 -0
  253. qanswer_sdk/models/report_copilot_task_update.py +117 -0
  254. qanswer_sdk/models/report_copilot_template.py +107 -0
  255. qanswer_sdk/models/report_copilot_template_simplified.py +95 -0
  256. qanswer_sdk/models/report_copilot_update_payload.py +101 -0
  257. qanswer_sdk/models/reset_password.py +87 -0
  258. qanswer_sdk/models/response_audit_model.py +99 -0
  259. qanswer_sdk/models/response_audit_stats_response.py +101 -0
  260. qanswer_sdk/models/retreive_all_synonyms_resp.py +99 -0
  261. qanswer_sdk/models/retry_params.py +89 -0
  262. qanswer_sdk/models/role.py +99 -0
  263. qanswer_sdk/models/search_document_response.py +105 -0
  264. qanswer_sdk/models/search_index_payload.py +114 -0
  265. qanswer_sdk/models/search_metadata_filter.py +89 -0
  266. qanswer_sdk/models/search_payload.py +124 -0
  267. qanswer_sdk/models/search_response.py +113 -0
  268. qanswer_sdk/models/search_task_settings.py +131 -0
  269. qanswer_sdk/models/search_task_settings_update_payload.py +95 -0
  270. qanswer_sdk/models/search_task_update.py +123 -0
  271. qanswer_sdk/models/set_logo1_request.py +87 -0
  272. qanswer_sdk/models/share_point_download_by_ids.py +99 -0
  273. qanswer_sdk/models/share_point_download_request.py +101 -0
  274. qanswer_sdk/models/shared_organization_access.py +109 -0
  275. qanswer_sdk/models/shared_team_access.py +107 -0
  276. qanswer_sdk/models/shared_user.py +99 -0
  277. qanswer_sdk/models/sign_up_request.py +96 -0
  278. qanswer_sdk/models/signout_request.py +87 -0
  279. qanswer_sdk/models/slot.py +138 -0
  280. qanswer_sdk/models/slot_in_prompt.py +91 -0
  281. qanswer_sdk/models/slot_update.py +138 -0
  282. qanswer_sdk/models/socket_conversation_message.py +207 -0
  283. qanswer_sdk/models/socket_data_extraction.py +109 -0
  284. qanswer_sdk/models/socket_file_metadata.py +172 -0
  285. qanswer_sdk/models/socket_join_conversation.py +97 -0
  286. qanswer_sdk/models/socket_join_dataset.py +93 -0
  287. qanswer_sdk/models/socket_report_continuation_response.py +106 -0
  288. qanswer_sdk/models/socket_report_copilot_generation_from_slots_response.py +120 -0
  289. qanswer_sdk/models/socket_report_copilot_refinement_response.py +108 -0
  290. qanswer_sdk/models/socket_speech2_text_response.py +99 -0
  291. qanswer_sdk/models/socket_stop_conversation.py +97 -0
  292. qanswer_sdk/models/sort_object.py +91 -0
  293. qanswer_sdk/models/source.py +125 -0
  294. qanswer_sdk/models/sparql2_text_payload.py +97 -0
  295. qanswer_sdk/models/speech2_text_response.py +87 -0
  296. qanswer_sdk/models/speech2_text_with_diarization_response.py +106 -0
  297. qanswer_sdk/models/stat_per_date.py +89 -0
  298. qanswer_sdk/models/status_response.py +89 -0
  299. qanswer_sdk/models/subject_model.py +91 -0
  300. qanswer_sdk/models/suggestion_list_response.py +87 -0
  301. qanswer_sdk/models/summa_server.py +101 -0
  302. qanswer_sdk/models/tag_payload.py +87 -0
  303. qanswer_sdk/models/tag_qa_list_payload.py +100 -0
  304. qanswer_sdk/models/tag_qa_payload.py +91 -0
  305. qanswer_sdk/models/team.py +93 -0
  306. qanswer_sdk/models/team_creation.py +89 -0
  307. qanswer_sdk/models/team_filter.py +91 -0
  308. qanswer_sdk/models/team_shared.py +105 -0
  309. qanswer_sdk/models/team_with_count.py +95 -0
  310. qanswer_sdk/models/terms_bucket.py +89 -0
  311. qanswer_sdk/models/text2_sparql_payload.py +156 -0
  312. qanswer_sdk/models/text2_sparql_task_settings.py +123 -0
  313. qanswer_sdk/models/text2_sparql_task_settings_update_payload.py +95 -0
  314. qanswer_sdk/models/text2_sparql_task_update.py +117 -0
  315. qanswer_sdk/models/text_classification_payload.py +99 -0
  316. qanswer_sdk/models/text_classification_response.py +87 -0
  317. qanswer_sdk/models/text_classification_v2_payload.py +99 -0
  318. qanswer_sdk/models/text_classification_v2_response.py +95 -0
  319. qanswer_sdk/models/total_stat.py +96 -0
  320. qanswer_sdk/models/ui_mappings.py +141 -0
  321. qanswer_sdk/models/update_metadata_model.py +95 -0
  322. qanswer_sdk/models/update_qn_a_pair_request.py +101 -0
  323. qanswer_sdk/models/update_qn_a_pair_response.py +89 -0
  324. qanswer_sdk/models/update_synonyms.py +93 -0
  325. qanswer_sdk/models/update_synonyms_resp.py +89 -0
  326. qanswer_sdk/models/uri_mapping.py +89 -0
  327. qanswer_sdk/models/user.py +91 -0
  328. qanswer_sdk/models/user_chatbot_setting_payload.py +106 -0
  329. qanswer_sdk/models/user_chatbot_setting_response.py +105 -0
  330. qanswer_sdk/models/user_dataset.py +144 -0
  331. qanswer_sdk/models/user_dataset_api_key.py +116 -0
  332. qanswer_sdk/models/user_filter.py +101 -0
  333. qanswer_sdk/models/user_identity_availability.py +87 -0
  334. qanswer_sdk/models/user_list_dto.py +101 -0
  335. qanswer_sdk/models/user_oauth_token.py +96 -0
  336. qanswer_sdk/models/user_profile.py +184 -0
  337. qanswer_sdk/models/user_profile_list_dto.py +101 -0
  338. qanswer_sdk/models/user_profile_paginated.py +101 -0
  339. qanswer_sdk/models/website_add_payload.py +98 -0
  340. qanswer_sdk/models/website_connector_settings.py +160 -0
  341. qanswer_sdk/models/widget_configs.py +105 -0
  342. qanswer_sdk/py.typed +0 -0
  343. qanswer_sdk/rest.py +257 -0
  344. qanswer_sdk-3.1193.0.dist-info/METADATA +125 -0
  345. qanswer_sdk-3.1193.0.dist-info/RECORD +346 -0
  346. qanswer_sdk-3.1193.0.dist-info/WHEEL +4 -0
@@ -0,0 +1,1346 @@
1
+ # coding: utf-8
2
+
3
+ """
4
+ QAnswer: Api Documentation
5
+
6
+ APIs provided by QAnswer
7
+
8
+ The version of the OpenAPI document: 1.0
9
+ Generated by OpenAPI Generator (https://openapi-generator.tech)
10
+
11
+ Do not edit the class manually.
12
+ """ # noqa: E501
13
+
14
+ import warnings
15
+ from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt
16
+ from typing import Any, Dict, List, Optional, Tuple, Union
17
+ from typing_extensions import Annotated
18
+
19
+ from pydantic import StrictStr
20
+ from typing import Any, Dict, Optional
21
+ from qanswer_sdk.models.entity_linker_response import EntityLinkerResponse
22
+
23
+ from qanswer_sdk.api_client import ApiClient, RequestSerialized
24
+ from qanswer_sdk.api_response import ApiResponse
25
+ from qanswer_sdk.rest import RESTResponseType
26
+
27
+
28
+ class TaskRDFTextLinkerApi:
29
+ """NOTE: This class is auto generated by OpenAPI Generator
30
+ Ref: https://openapi-generator.tech
31
+
32
+ Do not edit the class manually.
33
+ """
34
+
35
+ def __init__(self, api_client=None) -> None:
36
+ if api_client is None:
37
+ api_client = ApiClient.get_default()
38
+ self.api_client = api_client
39
+
40
+
41
+ @validate_call
42
+ def entity_and_relationlinker(
43
+ self,
44
+ text: StrictStr,
45
+ language: StrictStr,
46
+ dataset: StrictStr,
47
+ username: StrictStr,
48
+ q_answer_api_key: Optional[StrictStr] = None,
49
+ _request_timeout: Union[
50
+ None,
51
+ Annotated[StrictFloat, Field(gt=0)],
52
+ Tuple[
53
+ Annotated[StrictFloat, Field(gt=0)],
54
+ Annotated[StrictFloat, Field(gt=0)]
55
+ ]
56
+ ] = None,
57
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
58
+ _content_type: Optional[StrictStr] = None,
59
+ _headers: Optional[Dict[StrictStr, Any]] = None,
60
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
61
+ ) -> EntityLinkerResponse:
62
+ """Link all entities and relations in a text
63
+
64
+
65
+ :param text: (required)
66
+ :type text: str
67
+ :param language: (required)
68
+ :type language: str
69
+ :param dataset: (required)
70
+ :type dataset: str
71
+ :param username: (required)
72
+ :type username: str
73
+ :param q_answer_api_key:
74
+ :type q_answer_api_key: str
75
+ :param _request_timeout: timeout setting for this request. If one
76
+ number provided, it will be total request
77
+ timeout. It can also be a pair (tuple) of
78
+ (connection, read) timeouts.
79
+ :type _request_timeout: int, tuple(int, int), optional
80
+ :param _request_auth: set to override the auth_settings for an a single
81
+ request; this effectively ignores the
82
+ authentication in the spec for a single request.
83
+ :type _request_auth: dict, optional
84
+ :param _content_type: force content-type for the request.
85
+ :type _content_type: str, Optional
86
+ :param _headers: set to override the headers for a single
87
+ request; this effectively ignores the headers
88
+ in the spec for a single request.
89
+ :type _headers: dict, optional
90
+ :param _host_index: set to override the host_index for a single
91
+ request; this effectively ignores the host_index
92
+ in the spec for a single request.
93
+ :type _host_index: int, optional
94
+ :return: Returns the result object.
95
+ """ # noqa: E501
96
+
97
+ _param = self._entity_and_relationlinker_serialize(
98
+ text=text,
99
+ language=language,
100
+ dataset=dataset,
101
+ username=username,
102
+ q_answer_api_key=q_answer_api_key,
103
+ _request_auth=_request_auth,
104
+ _content_type=_content_type,
105
+ _headers=_headers,
106
+ _host_index=_host_index
107
+ )
108
+
109
+ _response_types_map: Dict[str, Optional[str]] = {
110
+ '200': "EntityLinkerResponse",
111
+ }
112
+ response_data = self.api_client.call_api(
113
+ *_param,
114
+ _request_timeout=_request_timeout
115
+ )
116
+ response_data.read()
117
+ return self.api_client.response_deserialize(
118
+ response_data=response_data,
119
+ response_types_map=_response_types_map,
120
+ ).data
121
+
122
+
123
+ @validate_call
124
+ def entity_and_relationlinker_with_http_info(
125
+ self,
126
+ text: StrictStr,
127
+ language: StrictStr,
128
+ dataset: StrictStr,
129
+ username: StrictStr,
130
+ q_answer_api_key: Optional[StrictStr] = None,
131
+ _request_timeout: Union[
132
+ None,
133
+ Annotated[StrictFloat, Field(gt=0)],
134
+ Tuple[
135
+ Annotated[StrictFloat, Field(gt=0)],
136
+ Annotated[StrictFloat, Field(gt=0)]
137
+ ]
138
+ ] = None,
139
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
140
+ _content_type: Optional[StrictStr] = None,
141
+ _headers: Optional[Dict[StrictStr, Any]] = None,
142
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
143
+ ) -> ApiResponse[EntityLinkerResponse]:
144
+ """Link all entities and relations in a text
145
+
146
+
147
+ :param text: (required)
148
+ :type text: str
149
+ :param language: (required)
150
+ :type language: str
151
+ :param dataset: (required)
152
+ :type dataset: str
153
+ :param username: (required)
154
+ :type username: str
155
+ :param q_answer_api_key:
156
+ :type q_answer_api_key: str
157
+ :param _request_timeout: timeout setting for this request. If one
158
+ number provided, it will be total request
159
+ timeout. It can also be a pair (tuple) of
160
+ (connection, read) timeouts.
161
+ :type _request_timeout: int, tuple(int, int), optional
162
+ :param _request_auth: set to override the auth_settings for an a single
163
+ request; this effectively ignores the
164
+ authentication in the spec for a single request.
165
+ :type _request_auth: dict, optional
166
+ :param _content_type: force content-type for the request.
167
+ :type _content_type: str, Optional
168
+ :param _headers: set to override the headers for a single
169
+ request; this effectively ignores the headers
170
+ in the spec for a single request.
171
+ :type _headers: dict, optional
172
+ :param _host_index: set to override the host_index for a single
173
+ request; this effectively ignores the host_index
174
+ in the spec for a single request.
175
+ :type _host_index: int, optional
176
+ :return: Returns the result object.
177
+ """ # noqa: E501
178
+
179
+ _param = self._entity_and_relationlinker_serialize(
180
+ text=text,
181
+ language=language,
182
+ dataset=dataset,
183
+ username=username,
184
+ q_answer_api_key=q_answer_api_key,
185
+ _request_auth=_request_auth,
186
+ _content_type=_content_type,
187
+ _headers=_headers,
188
+ _host_index=_host_index
189
+ )
190
+
191
+ _response_types_map: Dict[str, Optional[str]] = {
192
+ '200': "EntityLinkerResponse",
193
+ }
194
+ response_data = self.api_client.call_api(
195
+ *_param,
196
+ _request_timeout=_request_timeout
197
+ )
198
+ response_data.read()
199
+ return self.api_client.response_deserialize(
200
+ response_data=response_data,
201
+ response_types_map=_response_types_map,
202
+ )
203
+
204
+
205
+ @validate_call
206
+ def entity_and_relationlinker_without_preload_content(
207
+ self,
208
+ text: StrictStr,
209
+ language: StrictStr,
210
+ dataset: StrictStr,
211
+ username: StrictStr,
212
+ q_answer_api_key: Optional[StrictStr] = None,
213
+ _request_timeout: Union[
214
+ None,
215
+ Annotated[StrictFloat, Field(gt=0)],
216
+ Tuple[
217
+ Annotated[StrictFloat, Field(gt=0)],
218
+ Annotated[StrictFloat, Field(gt=0)]
219
+ ]
220
+ ] = None,
221
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
222
+ _content_type: Optional[StrictStr] = None,
223
+ _headers: Optional[Dict[StrictStr, Any]] = None,
224
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
225
+ ) -> RESTResponseType:
226
+ """Link all entities and relations in a text
227
+
228
+
229
+ :param text: (required)
230
+ :type text: str
231
+ :param language: (required)
232
+ :type language: str
233
+ :param dataset: (required)
234
+ :type dataset: str
235
+ :param username: (required)
236
+ :type username: str
237
+ :param q_answer_api_key:
238
+ :type q_answer_api_key: str
239
+ :param _request_timeout: timeout setting for this request. If one
240
+ number provided, it will be total request
241
+ timeout. It can also be a pair (tuple) of
242
+ (connection, read) timeouts.
243
+ :type _request_timeout: int, tuple(int, int), optional
244
+ :param _request_auth: set to override the auth_settings for an a single
245
+ request; this effectively ignores the
246
+ authentication in the spec for a single request.
247
+ :type _request_auth: dict, optional
248
+ :param _content_type: force content-type for the request.
249
+ :type _content_type: str, Optional
250
+ :param _headers: set to override the headers for a single
251
+ request; this effectively ignores the headers
252
+ in the spec for a single request.
253
+ :type _headers: dict, optional
254
+ :param _host_index: set to override the host_index for a single
255
+ request; this effectively ignores the host_index
256
+ in the spec for a single request.
257
+ :type _host_index: int, optional
258
+ :return: Returns the result object.
259
+ """ # noqa: E501
260
+
261
+ _param = self._entity_and_relationlinker_serialize(
262
+ text=text,
263
+ language=language,
264
+ dataset=dataset,
265
+ username=username,
266
+ q_answer_api_key=q_answer_api_key,
267
+ _request_auth=_request_auth,
268
+ _content_type=_content_type,
269
+ _headers=_headers,
270
+ _host_index=_host_index
271
+ )
272
+
273
+ _response_types_map: Dict[str, Optional[str]] = {
274
+ '200': "EntityLinkerResponse",
275
+ }
276
+ response_data = self.api_client.call_api(
277
+ *_param,
278
+ _request_timeout=_request_timeout
279
+ )
280
+ return response_data.response
281
+
282
+
283
+ def _entity_and_relationlinker_serialize(
284
+ self,
285
+ text,
286
+ language,
287
+ dataset,
288
+ username,
289
+ q_answer_api_key,
290
+ _request_auth,
291
+ _content_type,
292
+ _headers,
293
+ _host_index,
294
+ ) -> RequestSerialized:
295
+
296
+ _host = None
297
+
298
+ _collection_formats: Dict[str, str] = {
299
+ }
300
+
301
+ _path_params: Dict[str, str] = {}
302
+ _query_params: List[Tuple[str, str]] = []
303
+ _header_params: Dict[str, Optional[str]] = _headers or {}
304
+ _form_params: List[Tuple[str, str]] = []
305
+ _files: Dict[
306
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
307
+ ] = {}
308
+ _body_params: Optional[bytes] = None
309
+
310
+ # process the path parameters
311
+ # process the query parameters
312
+ if text is not None:
313
+
314
+ _query_params.append(('text', text))
315
+
316
+ if language is not None:
317
+
318
+ _query_params.append(('language', language))
319
+
320
+ if dataset is not None:
321
+
322
+ _query_params.append(('dataset', dataset))
323
+
324
+ if username is not None:
325
+
326
+ _query_params.append(('username', username))
327
+
328
+ # process the header parameters
329
+ if q_answer_api_key is not None:
330
+ _header_params['QAnswer-Api-Key'] = q_answer_api_key
331
+ # process the form parameters
332
+ # process the body parameter
333
+
334
+
335
+ # set the HTTP header `Accept`
336
+ if 'Accept' not in _header_params:
337
+ _header_params['Accept'] = self.api_client.select_header_accept(
338
+ [
339
+ '*/*'
340
+ ]
341
+ )
342
+
343
+
344
+ # authentication setting
345
+ _auth_settings: List[str] = [
346
+ 'QAnswer-Api-Key',
347
+ 'Bearer'
348
+ ]
349
+
350
+ return self.api_client.param_serialize(
351
+ method='GET',
352
+ resource_path='/api/tasks/rdf/text-linker/entity-and-relation-linker',
353
+ path_params=_path_params,
354
+ query_params=_query_params,
355
+ header_params=_header_params,
356
+ body=_body_params,
357
+ post_params=_form_params,
358
+ files=_files,
359
+ auth_settings=_auth_settings,
360
+ collection_formats=_collection_formats,
361
+ _host=_host,
362
+ _request_auth=_request_auth
363
+ )
364
+
365
+
366
+
367
+
368
+ @validate_call
369
+ def entitylinker(
370
+ self,
371
+ text: StrictStr,
372
+ language: StrictStr,
373
+ dataset: StrictStr,
374
+ username: StrictStr,
375
+ q_answer_api_key: Optional[StrictStr] = None,
376
+ _request_timeout: Union[
377
+ None,
378
+ Annotated[StrictFloat, Field(gt=0)],
379
+ Tuple[
380
+ Annotated[StrictFloat, Field(gt=0)],
381
+ Annotated[StrictFloat, Field(gt=0)]
382
+ ]
383
+ ] = None,
384
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
385
+ _content_type: Optional[StrictStr] = None,
386
+ _headers: Optional[Dict[StrictStr, Any]] = None,
387
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
388
+ ) -> EntityLinkerResponse:
389
+ """Link all entities in a text
390
+
391
+
392
+ :param text: (required)
393
+ :type text: str
394
+ :param language: (required)
395
+ :type language: str
396
+ :param dataset: (required)
397
+ :type dataset: str
398
+ :param username: (required)
399
+ :type username: str
400
+ :param q_answer_api_key:
401
+ :type q_answer_api_key: str
402
+ :param _request_timeout: timeout setting for this request. If one
403
+ number provided, it will be total request
404
+ timeout. It can also be a pair (tuple) of
405
+ (connection, read) timeouts.
406
+ :type _request_timeout: int, tuple(int, int), optional
407
+ :param _request_auth: set to override the auth_settings for an a single
408
+ request; this effectively ignores the
409
+ authentication in the spec for a single request.
410
+ :type _request_auth: dict, optional
411
+ :param _content_type: force content-type for the request.
412
+ :type _content_type: str, Optional
413
+ :param _headers: set to override the headers for a single
414
+ request; this effectively ignores the headers
415
+ in the spec for a single request.
416
+ :type _headers: dict, optional
417
+ :param _host_index: set to override the host_index for a single
418
+ request; this effectively ignores the host_index
419
+ in the spec for a single request.
420
+ :type _host_index: int, optional
421
+ :return: Returns the result object.
422
+ """ # noqa: E501
423
+
424
+ _param = self._entitylinker_serialize(
425
+ text=text,
426
+ language=language,
427
+ dataset=dataset,
428
+ username=username,
429
+ q_answer_api_key=q_answer_api_key,
430
+ _request_auth=_request_auth,
431
+ _content_type=_content_type,
432
+ _headers=_headers,
433
+ _host_index=_host_index
434
+ )
435
+
436
+ _response_types_map: Dict[str, Optional[str]] = {
437
+ '200': "EntityLinkerResponse",
438
+ }
439
+ response_data = self.api_client.call_api(
440
+ *_param,
441
+ _request_timeout=_request_timeout
442
+ )
443
+ response_data.read()
444
+ return self.api_client.response_deserialize(
445
+ response_data=response_data,
446
+ response_types_map=_response_types_map,
447
+ ).data
448
+
449
+
450
+ @validate_call
451
+ def entitylinker_with_http_info(
452
+ self,
453
+ text: StrictStr,
454
+ language: StrictStr,
455
+ dataset: StrictStr,
456
+ username: StrictStr,
457
+ q_answer_api_key: Optional[StrictStr] = None,
458
+ _request_timeout: Union[
459
+ None,
460
+ Annotated[StrictFloat, Field(gt=0)],
461
+ Tuple[
462
+ Annotated[StrictFloat, Field(gt=0)],
463
+ Annotated[StrictFloat, Field(gt=0)]
464
+ ]
465
+ ] = None,
466
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
467
+ _content_type: Optional[StrictStr] = None,
468
+ _headers: Optional[Dict[StrictStr, Any]] = None,
469
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
470
+ ) -> ApiResponse[EntityLinkerResponse]:
471
+ """Link all entities in a text
472
+
473
+
474
+ :param text: (required)
475
+ :type text: str
476
+ :param language: (required)
477
+ :type language: str
478
+ :param dataset: (required)
479
+ :type dataset: str
480
+ :param username: (required)
481
+ :type username: str
482
+ :param q_answer_api_key:
483
+ :type q_answer_api_key: str
484
+ :param _request_timeout: timeout setting for this request. If one
485
+ number provided, it will be total request
486
+ timeout. It can also be a pair (tuple) of
487
+ (connection, read) timeouts.
488
+ :type _request_timeout: int, tuple(int, int), optional
489
+ :param _request_auth: set to override the auth_settings for an a single
490
+ request; this effectively ignores the
491
+ authentication in the spec for a single request.
492
+ :type _request_auth: dict, optional
493
+ :param _content_type: force content-type for the request.
494
+ :type _content_type: str, Optional
495
+ :param _headers: set to override the headers for a single
496
+ request; this effectively ignores the headers
497
+ in the spec for a single request.
498
+ :type _headers: dict, optional
499
+ :param _host_index: set to override the host_index for a single
500
+ request; this effectively ignores the host_index
501
+ in the spec for a single request.
502
+ :type _host_index: int, optional
503
+ :return: Returns the result object.
504
+ """ # noqa: E501
505
+
506
+ _param = self._entitylinker_serialize(
507
+ text=text,
508
+ language=language,
509
+ dataset=dataset,
510
+ username=username,
511
+ q_answer_api_key=q_answer_api_key,
512
+ _request_auth=_request_auth,
513
+ _content_type=_content_type,
514
+ _headers=_headers,
515
+ _host_index=_host_index
516
+ )
517
+
518
+ _response_types_map: Dict[str, Optional[str]] = {
519
+ '200': "EntityLinkerResponse",
520
+ }
521
+ response_data = self.api_client.call_api(
522
+ *_param,
523
+ _request_timeout=_request_timeout
524
+ )
525
+ response_data.read()
526
+ return self.api_client.response_deserialize(
527
+ response_data=response_data,
528
+ response_types_map=_response_types_map,
529
+ )
530
+
531
+
532
+ @validate_call
533
+ def entitylinker_without_preload_content(
534
+ self,
535
+ text: StrictStr,
536
+ language: StrictStr,
537
+ dataset: StrictStr,
538
+ username: StrictStr,
539
+ q_answer_api_key: Optional[StrictStr] = None,
540
+ _request_timeout: Union[
541
+ None,
542
+ Annotated[StrictFloat, Field(gt=0)],
543
+ Tuple[
544
+ Annotated[StrictFloat, Field(gt=0)],
545
+ Annotated[StrictFloat, Field(gt=0)]
546
+ ]
547
+ ] = None,
548
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
549
+ _content_type: Optional[StrictStr] = None,
550
+ _headers: Optional[Dict[StrictStr, Any]] = None,
551
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
552
+ ) -> RESTResponseType:
553
+ """Link all entities in a text
554
+
555
+
556
+ :param text: (required)
557
+ :type text: str
558
+ :param language: (required)
559
+ :type language: str
560
+ :param dataset: (required)
561
+ :type dataset: str
562
+ :param username: (required)
563
+ :type username: str
564
+ :param q_answer_api_key:
565
+ :type q_answer_api_key: str
566
+ :param _request_timeout: timeout setting for this request. If one
567
+ number provided, it will be total request
568
+ timeout. It can also be a pair (tuple) of
569
+ (connection, read) timeouts.
570
+ :type _request_timeout: int, tuple(int, int), optional
571
+ :param _request_auth: set to override the auth_settings for an a single
572
+ request; this effectively ignores the
573
+ authentication in the spec for a single request.
574
+ :type _request_auth: dict, optional
575
+ :param _content_type: force content-type for the request.
576
+ :type _content_type: str, Optional
577
+ :param _headers: set to override the headers for a single
578
+ request; this effectively ignores the headers
579
+ in the spec for a single request.
580
+ :type _headers: dict, optional
581
+ :param _host_index: set to override the host_index for a single
582
+ request; this effectively ignores the host_index
583
+ in the spec for a single request.
584
+ :type _host_index: int, optional
585
+ :return: Returns the result object.
586
+ """ # noqa: E501
587
+
588
+ _param = self._entitylinker_serialize(
589
+ text=text,
590
+ language=language,
591
+ dataset=dataset,
592
+ username=username,
593
+ q_answer_api_key=q_answer_api_key,
594
+ _request_auth=_request_auth,
595
+ _content_type=_content_type,
596
+ _headers=_headers,
597
+ _host_index=_host_index
598
+ )
599
+
600
+ _response_types_map: Dict[str, Optional[str]] = {
601
+ '200': "EntityLinkerResponse",
602
+ }
603
+ response_data = self.api_client.call_api(
604
+ *_param,
605
+ _request_timeout=_request_timeout
606
+ )
607
+ return response_data.response
608
+
609
+
610
+ def _entitylinker_serialize(
611
+ self,
612
+ text,
613
+ language,
614
+ dataset,
615
+ username,
616
+ q_answer_api_key,
617
+ _request_auth,
618
+ _content_type,
619
+ _headers,
620
+ _host_index,
621
+ ) -> RequestSerialized:
622
+
623
+ _host = None
624
+
625
+ _collection_formats: Dict[str, str] = {
626
+ }
627
+
628
+ _path_params: Dict[str, str] = {}
629
+ _query_params: List[Tuple[str, str]] = []
630
+ _header_params: Dict[str, Optional[str]] = _headers or {}
631
+ _form_params: List[Tuple[str, str]] = []
632
+ _files: Dict[
633
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
634
+ ] = {}
635
+ _body_params: Optional[bytes] = None
636
+
637
+ # process the path parameters
638
+ # process the query parameters
639
+ if text is not None:
640
+
641
+ _query_params.append(('text', text))
642
+
643
+ if language is not None:
644
+
645
+ _query_params.append(('language', language))
646
+
647
+ if dataset is not None:
648
+
649
+ _query_params.append(('dataset', dataset))
650
+
651
+ if username is not None:
652
+
653
+ _query_params.append(('username', username))
654
+
655
+ # process the header parameters
656
+ if q_answer_api_key is not None:
657
+ _header_params['QAnswer-Api-Key'] = q_answer_api_key
658
+ # process the form parameters
659
+ # process the body parameter
660
+
661
+
662
+ # set the HTTP header `Accept`
663
+ if 'Accept' not in _header_params:
664
+ _header_params['Accept'] = self.api_client.select_header_accept(
665
+ [
666
+ '*/*'
667
+ ]
668
+ )
669
+
670
+
671
+ # authentication setting
672
+ _auth_settings: List[str] = [
673
+ 'QAnswer-Api-Key',
674
+ 'Bearer'
675
+ ]
676
+
677
+ return self.api_client.param_serialize(
678
+ method='GET',
679
+ resource_path='/api/tasks/rdf/text-linker/entity-linker',
680
+ path_params=_path_params,
681
+ query_params=_query_params,
682
+ header_params=_header_params,
683
+ body=_body_params,
684
+ post_params=_form_params,
685
+ files=_files,
686
+ auth_settings=_auth_settings,
687
+ collection_formats=_collection_formats,
688
+ _host=_host,
689
+ _request_auth=_request_auth
690
+ )
691
+
692
+
693
+
694
+
695
+ @validate_call
696
+ def link(
697
+ self,
698
+ text: StrictStr,
699
+ language: StrictStr,
700
+ username: StrictStr,
701
+ dataset: StrictStr,
702
+ q_answer_api_key: Optional[StrictStr] = None,
703
+ _request_timeout: Union[
704
+ None,
705
+ Annotated[StrictFloat, Field(gt=0)],
706
+ Tuple[
707
+ Annotated[StrictFloat, Field(gt=0)],
708
+ Annotated[StrictFloat, Field(gt=0)]
709
+ ]
710
+ ] = None,
711
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
712
+ _content_type: Optional[StrictStr] = None,
713
+ _headers: Optional[Dict[StrictStr, Any]] = None,
714
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
715
+ ) -> object:
716
+ """See for a text which are all possible options
717
+
718
+
719
+ :param text: (required)
720
+ :type text: str
721
+ :param language: (required)
722
+ :type language: str
723
+ :param username: (required)
724
+ :type username: str
725
+ :param dataset: (required)
726
+ :type dataset: str
727
+ :param q_answer_api_key:
728
+ :type q_answer_api_key: str
729
+ :param _request_timeout: timeout setting for this request. If one
730
+ number provided, it will be total request
731
+ timeout. It can also be a pair (tuple) of
732
+ (connection, read) timeouts.
733
+ :type _request_timeout: int, tuple(int, int), optional
734
+ :param _request_auth: set to override the auth_settings for an a single
735
+ request; this effectively ignores the
736
+ authentication in the spec for a single request.
737
+ :type _request_auth: dict, optional
738
+ :param _content_type: force content-type for the request.
739
+ :type _content_type: str, Optional
740
+ :param _headers: set to override the headers for a single
741
+ request; this effectively ignores the headers
742
+ in the spec for a single request.
743
+ :type _headers: dict, optional
744
+ :param _host_index: set to override the host_index for a single
745
+ request; this effectively ignores the host_index
746
+ in the spec for a single request.
747
+ :type _host_index: int, optional
748
+ :return: Returns the result object.
749
+ """ # noqa: E501
750
+
751
+ _param = self._link_serialize(
752
+ text=text,
753
+ language=language,
754
+ username=username,
755
+ dataset=dataset,
756
+ q_answer_api_key=q_answer_api_key,
757
+ _request_auth=_request_auth,
758
+ _content_type=_content_type,
759
+ _headers=_headers,
760
+ _host_index=_host_index
761
+ )
762
+
763
+ _response_types_map: Dict[str, Optional[str]] = {
764
+ '200': "object",
765
+ }
766
+ response_data = self.api_client.call_api(
767
+ *_param,
768
+ _request_timeout=_request_timeout
769
+ )
770
+ response_data.read()
771
+ return self.api_client.response_deserialize(
772
+ response_data=response_data,
773
+ response_types_map=_response_types_map,
774
+ ).data
775
+
776
+
777
+ @validate_call
778
+ def link_with_http_info(
779
+ self,
780
+ text: StrictStr,
781
+ language: StrictStr,
782
+ username: StrictStr,
783
+ dataset: StrictStr,
784
+ q_answer_api_key: Optional[StrictStr] = None,
785
+ _request_timeout: Union[
786
+ None,
787
+ Annotated[StrictFloat, Field(gt=0)],
788
+ Tuple[
789
+ Annotated[StrictFloat, Field(gt=0)],
790
+ Annotated[StrictFloat, Field(gt=0)]
791
+ ]
792
+ ] = None,
793
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
794
+ _content_type: Optional[StrictStr] = None,
795
+ _headers: Optional[Dict[StrictStr, Any]] = None,
796
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
797
+ ) -> ApiResponse[object]:
798
+ """See for a text which are all possible options
799
+
800
+
801
+ :param text: (required)
802
+ :type text: str
803
+ :param language: (required)
804
+ :type language: str
805
+ :param username: (required)
806
+ :type username: str
807
+ :param dataset: (required)
808
+ :type dataset: str
809
+ :param q_answer_api_key:
810
+ :type q_answer_api_key: str
811
+ :param _request_timeout: timeout setting for this request. If one
812
+ number provided, it will be total request
813
+ timeout. It can also be a pair (tuple) of
814
+ (connection, read) timeouts.
815
+ :type _request_timeout: int, tuple(int, int), optional
816
+ :param _request_auth: set to override the auth_settings for an a single
817
+ request; this effectively ignores the
818
+ authentication in the spec for a single request.
819
+ :type _request_auth: dict, optional
820
+ :param _content_type: force content-type for the request.
821
+ :type _content_type: str, Optional
822
+ :param _headers: set to override the headers for a single
823
+ request; this effectively ignores the headers
824
+ in the spec for a single request.
825
+ :type _headers: dict, optional
826
+ :param _host_index: set to override the host_index for a single
827
+ request; this effectively ignores the host_index
828
+ in the spec for a single request.
829
+ :type _host_index: int, optional
830
+ :return: Returns the result object.
831
+ """ # noqa: E501
832
+
833
+ _param = self._link_serialize(
834
+ text=text,
835
+ language=language,
836
+ username=username,
837
+ dataset=dataset,
838
+ q_answer_api_key=q_answer_api_key,
839
+ _request_auth=_request_auth,
840
+ _content_type=_content_type,
841
+ _headers=_headers,
842
+ _host_index=_host_index
843
+ )
844
+
845
+ _response_types_map: Dict[str, Optional[str]] = {
846
+ '200': "object",
847
+ }
848
+ response_data = self.api_client.call_api(
849
+ *_param,
850
+ _request_timeout=_request_timeout
851
+ )
852
+ response_data.read()
853
+ return self.api_client.response_deserialize(
854
+ response_data=response_data,
855
+ response_types_map=_response_types_map,
856
+ )
857
+
858
+
859
+ @validate_call
860
+ def link_without_preload_content(
861
+ self,
862
+ text: StrictStr,
863
+ language: StrictStr,
864
+ username: StrictStr,
865
+ dataset: StrictStr,
866
+ q_answer_api_key: Optional[StrictStr] = None,
867
+ _request_timeout: Union[
868
+ None,
869
+ Annotated[StrictFloat, Field(gt=0)],
870
+ Tuple[
871
+ Annotated[StrictFloat, Field(gt=0)],
872
+ Annotated[StrictFloat, Field(gt=0)]
873
+ ]
874
+ ] = None,
875
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
876
+ _content_type: Optional[StrictStr] = None,
877
+ _headers: Optional[Dict[StrictStr, Any]] = None,
878
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
879
+ ) -> RESTResponseType:
880
+ """See for a text which are all possible options
881
+
882
+
883
+ :param text: (required)
884
+ :type text: str
885
+ :param language: (required)
886
+ :type language: str
887
+ :param username: (required)
888
+ :type username: str
889
+ :param dataset: (required)
890
+ :type dataset: str
891
+ :param q_answer_api_key:
892
+ :type q_answer_api_key: str
893
+ :param _request_timeout: timeout setting for this request. If one
894
+ number provided, it will be total request
895
+ timeout. It can also be a pair (tuple) of
896
+ (connection, read) timeouts.
897
+ :type _request_timeout: int, tuple(int, int), optional
898
+ :param _request_auth: set to override the auth_settings for an a single
899
+ request; this effectively ignores the
900
+ authentication in the spec for a single request.
901
+ :type _request_auth: dict, optional
902
+ :param _content_type: force content-type for the request.
903
+ :type _content_type: str, Optional
904
+ :param _headers: set to override the headers for a single
905
+ request; this effectively ignores the headers
906
+ in the spec for a single request.
907
+ :type _headers: dict, optional
908
+ :param _host_index: set to override the host_index for a single
909
+ request; this effectively ignores the host_index
910
+ in the spec for a single request.
911
+ :type _host_index: int, optional
912
+ :return: Returns the result object.
913
+ """ # noqa: E501
914
+
915
+ _param = self._link_serialize(
916
+ text=text,
917
+ language=language,
918
+ username=username,
919
+ dataset=dataset,
920
+ q_answer_api_key=q_answer_api_key,
921
+ _request_auth=_request_auth,
922
+ _content_type=_content_type,
923
+ _headers=_headers,
924
+ _host_index=_host_index
925
+ )
926
+
927
+ _response_types_map: Dict[str, Optional[str]] = {
928
+ '200': "object",
929
+ }
930
+ response_data = self.api_client.call_api(
931
+ *_param,
932
+ _request_timeout=_request_timeout
933
+ )
934
+ return response_data.response
935
+
936
+
937
+ def _link_serialize(
938
+ self,
939
+ text,
940
+ language,
941
+ username,
942
+ dataset,
943
+ q_answer_api_key,
944
+ _request_auth,
945
+ _content_type,
946
+ _headers,
947
+ _host_index,
948
+ ) -> RequestSerialized:
949
+
950
+ _host = None
951
+
952
+ _collection_formats: Dict[str, str] = {
953
+ }
954
+
955
+ _path_params: Dict[str, str] = {}
956
+ _query_params: List[Tuple[str, str]] = []
957
+ _header_params: Dict[str, Optional[str]] = _headers or {}
958
+ _form_params: List[Tuple[str, str]] = []
959
+ _files: Dict[
960
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
961
+ ] = {}
962
+ _body_params: Optional[bytes] = None
963
+
964
+ # process the path parameters
965
+ # process the query parameters
966
+ if text is not None:
967
+
968
+ _query_params.append(('text', text))
969
+
970
+ if language is not None:
971
+
972
+ _query_params.append(('language', language))
973
+
974
+ if username is not None:
975
+
976
+ _query_params.append(('username', username))
977
+
978
+ if dataset is not None:
979
+
980
+ _query_params.append(('dataset', dataset))
981
+
982
+ # process the header parameters
983
+ if q_answer_api_key is not None:
984
+ _header_params['QAnswer-Api-Key'] = q_answer_api_key
985
+ # process the form parameters
986
+ # process the body parameter
987
+
988
+
989
+ # set the HTTP header `Accept`
990
+ if 'Accept' not in _header_params:
991
+ _header_params['Accept'] = self.api_client.select_header_accept(
992
+ [
993
+ '*/*'
994
+ ]
995
+ )
996
+
997
+
998
+ # authentication setting
999
+ _auth_settings: List[str] = [
1000
+ 'QAnswer-Api-Key',
1001
+ 'Bearer'
1002
+ ]
1003
+
1004
+ return self.api_client.param_serialize(
1005
+ method='GET',
1006
+ resource_path='/api/tasks/rdf/text-linker/link',
1007
+ path_params=_path_params,
1008
+ query_params=_query_params,
1009
+ header_params=_header_params,
1010
+ body=_body_params,
1011
+ post_params=_form_params,
1012
+ files=_files,
1013
+ auth_settings=_auth_settings,
1014
+ collection_formats=_collection_formats,
1015
+ _host=_host,
1016
+ _request_auth=_request_auth
1017
+ )
1018
+
1019
+
1020
+
1021
+
1022
+ @validate_call
1023
+ def relationlinker(
1024
+ self,
1025
+ text: StrictStr,
1026
+ language: StrictStr,
1027
+ dataset: StrictStr,
1028
+ username: StrictStr,
1029
+ q_answer_api_key: Optional[StrictStr] = None,
1030
+ _request_timeout: Union[
1031
+ None,
1032
+ Annotated[StrictFloat, Field(gt=0)],
1033
+ Tuple[
1034
+ Annotated[StrictFloat, Field(gt=0)],
1035
+ Annotated[StrictFloat, Field(gt=0)]
1036
+ ]
1037
+ ] = None,
1038
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1039
+ _content_type: Optional[StrictStr] = None,
1040
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1041
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1042
+ ) -> EntityLinkerResponse:
1043
+ """Link all relations in a text
1044
+
1045
+
1046
+ :param text: (required)
1047
+ :type text: str
1048
+ :param language: (required)
1049
+ :type language: str
1050
+ :param dataset: (required)
1051
+ :type dataset: str
1052
+ :param username: (required)
1053
+ :type username: str
1054
+ :param q_answer_api_key:
1055
+ :type q_answer_api_key: str
1056
+ :param _request_timeout: timeout setting for this request. If one
1057
+ number provided, it will be total request
1058
+ timeout. It can also be a pair (tuple) of
1059
+ (connection, read) timeouts.
1060
+ :type _request_timeout: int, tuple(int, int), optional
1061
+ :param _request_auth: set to override the auth_settings for an a single
1062
+ request; this effectively ignores the
1063
+ authentication in the spec for a single request.
1064
+ :type _request_auth: dict, optional
1065
+ :param _content_type: force content-type for the request.
1066
+ :type _content_type: str, Optional
1067
+ :param _headers: set to override the headers for a single
1068
+ request; this effectively ignores the headers
1069
+ in the spec for a single request.
1070
+ :type _headers: dict, optional
1071
+ :param _host_index: set to override the host_index for a single
1072
+ request; this effectively ignores the host_index
1073
+ in the spec for a single request.
1074
+ :type _host_index: int, optional
1075
+ :return: Returns the result object.
1076
+ """ # noqa: E501
1077
+
1078
+ _param = self._relationlinker_serialize(
1079
+ text=text,
1080
+ language=language,
1081
+ dataset=dataset,
1082
+ username=username,
1083
+ q_answer_api_key=q_answer_api_key,
1084
+ _request_auth=_request_auth,
1085
+ _content_type=_content_type,
1086
+ _headers=_headers,
1087
+ _host_index=_host_index
1088
+ )
1089
+
1090
+ _response_types_map: Dict[str, Optional[str]] = {
1091
+ '200': "EntityLinkerResponse",
1092
+ }
1093
+ response_data = self.api_client.call_api(
1094
+ *_param,
1095
+ _request_timeout=_request_timeout
1096
+ )
1097
+ response_data.read()
1098
+ return self.api_client.response_deserialize(
1099
+ response_data=response_data,
1100
+ response_types_map=_response_types_map,
1101
+ ).data
1102
+
1103
+
1104
+ @validate_call
1105
+ def relationlinker_with_http_info(
1106
+ self,
1107
+ text: StrictStr,
1108
+ language: StrictStr,
1109
+ dataset: StrictStr,
1110
+ username: StrictStr,
1111
+ q_answer_api_key: Optional[StrictStr] = None,
1112
+ _request_timeout: Union[
1113
+ None,
1114
+ Annotated[StrictFloat, Field(gt=0)],
1115
+ Tuple[
1116
+ Annotated[StrictFloat, Field(gt=0)],
1117
+ Annotated[StrictFloat, Field(gt=0)]
1118
+ ]
1119
+ ] = None,
1120
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1121
+ _content_type: Optional[StrictStr] = None,
1122
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1123
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1124
+ ) -> ApiResponse[EntityLinkerResponse]:
1125
+ """Link all relations in a text
1126
+
1127
+
1128
+ :param text: (required)
1129
+ :type text: str
1130
+ :param language: (required)
1131
+ :type language: str
1132
+ :param dataset: (required)
1133
+ :type dataset: str
1134
+ :param username: (required)
1135
+ :type username: str
1136
+ :param q_answer_api_key:
1137
+ :type q_answer_api_key: str
1138
+ :param _request_timeout: timeout setting for this request. If one
1139
+ number provided, it will be total request
1140
+ timeout. It can also be a pair (tuple) of
1141
+ (connection, read) timeouts.
1142
+ :type _request_timeout: int, tuple(int, int), optional
1143
+ :param _request_auth: set to override the auth_settings for an a single
1144
+ request; this effectively ignores the
1145
+ authentication in the spec for a single request.
1146
+ :type _request_auth: dict, optional
1147
+ :param _content_type: force content-type for the request.
1148
+ :type _content_type: str, Optional
1149
+ :param _headers: set to override the headers for a single
1150
+ request; this effectively ignores the headers
1151
+ in the spec for a single request.
1152
+ :type _headers: dict, optional
1153
+ :param _host_index: set to override the host_index for a single
1154
+ request; this effectively ignores the host_index
1155
+ in the spec for a single request.
1156
+ :type _host_index: int, optional
1157
+ :return: Returns the result object.
1158
+ """ # noqa: E501
1159
+
1160
+ _param = self._relationlinker_serialize(
1161
+ text=text,
1162
+ language=language,
1163
+ dataset=dataset,
1164
+ username=username,
1165
+ q_answer_api_key=q_answer_api_key,
1166
+ _request_auth=_request_auth,
1167
+ _content_type=_content_type,
1168
+ _headers=_headers,
1169
+ _host_index=_host_index
1170
+ )
1171
+
1172
+ _response_types_map: Dict[str, Optional[str]] = {
1173
+ '200': "EntityLinkerResponse",
1174
+ }
1175
+ response_data = self.api_client.call_api(
1176
+ *_param,
1177
+ _request_timeout=_request_timeout
1178
+ )
1179
+ response_data.read()
1180
+ return self.api_client.response_deserialize(
1181
+ response_data=response_data,
1182
+ response_types_map=_response_types_map,
1183
+ )
1184
+
1185
+
1186
+ @validate_call
1187
+ def relationlinker_without_preload_content(
1188
+ self,
1189
+ text: StrictStr,
1190
+ language: StrictStr,
1191
+ dataset: StrictStr,
1192
+ username: StrictStr,
1193
+ q_answer_api_key: Optional[StrictStr] = None,
1194
+ _request_timeout: Union[
1195
+ None,
1196
+ Annotated[StrictFloat, Field(gt=0)],
1197
+ Tuple[
1198
+ Annotated[StrictFloat, Field(gt=0)],
1199
+ Annotated[StrictFloat, Field(gt=0)]
1200
+ ]
1201
+ ] = None,
1202
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1203
+ _content_type: Optional[StrictStr] = None,
1204
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1205
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1206
+ ) -> RESTResponseType:
1207
+ """Link all relations in a text
1208
+
1209
+
1210
+ :param text: (required)
1211
+ :type text: str
1212
+ :param language: (required)
1213
+ :type language: str
1214
+ :param dataset: (required)
1215
+ :type dataset: str
1216
+ :param username: (required)
1217
+ :type username: str
1218
+ :param q_answer_api_key:
1219
+ :type q_answer_api_key: str
1220
+ :param _request_timeout: timeout setting for this request. If one
1221
+ number provided, it will be total request
1222
+ timeout. It can also be a pair (tuple) of
1223
+ (connection, read) timeouts.
1224
+ :type _request_timeout: int, tuple(int, int), optional
1225
+ :param _request_auth: set to override the auth_settings for an a single
1226
+ request; this effectively ignores the
1227
+ authentication in the spec for a single request.
1228
+ :type _request_auth: dict, optional
1229
+ :param _content_type: force content-type for the request.
1230
+ :type _content_type: str, Optional
1231
+ :param _headers: set to override the headers for a single
1232
+ request; this effectively ignores the headers
1233
+ in the spec for a single request.
1234
+ :type _headers: dict, optional
1235
+ :param _host_index: set to override the host_index for a single
1236
+ request; this effectively ignores the host_index
1237
+ in the spec for a single request.
1238
+ :type _host_index: int, optional
1239
+ :return: Returns the result object.
1240
+ """ # noqa: E501
1241
+
1242
+ _param = self._relationlinker_serialize(
1243
+ text=text,
1244
+ language=language,
1245
+ dataset=dataset,
1246
+ username=username,
1247
+ q_answer_api_key=q_answer_api_key,
1248
+ _request_auth=_request_auth,
1249
+ _content_type=_content_type,
1250
+ _headers=_headers,
1251
+ _host_index=_host_index
1252
+ )
1253
+
1254
+ _response_types_map: Dict[str, Optional[str]] = {
1255
+ '200': "EntityLinkerResponse",
1256
+ }
1257
+ response_data = self.api_client.call_api(
1258
+ *_param,
1259
+ _request_timeout=_request_timeout
1260
+ )
1261
+ return response_data.response
1262
+
1263
+
1264
+ def _relationlinker_serialize(
1265
+ self,
1266
+ text,
1267
+ language,
1268
+ dataset,
1269
+ username,
1270
+ q_answer_api_key,
1271
+ _request_auth,
1272
+ _content_type,
1273
+ _headers,
1274
+ _host_index,
1275
+ ) -> RequestSerialized:
1276
+
1277
+ _host = None
1278
+
1279
+ _collection_formats: Dict[str, str] = {
1280
+ }
1281
+
1282
+ _path_params: Dict[str, str] = {}
1283
+ _query_params: List[Tuple[str, str]] = []
1284
+ _header_params: Dict[str, Optional[str]] = _headers or {}
1285
+ _form_params: List[Tuple[str, str]] = []
1286
+ _files: Dict[
1287
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
1288
+ ] = {}
1289
+ _body_params: Optional[bytes] = None
1290
+
1291
+ # process the path parameters
1292
+ # process the query parameters
1293
+ if text is not None:
1294
+
1295
+ _query_params.append(('text', text))
1296
+
1297
+ if language is not None:
1298
+
1299
+ _query_params.append(('language', language))
1300
+
1301
+ if dataset is not None:
1302
+
1303
+ _query_params.append(('dataset', dataset))
1304
+
1305
+ if username is not None:
1306
+
1307
+ _query_params.append(('username', username))
1308
+
1309
+ # process the header parameters
1310
+ if q_answer_api_key is not None:
1311
+ _header_params['QAnswer-Api-Key'] = q_answer_api_key
1312
+ # process the form parameters
1313
+ # process the body parameter
1314
+
1315
+
1316
+ # set the HTTP header `Accept`
1317
+ if 'Accept' not in _header_params:
1318
+ _header_params['Accept'] = self.api_client.select_header_accept(
1319
+ [
1320
+ '*/*'
1321
+ ]
1322
+ )
1323
+
1324
+
1325
+ # authentication setting
1326
+ _auth_settings: List[str] = [
1327
+ 'QAnswer-Api-Key',
1328
+ 'Bearer'
1329
+ ]
1330
+
1331
+ return self.api_client.param_serialize(
1332
+ method='GET',
1333
+ resource_path='/api/tasks/rdf/text-linker/relation-linker',
1334
+ path_params=_path_params,
1335
+ query_params=_query_params,
1336
+ header_params=_header_params,
1337
+ body=_body_params,
1338
+ post_params=_form_params,
1339
+ files=_files,
1340
+ auth_settings=_auth_settings,
1341
+ collection_formats=_collection_formats,
1342
+ _host=_host,
1343
+ _request_auth=_request_auth
1344
+ )
1345
+
1346
+