import logging from typing import Any, Literal from uuid import UUID from flask import request from flask_restx import Resource from pydantic import BaseModel, Field, field_validator from werkzeug.exceptions import BadRequest, InternalServerError, NotFound import services from controllers.common.fields import GeneratedAppResponse, SimpleResultResponse from controllers.common.schema import register_response_schema_models, register_schema_models from controllers.service_api import service_api_ns from controllers.service_api.app.error import ( AppUnavailableError, CompletionRequestError, ConversationCompletedError, NotChatAppError, ProviderModelCurrentlyNotSupportError, ProviderNotInitializeError, ProviderQuotaExceededError, ) from controllers.service_api.schema import expect_user_json, expect_with_user, json_or_event_stream_response from controllers.service_api.wraps import FetchUserArg, WhereisUserArg, validate_app_token from controllers.web.error import InvokeRateLimitError as InvokeRateLimitHttpError from core.app.entities.app_invoke_entities import InvokeFrom from core.errors.error import ( ModelCurrentlyNotSupportError, ProviderTokenNotInitError, QuotaExceededError, ) from core.helper.trace_id_helper import get_external_trace_id, get_trace_session_id, omit_trace_session_id_from_payload from graphon.model_runtime.errors.invoke import InvokeError from libs import helper from libs.helper import UUIDStrOrEmpty from models.model import App, AppMode, EndUser from services.app_generate_service import AppGenerateService from services.app_task_service import AppTaskService from services.errors.app import IsDraftWorkflowError, WorkflowIdFormatError, WorkflowNotFoundError from services.errors.llm import InvokeRateLimitError logger = logging.getLogger(__name__) def _resolve_agent_app_streaming(*, app_mode: AppMode, response_mode: str | None) -> bool: """Agent App runtime is SSE-only until backend blocking runs are supported.""" if app_mode != AppMode.AGENT: return response_mode == "streaming" if response_mode == "blocking": raise BadRequest("Agent App only supports streaming response mode.") return True class CompletionRequestPayload(BaseModel): inputs: dict[str, Any] query: str = Field(default="") files: list[dict[str, Any]] | None = Field(default=None) response_mode: Literal["blocking", "streaming"] | None = None retriever_from: str = Field(default="dev") trace_session_id: str | None = Field(default=None, description="Trace session ID for observability grouping") class ChatRequestPayload(BaseModel): inputs: dict[str, Any] query: str files: list[dict[str, Any]] | None = Field(default=None) response_mode: Literal["blocking", "streaming"] | None = None conversation_id: UUIDStrOrEmpty | None = Field(default=None, description="Conversation UUID") retriever_from: str = Field(default="dev") auto_generate_name: bool = Field(default=True, description="Auto generate conversation name") workflow_id: str | None = Field(default=None, description="Workflow ID for advanced chat") trace_session_id: str | None = Field(default=None, description="Trace session ID for observability grouping") @field_validator("conversation_id", mode="before") @classmethod def normalize_conversation_id(cls, value: str | UUID | None) -> str | None: """Allow missing or blank conversation IDs; enforce UUID format when provided.""" if isinstance(value, str): value = value.strip() if not value: return None try: return helper.uuid_value(value) except ValueError as exc: raise ValueError("conversation_id must be a valid UUID") from exc register_schema_models(service_api_ns, CompletionRequestPayload, ChatRequestPayload) register_response_schema_models(service_api_ns, GeneratedAppResponse, SimpleResultResponse) @service_api_ns.route("/completion-messages") class CompletionApi(Resource): @service_api_ns.doc( summary="Send Completion Message", description="Send a request to the text generation application.", tags=["Completions"], responses={ 200: ( "Successful response. The content type and structure depend on the `response_mode` parameter " "in the request.\n" "\n" "- If `response_mode` is `blocking`, returns `application/json` with a `CompletionResponse` " "object.\n" "- If `response_mode` is `streaming`, returns `text/event-stream` with a stream of " "`ChunkCompletionEvent` objects." ), 400: ( "- `app_unavailable` : App unavailable or misconfigured.\n" "- `provider_not_initialize` : No valid model provider credentials found.\n" "- `provider_quota_exceeded` : Model provider quota exhausted.\n" "- `model_currently_not_support` : Current model unavailable.\n" "- `completion_request_error` : Text generation failed." ), 429: "`too_many_requests` : Too many concurrent requests for this app.", 500: "`internal_server_error` : Internal server error.", }, ) @expect_with_user(service_api_ns, CompletionRequestPayload) @json_or_event_stream_response(service_api_ns) @service_api_ns.doc("create_completion") @service_api_ns.doc(description="Create a completion for the given prompt") @service_api_ns.doc( responses={ 200: "Completion created successfully", 400: "Bad request - invalid parameters", 401: "Unauthorized - invalid API token", 404: "Conversation not found", 500: "Internal server error", } ) @service_api_ns.response( 200, "Completion created successfully", service_api_ns.models[GeneratedAppResponse.__name__], ) @validate_app_token(fetch_user_arg=FetchUserArg(fetch_from=WhereisUserArg.JSON, required=True)) def post(self, app_model: App, end_user: EndUser): """Create a completion for the given prompt. This endpoint generates a completion based on the provided inputs and query. Supports both blocking and streaming response modes. """ if app_model.mode != AppMode.COMPLETION: raise AppUnavailableError() payload = CompletionRequestPayload.model_validate( omit_trace_session_id_from_payload(service_api_ns.payload) or {} ) external_trace_id = get_external_trace_id(request) args = payload.model_dump(exclude_none=True) trace_session_id = get_trace_session_id(request) if trace_session_id: args["trace_session_id"] = trace_session_id if external_trace_id: args["external_trace_id"] = external_trace_id streaming = payload.response_mode == "streaming" args["auto_generate_name"] = False try: response = AppGenerateService.generate( app_model=app_model, user=end_user, args=args, invoke_from=InvokeFrom.SERVICE_API, streaming=streaming, ) return helper.compact_generate_response(response) except services.errors.conversation.ConversationNotExistsError: raise NotFound("Conversation Not Exists.") except services.errors.conversation.ConversationCompletedError: raise ConversationCompletedError() except services.errors.app_model_config.AppModelConfigBrokenError: logger.exception("App model config broken.") raise AppUnavailableError() except ProviderTokenNotInitError as ex: raise ProviderNotInitializeError(ex.description) except QuotaExceededError: raise ProviderQuotaExceededError() except ModelCurrentlyNotSupportError: raise ProviderModelCurrentlyNotSupportError() except InvokeError as e: raise CompletionRequestError(e.description) except ValueError as e: raise e except Exception: logger.exception("internal server error.") raise InternalServerError() @service_api_ns.route("/completion-messages//stop") class CompletionStopApi(Resource): @service_api_ns.doc( summary="Stop Completion Message Generation", description="Stops a completion message generation task. Only supported in `streaming` mode.", tags=["Completions"], responses={ 400: "`app_unavailable` : App unavailable or misconfigured.", }, ) @expect_user_json(service_api_ns) @service_api_ns.doc("stop_completion") @service_api_ns.doc(description="Stop a running completion task") @service_api_ns.doc(params={"task_id": "The ID of the task to stop"}) @service_api_ns.doc( responses={ 200: "Task stopped successfully", 401: "Unauthorized - invalid API token", 404: "Task not found", } ) @service_api_ns.response(200, "Task stopped successfully", service_api_ns.models[SimpleResultResponse.__name__]) @validate_app_token(fetch_user_arg=FetchUserArg(fetch_from=WhereisUserArg.JSON, required=True)) def post(self, app_model: App, end_user: EndUser, task_id: str): """Stop a running completion task.""" if app_model.mode != AppMode.COMPLETION: raise AppUnavailableError() AppTaskService.stop_task( task_id=task_id, invoke_from=InvokeFrom.SERVICE_API, user_id=end_user.id, app_mode=AppMode.value_of(app_model.mode), ) return {"result": "success"}, 200 @service_api_ns.route("/chat-messages") class ChatApi(Resource): @service_api_ns.doc( summary="Send Chat Message", description="Send a request to the chat application.", tags=["Chats", "Chatflows"], responses={ 200: ( "Successful response. The content type and structure depend on the `response_mode` parameter " "in the request.\n" "\n" "- If `response_mode` is `blocking`, returns `application/json` with a " "`ChatCompletionResponse` object.\n" "- If `response_mode` is `streaming`, returns `text/event-stream` with a stream of " "Server-Sent Events." ), 400: ( "- `app_unavailable` : App unavailable or misconfigured.\n" "- `not_chat_app` : App mode does not match the API route.\n" "- `conversation_completed` : The conversation has ended.\n" "- `provider_not_initialize` : No valid model provider credentials found.\n" "- `provider_quota_exceeded` : Model provider quota exhausted.\n" "- `model_currently_not_support` : Current model unavailable.\n" "- `completion_request_error` : Text generation failed." ), 404: "`not_found` : Conversation does not exist.", 429: ( "- `too_many_requests` : Too many concurrent requests for this app.\n" "- `rate_limit_error` : The upstream model provider rate limit was exceeded." ), 500: "`internal_server_error` : Internal server error.", }, ) @expect_with_user(service_api_ns, ChatRequestPayload) @json_or_event_stream_response(service_api_ns) @service_api_ns.doc("create_chat_message") @service_api_ns.doc(description="Send a message in a chat conversation") @service_api_ns.doc( responses={ 200: "Message sent successfully", 400: "Bad request - invalid parameters or workflow issues", 401: "Unauthorized - invalid API token", 404: "Conversation or workflow not found", 429: "Rate limit exceeded", 500: "Internal server error", } ) @service_api_ns.response( 200, "Message sent successfully", service_api_ns.models[GeneratedAppResponse.__name__], ) @validate_app_token(fetch_user_arg=FetchUserArg(fetch_from=WhereisUserArg.JSON, required=True)) def post(self, app_model: App, end_user: EndUser): """Send a message in a chat conversation. This endpoint handles chat messages for chat, agent chat, and advanced chat applications. Supports conversation management and both blocking and streaming response modes. """ app_mode = AppMode.value_of(app_model.mode) if app_mode not in {AppMode.CHAT, AppMode.AGENT_CHAT, AppMode.ADVANCED_CHAT, AppMode.AGENT}: raise NotChatAppError() payload = ChatRequestPayload.model_validate(omit_trace_session_id_from_payload(service_api_ns.payload) or {}) external_trace_id = get_external_trace_id(request) args = payload.model_dump(exclude_none=True) trace_session_id = get_trace_session_id(request) if trace_session_id: args["trace_session_id"] = trace_session_id if external_trace_id: args["external_trace_id"] = external_trace_id streaming = _resolve_agent_app_streaming(app_mode=app_mode, response_mode=payload.response_mode) try: response = AppGenerateService.generate( app_model=app_model, user=end_user, args=args, invoke_from=InvokeFrom.SERVICE_API, streaming=streaming ) return helper.compact_generate_response(response) except WorkflowNotFoundError as ex: raise NotFound(str(ex)) except IsDraftWorkflowError as ex: raise BadRequest(str(ex)) except WorkflowIdFormatError as ex: raise BadRequest(str(ex)) except services.errors.conversation.ConversationNotExistsError: raise NotFound("Conversation Not Exists.") except services.errors.conversation.ConversationCompletedError: raise ConversationCompletedError() except services.errors.app_model_config.AppModelConfigBrokenError: logger.exception("App model config broken.") raise AppUnavailableError() except ProviderTokenNotInitError as ex: raise ProviderNotInitializeError(ex.description) except QuotaExceededError: raise ProviderQuotaExceededError() except ModelCurrentlyNotSupportError: raise ProviderModelCurrentlyNotSupportError() except InvokeRateLimitError as ex: raise InvokeRateLimitHttpError(ex.description) except InvokeError as e: raise CompletionRequestError(e.description) except ValueError as e: raise e except Exception: logger.exception("internal server error.") raise InternalServerError() @service_api_ns.route("/chat-messages//stop") class ChatStopApi(Resource): @service_api_ns.doc( summary="Stop Chat Message Generation", description="Stops a chat message generation task. Only supported in `streaming` mode.", tags=["Chats", "Chatflows"], responses={ 400: "`not_chat_app` : App mode does not match the API route.", }, ) @expect_user_json(service_api_ns) @service_api_ns.doc("stop_chat_message") @service_api_ns.doc(description="Stop a running chat message generation") @service_api_ns.doc(params={"task_id": "The ID of the task to stop"}) @service_api_ns.doc( responses={ 200: "Task stopped successfully", 401: "Unauthorized - invalid API token", 404: "Task not found", } ) @service_api_ns.response(200, "Task stopped successfully", service_api_ns.models[SimpleResultResponse.__name__]) @validate_app_token(fetch_user_arg=FetchUserArg(fetch_from=WhereisUserArg.JSON, required=True)) def post(self, app_model: App, end_user: EndUser, task_id: str): """Stop a running chat message generation.""" app_mode = AppMode.value_of(app_model.mode) if app_mode not in {AppMode.CHAT, AppMode.AGENT_CHAT, AppMode.ADVANCED_CHAT, AppMode.AGENT}: raise NotChatAppError() AppTaskService.stop_task( task_id=task_id, invoke_from=InvokeFrom.SERVICE_API, user_id=end_user.id, app_mode=app_mode, ) return {"result": "success"}, 200