feat: support baidu model #4936
Conversation
|
@Dogtiti is attempting to deploy a commit to the NextChat Team on Vercel. A member of the Team first needs to authorize it. |
WalkthroughThe updates enhance the application's Baidu API integration by adding new components, configuration options, and conditional logic to handle the new model provider, Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant Settings as Settings Component
participant Auth as Auth Function
participant ServerConfig as Server Configuration
participant BaiduAPI as Baidu API
User ->> Settings: Enter Baidu API Key and Secret Key
Settings ->> Auth: Save the API Key and Secret Key
Auth ->> ServerConfig: Initialize with Baidu configuration
User ->> BaiduAPI: Make a request
BaiduAPI ->> Auth: Authenticate request
Auth ->> BaiduAPI: Return Access Token
BaiduAPI ->> User: Return requested data
sequenceDiagram
participant User
participant API as Client API
participant Platform as ErnieApi
participant BaiduAPI as Baidu API
User ->> API: Request using Ernie Provider
API ->> Platform: Forward request to ErnieApi
Platform ->> BaiduAPI: Make authenticated API call
BaiduAPI ->> Platform: Return API response
Platform ->> User: Deliver result
Poem
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (invoked as PR comments)
Additionally, you can add CodeRabbit Configration File (
|
app/utils/model.ts
Outdated
| @@ -24,10 +24,13 @@ export function collectModelTable( | |||
|
|
|||
| // default models | |||
| models.forEach((m) => { | |||
| // supoort name=displayName eg：completions_pro=ernie-4.0-8k | |||
| const [name, displayName] = m.name?.split("="); | |||
There was a problem hiding this comment.
不建议在这个地方还使用更复杂的逻辑。前面的别名，在ChatPath函数中处理即可
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 4
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (14)
- .gitignore (1 hunks)
- app/api/auth.ts (1 hunks)
- app/api/baidu/[...path]/route.ts (1 hunks)
- app/client/api.ts (2 hunks)
- app/client/platforms/baidu.ts (1 hunks)
- app/components/exporter.tsx (1 hunks)
- app/components/home.tsx (1 hunks)
- app/components/settings.tsx (2 hunks)
- app/config/server.ts (3 hunks)
- app/constant.ts (6 hunks)
- app/locales/cn.ts (1 hunks)
- app/store/access.ts (3 hunks)
- app/store/chat.ts (2 hunks)
- app/utils/model.ts (1 hunks)
Files skipped from review due to trivial changes (1)
- .gitignore
Additional context used
Learnings (1)
app/store/access.ts (1)
Learnt from: lloydzhou PR: ChatGPTNextWeb/ChatGPT-Next-Web#4925 File: app/store/access.ts:86-88 Timestamp: 2024-07-04T15:40:31.080Z Learning: The function name `isValidaBaidu` in `app/store/access.ts` should be corrected to `isValidBaidu`.
Biome
app/api/auth.ts
[error] 79-79: Useless case clause.
because the default clause is present:
Unsafe fix: Remove the useless case.
(lint/complexity/noUselessSwitchCase)
app/utils/model.ts
[error] 28-28: Unsafe usage of optional chaining.
If it short-circuits with 'undefined' the evaluation will throw TypeError here:
(lint/correctness/noUnsafeOptionalChaining)
Additional comments not posted (29)
app/store/access.ts (3)
50-54: LGTM!The addition of Baidu API configuration fields looks good.
91-93: LGTM!The addition of the
isValidBaidumethod looks good. The function name is correctly spelled.
104-104: LGTM!The addition of the
isValidBaiducheck in theisAuthorizedmethod looks good.app/config/server.ts (3)
38-47: LGTM!The addition of configuration options for Baidu services looks good.
105-105: LGTM!The addition of the
isBaiduflag looks good.
137-141: LGTM!The addition of Baidu-specific configurations in the
getServerSideConfigfunction looks good.app/api/baidu/[...path]/route.ts (3)
1-14: Imports and Constants Look GoodThe imports and constants are well-organized and correctly defined. No issues found.
16-40: Verify Error Handling inhandleFunctionThe
handlefunction is well-structured, but ensure that the error handling covers all potential exceptions.Please verify if there are any specific exceptions that need to be handled separately.
45-64: Constants for Runtime and Preferred Regions Look GoodThe
runtimeandpreferredRegionconstants are correctly defined and useful for deployment configuration.app/client/api.ts (3)
12-12: New Import forErnieApiLooks GoodThe import for
ErnieApifrom the Baidu platform is correctly added.
109-111: Switch Case forErnieApiLooks GoodThe switch case for
ErnieApihas been correctly added to theClientApiconstructor.
109-111: Functions inClientApiClass Look GoodThe functions within the
ClientApiclass are well-defined and there are no issues found.app/components/home.tsx (3)
178-179: Update inuseLoadDataFunction Looks GoodThe
useLoadDatafunction has been correctly updated to supportServiceProvider.Baidu.
Line range hint
1-177:ScreenComponent Looks GoodThe
Screencomponent is well-defined and there are no issues found.
Line range hint
1-177:HomeComponent Looks GoodThe
Homecomponent is well-defined and there are no issues found.app/constant.ts (3)
17-20: New Constants for Baidu Look GoodThe new constants
BAIDU_BASE_URLandBAIDU_OATUH_URLare correctly defined.
35-35: New Enums for Baidu Look GoodThe new enums for Baidu in
ApiPath,ServiceProvider, andModelProviderare correctly defined.Also applies to: 79-79, 86-86
189-197: New Default Models for Baidu Look GoodThe new default models for Baidu are correctly defined.
app/client/platforms/baidu.ts (5)
50-73: LGTM! Ensure correct base URL construction.The
pathmethod correctly constructs the base URL based on different configurations and logs the proxy endpoint. The code handles various scenarios, including custom configurations and default values.
76-78: LGTM! Ensure message extraction.The
extractMessagemethod correctly extracts the message content from the response.
80-239: Ensure robust chat interaction handling.The
chatmethod handles chat interactions, including constructing the request payload, managing streaming responses, and handling errors. The method appears to cover all necessary aspects, including logging and animation for smooth UX.
241-246: LGTM! Ensure correct usage reporting.The
usagemethod correctly returns a default usage object withusedandtotalvalues set to 0.
248-250: LGTM! Ensure correct model fetching.The
modelsmethod correctly returns an empty array as a placeholder for the list of models.app/locales/cn.ts (1)
350-365: LGTM! Ensure correct localization entries.The new key-value pairs for Baidu-related API keys and endpoints are correctly added and follow the existing structure.
app/components/exporter.tsx (1)
324-325: LGTM! Ensure correct handling of Baidu service provider.The new case for
ServiceProvider.Baiduin thePreviewActionscomponent correctly handles the Baidu service provider by assigningModelProvider.Ernieto theapivariable.app/store/chat.ts (2)
371-372: LGTM! Ensure correct handling of Baidu service provider in onUserInput.The new case for
ServiceProvider.Baiduin theonUserInputmethod correctly handles the Baidu service provider by assigningModelProvider.Ernieto theapivariable.
557-558: LGTM! Ensure correct handling of Baidu service provider in summarizeSession.The new case for
ServiceProvider.Baiduin thesummarizeSessionmethod correctly handles the Baidu service provider by assigningModelProvider.Ernieto theapivariable.app/components/settings.tsx (2)
56-56: Import statement for Baidu looks good.The import statement for Baidu is correctly added.
1191-1251: Addition of Baidu settings looks good.The settings for Baidu API configuration follow the existing pattern for other service providers and are correctly implemented.
…into feat-baidu
app/client/platforms/baidu.ts
Outdated
|
|
||
| if (baseUrl.length === 0) { | ||
| const isApp = !!getClientConfig()?.isApp; | ||
| baseUrl = isApp ? DEFAULT_API_HOST + "/api/proxy/baidu" : ApiPath.Baidu; |
There was a problem hiding this comment.
如果加了api/proxy/baidu
需要在next.config.mjs添加对应的转发路由，这实际上是用来处理app端发请求的。
这里百度的可以不用走proxy，直接请求。
所以，app内应该直接使用百度官方的地址
app/constant.ts
Outdated
| "ernie-4.0-8k-preview", | ||
| "completions_adv_pro=ernie-4.0-8k-preview-0518", | ||
| "ernie-4.0-8k-latest", | ||
| "completions=ernie-3.5-8k", |
app/client/platforms/baidu.ts
Outdated
| } | ||
|
|
||
| async chat(options: ChatOptions) { | ||
| const visionModel = isVisionModel(options.config.model); |
app/constant.ts
Outdated
| export const Baidu = { | ||
| ExampleEndpoint: "https://aip.baidubce.com", | ||
| ChatPath: (modelName: string) => | ||
| `/rpc/2.0/ai_custom/v1/wenxinworkshop/chat/${modelName}`, |
There was a problem hiding this comment.
是不是，下面的baiduModels还是按正常的方式配置，但是生成ChatPath的时候，处理一下就好了？
app/utils/model.ts
Outdated
| @@ -24,10 +24,13 @@ export function collectModelTable( | |||
|
|
|||
| // default models | |||
| models.forEach((m) => { | |||
| // supoort name=displayName eg：completions_pro=ernie-4.0-8k | |||
| const [name, displayName] = m.name?.split("="); | |||
There was a problem hiding this comment.
不建议在这个地方还使用更复杂的逻辑。前面的别名，在ChatPath函数中处理即可
There was a problem hiding this comment.
Actionable comments posted: 0
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (3)
- app/client/platforms/baidu.ts (1 hunks)
- app/constant.ts (6 hunks)
- app/utils/model.ts (1 hunks)
Files skipped from review as they are similar to previous changes (3)
- app/client/platforms/baidu.ts
- app/constant.ts
- app/utils/model.ts
app/api/baidu/[...path]/route.ts
Outdated
| * 使用 AK，SK 生成鉴权签名（Access Token） | ||
| * @return 鉴权签名信息 | ||
| */ | ||
| async function getAccessToken(): Promise<{ |
There was a problem hiding this comment.
这个函数需要放一个公共的位置：
- 如果是app端运行，或者用户直接在前端配置了百度的密钥，这个时候，需要在前端生成access_token，直接发送给配置的地址。
- 如果用户没有在前端配置自己的密钥，这个时候，发到
/api/baidu/的请求是不带access_token的，这个时候，需要node server生成这个并放到请求里面。
app/client/platforms/baidu.ts
Outdated
| options.onController?.(controller); | ||
|
|
||
| try { | ||
| const chatPath = this.path(Baidu.ChatPath(modelConfig.model)); |
There was a problem hiding this comment.
这里参考platform/google的逻辑，如果是app内，或者前端配置了app_id+app_secret，这里需要生成access_token并放到url中
There was a problem hiding this comment.
Actionable comments posted: 3
Outside diff range and nitpick comments (1)
app/client/platforms/baidu.ts (1)
73-73: Remove console log statement.The console log statement should be removed or replaced with a proper logging mechanism if needed for debugging.
- console.log("[Proxy Endpoint] ", baseUrl, path);
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (3)
- app/api/baidu/[...path]/route.ts (1 hunks)
- app/client/platforms/baidu.ts (1 hunks)
- app/constant.ts (6 hunks)
Files skipped from review as they are similar to previous changes (2)
- app/api/baidu/[...path]/route.ts
- app/constant.ts
Additional context used
Biome
app/client/platforms/baidu.ts
[error] 120-120: Avoid redundant double-negation.
It is not necessary to use double-negation when a value will already be coerced to a boolean.
Unsafe fix: Remove redundant double-negation(lint/complexity/noExtraBooleanCast)
Additional comments not posted (2)
app/client/platforms/baidu.ts (2)
84-90: Ensure message length is odd.The logic to prepend an empty message if the message count is even is correct. Ensure this logic is tested to prevent errors from Baidu's API.
178-181: EnsureonFinishis called once.The
finishfunction should ensure thatonFinishis called only once, which is correctly handled here.
There was a problem hiding this comment.
Actionable comments posted: 2
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (2)
- app/locales/cn.ts (1 hunks)
- app/locales/en.ts (1 hunks)
Additional comments not posted (3)
app/locales/en.ts (3)
337-342: LGTM!The localization strings for Baidu API Key are accurate and consistent with other entries.
343-347: LGTM!The localization strings for Baidu Secret Key are accurate and consistent with other entries.
348-352: LGTM!The localization strings for Baidu Endpoint are accurate and consistent with other entries.
There was a problem hiding this comment.
Actionable comments posted: 1
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (5)
- README.md (1 hunks)
- README_CN.md (1 hunks)
- app/api/baidu/[...path]/route.ts (1 hunks)
- app/api/common.ts (2 hunks)
- app/utils/baidu.ts (1 hunks)
Files skipped from review due to trivial changes (2)
- README.md
- README_CN.md
Files skipped from review as they are similar to previous changes (1)
- app/api/baidu/[...path]/route.ts
Additional comments not posted (3)
app/api/common.ts (3)
Line range hint
73-85:
Verify Azure-specific deployment logic.The Azure-specific logic for handling custom models and deployment names appears correct. Ensure that the
serverConfig.customModelsandserverConfig.azureUrlconfigurations are properly set and validated to avoid potential issues.
Line range hint
141-161:
Ensure correct handling of unauthorized model use.The logic for preventing unauthorized use of certain models is essential for security. Verify that the function correctly identifies and handles these scenarios, returning appropriate error responses and logging relevant information for debugging.
Line range hint
163-200:
Ensure proper logging and resource cleanup.The error handling for the fetch request appears adequate. Verify that the function logs relevant information for debugging and cleans up resources, such as clearing timeouts, to avoid potential memory leaks.
Summary by CodeRabbit
New Features
Improvements
Documentation