You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
docs: show GLM setup through Z.ai and BigModel - #5369
Add a GLM example beside Qwen in docs/custom-engines.md, using the existing OpenAI-compatible instance configuration. It gives the general API base URLs for Z.ai and Zhipu BigModel, the matching key fields, and an exact model ID example, with links to both providers' official guides.
Why
Addresses the documentation example requested in #5366. The broader provider-picker proposal remains open.
How it was verified
Checked both official OpenAI compatibility guides and the driver's /chat/completions, /models, and custom model behavior. The existing documentation CI subset passed (19 tests), and verification-documentation checks passed (7 tests). Diff checks passed. No live GLM request was made. Full pnpm typecheck and pnpm test have not run for this documentation change.
Screenshots (UI changes)
Documentation change only.
Checklist
pnpm typecheck and pnpm test pass locally
Server behavior changes come with tests (documentation only)
No dist-server/ edits (it's build output)
macOS-only code is platform-gated; no shell: true / cmd.exe string-building
No secrets in logs, responses, events, or argv
Summary by CodeRabbit
Documentation
Added setup guidance for connecting to GLM through Z.ai or Zhipu BigModel, including service URLs, API keys, model IDs, and model discovery options.
No actionable comments were generated in the recent review.
Walkthrough
The custom engines guide adds a GLM setup example for Z.ai and Zhipu BigModel using the openai-compat driver. It documents endpoint URLs, API key and model settings, model discovery, and fallback behavior.
Changes: GLM setup documentation
Layer / File(s)
Summary
GLM configuration example docs/custom-engines.md
Adds setup instructions for Z.ai and Zhipu BigModel, including API endpoints, API key and model settings, and documented model discovery and fallback behavior.
milind-soni/OpenMausBot#5202: Requests a hosted OpenAI-compatible example; this change adds a hosted GLM example, but does not cover the PowerTokens gateway.
Possibly related PRs
milind-soni/OpenMausBot#3868: Changes model selection and persistence behavior for OpenAI-compatible instances, which relates to the example’s config.model and fallback notes.
milind-soni/OpenMausBot#3813: Documents and implements custom model IDs and discovery behavior for OpenAI-compatible routers, which the GLM example also describes.
Suggested reviewers:adityaumale
Merge Risk: Minimal · up to 60387
The change adds GLM setup guidance; no actionable merge-blocking risk is established.
Pre-merge checks: 5
Check name
Status
Explanation
Title check
The title clearly summarizes the GLM setup documentation added for Z.ai and BigModel.
Description check
The description covers what changed, why, verification, screenshots, and the checklist. It clearly states that full typecheck and test runs were not performed.
Docstring Coverage
No eligible functions found in the changed files. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff with cyclomatic complexity of at least 2. Documentat…
Linked Issues check
Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check
Check skipped because no linked issues were found for this pull request.
Full details: Docstring Coverage
Explanation
No eligible functions found in the changed files. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff with cyclomatic complexity of at least 2. Documentation-only edits and deletions within surviving functions are included; unchanged diff context and fully deleted functions are excluded. Analyzed 0 functions across 0 files. (1 skipped: 1 unsupported.)
Finishing Touches
Generate unit tests (beta)
Create a new PR
Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.
File: No configuration file from this repository applied
Commit: Unavailable
Layers: defaults
Review profile: CHILL
Plan: Advanced
Run ID: 738ef515-679a-4bc4-a8ae-2a49cd5c2cfd
Commits
Reviewing files that changed from the base of the PR and between f3b00bb and 60387f7.
Files selected for processing: 1
docs/custom-engines.md
Included review availability: This review used your included allowance. Your plan provides up to 10 included reviews per hour; 9 remain after this review.
The reason will be displayed to describe this comment to others. Learn more.
Claude Code Review
This pull request is from a fork — automated review is disabled. A repository maintainer can comment @claude review to run a one-time review.
This branch has not been deployed
No deployments
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What changed
Add a GLM example beside Qwen in
docs/custom-engines.md, using the existing OpenAI-compatible instance configuration. It gives the general API base URLs for Z.ai and Zhipu BigModel, the matching key fields, and an exact model ID example, with links to both providers' official guides.Why
Addresses the documentation example requested in #5366. The broader provider-picker proposal remains open.
How it was verified
Checked both official OpenAI compatibility guides and the driver's
/chat/completions,/models, and custom model behavior. The existing documentation CI subset passed (19 tests), and verification-documentation checks passed (7 tests). Diff checks passed. No live GLM request was made. Fullpnpm typecheckandpnpm testhave not run for this documentation change.Screenshots (UI changes)
Documentation change only.
Checklist
pnpm typecheckandpnpm testpass locallydist-server/edits (it's build output)shell: true/ cmd.exe string-buildingSummary by CodeRabbit