序列化表格

程序包 com.zhipu.oapi.service.v4.deserialize

类com.zhipu.oapi.service.v4.deserialize.BaseNodeDeserializer扩展com.fasterxml.jackson.databind.deser.std.StdDeserializer<T extends com.fasterxml.jackson.databind.JsonNode>实现可序列化

序列化字段

_supportsUpdates

Boolean _supportsUpdates

类com.zhipu.oapi.service.v4.deserialize.ChatFunctionCallDeserializer扩展BaseNodeDeserializer<ChatFunctionCall>实现可序列化

类com.zhipu.oapi.service.v4.deserialize.ChatMessageDeserializer扩展BaseNodeDeserializer<ChatMessage>实现可序列化

类com.zhipu.oapi.service.v4.deserialize.ChoiceDeserializer扩展BaseNodeDeserializer<Choice>实现可序列化

类com.zhipu.oapi.service.v4.deserialize.CodeGeexContextDeserializer扩展BaseNodeDeserializer<CodeGeexContext>实现可序列化

类com.zhipu.oapi.service.v4.deserialize.DeltaDeserializer扩展BaseNodeDeserializer<Delta>实现可序列化

类com.zhipu.oapi.service.v4.deserialize.ModelDataDeserializer扩展BaseNodeDeserializer<ModelData>实现可序列化

类com.zhipu.oapi.service.v4.deserialize.ObjectDeserializer扩展BaseNodeDeserializer<com.fasterxml.jackson.databind.node.ObjectNode>实现可序列化

serialVersionUID:

1L

类com.zhipu.oapi.service.v4.deserialize.ToolCallsDeserializer扩展BaseNodeDeserializer<ToolCalls>实现可序列化

程序包 com.zhipu.oapi.service.v4.deserialize.tools

类com.zhipu.oapi.service.v4.deserialize.tools.ChoiceDeltaDeserializer扩展BaseNodeDeserializer<ChoiceDelta>实现可序列化

类com.zhipu.oapi.service.v4.deserialize.tools.ChoiceDeltaToolCallDeserializer扩展BaseNodeDeserializer<ChoiceDeltaToolCall>实现可序列化

类com.zhipu.oapi.service.v4.deserialize.tools.SearchChatMessageDeserializer扩展BaseNodeDeserializer<SearchChatMessage>实现可序列化

类com.zhipu.oapi.service.v4.deserialize.tools.SearchIntentDeserializer扩展BaseNodeDeserializer<SearchIntent>实现可序列化

类com.zhipu.oapi.service.v4.deserialize.tools.SearchRecommendDeserializer扩展BaseNodeDeserializer<SearchRecommend>实现可序列化

类com.zhipu.oapi.service.v4.deserialize.tools.SearchResultDeserializer扩展BaseNodeDeserializer<SearchResult>实现可序列化

类com.zhipu.oapi.service.v4.deserialize.tools.WebSearchChoiceDeserializer扩展BaseNodeDeserializer<WebSearchChoice>实现可序列化

类com.zhipu.oapi.service.v4.deserialize.tools.WebSearchMessageDeserializer扩展BaseNodeDeserializer<WebSearchMessage>实现可序列化

类com.zhipu.oapi.service.v4.deserialize.tools.WebSearchMessageToolCallDeserializer扩展BaseNodeDeserializer<WebSearchMessageToolCall>实现可序列化

类com.zhipu.oapi.service.v4.deserialize.tools.WebSearchProDeserializer扩展BaseNodeDeserializer<WebSearchPro>实现可序列化

程序包 com.zhipu.oapi.service.v4.deserialize.videos

类com.zhipu.oapi.service.v4.deserialize.videos.VideoObjectDeserializer扩展BaseNodeDeserializer<VideoObject>实现可序列化

类com.zhipu.oapi.service.v4.deserialize.videos.VideoResultDeserializer扩展BaseNodeDeserializer<VideoResult>实现可序列化

程序包 com.zhipu.oapi.service.v4.model

类com.zhipu.oapi.service.v4.model.ChatFunction扩展com.fasterxml.jackson.databind.node.ObjectNode实现可序列化

序列化字段

name

String name

description

String description

parameters

ChatFunctionParameters parameters

required

List<E> required

类com.zhipu.oapi.service.v4.model.ChatFunctionCall扩展com.fasterxml.jackson.databind.node.ObjectNode实现可序列化

序列化字段

name

String name

模型生成的应调用函数的名称

arguments

com.fasterxml.jackson.databind.JsonNode arguments

模型生成的 JSON 格式的函数调用参数。请注意，模型生成的 JSON 并不总是有效的，可能会出现函数模式未定义的参数。在调用函数之前，请在代码中验证参数

类com.zhipu.oapi.service.v4.model.ChatFunctionParameters扩展com.fasterxml.jackson.databind.node.ObjectNode实现可序列化

序列化字段

type

String type

properties

com.fasterxml.jackson.databind.JsonNode properties

required

List<E> required

类com.zhipu.oapi.service.v4.model.ChatMessage扩展com.fasterxml.jackson.databind.node.ObjectNode实现可序列化

序列化字段

role

String role

content

Object content

name

String name

tool_calls

List<E> tool_calls

tool_call_id

String tool_call_id

类com.zhipu.oapi.service.v4.model.ChatTool扩展com.fasterxml.jackson.databind.node.ObjectNode实现可序列化

序列化字段

type

String type

function

ChatFunction function

retrieval

Retrieval retrieval

web_search

WebSearch web_search

类com.zhipu.oapi.service.v4.model.Choice扩展com.fasterxml.jackson.databind.node.ObjectNode实现可序列化

序列化字段

finishReason

String finishReason

index

Long index

message

ChatMessage message

delta

Delta delta

类com.zhipu.oapi.service.v4.model.Delta扩展com.fasterxml.jackson.databind.node.ObjectNode实现可序列化

序列化字段

role

String role

content

String content

tool_calls

List<E> tool_calls

类com.zhipu.oapi.service.v4.model.ModelData扩展com.fasterxml.jackson.databind.node.ObjectNode实现可序列化

序列化字段

choices

List<E> choices

usage

Usage usage

requestId

String requestId

taskStatus

TaskStatus taskStatus

created

Long created

model

String model

id

String id

类com.zhipu.oapi.service.v4.model.Retrieval扩展com.fasterxml.jackson.databind.node.ObjectNode实现可序列化

序列化字段

knowledge_id

String knowledge_id

当涉及到知识库ID时，请前往开放平台的知识库模块进行创建或获取。

prompt_template

String prompt_template

请求模型时的知识库模板，默认模板： 从文档 """ {{ knowledge}} """ 中找问题 """ {{question}} """ 的答案，找到答案就仅使用文档语句回答问题，找不到答案就用自身知识回答并且告诉用户该信息不是来自文档。 不要复述问题，直接开始回答 注意：用户自定义模板时，知识库内容占位符 和用户侧问题占位符必是{{ knowledge}} 和{{question}}，其他模板内容用户可根据实际场景定义

类com.zhipu.oapi.service.v4.model.SSEFormatException扩展Throwable实现可序列化

类com.zhipu.oapi.service.v4.model.ToolCalls扩展com.fasterxml.jackson.databind.node.ObjectNode实现可序列化

序列化字段

function

ChatFunctionCall function

id

String id

命中函数的唯一标识符

type

String type

模型调用工具的类型,目前仅支持functon

类com.zhipu.oapi.service.v4.model.WebSearch扩展com.fasterxml.jackson.databind.node.ObjectNode实现可序列化

序列化字段

enable

Boolean enable

是否启用搜索，默认启用搜索 启用：true 禁用：false

search_result

Boolean search_result

是否返回搜索结果，默认返回搜索结果 返回：true 不返回：false

search_query

String search_query

强制搜索自定义关键内容，此时模型会根据自定义搜索关键内容返回的结果作为背景知识来回答用户发起的对话。

类com.zhipu.oapi.service.v4.model.ZhiPuAiHttpException扩展RuntimeException实现可序列化

序列化字段

statusCode

int statusCode

HTTP status code

code

String code

ZhiPuAI error code, for example "invalid_api_key"

param

String param

type

String type

ZhiPuAI error type, for example "invalid_request_error"

程序包 com.zhipu.oapi.service.v4.model.params

类com.zhipu.oapi.service.v4.model.params.CodeGeexContext扩展com.fasterxml.jackson.databind.node.ObjectNode实现可序列化

序列化字段

path

String path

code

String code

程序包 com.zhipu.oapi.service.v4.tools

类com.zhipu.oapi.service.v4.tools.ChoiceDelta扩展com.fasterxml.jackson.databind.node.ObjectNode实现可序列化

序列化字段

role

String role

角色

toolCalls

List<E> toolCalls

工具调用列表

类com.zhipu.oapi.service.v4.tools.ChoiceDeltaToolCall扩展com.fasterxml.jackson.databind.node.ObjectNode实现可序列化

序列化字段

index

int index

索引

id

String id

ID

searchIntent

SearchIntent searchIntent

搜索意图

searchResult

SearchResult searchResult

搜索结果

searchRecommend

SearchRecommend searchRecommend

推荐query

type

String type

Tool call 类型

类com.zhipu.oapi.service.v4.tools.SearchChatMessage扩展com.fasterxml.jackson.databind.node.ObjectNode实现可序列化

序列化字段

role

String role

content

Object content

类com.zhipu.oapi.service.v4.tools.SearchIntent扩展com.fasterxml.jackson.databind.node.ObjectNode实现可序列化

序列化字段

index

int index

搜索轮次，默认为 0

query

String query

搜索优化 query

intent

String intent

判断的意图类型

keywords

String keywords

搜索关键词

类com.zhipu.oapi.service.v4.tools.SearchRecommend扩展com.fasterxml.jackson.databind.node.ObjectNode实现可序列化

序列化字段

index

int index

搜索轮次，默认为 0

query

String query

推荐query

类com.zhipu.oapi.service.v4.tools.SearchResult扩展com.fasterxml.jackson.databind.node.ObjectNode实现可序列化

序列化字段

index

int index

搜索轮次，默认为 0

title

String title

标题

link

String link

链接

content

String content

内容

icon

String icon

图标

media

String media

来源媒体

refer

String refer

角标序号 [ref_1]

类com.zhipu.oapi.service.v4.tools.WebSearchChoice扩展com.fasterxml.jackson.databind.node.ObjectNode实现可序列化

序列化字段

index

int index

索引

finishReason

String finishReason

完成原因

message

WebSearchMessage message

消息

delta

ChoiceDelta delta

delta

类com.zhipu.oapi.service.v4.tools.WebSearchMessage扩展com.fasterxml.jackson.databind.node.ObjectNode实现可序列化

序列化字段

role

String role

角色

toolCalls

List<E> toolCalls

工具调用列表

类com.zhipu.oapi.service.v4.tools.WebSearchMessageToolCall扩展com.fasterxml.jackson.databind.node.ObjectNode实现可序列化

序列化字段

id

String id

Tool call ID

searchIntent

SearchIntent searchIntent

搜索意图

searchResult

SearchResult searchResult

搜索结果

searchRecommend

SearchRecommend searchRecommend

推荐query

type

String type

Tool call 类型

类com.zhipu.oapi.service.v4.tools.WebSearchPro扩展com.fasterxml.jackson.databind.node.ObjectNode实现可序列化

序列化字段

created

Integer created

创建时间

choices

List<E> choices

选择项

requestId

String requestId

请求ID

id

String id

ID

程序包 com.zhipu.oapi.service.v4.videos

类com.zhipu.oapi.service.v4.videos.VideoObject扩展com.fasterxml.jackson.databind.node.ObjectNode实现可序列化

序列化字段

id

String id

智谱 AI 开放平台生成的任务订单号，调用请求结果接口时请使用此订单号

model

String model

模型名称

videoResult

List<E> videoResult

视频生成结果

taskStatus

String taskStatus

处理状态，PROCESSING（处理中），SUCCESS（成功），FAIL（失败） 注：处理中状态需通过查询获取结果

optimizedPrompt

String optimizedPrompt

如进行bpo，返回优化后的prompt

requestId

String requestId

用户在客户端请求时提交的任务编号或者平台生成的任务编号

类com.zhipu.oapi.service.v4.videos.VideoResult扩展com.fasterxml.jackson.databind.node.ObjectNode实现可序列化

序列化字段

url

String url

视频url

coverImageUrl

String coverImageUrl

预览图