智谱AI语言模型GLM-4接口开发文档

GLM-4

GLM-4 提供了多款模型，适用于各种应用场景。查看GLM-4系列模型比较，选择最适合的模型。

模型编码：glm-4-plus、glm-4-0520、glm-4 、glm-4-air、glm-4-airx、glm-4-long 、 glm-4-flashx 、 glm-4-flash

同步调用

接口请求
类型说明方法https请求URLhttps://open.bigmodel.cn/api/paas/v4/chat/completions调用方式同步调用，等待模型完成执行并返回最终结果或使用SSE调用字符编码UTF-8请求格式JSON响应格式JSON或标准Stream Event请求类型POST开发语言任何能够发起HTTP请求的开发语言

请求参数

参数名称类型必填参数描述modelString是要调用的模型编码。messagesList是调用语言模型时，当前对话消息列表作为模型的提示输入，以JSON数组形式提供，例如{“role”: “user”, “content”: “Hello”}。可能的消息类型包括系统消息、用户消息、助手消息和工具消息。request_idString否由用户端传递，需要唯一；用于区分每次请求的唯一标识符。如果用户端未提供，平台将默认生成。do_sampleBoolean否当do_sample为true时，启用采样策略；当do_sample为false时，温度和top_p等采样策略参数将不生效。默认值为true。streamBoolean否该参数在使用同步调用时应设置为false或省略。表示模型在生成所有内容后一次性返回所有内容。默认值为false。如果设置为true，模型将通过标准Event Stream逐块返回生成的内容。当Event Stream结束时，将返回一个data: [DONE]消息。temperatureFloat否采样温度，控制输出的随机性，必须为正数取值范围是：[0.0, 1.0]，默认值为0.95。top_pFloat否另用温度取样的另一种方法，取值范围是：[0.0, 1.0]，默认值为0.7。max_tokensInteger否模型输出的最大token数，最大输出为4095，默认值为1024。stopList否模型遇到stop指定的字符时会停止生成。目前仅支持单个stop词，格式为[“stop_word1”]。toolsList否模型可以调用的工具。typeString是工具类型，目前支持 function、retrieval、web_search。 function:

Object

(必需): 仅当工具类型为 function 时补充。  name:

String

(必需): 函数名称，只能包含 a-z、A-Z、0-9、下划线和连字符。最大长度限制为64。  description:

String

(必需): 用于描述函数的能力。模型将根据此描述确定函数调用的方式。  parameters:

Object

(必需): 参数字段必须传递一个Json Schema对象，以准确定义函数接受的参数。如果调用函数时不需要参数，则可以省略此参数。

"parameters": { "type": "object", "properties": { "location": { "type": "string", "description": "城市，例如：北京" }, "unit": { "type": "string", "enum": ["celsius", "fahrenheit"] }},"required": ["location"]}

更多详情：函数调用使用指南retrieval:

Object

描述: 仅当工具类型为 retrieval 时补充。  knowledge_id:

String

(必需): 涉及知识库ID时，请前往开放平台的知识库模块创建或获取。  prompt_template:

String

(非必需): 请求模型时的知识库模板，默认模板：  

从文档 "{{ knowledge }}" 中查找问题的答案 "{{question}}" 如果找到答案，仅使用文档的陈述来回答问题；如果未找到，则使用自己的知识回答，并告知用户此信息不是来自文档。不要重复问题，直接开始回答。

用户自定义模板时，知识库内容占位符和用户端问题占位符必须分别为{{ knowledge }}和{{ question }};更多详情：Retrieval使用指南web_search:

Object

描述: 仅当工具类型为 web_search 时补充，如果tools中存在type retrieval，则web_search将不生效。  enable:

Boolean

(非必需): 网络搜索功能：默认为关闭状态（False）。启用搜索：设置为

True

。禁用搜索：设置为

False

。  search_query:

String

(非必需): 强制自定义搜索键内容。  search_result:

Boolean

(非必需): 获取网页搜索来源的详细信息。默认禁用。启用：true，禁用：false。更多详情：web_search使用指南tool_choiceString或Object否用于控制模型选择调用哪个函数的方式，仅在工具类型为function时补充。默认auto，目前仅支持auto。user_idString否终端用户的唯一ID，帮助平台对终端用户的非法活动、生成非法不当信息或其他滥用行为进行干预。ID长度要求：至少6个字符，最多128个字符。

message 格式

System Message****格式
参数名称类型必填参数说明roleString是消息的角色信息，此时应为

system

contentString是消息内容
User Message Format
参数名称类型必填参数说明roleString是消息的角色信息，此时应为

user

contentString是消息内容
Assistant Message Format
参数名称类型必填参数说明roleString是消息的角色信息，此时应为

assistant

contentString是"content"与"tool_calls"二必选一。 消息内容。其中包括了

tool_calls

字段，

content

字段为空。tool_callsList是"content"与"tool_calls"二必选一。 模型产生的工具调用消息idString是工具idtypeString是工具类型, 支持

web_search

、

retrieval

、

function

functionObject否type为"function"时不为空nameString是函数名称argumentsString是模型生成的调用函数的参数列表，JSON 格式。请注意，模型可能会生成无效的JSON，也可能会虚构一些不在您的函数规范中的参数。在调用函数之前，请在代码中验证这些参数是否有效。
Tool Message格式

Tool Message

表示调用工具后的返回结果。模型然后根据

工具消息

输出自然语言格式的消息给用户。
参数名称类型必填参数描述roleString是消息的角色信息，此时应为

tool

。contentString是工具消息的内容，调用工具后的返回结果。tool_call_idString是工具调用的记录。

响应参数

参数名称类型参数描述idString任务IDcreatedLong请求创建时间，为Unix时间戳，单位为秒modelString模型名称choicesList当前对话的模型输出内容indexInteger结果索引finish_reasonString模型推理终止的原因。可以是’stop’、‘tool_calls’、‘length’、‘sensitive’或’network_error’。messageObject模型返回的文本消息roleString当前对话角色，默认为’assistant’（模型）contentString当前对话内容。命中函数时为null，否则返回模型推理结果。tool_callsList模型生成的应调用的函数名称和参数。functionObject包含模型生成的函数名称和JSON格式的参数。nameString模型生成的函数名称。argumentsString模型生成的函数调用参数的JSON格式。调用函数前请验证参数。idString命中函数的唯一标识符。typeString模型调用的工具类型，目前仅支持’function’。usageObject模型调用结束时返回的token使用统计。prompt_tokensInteger用户输入的token数量completion_tokensInteger模型输出的token数量total_tokensInteger总token数量web_searchList返回与网页搜索相关的信息。iconString来源网站的图标titleString搜索结果的标题linkString搜索结果的网页链接mediaString搜索结果网页的媒体来源名称contentString搜索结果网页引用的文本内容

请求示例

from zhipuai import ZhipuAI
client = ZhipuAI(api_key="")# 请填写您自己的APIKey
response = client.chat.completions.create(
    model="glm-4",# 请填写您要调用的模型名称
    messages=[{"role":"user","content":"作为一名营销专家，请为我的产品创作一个吸引人的口号"},{"role":"assistant","content":"当然，要创作一个吸引人的口号，请告诉我一些关于您产品的信息"},{"role":"user","content":"智谱AI开放平台"},{"role":"assistant","content":"点燃未来，智谱AI绘制无限，让创新触手可及！"},{"role":"user","content":"创作一个更精准且吸引人的口号"}],)print(response.choices[0].message)

响应示例

{"created":1703487403,"id":"8239375684858666781","model":"glm-4","request_id":"8239375684858666781","choices":[{"finish_reason":"stop","index":0,"message":{"content":"以AI绘蓝图 — 智谱AI，让创新的每一刻成为可能。","role":"assistant"}}],"usage":{"completion_tokens":217,"prompt_tokens":31,"total_tokens":248}}

流式输出

响应参数

参数名称类型参数描述idString智谱AI开放平台生成的任务序号，调用请求结果接口时请使用此序号createdLong请求创建时间，为Unix时间戳，单位为秒choicesList当前对话的模型输出内容indexInteger结果索引finish_reasonString模型推理终止的原因。'stop’表示自然结束或触发stop词，'tool_calls’表示模型命中函数，'length’表示达到token长度限制，'sensitive’表示内容被安全审核接口拦截（用户应判断并决定是否撤回公开内容），'network_error’表示模型推理异常。deltaObject模型增量返回的文本信息roleString当前对话角色，默认为’assistant’（模型）contentString当前对话内容。命中函数时为null，否则返回模型推理结果。tool_callsList模型生成的应调用的函数名称和参数。functionObject包含模型生成的函数名称和JSON格式的参数。nameString模型生成的函数名称。argumentsString模型生成的函数调用参数的JSON格式。调用函数前请验证参数。idString命中函数的唯一标识符。typeString模型调用的工具类型，目前仅支持’function’。usageObject模型调用结束时返回的token使用统计。prompt_tokensInteger用户输入的token数量completion_tokensInteger模型输出的token数量total_tokensInteger总token数量web_searchList返回与网页搜索相关的信息。iconiconString来源网站的图标titleString搜索结果的标题linkString搜索结果的网页链接mediaString搜索结果网页的媒体来源名称contentString搜索结果网页引用的文本内容

请求示例

我们已经升级到最新的模型GLM-4和GLM-3-Turbo，支持系统提示、函数调用、检索、Web_Search等新功能。要使用这些新功能，需要升级到最新版本的Python SDK。如果您安装了旧版本的SDK，请更新到最新版本。

pip install --upgrade zhipuai

from zhipuai import ZhipuAI
client = ZhipuAI(api_key="")# 请填写您自己的APIKey
response = client.chat.completions.create(
    model="glm-4",# 请填写您要调用的模型名称
    messages=[{"role":"system","content":"你是一个乐于回答各种问题的小助手，你的任务是提供专业、准确、有洞察力的建议。"},{"role":"user","content":"我对太阳系的行星非常感兴趣，尤其是土星。请提供关于土星的基本信息，包括它的大小、组成、环系统以及任何独特的天文现象。"},],
    stream=True,)for chunk in response:print(chunk.choices[0].delta)

响应示例:

data:{"id":"8313807536837492492","created":1706092316,"model":"glm-4","choices":[{"index":0,"delta":{"role":"assistant","content":"土"}}]}
data:{"id":"8313807536837492492","created":1706092316,"model":"glm-4","choices":[{"index":0,"delta":{"role":"assistant","content":"星"}}]}....
data:{"id":"8313807536837492492","created":1706092316,"model":"glm-4","choices":[{"index":0,"delta":{"role":"assistant","content":"，"}}]}
data:{"id":"8313807536837492492","created":1706092316,"model":"glm-4","choices":[{"index":0,"delta":{"role":"assistant","content":"主要由"}}]}
data:{"id":"8313807536837492492","created":1706092316,"model":"glm-4","choices":[{"index":0,"finish_reason":"length","delta":{"role":"assistant","content":""}}],"usage":{"prompt_tokens":60,"completion_tokens":100,"total_tokens":160}}
data:[DONE]

函数调用

请求示例

from zhipuai import ZhipuAI

client = ZhipuAI(api_key="")# 请填写您自己的APIKey

tools =[{"type":"function","function":{"name":"query_train_info","description":"根据用户提供的信息查询火车时刻","parameters":{"type":"object","properties":{"departure":{"type":"string","description":"出发城市或车站",},"destination":{"type":"string","description":"目的地城市或车站",},"date":{"type":"string","description":"要查询的火车日期",},},"required":["departure","destination","date"],},}}]
messages =[{"role":"user","content":"你能帮我查一下2024年1月1日从北京南站到上海的火车票吗？"}]
response = client.chat.completions.create(
    model="glm-4",# 请填写您要调用的模型名称
    messages=messages,
    tools=tools,
    tool_choice="auto",)print(response.choices[0].message)

响应示例

{"id":"8231168139794583938","model":"glm-4","request_id":"8231168139794583938","created":1703490288,"choices":[{"finish_reason":"tool_calls","index":0,"message":{"role":"assistant","tool_calls":[{"id":"call_8231168139794583938","index":0,"type":"function","function":{"arguments":'{"date": "2024-01-01","departure": "北京南站","destination": "上海"}',"name":"query_train_info"}}]}}],"usage":{"completion_tokens":31,"prompt_tokens":120,"total_tokens":151}}

异步调用

接口请求
类型说明传输方式HTTPS请求URL

https://open.bigmodel.cn/api/paas/v4/async/chat/completions

调用方式异步，结果必须通过查询接口获取字符编码UTF-8请求格式JSON响应格式JSONHTTP方法POST开发语言任何能够发起HTTP请求的开发语言

请求参数

请求参数与同步API调用相同。

响应参数

参数名称类型描述request_idString请求发起时客户端提交的任务号或平台生成的任务号。idString智谱AI开放平台生成的任务序号，查询结果时使用此序号。modelStringAPI请求时调用的模型名称。task_statusstring请求的处理状态：

PROCESSING

（处理中），

SUCCESS

（成功），

FAIL

（失败）。此状态必须查询才能确定结果。

调用示例

from zhipuai import ZhipuAI

client = ZhipuAI(api_key="") # 请填写您自己的APIKey
response = client.chat.asyncCompletions.create(
    model="glm-4",  # 请填写您要调用的模型名称
    messages=[
        {
            "role": "user",
            "content": "
作为童话之王，请以始终保持一颗善良的心为主题，写一篇简短的童话故事。故事应能激发孩子们的学习兴趣和想象力，同时帮助他们更好地理解和接受故事中蕴含的道德和价值观。"
        }
    ],
)
print(response)

响应示例

id='123456789' request_id='654321' model='glm-4' task_status='PROCESSING'

任务结果查询

接口请求
类型说明传输方式https请求URLhttps://open.bigmodel.cn/api/paas/v4/async-result/{id}调用方式同步调用，等待模型完全执行并返回最终结果字符编码UTF-8请求格式JSON响应格式JSONHTTP方法GET开发语言同步调用，等待模型完全执行并返回最终结果

请求参数

参数名称类型必填描述idString是任务id

响应参数

参数名称类型描述modelString模型名称choicesList当前对话模型输出内容，目前仅返回一个indexInteger结果索引finish_reasonString模型推理终止的原因。"stop"表示自然结束或触发stop词，"length"表示达到token长度限制。messageObject模型返回的文本消息roleString当前对话角色，目前默认为assistant（模型）contentString当前对话内容tool_callsList模型生成的应调用的函数名称和参数。functionObjectnameString模型生成的应调用的函数名称。argumentsString模型生成的函数调用参数的JSON格式。注意，模型生成的JSON不一定有效，可能包含函数模式中未定义的参数。在调用函数前，请在你的代码中验证参数。idString命中函数的唯一标识符。typeString模型调用的工具类型，目前仅支持’function’。"task_statusString处理状态：PROCESSING（处理中），SUCCESS（成功），FAIL（失败）request_idString客户端请求时提交的任务号或平台生成的任务号idString智谱AI开放平台生成的任务序号，调用请求结果接口时使用此序号usageObject本次模型调用的token统计prompt_tokensint用户输入的token数量completion_tokensint模型输出的token数量total_tokensint总token数量

请求示例

import time
from zhipuai import ZhipuAI

client = ZhipuAI(api_key="")# 请填写您自己的APIKey

response = client.chat.asyncCompletions.create(
    model="glm-4",# 请填写您要调用的模型名称
    messages=[{"role":"user","content": "
作为童话之王，请以始终保持一颗善良的心为主题，写一篇简短的童话故事。故事应能激发孩子们的学习兴趣和想象力，同时帮助他们更好地理解和接受故事中蕴含的道德和价值观。"
        }],)
task_id = response.id
task_status =''
get_cnt =0while task_status !='SUCCESS'and task_status !='FAILED'and get_cnt <=40:
    result_response = client.chat.asyncCompletions.retrieve_completion_result(id=task_id)print(result_response)
    task_status = result_response.task_status

    time.sleep(2)
    get_cnt +=1

响应示例:

{"id":"123456789","request_id":"123123123","model":null,"task_status":"PROCESSING"}{"id":"123456789","request_id":"123123123","model":null,"task_status":"PROCESSING"}......{"id":"123456789","request_id":"123123123","model":null,"task_status":"PROCESSING"}{"id":"123456789","request_id":"123123123","model":"glm-4","task_status":"SUCCESS","choices":[{"index":0,"finish_reason":"stop","message":{"content": "从前，有一个美丽的村庄，那里的孩子们都喜欢一起玩耍、学习和探索。其中有一个小男孩叫小明，他有一颗善良的心，总是乐于帮助别人。

一天，小明在森林里发现了一只翅膀受伤的小鸟，无法飞翔。小明心疼这只小鸟，便把它带回家，用温暖和爱心照顾它。在小明的细心照料下，小鸟的翅膀渐渐康复，开始在房间里飞来飞去。

看到小鸟奇迹般的康复，小明对鸟类产生了浓厚的兴趣，想要了解更多关于鸟类的知识。他开始阅读有关鸟类的书籍，学习它们的习性和生活方式。通过学习，小明对鸟类有了深刻的了解，他和那只小鸟也建立了深厚的友谊。

一天，小明在森林里散步时，发现了一只被困在猎人陷阱里的小兔子。小明毫不犹豫地救出了小兔子。小兔子感激地看着小明，并告诉他森林里有一个神秘的宝藏——一颗能实现愿望的魔法宝石。

充满好奇心的小明决定去寻找这颗宝石。他带着小鸟和小兔子踏上了冒险之旅。在旅途中，他们遇到了许多挑战，但小明始终保持着善良的心，勇敢地面对每一个困难。他不仅学会了如何与森林里的动物相处，还学会了许多生存技能。

经过一段时间的努力，小明终于找到了那颗魔法宝石。宝石发出耀眼的光芒，将小明和他的朋友们带到了一个美丽的世界。在那里，他们遇到了一位智慧的老人，老人告诉小明，宝石的力量来自于一个人的善良之心。只有拥有善良之心的人才能激活宝石的力量，实现自己的愿望。

小明明白了这个道理，感谢了老人，带着宝石回到了现实世界。他用宝石的力量帮助他人，让村庄变得更加美好。小明成为了村庄里的榜样，通过他的行动，孩子们明白了始终保持一颗善良的心的重要性。

从此以后，小明和村民们幸福地生活在一起。听过小明故事的孩子们明白了善良之心的重要性。他们以小明为榜样，努力成为一个有爱心、有责任感的人。在这个过程中，他们的学习兴趣和想象力也被激发，成长为优秀的孩子。

这个故事告诉我们，始终保持一颗善良的心，用我们的行动去影响周围的人。只有拥有善良之心的人，才能解锁自己的潜力，实现梦想。让我们都努力成为一个有善良之心的人。","role":"assistant","tool_calls":null}}],"usage":{"prompt_tokens":52,"completion_tokens":470,"total_tokens":522}}

links：
https://open.bigmodel.cn/dev/api/normal-model/glm-4