AI SDK
Community Providers

Zhipu AI (Z.AI)

Learn how to use the Zhipu (Z.AI) provider.

Zhipu AI Provider is a community provider for the AI SDK. It enables seamless integration with GLM and Embedding Models provided on bigmodel.cn or z.ai by ZhipuAI.

Setup

$ pnpm add zhipu-ai-provider

Set up your .env file / environment with your API key.

ZHIPU_API_KEY=<your-api-key>

Provider Instance

You can import the default provider instance zhipu from zhipu-ai-provider (This automatically reads the API key from the environment variable ZHIPU_API_KEY):

import { zhipu } from 'zhipu-ai-provider';

Alternatively, you can create a provider instance with custom configuration with createZhipu (do this if you want to use the non-Chinese Z.AI infrastructure):

import { createZhipu } from 'zhipu-ai-provider';

const zhipu = createZhipu({
  baseURL: 'https://api.z.ai/api/paas/v4',
  apiKey: 'your-api-key',
});

You can use the following optional settings to customize the Zhipu provider instance:

  • baseURL: string

    • Use a different URL prefix for API calls, e.g. to use proxy servers. The default prefix is https://open.bigmodel.cn/api/paas/v4.

  • apiKey: string

    • Your API key for Zhipu BigModel Platform. If not provided, the provider will attempt to read the API key from the environment variable ZHIPU_API_KEY.

  • headers: Record<string, string>

    • Custom headers to include in the requests.

Example

import { generateText } from 'ai';
import { zhipu } from 'zhipu-ai-provider';

const { text } = await generateText({
  model: zhipu('glm-4-plus'),
  prompt: 'Why is the sky blue?',
});

console.log(text);

Documentation

PreviousVoyage AINextvectorstores