message.py 9.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217
  1. # -*- coding:utf-8 -*-
  2. import json
  3. import logging
  4. from typing import Generator, Union
  5. from flask import stream_with_context, Response
  6. from flask_restful import reqparse, fields, marshal_with
  7. from flask_restful.inputs import int_range
  8. from werkzeug.exceptions import NotFound, InternalServerError
  9. import services
  10. from controllers.web import api
  11. from controllers.web.error import NotChatAppError, CompletionRequestError, ProviderNotInitializeError, \
  12. AppMoreLikeThisDisabledError, NotCompletionAppError, AppSuggestedQuestionsAfterAnswerDisabledError, \
  13. ProviderQuotaExceededError, ProviderModelCurrentlyNotSupportError
  14. from controllers.web.wraps import WebApiResource
  15. from core.entities.application_entities import InvokeFrom
  16. from core.errors.error import ProviderTokenNotInitError, QuotaExceededError, ModelCurrentlyNotSupportError
  17. from core.model_runtime.errors.invoke import InvokeError
  18. from libs.helper import uuid_value, TimestampField
  19. from services.completion_service import CompletionService
  20. from services.errors.app import MoreLikeThisDisabledError
  21. from services.errors.conversation import ConversationNotExistsError
  22. from services.errors.message import MessageNotExistsError, SuggestedQuestionsAfterAnswerDisabledError
  23. from services.message_service import MessageService
  24. from fields.conversation_fields import message_file_fields
  25. class MessageListApi(WebApiResource):
  26. feedback_fields = {
  27. 'rating': fields.String
  28. }
  29. retriever_resource_fields = {
  30. 'id': fields.String,
  31. 'message_id': fields.String,
  32. 'position': fields.Integer,
  33. 'dataset_id': fields.String,
  34. 'dataset_name': fields.String,
  35. 'document_id': fields.String,
  36. 'document_name': fields.String,
  37. 'data_source_type': fields.String,
  38. 'segment_id': fields.String,
  39. 'score': fields.Float,
  40. 'hit_count': fields.Integer,
  41. 'word_count': fields.Integer,
  42. 'segment_position': fields.Integer,
  43. 'index_node_hash': fields.String,
  44. 'content': fields.String,
  45. 'created_at': TimestampField
  46. }
  47. message_fields = {
  48. 'id': fields.String,
  49. 'conversation_id': fields.String,
  50. 'inputs': fields.Raw,
  51. 'query': fields.String,
  52. 'answer': fields.String,
  53. 'message_files': fields.List(fields.Nested(message_file_fields), attribute='files'),
  54. 'feedback': fields.Nested(feedback_fields, attribute='user_feedback', allow_null=True),
  55. 'retriever_resources': fields.List(fields.Nested(retriever_resource_fields)),
  56. 'created_at': TimestampField
  57. }
  58. message_infinite_scroll_pagination_fields = {
  59. 'limit': fields.Integer,
  60. 'has_more': fields.Boolean,
  61. 'data': fields.List(fields.Nested(message_fields))
  62. }
  63. @marshal_with(message_infinite_scroll_pagination_fields)
  64. def get(self, app_model, end_user):
  65. if app_model.mode != 'chat':
  66. raise NotChatAppError()
  67. parser = reqparse.RequestParser()
  68. parser.add_argument('conversation_id', required=True, type=uuid_value, location='args')
  69. parser.add_argument('first_id', type=uuid_value, location='args')
  70. parser.add_argument('limit', type=int_range(1, 100), required=False, default=20, location='args')
  71. args = parser.parse_args()
  72. try:
  73. return MessageService.pagination_by_first_id(app_model, end_user,
  74. args['conversation_id'], args['first_id'], args['limit'])
  75. except services.errors.conversation.ConversationNotExistsError:
  76. raise NotFound("Conversation Not Exists.")
  77. except services.errors.message.FirstMessageNotExistsError:
  78. raise NotFound("First Message Not Exists.")
  79. class MessageFeedbackApi(WebApiResource):
  80. def post(self, app_model, end_user, message_id):
  81. message_id = str(message_id)
  82. parser = reqparse.RequestParser()
  83. parser.add_argument('rating', type=str, choices=['like', 'dislike', None], location='json')
  84. args = parser.parse_args()
  85. try:
  86. MessageService.create_feedback(app_model, message_id, end_user, args['rating'])
  87. except services.errors.message.MessageNotExistsError:
  88. raise NotFound("Message Not Exists.")
  89. return {'result': 'success'}
  90. class MessageMoreLikeThisApi(WebApiResource):
  91. def get(self, app_model, end_user, message_id):
  92. if app_model.mode != 'completion':
  93. raise NotCompletionAppError()
  94. message_id = str(message_id)
  95. parser = reqparse.RequestParser()
  96. parser.add_argument('response_mode', type=str, required=True, choices=['blocking', 'streaming'], location='args')
  97. args = parser.parse_args()
  98. streaming = args['response_mode'] == 'streaming'
  99. try:
  100. response = CompletionService.generate_more_like_this(
  101. app_model=app_model,
  102. user=end_user,
  103. message_id=message_id,
  104. invoke_from=InvokeFrom.WEB_APP,
  105. streaming=streaming
  106. )
  107. return compact_response(response)
  108. except MessageNotExistsError:
  109. raise NotFound("Message Not Exists.")
  110. except MoreLikeThisDisabledError:
  111. raise AppMoreLikeThisDisabledError()
  112. except ProviderTokenNotInitError as ex:
  113. raise ProviderNotInitializeError(ex.description)
  114. except QuotaExceededError:
  115. raise ProviderQuotaExceededError()
  116. except ModelCurrentlyNotSupportError:
  117. raise ProviderModelCurrentlyNotSupportError()
  118. except InvokeError as e:
  119. raise CompletionRequestError(str(e))
  120. except ValueError as e:
  121. raise e
  122. except Exception:
  123. logging.exception("internal server error.")
  124. raise InternalServerError()
  125. def compact_response(response: Union[dict, Generator]) -> Response:
  126. if isinstance(response, dict):
  127. return Response(response=json.dumps(response), status=200, mimetype='application/json')
  128. else:
  129. def generate() -> Generator:
  130. try:
  131. for chunk in response:
  132. yield chunk
  133. except MessageNotExistsError:
  134. yield "data: " + json.dumps(api.handle_error(NotFound("Message Not Exists.")).get_json()) + "\n\n"
  135. except MoreLikeThisDisabledError:
  136. yield "data: " + json.dumps(api.handle_error(AppMoreLikeThisDisabledError()).get_json()) + "\n\n"
  137. except ProviderTokenNotInitError as ex:
  138. yield "data: " + json.dumps(api.handle_error(ProviderNotInitializeError(ex.description)).get_json()) + "\n\n"
  139. except QuotaExceededError:
  140. yield "data: " + json.dumps(api.handle_error(ProviderQuotaExceededError()).get_json()) + "\n\n"
  141. except ModelCurrentlyNotSupportError:
  142. yield "data: " + json.dumps(api.handle_error(ProviderModelCurrentlyNotSupportError()).get_json()) + "\n\n"
  143. except InvokeError as e:
  144. yield "data: " + json.dumps(api.handle_error(CompletionRequestError(str(e))).get_json()) + "\n\n"
  145. except ValueError as e:
  146. yield "data: " + json.dumps(api.handle_error(e).get_json()) + "\n\n"
  147. except Exception:
  148. logging.exception("internal server error.")
  149. yield "data: " + json.dumps(api.handle_error(InternalServerError()).get_json()) + "\n\n"
  150. return Response(stream_with_context(generate()), status=200,
  151. mimetype='text/event-stream')
  152. class MessageSuggestedQuestionApi(WebApiResource):
  153. def get(self, app_model, end_user, message_id):
  154. if app_model.mode != 'chat':
  155. raise NotCompletionAppError()
  156. message_id = str(message_id)
  157. try:
  158. questions = MessageService.get_suggested_questions_after_answer(
  159. app_model=app_model,
  160. user=end_user,
  161. message_id=message_id
  162. )
  163. except MessageNotExistsError:
  164. raise NotFound("Message not found")
  165. except ConversationNotExistsError:
  166. raise NotFound("Conversation not found")
  167. except SuggestedQuestionsAfterAnswerDisabledError:
  168. raise AppSuggestedQuestionsAfterAnswerDisabledError()
  169. except ProviderTokenNotInitError as ex:
  170. raise ProviderNotInitializeError(ex.description)
  171. except QuotaExceededError:
  172. raise ProviderQuotaExceededError()
  173. except ModelCurrentlyNotSupportError:
  174. raise ProviderModelCurrentlyNotSupportError()
  175. except InvokeError as e:
  176. raise CompletionRequestError(str(e))
  177. except Exception:
  178. logging.exception("internal server error.")
  179. raise InternalServerError()
  180. return {'data': questions}
  181. api.add_resource(MessageListApi, '/messages')
  182. api.add_resource(MessageFeedbackApi, '/messages/<uuid:message_id>/feedbacks')
  183. api.add_resource(MessageMoreLikeThisApi, '/messages/<uuid:message_id>/more-like-this')
  184. api.add_resource(MessageSuggestedQuestionApi, '/messages/<uuid:message_id>/suggested-questions')