feat(core): Support multi round conversation operator (#986)

dbgpt/serve/conversation/__init__.py

@@ -0,0 +1,2 @@
+# This is an auto-generated __init__.py file
+# generated by `dbgpt new serve conversation`

dbgpt/serve/conversation/api/__init__.py

@@ -0,0 +1,2 @@
+# This is an auto-generated __init__.py file
+# generated by `dbgpt new serve conversation`

dbgpt/serve/conversation/api/endpoints.py

@@ -0,0 +1,176 @@
+from typing import Optional, List
+from functools import cache
+from fastapi import APIRouter, Depends, Query, HTTPException
+from fastapi.security.http import HTTPAuthorizationCredentials, HTTPBearer
+
+
+from dbgpt.component import SystemApp
+from dbgpt.serve.core import Result
+from dbgpt.util import PaginationResult
+from .schemas import ServeRequest, ServerResponse
+from ..service.service import Service
+from ..config import APP_NAME, SERVE_APP_NAME, ServeConfig, SERVE_SERVICE_COMPONENT_NAME
+
+router = APIRouter()
+
+# Add your API endpoints here
+
+global_system_app: Optional[SystemApp] = None
+
+
+def get_service() -> Service:
+    """Get the service instance"""
+    return global_system_app.get_component(SERVE_SERVICE_COMPONENT_NAME, Service)
+
+
+get_bearer_token = HTTPBearer(auto_error=False)
+
+
+@cache
+def _parse_api_keys(api_keys: str) -> List[str]:
+    """Parse the string api keys to a list
+
+    Args:
+        api_keys (str): The string api keys
+
+    Returns:
+        List[str]: The list of api keys
+    """
+    if not api_keys:
+        return []
+    return [key.strip() for key in api_keys.split(",")]
+
+
+async def check_api_key(
+    auth: Optional[HTTPAuthorizationCredentials] = Depends(get_bearer_token),
+    service: Service = Depends(get_service),
+) -> Optional[str]:
+    """Check the api key
+
+    If the api key is not set, allow all.
+
+    Your can pass the token in you request header like this:
+
+    .. code-block:: python
+
+        import requests
+        client_api_key = "your_api_key"
+        headers = {"Authorization": "Bearer " + client_api_key }
+        res = requests.get("http://test/hello", headers=headers)
+        assert res.status_code == 200
+
+    """
+    if service.config.api_keys:
+        api_keys = _parse_api_keys(service.config.api_keys)
+        if auth is None or (token := auth.credentials) not in api_keys:
+            raise HTTPException(
+                status_code=401,
+                detail={
+                    "error": {
+                        "message": "",
+                        "type": "invalid_request_error",
+                        "param": None,
+                        "code": "invalid_api_key",
+                    }
+                },
+            )
+        return token
+    else:
+        # api_keys not set; allow all
+        return None
+
+
+@router.get("/health")
+async def health():
+    """Health check endpoint"""
+    return {"status": "ok"}
+
+
+@router.get("/test_auth", dependencies=[Depends(check_api_key)])
+async def test_auth():
+    """Test auth endpoint"""
+    return {"status": "ok"}
+
+
+@router.post(
+    "/", response_model=Result[ServerResponse], dependencies=[Depends(check_api_key)]
+)
+async def create(
+    request: ServeRequest, service: Service = Depends(get_service)
+) -> Result[ServerResponse]:
+    """Create a new Conversation entity
+
+    Args:
+        request (ServeRequest): The request
+        service (Service): The service
+    Returns:
+        ServerResponse: The response
+    """
+    return Result.succ(service.create(request))
+
+
+@router.put(
+    "/", response_model=Result[ServerResponse], dependencies=[Depends(check_api_key)]
+)
+async def update(
+    request: ServeRequest, service: Service = Depends(get_service)
+) -> Result[ServerResponse]:
+    """Update a Conversation entity
+
+    Args:
+        request (ServeRequest): The request
+        service (Service): The service
+    Returns:
+        ServerResponse: The response
+    """
+    return Result.succ(service.update(request))
+
+
+@router.post(
+    "/query",
+    response_model=Result[ServerResponse],
+    dependencies=[Depends(check_api_key)],
+)
+async def query(
+    request: ServeRequest, service: Service = Depends(get_service)
+) -> Result[ServerResponse]:
+    """Query Conversation entities
+
+    Args:
+        request (ServeRequest): The request
+        service (Service): The service
+    Returns:
+        ServerResponse: The response
+    """
+    return Result.succ(service.get(request))
+
+
+@router.post(
+    "/query_page",
+    response_model=Result[PaginationResult[ServerResponse]],
+    dependencies=[Depends(check_api_key)],
+)
+async def query_page(
+    request: ServeRequest,
+    page: Optional[int] = Query(default=1, description="current page"),
+    page_size: Optional[int] = Query(default=20, description="page size"),
+    service: Service = Depends(get_service),
+) -> Result[PaginationResult[ServerResponse]]:
+    """Query Conversation entities
+
+    Args:
+        request (ServeRequest): The request
+        page (int): The page number
+        page_size (int): The page size
+        service (Service): The service
+    Returns:
+        ServerResponse: The response
+    """
+    return Result.succ(service.get_list_by_page(request, page, page_size))
+
+
+def init_endpoints(system_app: SystemApp) -> None:
+    """Initialize the endpoints"""
+    global global_system_app
+    system_app.register(Service)
+    global_system_app = system_app

dbgpt/serve/conversation/api/schemas.py

@@ -0,0 +1,20 @@
+# Define your Pydantic schemas here
+from dbgpt._private.pydantic import BaseModel, Field
+from ..config import SERVE_APP_NAME_HUMP
+
+
+class ServeRequest(BaseModel):
+    """Conversation request model"""
+
+    # TODO define your own fields here
+
+    class Config:
+        title = f"ServeRequest for {SERVE_APP_NAME_HUMP}"
+
+
+class ServerResponse(BaseModel):
+    """Conversation response model"""
+
+    # TODO define your own fields here
+    class Config:
+        title = f"ServerResponse for {SERVE_APP_NAME_HUMP}"

dbgpt/serve/conversation/config.py

@@ -0,0 +1,23 @@
+from typing import Optional
+from dataclasses import dataclass, field
+
+from dbgpt.serve.core import BaseServeConfig
+
+
+APP_NAME = "conversation"
+SERVE_APP_NAME = "dbgpt_serve_conversation"
+SERVE_APP_NAME_HUMP = "dbgpt_serve_Conversation"
+SERVE_CONFIG_KEY_PREFIX = "dbgpt.serve.conversation."
+SERVE_SERVICE_COMPONENT_NAME = f"{SERVE_APP_NAME}_service"
+# Database table name
+SERVER_APP_TABLE_NAME = "dbgpt_serve_conversation"
+
+
+@dataclass
+class ServeConfig(BaseServeConfig):
+    """Parameters for the serve command"""
+
+    # TODO: add your own parameters here
+    api_keys: Optional[str] = field(
+        default=None, metadata={"help": "API keys for the endpoint, if None, allow all"}
+    )

dbgpt/serve/conversation/dependencies.py

@@ -0,0 +1 @@
+# Define your dependencies here

dbgpt/serve/conversation/models/__init__.py

@@ -0,0 +1,2 @@
+# This is an auto-generated __init__.py file
+# generated by `dbgpt new serve conversation`

dbgpt/serve/conversation/models/models.py

@@ -0,0 +1,68 @@
+"""This is an auto-generated model file
+You can define your own models and DAOs here
+"""
+from typing import Union, Any, Dict
+from datetime import datetime
+from sqlalchemy import Column, Integer, String, Index, Text, DateTime
+from dbgpt.storage.metadata import Model, BaseDao, db
+from ..api.schemas import ServeRequest, ServerResponse
+from ..config import ServeConfig, SERVER_APP_TABLE_NAME
+
+
+class ServeEntity(Model):
+    __tablename__ = SERVER_APP_TABLE_NAME
+    id = Column(Integer, primary_key=True, comment="Auto increment id")
+
+    # TODO: define your own fields here
+
+    gmt_created = Column(DateTime, default=datetime.now, comment="Record creation time")
+    gmt_modified = Column(DateTime, default=datetime.now, comment="Record update time")
+
+    def __repr__(self):
+        return f"ServeEntity(id={self.id}, gmt_created='{self.gmt_created}', gmt_modified='{self.gmt_modified}')"
+
+
+class ServeDao(BaseDao[ServeEntity, ServeRequest, ServerResponse]):
+    """The DAO class for Conversation"""
+
+    def __init__(self, serve_config: ServeConfig):
+        super().__init__()
+        self._serve_config = serve_config
+
+    def from_request(self, request: Union[ServeRequest, Dict[str, Any]]) -> ServeEntity:
+        """Convert the request to an entity
+
+        Args:
+            request (Union[ServeRequest, Dict[str, Any]]): The request
+
+        Returns:
+            T: The entity
+        """
+        request_dict = request.dict() if isinstance(request, ServeRequest) else request
+        entity = ServeEntity(**request_dict)
+        # TODO implement your own logic here, transfer the request_dict to an entity
+        return entity
+
+    def to_request(self, entity: ServeEntity) -> ServeRequest:
+        """Convert the entity to a request
+
+        Args:
+            entity (T): The entity
+
+        Returns:
+            REQ: The request
+        """
+        # TODO implement your own logic here, transfer the entity to a request
+        return ServeRequest()
+
+    def to_response(self, entity: ServeEntity) -> ServerResponse:
+        """Convert the entity to a response
+
+        Args:
+            entity (T): The entity
+
+        Returns:
+            RES: The response
+        """
+        # TODO implement your own logic here, transfer the entity to a response
+        return ServerResponse()

dbgpt/serve/conversation/serve.py

@@ -0,0 +1,99 @@
+from typing import List, Optional, Union
+import logging
+from dbgpt.component import SystemApp
+from sqlalchemy import URL
+from dbgpt.core import StorageInterface
+from dbgpt.storage.metadata import DatabaseManager
+from dbgpt.serve.core import BaseServe
+
+from .config import (
+    SERVE_APP_NAME,
+    SERVE_APP_NAME_HUMP,
+    APP_NAME,
+    SERVE_CONFIG_KEY_PREFIX,
+    ServeConfig,
+)
+
+logger = logging.getLogger(__name__)
+
+
+class Serve(BaseServe):
+    """Serve component for DB-GPT
+
+    Message DB-GPT conversation history and provide API for other components to access.
+
+    TODO: Move some Http API in app to this component.
+    """
+
+    name = SERVE_APP_NAME
+
+    def __init__(
+        self,
+        system_app: SystemApp,
+        api_prefix: Optional[str] = f"/api/v1/serve/{APP_NAME}",
+        api_tags: Optional[List[str]] = None,
+        db_url_or_db: Union[str, URL, DatabaseManager] = None,
+        try_create_tables: Optional[bool] = False,
+    ):
+        if api_tags is None:
+            api_tags = [SERVE_APP_NAME_HUMP]
+        super().__init__(
+            system_app, api_prefix, api_tags, db_url_or_db, try_create_tables
+        )
+        self._db_manager: Optional[DatabaseManager] = None
+        self._conv_storage = None
+        self._message_storage = None
+
+    @property
+    def conv_storage(self) -> StorageInterface:
+        return self._conv_storage
+
+    @property
+    def message_storage(self) -> StorageInterface:
+        return self._message_storage
+
+    def init_app(self, system_app: SystemApp):
+        if self._app_has_initiated:
+            return
+        self._system_app = system_app
+        self._app_has_initiated = True
+
+    def on_init(self):
+        """Called when init the application.
+
+        You can do some initialization here. You can't get other components here because they may be not initialized yet
+        """
+        # Load DB Model
+        from dbgpt.storage.chat_history.chat_history_db import (
+            ChatHistoryEntity,
+            ChatHistoryMessageEntity,
+        )
+
+    def before_start(self):
+        """Called before the start of the application."""
+        # TODO: Your code here
+        from dbgpt.storage.metadata.db_storage import SQLAlchemyStorage
+        from dbgpt.util.serialization.json_serialization import JsonSerializer
+        from dbgpt.storage.chat_history.chat_history_db import (
+            ChatHistoryEntity,
+            ChatHistoryMessageEntity,
+        )
+        from dbgpt.storage.chat_history.storage_adapter import (
+            DBStorageConversationItemAdapter,
+            DBMessageStorageItemAdapter,
+        )
+
+        self._db_manager = self.create_or_get_db_manager()
+
+        self._conv_storage = SQLAlchemyStorage(
+            self._db_manager,
+            ChatHistoryEntity,
+            DBStorageConversationItemAdapter(),
+            JsonSerializer(),
+        )
+        self._message_storage = SQLAlchemyStorage(
+            self._db_manager,
+            ChatHistoryMessageEntity,
+            DBMessageStorageItemAdapter(),
+            JsonSerializer(),
+        )

dbgpt/serve/conversation/service/service.py

@@ -0,0 +1,116 @@
+from typing import Optional, List
+from dbgpt.component import BaseComponent, SystemApp
+from dbgpt.storage.metadata import BaseDao
+from dbgpt.util.pagination_utils import PaginationResult
+from dbgpt.serve.core import BaseService
+from ..models.models import ServeDao, ServeEntity
+from ..api.schemas import ServeRequest, ServerResponse
+from ..config import SERVE_SERVICE_COMPONENT_NAME, SERVE_CONFIG_KEY_PREFIX, ServeConfig
+
+
+class Service(BaseService[ServeEntity, ServeRequest, ServerResponse]):
+    """The service class for Conversation"""
+
+    name = SERVE_SERVICE_COMPONENT_NAME
+
+    def __init__(self, system_app: SystemApp, dao: Optional[ServeDao] = None):
+        self._system_app = None
+        self._serve_config: ServeConfig = None
+        self._dao: ServeDao = dao
+        super().__init__(system_app)
+
+    def init_app(self, system_app: SystemApp) -> None:
+        """Initialize the service
+
+        Args:
+            system_app (SystemApp): The system app
+        """
+        self._serve_config = ServeConfig.from_app_config(
+            system_app.config, SERVE_CONFIG_KEY_PREFIX
+        )
+        self._dao = self._dao or ServeDao(self._serve_config)
+        self._system_app = system_app
+
+    @property
+    def dao(self) -> BaseDao[ServeEntity, ServeRequest, ServerResponse]:
+        """Returns the internal DAO."""
+        return self._dao
+
+    @property
+    def config(self) -> ServeConfig:
+        """Returns the internal ServeConfig."""
+        return self._serve_config
+
+    def update(self, request: ServeRequest) -> ServerResponse:
+        """Update a Conversation entity
+
+        Args:
+            request (ServeRequest): The request
+
+        Returns:
+            ServerResponse: The response
+        """
+        # TODO: implement your own logic here
+        # Build the query request from the request
+        query_request = {
+            # "id": request.id
+        }
+        return self.dao.update(query_request, update_request=request)
+
+    def get(self, request: ServeRequest) -> Optional[ServerResponse]:
+        """Get a Conversation entity
+
+        Args:
+            request (ServeRequest): The request
+
+        Returns:
+            ServerResponse: The response
+        """
+        # TODO: implement your own logic here
+        # Build the query request from the request
+        query_request = request
+        return self.dao.get_one(query_request)
+
+    def delete(self, request: ServeRequest) -> None:
+        """Delete a Conversation entity
+
+        Args:
+            request (ServeRequest): The request
+        """
+
+        # TODO: implement your own logic here
+        # Build the query request from the request
+        query_request = {
+            # "id": request.id
+        }
+        self.dao.delete(query_request)
+
+    def get_list(self, request: ServeRequest) -> List[ServerResponse]:
+        """Get a list of Conversation entities
+
+        Args:
+            request (ServeRequest): The request
+
+        Returns:
+            List[ServerResponse]: The response
+        """
+        # TODO: implement your own logic here
+        # Build the query request from the request
+        query_request = request
+        return self.dao.get_list(query_request)
+
+    def get_list_by_page(
+        self, request: ServeRequest, page: int, page_size: int
+    ) -> PaginationResult[ServerResponse]:
+        """Get a list of Conversation entities by page
+
+        Args:
+            request (ServeRequest): The request
+            page (int): The page number
+            page_size (int): The page size
+
+        Returns:
+            List[ServerResponse]: The response
+        """
+        query_request = request
+        return self.dao.get_list_page(query_request, page, page_size)

dbgpt/serve/conversation/tests/test_endpoints.py

@@ -0,0 +1,124 @@
+import pytest
+from httpx import AsyncClient
+
+from fastapi import FastAPI
+from dbgpt.component import SystemApp
+from dbgpt.storage.metadata import db
+from dbgpt.util import PaginationResult
+from ..config import SERVE_CONFIG_KEY_PREFIX
+from ..api.endpoints import router, init_endpoints
+from ..api.schemas import ServeRequest, ServerResponse
+
+from dbgpt.serve.core.tests.conftest import client, asystem_app
+
+
+@pytest.fixture(autouse=True)
+def setup_and_teardown():
+    db.init_db("sqlite:///:memory:")
+    db.create_all()
+
+    yield
+
+
+def client_init_caller(app: FastAPI, system_app: SystemApp):
+    app.include_router(router)
+    init_endpoints(system_app)
+
+
+@pytest.mark.asyncio
+@pytest.mark.parametrize(
+    "client, asystem_app, has_auth",
+    [
+        (
+            {
+                "app_caller": client_init_caller,
+                "client_api_key": "test_token1",
+            },
+            {
+                "app_config": {
+                    f"{SERVE_CONFIG_KEY_PREFIX}api_keys": "test_token1,test_token2"
+                }
+            },
+            True,
+        ),
+        (
+            {
+                "app_caller": client_init_caller,
+                "client_api_key": "error_token",
+            },
+            {
+                "app_config": {
+                    f"{SERVE_CONFIG_KEY_PREFIX}api_keys": "test_token1,test_token2"
+                }
+            },
+            False,
+        ),
+    ],
+    indirect=["client", "asystem_app"],
+)
+async def test_api_health(client: AsyncClient, asystem_app, has_auth: bool):
+    response = await client.get("/test_auth")
+    if has_auth:
+        assert response.status_code == 200
+        assert response.json() == {"status": "ok"}
+    else:
+        assert response.status_code == 401
+        assert response.json() == {
+            "detail": {
+                "error": {
+                    "message": "",
+                    "type": "invalid_request_error",
+                    "param": None,
+                    "code": "invalid_api_key",
+                }
+            }
+        }
+
+
+@pytest.mark.asyncio
+@pytest.mark.parametrize(
+    "client", [{"app_caller": client_init_caller}], indirect=["client"]
+)
+async def test_api_health(client: AsyncClient):
+    response = await client.get("/health")
+    assert response.status_code == 200
+    assert response.json() == {"status": "ok"}
+
+
+@pytest.mark.asyncio
+@pytest.mark.parametrize(
+    "client", [{"app_caller": client_init_caller}], indirect=["client"]
+)
+async def test_api_create(client: AsyncClient):
+    # TODO: add your test case
+    pass
+
+
+@pytest.mark.asyncio
+@pytest.mark.parametrize(
+    "client", [{"app_caller": client_init_caller}], indirect=["client"]
+)
+async def test_api_update(client: AsyncClient):
+    # TODO: implement your test case
+    pass
+
+
+@pytest.mark.asyncio
+@pytest.mark.parametrize(
+    "client", [{"app_caller": client_init_caller}], indirect=["client"]
+)
+async def test_api_query(client: AsyncClient):
+    # TODO: implement your test case
+    pass
+
+
+@pytest.mark.asyncio
+@pytest.mark.parametrize(
+    "client", [{"app_caller": client_init_caller}], indirect=["client"]
+)
+async def test_api_query_by_page(client: AsyncClient):
+    # TODO: implement your test case
+    pass
+
+
+# Add more test cases according to your own logic

dbgpt/serve/conversation/tests/test_models.py

@@ -0,0 +1,109 @@
+from typing import List
+import pytest
+from dbgpt.storage.metadata import db
+from ..config import ServeConfig
+from ..api.schemas import ServeRequest, ServerResponse
+from ..models.models import ServeEntity, ServeDao
+
+
+@pytest.fixture(autouse=True)
+def setup_and_teardown():
+    db.init_db("sqlite:///:memory:")
+    db.create_all()
+
+    yield
+
+
+@pytest.fixture
+def server_config():
+    # TODO : build your server config
+    return ServeConfig()
+
+
+@pytest.fixture
+def dao(server_config):
+    return ServeDao(server_config)
+
+
+@pytest.fixture
+def default_entity_dict():
+    # TODO: build your default entity dict
+    return {}
+
+
+def test_table_exist():
+    assert ServeEntity.__tablename__ in db.metadata.tables
+
+
+def test_entity_create(default_entity_dict):
+    entity: ServeEntity = ServeEntity.create(**default_entity_dict)
+    # TODO: implement your test case
+    with db.session() as session:
+        db_entity: ServeEntity = session.query(ServeEntity).get(entity.id)
+        assert db_entity.id == entity.id
+
+
+def test_entity_unique_key(default_entity_dict):
+    # TODO: implement your test case
+    pass
+
+
+def test_entity_get(default_entity_dict):
+    entity: ServeEntity = ServeEntity.create(**default_entity_dict)
+    db_entity: ServeEntity = ServeEntity.get(entity.id)
+    assert db_entity.id == entity.id
+    # TODO: implement your test case
+
+
+def test_entity_update(default_entity_dict):
+    # TODO: implement your test case
+    pass
+
+
+def test_entity_delete(default_entity_dict):
+    # TODO: implement your test case
+    entity: ServeEntity = ServeEntity.create(**default_entity_dict)
+    entity.delete()
+    db_entity: ServeEntity = ServeEntity.get(entity.id)
+    assert db_entity is None
+
+
+def test_entity_all():
+    # TODO: implement your test case
+    pass
+
+
+def test_dao_create(dao, default_entity_dict):
+    # TODO: implement your test case
+    req = ServeRequest(**default_entity_dict)
+    res: ServerResponse = dao.create(req)
+    assert res is not None
+
+
+def test_dao_get_one(dao, default_entity_dict):
+    # TODO: implement your test case
+    req = ServeRequest(**default_entity_dict)
+    res: ServerResponse = dao.create(req)
+
+
+def test_get_dao_get_list(dao):
+    # TODO: implement your test case
+    pass
+
+
+def test_dao_update(dao, default_entity_dict):
+    # TODO: implement your test case
+    pass
+
+
+def test_dao_delete(dao, default_entity_dict):
+    # TODO: implement your test case
+    pass
+
+
+def test_dao_get_list_page(dao):
+    # TODO: implement your test case
+    pass
+
+
+# Add more test cases according to your own logic

dbgpt/serve/conversation/tests/test_service.py

@@ -0,0 +1,76 @@
+from typing import List
+import pytest
+from dbgpt.component import SystemApp
+from dbgpt.storage.metadata import db
+from dbgpt.serve.core.tests.conftest import system_app
+
+from ..models.models import ServeEntity
+from ..api.schemas import ServeRequest, ServerResponse
+from ..service.service import Service
+
+
+@pytest.fixture(autouse=True)
+def setup_and_teardown():
+    db.init_db("sqlite:///:memory:")
+    db.create_all()
+    yield
+
+
+@pytest.fixture
+def service(system_app: SystemApp):
+    instance = Service(system_app)
+    instance.init_app(system_app)
+    return instance
+
+
+@pytest.fixture
+def default_entity_dict():
+    # TODO: build your default entity dict
+    return {}
+
+
+@pytest.mark.parametrize(
+    "system_app",
+    [{"app_config": {"DEBUG": True, "dbgpt.serve.test_key": "hello"}}],
+    indirect=True,
+)
+def test_config_exists(service: Service):
+    system_app: SystemApp = service._system_app
+    assert system_app.config.get("DEBUG") is True
+    assert system_app.config.get("dbgpt.serve.test_key") == "hello"
+    assert service.config is not None
+
+
+def test_service_create(service: Service, default_entity_dict):
+    # TODO: implement your test case
+    # eg. entity: ServerResponse = service.create(ServeRequest(**default_entity_dict))
+    # ...
+    pass
+
+
+def test_service_update(service: Service, default_entity_dict):
+    # TODO: implement your test case
+    pass
+
+
+def test_service_get(service: Service, default_entity_dict):
+    # TODO: implement your test case
+    pass
+
+
+def test_service_delete(service: Service, default_entity_dict):
+    # TODO: implement your test case
+    pass
+
+
+def test_service_get_list(service: Service):
+    # TODO: implement your test case
+    pass
+
+
+def test_service_get_list_by_page(service: Service):
+    # TODO: implement your test case
+    pass
+
+
+# Add more test cases according to your own logic