refactor: rename source filenames and models

Author: moeakwak

backend/api/conf/config.py

@@ -63,7 +63,7 @@ def chatgpt_base_url_end_with_slash(cls, v):
         return v
 
 
-class OpenaiAPISetting(BaseModel):
+class OpenaiApiSetting(BaseModel):
     openai_base_url: str = 'https://api.openai.com/v1/'
     connect_timeout: int = Field(10, ge=1)
     read_timeout: int = Field(20, ge=1)
@@ -81,7 +81,7 @@ class StatsSetting(BaseModel):
 
 class ConfigModel(BaseModel):
     openai_web: OpenaiWebChatGPTSetting = OpenaiWebChatGPTSetting()
-    openai_api: OpenaiAPISetting = OpenaiAPISetting()
+    openai_api: OpenaiApiSetting = OpenaiApiSetting()
     common: CommonSetting = CommonSetting()
     http: HttpSetting = HttpSetting()
     data: DataSetting = DataSetting()
@@ -96,7 +96,7 @@ class Config:
 @singleton_with_lock
 class Config(BaseConfig[ConfigModel]):
     if _TYPE_CHECKING:
-        openai_api: OpenaiAPISetting = OpenaiAPISetting()
+        openai_api: OpenaiApiSetting = OpenaiApiSetting()
         common: CommonSetting = CommonSetting()
         http: HttpSetting = HttpSetting()
         openai_web: OpenaiWebChatGPTSetting = OpenaiWebChatGPTSetting()

backend/api/middlewares/request_statistics.py

@@ -86,7 +86,7 @@ async def send_with_inspecting_body(message):
             elapsed_ms = round(elapsed_ms * 1000, 2)
 
             await RequestLogDocument(
-                meta=RequestLogMeta(route_path=route.path, method=method),
+                metadata=RequestLogMeta(route_path=route.path, method=method),
                 user_id=user_id,
                 elapsed_ms=elapsed_ms,
                 status=body_code or raw_status_code or scope.get("ask_websocket_close_code", None)

backend/api/models/db.py

@@ -51,7 +51,8 @@ class UserSetting(Base):
     user_id: Mapped[int] = mapped_column(ForeignKey("user.id"), comment="用户id")
     user: Mapped[User] = relationship("User", back_populates="setting", lazy="joined")
     credits: Mapped[float] = mapped_column(Float, default=0, comment="积分")
-    openai_web_chat_status: Mapped[OpenaiWebChatStatus] = mapped_column(Enum(OpenaiWebChatStatus), default=OpenaiWebChatStatus.idling,
+    openai_web_chat_status: Mapped[OpenaiWebChatStatus] = mapped_column(Enum(OpenaiWebChatStatus),
+                                                                        default=OpenaiWebChatStatus.idling,
                                                                         comment="对话状态")
     openai_web: Mapped[OpenaiWebSourceSettingSchema] = mapped_column(Pydantic(OpenaiWebSourceSettingSchema))
     openai_api: Mapped[OpenaiApiSourceSettingSchema] = mapped_column(Pydantic(OpenaiApiSourceSettingSchema))

backend/api/models/doc.py

@@ -7,7 +7,7 @@
 
 from api.enums import OpenaiWebChatModels, OpenaiApiChatModels
 from api.models.types import SourceTypeLiteral
-from api.schemas.openai_schemas import OpenAIChatResponseUsage
+from api.schemas.openai_schemas import OpenaiChatResponseUsage
 from api.conf import Config
 
 config = Config()
@@ -61,7 +61,7 @@ class OpenaiWebChatMessageMetadata(BaseModel):
 
 class OpenaiApiChatMessageMetadata(BaseModel):
     source: Literal['openai_api']
-    usage: Optional[OpenAIChatResponseUsage]
+    usage: Optional[OpenaiChatResponseUsage]
     finish_reason: Optional[str]
 
 
@@ -172,15 +172,15 @@ class BaseConversationHistory(BaseModel):
     mapping: dict[str, BaseChatMessage]
     current_node: Optional[uuid.UUID]
     current_model: Optional[str]
-    meta: Optional[Annotated[
+    metadata: Optional[Annotated[
         Union[OpenaiWebConversationHistoryMeta, OpenaiApiConversationHistoryMeta], Field(discriminator='source')]]
 
 
 class OpenaiWebConversationHistoryDocument(Document, BaseConversationHistory):
     id: uuid.UUID = Field(default_factory=uuid.uuid4, alias="_id")
     source: Literal["openai_web"]
     mapping: dict[str, OpenaiWebChatMessage]
-    meta: Optional[OpenaiWebConversationHistoryMeta]
+    metadata: Optional[OpenaiWebConversationHistoryMeta]
 
     class Settings:
         name = "openai_web_conversation_history"
@@ -204,7 +204,7 @@ class RequestLogMeta(BaseModel):
 
 class RequestLogDocument(Document):
     time: datetime.datetime = Field(default_factory=lambda: datetime.datetime.utcnow())
-    meta: RequestLogMeta
+    metadata: RequestLogMeta
     user_id: Optional[int]
     elapsed_ms: float
     status: Optional[int]
@@ -231,7 +231,7 @@ class OpenaiApiAskLogMeta(BaseModel):
 
 class AskLogDocument(Document):
     time: datetime.datetime = Field(default_factory=lambda: datetime.datetime.utcnow())
-    meta: Union[OpenaiWebAskLogMeta, OpenaiApiAskLogMeta] = Field(discriminator='source')
+    metadata: Union[OpenaiWebAskLogMeta, OpenaiApiAskLogMeta] = Field(discriminator='source')
     user_id: int
     queueing_time: Optional[float]
     ask_time: Optional[float]

backend/api/routers/chat.py

@@ -26,15 +26,15 @@
 from api.routers.conv import _get_conversation_by_id
 from api.schemas import OpenaiWebConversationSchema, AskRequest, AskResponse, AskResponseType, UserReadAdmin, \
     BaseConversationSchema
-from api.schemas.openai_schemas import OpenAIChatPlugin, OpenAIChatPluginUserSettings
-from api.sources import RevChatGPTManager, convert_revchatgpt_message, OpenAIChatManager, OpenAIChatException
+from api.schemas.openai_schemas import OpenaiChatPlugin, OpenaiChatPluginUserSettings
+from api.sources import OpenaiWebChatManager, convert_revchatgpt_message, OpenaiApiChatManager, OpenAIChatException
 from api.users import websocket_auth, current_active_user, current_super_user
 from utils.logger import get_logger
 
 logger = get_logger(__name__)
 router = APIRouter()
-openai_web_manager = RevChatGPTManager()
-openai_api_manager = OpenAIChatManager()
+openai_web_manager = OpenaiWebChatManager()
+openai_api_manager = OpenaiApiChatManager()
 config = Config()
 
 
@@ -48,8 +48,8 @@ async def change_user_chat_status(user_id: int, status: OpenaiWebChatStatus):
     return user
 
 
-_plugins_result: list[OpenAIChatPlugin] | None = None
-_plugins_result_map: dict[str, OpenAIChatPlugin] | None = None
+_plugins_result: list[OpenaiChatPlugin] | None = None
+_plugins_result_map: dict[str, OpenaiChatPlugin] | None = None
 _plugins_result_last_update_time = None
 
 
@@ -62,19 +62,19 @@ async def _refresh_plugins():
     return _plugins_result
 
 
-@router.get("/chat/openai-plugins/all", tags=["chat"], response_model=list[OpenAIChatPlugin])
+@router.get("/chat/openai-plugins/all", tags=["chat"], response_model=list[OpenaiChatPlugin])
 async def get_all_openai_web_chat_plugins(_user: User = Depends(current_active_user)):
     plugins = await _refresh_plugins()
     return plugins
 
 
-@router.get("/chat/openai-plugins/installed", tags=["chat"], response_model=list[OpenAIChatPlugin])
+@router.get("/chat/openai-plugins/installed", tags=["chat"], response_model=list[OpenaiChatPlugin])
 async def get_installed_openai_web_chat_plugins(_user: User = Depends(current_active_user)):
     plugins = await _refresh_plugins()
     return [plugin for plugin in plugins if plugin.user_settings and plugin.user_settings.is_installed]
 
 
-@router.get("/chat/openai-plugin/{plugin_id}", tags=["chat"], response_model=OpenAIChatPlugin)
+@router.get("/chat/openai-plugin/{plugin_id}", tags=["chat"], response_model=OpenaiChatPlugin)
 async def get_openai_web_plugin(plugin_id: str, _user: User = Depends(current_active_user)):
     await _refresh_plugins()
     global _plugins_result_map
@@ -84,13 +84,13 @@ async def get_openai_web_plugin(plugin_id: str, _user: User = Depends(current_ac
         raise InvalidParamsException("errors.pluginNotFound")
 
 
-@router.patch("/chat/openai-plugin/{plugin_id}/user-settings", tags=["chat"], response_model=OpenAIChatPlugin)
-async def update_chat_plugin_user_settings(plugin_id: str, settings: OpenAIChatPluginUserSettings,
+@router.patch("/chat/openai-plugin/{plugin_id}/user-settings", tags=["chat"], response_model=OpenaiChatPlugin)
+async def update_chat_plugin_user_settings(plugin_id: str, settings: OpenaiChatPluginUserSettings,
                                            _user: User = Depends(current_super_user)):
     if settings.is_authenticated is not None:
         raise InvalidParamsException("can not set is_authenticated")
     result = await openai_web_manager.change_plugin_user_settings(plugin_id, settings)
-    assert isinstance(result, OpenAIChatPlugin)
+    assert isinstance(result, OpenaiChatPlugin)
 
     global _plugins_result, _plugins_result_last_update_time
     if _plugins_result is not None:
@@ -527,7 +527,7 @@ async def reply(response: AskResponse):
 
             # 写入到 scope 中，供统计
             await AskLogDocument(
-                meta=meta,
+                metadata=meta,
                 user_id=user.id,
                 queueing_time=queueing_time,
                 ask_time=ask_time,

backend/api/routers/conv.py

@@ -15,13 +15,13 @@
     BaseConversationHistory
 from api.response import response
 from api.schemas import OpenaiWebConversationSchema, BaseConversationSchema, OpenaiApiConversationSchema
-from api.sources import RevChatGPTManager
+from api.sources import OpenaiWebChatManager
 from api.users import current_active_user, current_super_user
 from utils.logger import get_logger
 
 logger = get_logger(__name__)
 router = APIRouter()
-openai_web_manager = RevChatGPTManager()
+openai_web_manager = OpenaiWebChatManager()
 
 
 async def _get_conversation_by_id(conversation_id: str | uuid.UUID, user: User = Depends(current_active_user)):

backend/api/schemas/openai_schemas.py

@@ -3,29 +3,29 @@
 from pydantic import BaseModel
 
 
-class OpenAIChatResponseChoice(BaseModel):
+class OpenaiChatResponseChoice(BaseModel):
     index: Optional[int]
     message: Optional[dict[Literal["role", "content"], str]]
     delta: Optional[dict[Literal["role", "content"], str]]
     finish_reason: Optional[str]
 
 
-class OpenAIChatResponseUsage(BaseModel):
+class OpenaiChatResponseUsage(BaseModel):
     prompt_tokens: Optional[int]
     completion_tokens: Optional[int]
 
 
-class OpenAIChatResponse(BaseModel):
-    choices: Optional[list[OpenAIChatResponseChoice]]
-    usage: Optional[OpenAIChatResponseUsage]
+class OpenaiChatResponse(BaseModel):
+    choices: Optional[list[OpenaiChatResponseChoice]]
+    usage: Optional[OpenaiChatResponseUsage]
 
 
-class OpenAIChatPluginCategory(BaseModel):
+class OpenaiChatPluginCategory(BaseModel):
     id: Optional[str]
     title: Optional[str]
 
 
-class OpenAIChatPluginManifest(BaseModel):
+class OpenaiChatPluginManifest(BaseModel):
     api: Optional[dict[str, Any]]  # type openapi, url
     auth: Optional[dict[str, Any]]  # type none
     logo_url: Optional[str]
@@ -38,17 +38,17 @@ class OpenAIChatPluginManifest(BaseModel):
     legal_info_url: Optional[str]
 
 
-class OpenAIChatPluginUserSettings(BaseModel):
+class OpenaiChatPluginUserSettings(BaseModel):
     is_authenticated: Optional[bool]
     is_installed: Optional[bool]
 
 
-class OpenAIChatPlugin(BaseModel):
+class OpenaiChatPlugin(BaseModel):
     id: Optional[str]
     namespace: Optional[str]
-    manifest: Optional[OpenAIChatPluginManifest]
-    categories: Optional[list[OpenAIChatPluginCategory]]
+    manifest: Optional[OpenaiChatPluginManifest]
+    categories: Optional[list[OpenaiChatPluginCategory]]
     domain: Optional[str]
     status: Optional[Literal['approved'] | str]
-    user_settings: Optional[OpenAIChatPluginUserSettings | dict[str, Any]]  # is_authenticated, is_installed
+    user_settings: Optional[OpenaiChatPluginUserSettings | dict[str, Any]]  # is_authenticated, is_installed
     oauth_client_id: Optional[str]

backend/api/sources/__init__.py

@@ -1,2 +1,2 @@
-from .revchatgpt import *
-from .openai import *
+from .openai_web import *
+from .openai_api import *

backend/api/sources/openai.py backend/api/sources/openai_api.pybackend/api/sources/openai.py renamed to backend/api/sources/openai_api.py

@@ -10,7 +10,7 @@
 from api.enums import OpenaiApiChatModels, ChatSourceTypes
 from api.models.doc import OpenaiApiChatMessage, OpenaiApiConversationHistoryDocument, OpenaiApiChatMessageMetadata, \
     OpenaiApiChatMessageTextContent
-from api.schemas.openai_schemas import OpenAIChatResponse
+from api.schemas.openai_schemas import OpenaiChatResponse
 from utils.common import singleton_with_lock
 from utils.logger import get_logger
 
@@ -47,7 +47,7 @@ async def _check_response(response: httpx.Response) -> None:
 
 
 @singleton_with_lock
-class OpenAIChatManager:
+class OpenaiApiChatManager:
     """
     OpenAI API Manager
     """
@@ -144,7 +144,7 @@ async def ask(self, content: str, conversation_id: uuid.UUID = None,
 
                 try:
                     line = json.loads(line)
-                    resp = OpenAIChatResponse(**line)
+                    resp = OpenaiChatResponse(**line)
 
                     if resp.choices[0].message is not None:
                         text_content = resp.choices[0].message.get("content")

backend/api/sources/revchatgpt.py backend/api/sources/openai_web.pybackend/api/sources/revchatgpt.py renamed to backend/api/sources/openai_web.py

@@ -18,7 +18,7 @@
     OpenaiWebChatMessageTetherBrowsingDisplayContent, OpenaiWebChatMessageTetherQuoteContent, \
     OpenaiWebChatMessageContent, \
     OpenaiWebChatMessageSystemErrorContent, OpenaiWebChatMessageStderrContent
-from api.schemas.openai_schemas import OpenAIChatPlugin, OpenAIChatPluginUserSettings
+from api.schemas.openai_schemas import OpenaiChatPlugin, OpenaiChatPluginUserSettings
 from utils.common import singleton_with_lock
 from utils.logger import get_logger
 
@@ -129,7 +129,7 @@ async def _check_response(response: httpx.Response) -> None:
 
 
 @singleton_with_lock
-class RevChatGPTManager:
+class OpenaiWebChatManager:
     """
     TODO: 解除 revChatGPT 依赖
     """
@@ -188,7 +188,7 @@ async def get_conversation_history(self, conversation_id: uuid.UUID | str) -> Op
             mapping=mapping,
             current_node=result.get("current_node"),
             current_model=current_model,
-            meta=OpenaiWebConversationHistoryMeta(
+            metadata=OpenaiWebConversationHistoryMeta(
                 source="openai_web",
                 plugin_ids=result.get("plugin_ids"),
                 moderation_results=result.get("moderation_results"),
@@ -296,9 +296,9 @@ async def get_plugin_manifests(self, statuses="approved", is_installed=None, off
             timeout=config.openai_web.ask_timeout
         )
         await _check_response(response)
-        return parse_obj_as(list[OpenAIChatPlugin], response.json().get("items"))
+        return parse_obj_as(list[OpenaiChatPlugin], response.json().get("items"))
 
-    async def change_plugin_user_settings(self, plugin_id: str, setting: OpenAIChatPluginUserSettings):
+    async def change_plugin_user_settings(self, plugin_id: str, setting: OpenaiChatPluginUserSettings):
         if not config.openai_web.is_plus_account:
             raise InvalidParamsException("errors.notPlusChatgptAccount")
         response = await self.chatbot.session.patch(
@@ -307,7 +307,7 @@ async def change_plugin_user_settings(self, plugin_id: str, setting: OpenAIChatP
         )
         await _check_response(response)
         try:
-            result = OpenAIChatPlugin.parse_obj(response.json())
+            result = OpenaiChatPlugin.parse_obj(response.json())
             return result
         except ValidationError as e:
             logger.warning(f"Failed to parse plugin: {e}")