Skip to content

docs: show GLM setup through Z.ai and BigModel #5369

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
leonongoing wants to merge 1 commit into
base: main
Choose a base branch
from
+20 −0
Open

docs: show GLM setup through Z.ai and BigModel #5369

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions docs/custom-engines.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -197,6 +197,26 @@ capabilities or account access.
See [Alibaba Cloud's OpenAI-compatible API guide](https://help.aliyun.com/zh/model-studio/compatibility-of-openai-with-dashscope)
for current addresses, model availability and region requirements.

### Example: GLM through Z.ai or Zhipu BigModel

Use the `openai-compat` instance above with a general API key from your
chosen service. Set `config.url` to its OpenAI-compatible base URL:

| Service | Base URL |
|---|---|
| Z.ai (international) | `https://api.z.ai/api/paas/v4` |
| Zhipu BigModel (mainland China) | `https://open.bigmodel.cn/api/paas/v4` |

Set `environment.MY_ENDPOINT_KEY` to that service's API key and keep
`config.apiKeyEnv` as `MY_ENDPOINT_KEY`. Set `config.model` to an exact model
ID available to your account, such as `glm-5.3`. The driver appends
`/chat/completions` to the base URL and attempts `/models` discovery; a
manually configured model stays selectable if discovery is unavailable.

Both services document this general API setup and their current model IDs
in their OpenAI compatibility guides. See the [Z.ai guide](https://docs.z.ai/guides/develop/openai/python)
and the [Zhipu BigModel guide](https://docs.bigmodel.cn/cn/guide/develop/openai/introduction).

## Notes

- `config.json` is written with mode 0600; values in `environment` are stored
Expand Down
Loading