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,158 @@
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
+
15
+ from __future__ import annotations
16
+ import pprint
17
+ import re # noqa: F401
18
+ import json
19
+
20
+ from datetime import datetime
21
+ from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictInt, StrictStr, field_validator
22
+ from typing import Any, ClassVar, Dict, List, Optional
23
+ from qanswer_sdk.models.dataset_config_request import DatasetConfigRequest
24
+ from qanswer_sdk.models.logo import Logo
25
+ from qanswer_sdk.models.shared_organization_access import SharedOrganizationAccess
26
+ from qanswer_sdk.models.shared_team_access import SharedTeamAccess
27
+ from qanswer_sdk.models.user import User
28
+ from typing import Optional, Set
29
+ from typing_extensions import Self
30
+
31
+ class DatasetDetailKg(BaseModel):
32
+ """
33
+ DatasetDetailKg
34
+ """ # noqa: E501
35
+ id: Optional[StrictInt] = None
36
+ dataset: Optional[StrictStr] = None
37
+ name: Optional[StrictStr] = None
38
+ description: Optional[StrictStr] = None
39
+ user: Optional[User] = None
40
+ uploaded: Optional[StrictBool] = None
41
+ indexed: Optional[StrictBool] = None
42
+ access: Optional[StrictBool] = None
43
+ access_type: Optional[StrictStr] = Field(default=None, alias="accessType")
44
+ size: Optional[StrictInt] = None
45
+ created: Optional[datetime] = None
46
+ index_type: Optional[StrictStr] = Field(default=None, alias="indexType")
47
+ languages: Optional[List[StrictStr]] = None
48
+ shared_teams: Optional[List[SharedTeamAccess]] = Field(default=None, alias="sharedTeams")
49
+ shared_organizations: Optional[List[SharedOrganizationAccess]] = Field(default=None, alias="sharedOrganizations")
50
+ logo: Optional[Logo] = None
51
+ config: Optional[DatasetConfigRequest] = None
52
+ __properties: ClassVar[List[str]] = ["id", "dataset", "name", "description", "user", "uploaded", "indexed", "access", "accessType", "size", "created", "indexType", "languages", "sharedTeams", "sharedOrganizations", "logo", "config"]
53
+
54
+ @field_validator('access_type')
55
+ def access_type_validate_enum(cls, value):
56
+ """Validates the enum"""
57
+ if value is None:
58
+ return value
59
+
60
+ if value not in set(['Owned', 'SharedWrite', 'SharedRead', 'UseOnly', 'LoggedIn', 'Open', 'None']):
61
+ raise ValueError("must be one of enum values ('Owned', 'SharedWrite', 'SharedRead', 'UseOnly', 'LoggedIn', 'Open', 'None')")
62
+ return value
63
+
64
+ model_config = ConfigDict(
65
+ populate_by_name=True,
66
+ validate_assignment=True,
67
+ protected_namespaces=(),
68
+ )
69
+
70
+
71
+ def to_str(self) -> str:
72
+ """Returns the string representation of the model using alias"""
73
+ return pprint.pformat(self.model_dump(by_alias=True))
74
+
75
+ def to_json(self) -> str:
76
+ """Returns the JSON representation of the model using alias"""
77
+ # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
78
+ return json.dumps(self.to_dict())
79
+
80
+ @classmethod
81
+ def from_json(cls, json_str: str) -> Optional[Self]:
82
+ """Create an instance of DatasetDetailKg from a JSON string"""
83
+ return cls.from_dict(json.loads(json_str))
84
+
85
+ def to_dict(self) -> Dict[str, Any]:
86
+ """Return the dictionary representation of the model using alias.
87
+
88
+ This has the following differences from calling pydantic's
89
+ `self.model_dump(by_alias=True)`:
90
+
91
+ * `None` is only added to the output dict for nullable fields that
92
+ were set at model initialization. Other fields with value `None`
93
+ are ignored.
94
+ """
95
+ excluded_fields: Set[str] = set([
96
+ ])
97
+
98
+ _dict = self.model_dump(
99
+ by_alias=True,
100
+ exclude=excluded_fields,
101
+ exclude_none=True,
102
+ )
103
+ # override the default output from pydantic by calling `to_dict()` of user
104
+ if self.user:
105
+ _dict['user'] = self.user.to_dict()
106
+ # override the default output from pydantic by calling `to_dict()` of each item in shared_teams (list)
107
+ _items = []
108
+ if self.shared_teams:
109
+ for _item_shared_teams in self.shared_teams:
110
+ if _item_shared_teams:
111
+ _items.append(_item_shared_teams.to_dict())
112
+ _dict['sharedTeams'] = _items
113
+ # override the default output from pydantic by calling `to_dict()` of each item in shared_organizations (list)
114
+ _items = []
115
+ if self.shared_organizations:
116
+ for _item_shared_organizations in self.shared_organizations:
117
+ if _item_shared_organizations:
118
+ _items.append(_item_shared_organizations.to_dict())
119
+ _dict['sharedOrganizations'] = _items
120
+ # override the default output from pydantic by calling `to_dict()` of logo
121
+ if self.logo:
122
+ _dict['logo'] = self.logo.to_dict()
123
+ # override the default output from pydantic by calling `to_dict()` of config
124
+ if self.config:
125
+ _dict['config'] = self.config.to_dict()
126
+ return _dict
127
+
128
+ @classmethod
129
+ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
130
+ """Create an instance of DatasetDetailKg from a dict"""
131
+ if obj is None:
132
+ return None
133
+
134
+ if not isinstance(obj, dict):
135
+ return cls.model_validate(obj)
136
+
137
+ _obj = cls.model_validate({
138
+ "id": obj.get("id"),
139
+ "dataset": obj.get("dataset"),
140
+ "name": obj.get("name"),
141
+ "description": obj.get("description"),
142
+ "user": User.from_dict(obj["user"]) if obj.get("user") is not None else None,
143
+ "uploaded": obj.get("uploaded"),
144
+ "indexed": obj.get("indexed"),
145
+ "access": obj.get("access"),
146
+ "accessType": obj.get("accessType"),
147
+ "size": obj.get("size"),
148
+ "created": obj.get("created"),
149
+ "indexType": obj.get("indexType"),
150
+ "languages": obj.get("languages"),
151
+ "sharedTeams": [SharedTeamAccess.from_dict(_item) for _item in obj["sharedTeams"]] if obj.get("sharedTeams") is not None else None,
152
+ "sharedOrganizations": [SharedOrganizationAccess.from_dict(_item) for _item in obj["sharedOrganizations"]] if obj.get("sharedOrganizations") is not None else None,
153
+ "logo": Logo.from_dict(obj["logo"]) if obj.get("logo") is not None else None,
154
+ "config": DatasetConfigRequest.from_dict(obj["config"]) if obj.get("config") is not None else None
155
+ })
156
+ return _obj
157
+
158
+
@@ -0,0 +1,207 @@
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
+
15
+ from __future__ import annotations
16
+ import pprint
17
+ import re # noqa: F401
18
+ import json
19
+
20
+ from pydantic import BaseModel, ConfigDict, StrictBool, StrictFloat, StrictInt, StrictStr, field_validator
21
+ from typing import Any, ClassVar, Dict, List, Optional, Union
22
+ from qanswer_sdk.models.widget_configs import WidgetConfigs
23
+ from typing import Optional, Set
24
+ from typing_extensions import Self
25
+
26
+ class DatasetSchema(BaseModel):
27
+ """
28
+ DatasetSchema
29
+ """ # noqa: E501
30
+ id: StrictInt
31
+ dataset: StrictStr
32
+ username: StrictStr
33
+ index_hash: Optional[StrictStr] = None
34
+ do_ocr: Optional[StrictBool] = None
35
+ language: Optional[StrictStr] = None
36
+ is_updating: Optional[StrictBool] = None
37
+ use_reader: Optional[StrictBool] = None
38
+ use_ranker: Optional[StrictBool] = None
39
+ use_fallback: Optional[StrictBool] = None
40
+ top_k_retriever: Optional[StrictInt] = None
41
+ top_k_reader: Optional[StrictInt] = None
42
+ top_k_ranker: Optional[StrictInt] = None
43
+ return_no_ans: Optional[StrictBool] = None
44
+ no_ans_boost: Optional[Union[StrictFloat, StrictInt]] = None
45
+ max_seq_len: Optional[StrictInt] = None
46
+ doc_stride: Optional[StrictInt] = None
47
+ max_ans_len: Optional[StrictInt] = None
48
+ weight_title: Optional[Union[StrictFloat, StrictInt]] = None
49
+ weight_text: Optional[Union[StrictFloat, StrictInt]] = None
50
+ split_by: Optional[StrictStr] = None
51
+ split_len: Optional[StrictInt] = None
52
+ split_overlap: Optional[StrictInt] = None
53
+ llm_choice: Optional[StrictStr] = None
54
+ bot_name: Optional[StrictStr] = None
55
+ bot_description: Optional[StrictStr] = None
56
+ bot_mode: Optional[StrictStr] = None
57
+ bot_knowledge: Optional[StrictStr] = None
58
+ bot_answer_length: Optional[StrictStr] = None
59
+ bot_seed: Optional[StrictInt] = None
60
+ bot_temperature: Optional[Union[StrictFloat, StrictInt]] = None
61
+ prompt: Optional[StrictStr] = None
62
+ number_of_references: Optional[StrictInt] = None
63
+ stream_speed: Optional[Union[StrictFloat, StrictInt]] = None
64
+ initial_message: Optional[StrictStr] = None
65
+ track_geo: Optional[StrictBool] = None
66
+ creation_date: Optional[StrictStr] = None
67
+ use_training: Optional[StrictBool] = None
68
+ embedding_model: Optional[StrictStr] = None
69
+ data_storage_preference: Optional[StrictStr] = None
70
+ logs_visibility_policy: Optional[StrictStr] = None
71
+ dataset_type: Optional[StrictStr] = None
72
+ widget_configs: WidgetConfigs
73
+ n_tokens: Optional[StrictInt] = None
74
+ __properties: ClassVar[List[str]] = ["id", "dataset", "username", "index_hash", "do_ocr", "language", "is_updating", "use_reader", "use_ranker", "use_fallback", "top_k_retriever", "top_k_reader", "top_k_ranker", "return_no_ans", "no_ans_boost", "max_seq_len", "doc_stride", "max_ans_len", "weight_title", "weight_text", "split_by", "split_len", "split_overlap", "llm_choice", "bot_name", "bot_description", "bot_mode", "bot_knowledge", "bot_answer_length", "bot_seed", "bot_temperature", "prompt", "number_of_references", "stream_speed", "initial_message", "track_geo", "creation_date", "use_training", "embedding_model", "data_storage_preference", "logs_visibility_policy", "dataset_type", "widget_configs", "n_tokens"]
75
+
76
+ @field_validator('data_storage_preference')
77
+ def data_storage_preference_validate_enum(cls, value):
78
+ """Validates the enum"""
79
+ if value is None:
80
+ return value
81
+
82
+ if value not in set(['store_all', 'discard_all', 'store_anonymized']):
83
+ raise ValueError("must be one of enum values ('store_all', 'discard_all', 'store_anonymized')")
84
+ return value
85
+
86
+ @field_validator('logs_visibility_policy')
87
+ def logs_visibility_policy_validate_enum(cls, value):
88
+ """Validates the enum"""
89
+ if value is None:
90
+ return value
91
+
92
+ if value not in set(['show_all', 'show_private', 'show_owner']):
93
+ raise ValueError("must be one of enum values ('show_all', 'show_private', 'show_owner')")
94
+ return value
95
+
96
+ @field_validator('dataset_type')
97
+ def dataset_type_validate_enum(cls, value):
98
+ """Validates the enum"""
99
+ if value is None:
100
+ return value
101
+
102
+ if value not in set(['default', 'chatbot_playground', 'document_playground']):
103
+ raise ValueError("must be one of enum values ('default', 'chatbot_playground', 'document_playground')")
104
+ return value
105
+
106
+ model_config = ConfigDict(
107
+ populate_by_name=True,
108
+ validate_assignment=True,
109
+ protected_namespaces=(),
110
+ )
111
+
112
+
113
+ def to_str(self) -> str:
114
+ """Returns the string representation of the model using alias"""
115
+ return pprint.pformat(self.model_dump(by_alias=True))
116
+
117
+ def to_json(self) -> str:
118
+ """Returns the JSON representation of the model using alias"""
119
+ # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
120
+ return json.dumps(self.to_dict())
121
+
122
+ @classmethod
123
+ def from_json(cls, json_str: str) -> Optional[Self]:
124
+ """Create an instance of DatasetSchema from a JSON string"""
125
+ return cls.from_dict(json.loads(json_str))
126
+
127
+ def to_dict(self) -> Dict[str, Any]:
128
+ """Return the dictionary representation of the model using alias.
129
+
130
+ This has the following differences from calling pydantic's
131
+ `self.model_dump(by_alias=True)`:
132
+
133
+ * `None` is only added to the output dict for nullable fields that
134
+ were set at model initialization. Other fields with value `None`
135
+ are ignored.
136
+ """
137
+ excluded_fields: Set[str] = set([
138
+ ])
139
+
140
+ _dict = self.model_dump(
141
+ by_alias=True,
142
+ exclude=excluded_fields,
143
+ exclude_none=True,
144
+ )
145
+ # override the default output from pydantic by calling `to_dict()` of widget_configs
146
+ if self.widget_configs:
147
+ _dict['widget_configs'] = self.widget_configs.to_dict()
148
+ return _dict
149
+
150
+ @classmethod
151
+ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
152
+ """Create an instance of DatasetSchema from a dict"""
153
+ if obj is None:
154
+ return None
155
+
156
+ if not isinstance(obj, dict):
157
+ return cls.model_validate(obj)
158
+
159
+ _obj = cls.model_validate({
160
+ "id": obj.get("id"),
161
+ "dataset": obj.get("dataset"),
162
+ "username": obj.get("username"),
163
+ "index_hash": obj.get("index_hash"),
164
+ "do_ocr": obj.get("do_ocr"),
165
+ "language": obj.get("language"),
166
+ "is_updating": obj.get("is_updating"),
167
+ "use_reader": obj.get("use_reader"),
168
+ "use_ranker": obj.get("use_ranker"),
169
+ "use_fallback": obj.get("use_fallback"),
170
+ "top_k_retriever": obj.get("top_k_retriever"),
171
+ "top_k_reader": obj.get("top_k_reader"),
172
+ "top_k_ranker": obj.get("top_k_ranker"),
173
+ "return_no_ans": obj.get("return_no_ans"),
174
+ "no_ans_boost": obj.get("no_ans_boost"),
175
+ "max_seq_len": obj.get("max_seq_len"),
176
+ "doc_stride": obj.get("doc_stride"),
177
+ "max_ans_len": obj.get("max_ans_len"),
178
+ "weight_title": obj.get("weight_title"),
179
+ "weight_text": obj.get("weight_text"),
180
+ "split_by": obj.get("split_by"),
181
+ "split_len": obj.get("split_len"),
182
+ "split_overlap": obj.get("split_overlap"),
183
+ "llm_choice": obj.get("llm_choice"),
184
+ "bot_name": obj.get("bot_name"),
185
+ "bot_description": obj.get("bot_description"),
186
+ "bot_mode": obj.get("bot_mode"),
187
+ "bot_knowledge": obj.get("bot_knowledge"),
188
+ "bot_answer_length": obj.get("bot_answer_length"),
189
+ "bot_seed": obj.get("bot_seed"),
190
+ "bot_temperature": obj.get("bot_temperature"),
191
+ "prompt": obj.get("prompt"),
192
+ "number_of_references": obj.get("number_of_references"),
193
+ "stream_speed": obj.get("stream_speed"),
194
+ "initial_message": obj.get("initial_message"),
195
+ "track_geo": obj.get("track_geo"),
196
+ "creation_date": obj.get("creation_date"),
197
+ "use_training": obj.get("use_training"),
198
+ "embedding_model": obj.get("embedding_model"),
199
+ "data_storage_preference": obj.get("data_storage_preference"),
200
+ "logs_visibility_policy": obj.get("logs_visibility_policy"),
201
+ "dataset_type": obj.get("dataset_type"),
202
+ "widget_configs": WidgetConfigs.from_dict(obj["widget_configs"]) if obj.get("widget_configs") is not None else None,
203
+ "n_tokens": obj.get("n_tokens")
204
+ })
205
+ return _obj
206
+
207
+
@@ -0,0 +1,195 @@
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
+
15
+ from __future__ import annotations
16
+ import pprint
17
+ import re # noqa: F401
18
+ import json
19
+
20
+ from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictFloat, StrictInt, StrictStr, field_validator
21
+ from typing import Any, ClassVar, Dict, List, Optional, Union
22
+ from typing import Optional, Set
23
+ from typing_extensions import Self
24
+
25
+ class DatasetUpdateObject(BaseModel):
26
+ """
27
+ DatasetUpdateObject
28
+ """ # noqa: E501
29
+ dataset: StrictStr = Field(description="Dataset identifier")
30
+ username: StrictStr = Field(description="Username associated with the dataset")
31
+ is_updating: Optional[StrictBool] = Field(default=None, description="Flag to check if updating")
32
+ use_reader: Optional[StrictBool] = Field(default=None, description="Flag to use reader")
33
+ use_ranker: Optional[StrictBool] = Field(default=None, description="Flag to use ranker")
34
+ use_fallback: Optional[StrictBool] = Field(default=None, description="Use fallback option")
35
+ top_k_retriever: Optional[StrictInt] = Field(default=None, description="Number of retriever results")
36
+ top_k_reader: Optional[StrictInt] = Field(default=None, description="Number of reader results")
37
+ do_ocr: Optional[StrictBool] = Field(default=None, description="Flag for OCR usage")
38
+ return_no_ans: Optional[StrictBool] = Field(default=None, description="Return no answer flag")
39
+ no_ans_boost: Optional[StrictInt] = Field(default=None, description="No answer boost")
40
+ max_seq_len: Optional[StrictInt] = Field(default=None, description="Maximum sequence length")
41
+ doc_stride: Optional[StrictInt] = Field(default=None, description="Document stride")
42
+ max_ans_len: Optional[StrictInt] = Field(default=None, description="Maximum answer length")
43
+ weight_title: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, description="Weight of title in ranking")
44
+ weight_text: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, description="Weight of text in ranking")
45
+ llm_choice: Optional[StrictStr] = Field(default=None, description="Choice of language model")
46
+ bot_name: Optional[StrictStr] = Field(default=None, description="Bot name")
47
+ bot_description: Optional[StrictStr] = Field(default=None, description="Bot description")
48
+ bot_mode: Optional[StrictStr] = Field(default=None, description="Bot mode")
49
+ bot_knowledge: Optional[StrictStr] = Field(default=None, description="Bot knowledge settings")
50
+ bot_answer_length: Optional[StrictStr] = Field(default=None, description="Bot answer length")
51
+ bot_seed: Optional[StrictInt] = Field(default=None, description="Seed for bot randomness")
52
+ bot_temperature: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, description="Temperature for bot responses")
53
+ prompt: Optional[StrictStr] = Field(default=None, description="Prompt to give the bot")
54
+ number_of_references: Optional[StrictInt] = Field(default=None, description="Number of references used in answering questions")
55
+ data_storage_preference: Optional[StrictStr] = None
56
+ logs_visibility_policy: Optional[StrictStr] = None
57
+ stream_speed: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, description="Stream speed")
58
+ initial_message: Optional[StrictStr] = Field(default=None, description="Initial message displayed")
59
+ widget_init_msg: Optional[StrictStr] = Field(default=None, description="Widget's initial message")
60
+ widget_theme: Optional[StrictStr] = Field(default=None, description="Widget theme")
61
+ widget_open_default: Optional[StrictBool] = Field(default=None, description="Flag to open widget by default")
62
+ widget_font: Optional[StrictStr] = Field(default=None, description="Font used in the widget")
63
+ widget_color_primary: Optional[StrictStr] = Field(default=None, description="Primary color of the widget", alias="widget_colorPrimary")
64
+ widget_color_secondary: Optional[StrictStr] = Field(default=None, description="Secondary color of the widget", alias="widget_colorSecondary")
65
+ widget_align: Optional[StrictStr] = Field(default=None, description="Widget alignment")
66
+ widget_offset_x: Optional[StrictInt] = Field(default=None, description="Widget offset X", alias="widget_offsetX")
67
+ widget_offset_y: Optional[StrictInt] = Field(default=None, description="Widget offset Y", alias="widget_offsetY")
68
+ widget_show_powered_by: Optional[StrictBool] = Field(default=None, description="Show powered by label in the widget")
69
+ track_geo: Optional[StrictBool] = Field(default=None, description="Flag to track geo location")
70
+ use_training: Optional[StrictBool] = Field(default=None, description="Flag to use training data")
71
+ split_by: Optional[StrictStr] = Field(default=None, description="Split method")
72
+ split_len: Optional[StrictInt] = Field(default=None, description="Split length")
73
+ split_overlap: Optional[StrictInt] = Field(default=None, description="Split overlap")
74
+ __properties: ClassVar[List[str]] = ["dataset", "username", "is_updating", "use_reader", "use_ranker", "use_fallback", "top_k_retriever", "top_k_reader", "do_ocr", "return_no_ans", "no_ans_boost", "max_seq_len", "doc_stride", "max_ans_len", "weight_title", "weight_text", "llm_choice", "bot_name", "bot_description", "bot_mode", "bot_knowledge", "bot_answer_length", "bot_seed", "bot_temperature", "prompt", "number_of_references", "data_storage_preference", "logs_visibility_policy", "stream_speed", "initial_message", "widget_init_msg", "widget_theme", "widget_open_default", "widget_font", "widget_colorPrimary", "widget_colorSecondary", "widget_align", "widget_offsetX", "widget_offsetY", "widget_show_powered_by", "track_geo", "use_training", "split_by", "split_len", "split_overlap"]
75
+
76
+ @field_validator('data_storage_preference')
77
+ def data_storage_preference_validate_enum(cls, value):
78
+ """Validates the enum"""
79
+ if value is None:
80
+ return value
81
+
82
+ if value not in set(['store_all', 'discard_all', 'store_anonymized']):
83
+ raise ValueError("must be one of enum values ('store_all', 'discard_all', 'store_anonymized')")
84
+ return value
85
+
86
+ @field_validator('logs_visibility_policy')
87
+ def logs_visibility_policy_validate_enum(cls, value):
88
+ """Validates the enum"""
89
+ if value is None:
90
+ return value
91
+
92
+ if value not in set(['show_all', 'show_private', 'show_owner']):
93
+ raise ValueError("must be one of enum values ('show_all', 'show_private', 'show_owner')")
94
+ return value
95
+
96
+ model_config = ConfigDict(
97
+ populate_by_name=True,
98
+ validate_assignment=True,
99
+ protected_namespaces=(),
100
+ )
101
+
102
+
103
+ def to_str(self) -> str:
104
+ """Returns the string representation of the model using alias"""
105
+ return pprint.pformat(self.model_dump(by_alias=True))
106
+
107
+ def to_json(self) -> str:
108
+ """Returns the JSON representation of the model using alias"""
109
+ # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
110
+ return json.dumps(self.to_dict())
111
+
112
+ @classmethod
113
+ def from_json(cls, json_str: str) -> Optional[Self]:
114
+ """Create an instance of DatasetUpdateObject from a JSON string"""
115
+ return cls.from_dict(json.loads(json_str))
116
+
117
+ def to_dict(self) -> Dict[str, Any]:
118
+ """Return the dictionary representation of the model using alias.
119
+
120
+ This has the following differences from calling pydantic's
121
+ `self.model_dump(by_alias=True)`:
122
+
123
+ * `None` is only added to the output dict for nullable fields that
124
+ were set at model initialization. Other fields with value `None`
125
+ are ignored.
126
+ """
127
+ excluded_fields: Set[str] = set([
128
+ ])
129
+
130
+ _dict = self.model_dump(
131
+ by_alias=True,
132
+ exclude=excluded_fields,
133
+ exclude_none=True,
134
+ )
135
+ return _dict
136
+
137
+ @classmethod
138
+ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
139
+ """Create an instance of DatasetUpdateObject from a dict"""
140
+ if obj is None:
141
+ return None
142
+
143
+ if not isinstance(obj, dict):
144
+ return cls.model_validate(obj)
145
+
146
+ _obj = cls.model_validate({
147
+ "dataset": obj.get("dataset"),
148
+ "username": obj.get("username"),
149
+ "is_updating": obj.get("is_updating"),
150
+ "use_reader": obj.get("use_reader"),
151
+ "use_ranker": obj.get("use_ranker"),
152
+ "use_fallback": obj.get("use_fallback"),
153
+ "top_k_retriever": obj.get("top_k_retriever"),
154
+ "top_k_reader": obj.get("top_k_reader"),
155
+ "do_ocr": obj.get("do_ocr"),
156
+ "return_no_ans": obj.get("return_no_ans"),
157
+ "no_ans_boost": obj.get("no_ans_boost"),
158
+ "max_seq_len": obj.get("max_seq_len"),
159
+ "doc_stride": obj.get("doc_stride"),
160
+ "max_ans_len": obj.get("max_ans_len"),
161
+ "weight_title": obj.get("weight_title"),
162
+ "weight_text": obj.get("weight_text"),
163
+ "llm_choice": obj.get("llm_choice"),
164
+ "bot_name": obj.get("bot_name"),
165
+ "bot_description": obj.get("bot_description"),
166
+ "bot_mode": obj.get("bot_mode"),
167
+ "bot_knowledge": obj.get("bot_knowledge"),
168
+ "bot_answer_length": obj.get("bot_answer_length"),
169
+ "bot_seed": obj.get("bot_seed"),
170
+ "bot_temperature": obj.get("bot_temperature"),
171
+ "prompt": obj.get("prompt"),
172
+ "number_of_references": obj.get("number_of_references"),
173
+ "data_storage_preference": obj.get("data_storage_preference"),
174
+ "logs_visibility_policy": obj.get("logs_visibility_policy"),
175
+ "stream_speed": obj.get("stream_speed"),
176
+ "initial_message": obj.get("initial_message"),
177
+ "widget_init_msg": obj.get("widget_init_msg"),
178
+ "widget_theme": obj.get("widget_theme"),
179
+ "widget_open_default": obj.get("widget_open_default"),
180
+ "widget_font": obj.get("widget_font"),
181
+ "widget_colorPrimary": obj.get("widget_colorPrimary"),
182
+ "widget_colorSecondary": obj.get("widget_colorSecondary"),
183
+ "widget_align": obj.get("widget_align"),
184
+ "widget_offsetX": obj.get("widget_offsetX"),
185
+ "widget_offsetY": obj.get("widget_offsetY"),
186
+ "widget_show_powered_by": obj.get("widget_show_powered_by"),
187
+ "track_geo": obj.get("track_geo"),
188
+ "use_training": obj.get("use_training"),
189
+ "split_by": obj.get("split_by"),
190
+ "split_len": obj.get("split_len"),
191
+ "split_overlap": obj.get("split_overlap")
192
+ })
193
+ return _obj
194
+
195
+
@@ -0,0 +1,87 @@
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
+
15
+ from __future__ import annotations
16
+ import pprint
17
+ import re # noqa: F401
18
+ import json
19
+
20
+ from pydantic import BaseModel, ConfigDict, StrictStr
21
+ from typing import Any, ClassVar, Dict, List
22
+ from typing import Optional, Set
23
+ from typing_extensions import Self
24
+
25
+ class DatasetUsersResponse(BaseModel):
26
+ """
27
+ DatasetUsersResponse
28
+ """ # noqa: E501
29
+ users: List[StrictStr]
30
+ __properties: ClassVar[List[str]] = ["users"]
31
+
32
+ model_config = ConfigDict(
33
+ populate_by_name=True,
34
+ validate_assignment=True,
35
+ protected_namespaces=(),
36
+ )
37
+
38
+
39
+ def to_str(self) -> str:
40
+ """Returns the string representation of the model using alias"""
41
+ return pprint.pformat(self.model_dump(by_alias=True))
42
+
43
+ def to_json(self) -> str:
44
+ """Returns the JSON representation of the model using alias"""
45
+ # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
46
+ return json.dumps(self.to_dict())
47
+
48
+ @classmethod
49
+ def from_json(cls, json_str: str) -> Optional[Self]:
50
+ """Create an instance of DatasetUsersResponse from a JSON string"""
51
+ return cls.from_dict(json.loads(json_str))
52
+
53
+ def to_dict(self) -> Dict[str, Any]:
54
+ """Return the dictionary representation of the model using alias.
55
+
56
+ This has the following differences from calling pydantic's
57
+ `self.model_dump(by_alias=True)`:
58
+
59
+ * `None` is only added to the output dict for nullable fields that
60
+ were set at model initialization. Other fields with value `None`
61
+ are ignored.
62
+ """
63
+ excluded_fields: Set[str] = set([
64
+ ])
65
+
66
+ _dict = self.model_dump(
67
+ by_alias=True,
68
+ exclude=excluded_fields,
69
+ exclude_none=True,
70
+ )
71
+ return _dict
72
+
73
+ @classmethod
74
+ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
75
+ """Create an instance of DatasetUsersResponse from a dict"""
76
+ if obj is None:
77
+ return None
78
+
79
+ if not isinstance(obj, dict):
80
+ return cls.model_validate(obj)
81
+
82
+ _obj = cls.model_validate({
83
+ "users": obj.get("users")
84
+ })
85
+ return _obj
86
+
87
+