序列化表格
-
程序包 com.zhipu.oapi.service.v4.assistant
-
类 com.zhipu.oapi.service.v4.assistant.AssistantChoice
class AssistantChoice extends com.fasterxml.jackson.databind.node.ObjectNode implements Serializable-
序列化字段
-
delta
MessageContent delta
当前会话输出消息体 -
finishReason
String finishReason
推理结束原因 stop 代表推理自然结束或触发停止词。sensitive 代表模型推理内容被安全审核接口拦截。 network_error 代表模型推理服务异常。 -
index
int index
结果下标 -
metadata
Map<String,
Object> metadata 元信息,拓展字段
-
-
-
类 com.zhipu.oapi.service.v4.assistant.AssistantCompletion
class AssistantCompletion extends com.fasterxml.jackson.databind.node.ObjectNode implements Serializable-
序列化字段
-
assistantId
String assistantId
智能体 ID -
choices
List<AssistantChoice> choices
增量返回的信息 -
conversationId
String conversationId
会话 ID -
created
int created
请求创建时间,Unix 时间戳 -
id
String id
请求 ID -
lastError
ErrorInfo lastError
异常信息 -
metadata
Map<String,
Object> metadata 元信息,拓展字段 -
status
String status
返回状态,包括:`completed` 表示生成结束,`in_progress` 表示生成中,`failed` 表示生成异常 -
usage
CompletionUsage usage
tokens 数量统计
-
-
-
类 com.zhipu.oapi.service.v4.assistant.CompletionUsage
class CompletionUsage extends com.fasterxml.jackson.databind.node.ObjectNode implements Serializable-
序列化字段
-
completionTokens
int completionTokens
输出的 tokens 数量 -
promptTokens
int promptTokens
输入的 tokens 数量 -
totalTokens
int totalTokens
总 tokens 数量
-
-
-
类 com.zhipu.oapi.service.v4.assistant.ErrorInfo
class ErrorInfo extends com.fasterxml.jackson.databind.node.ObjectNode implements Serializable
-
-
程序包 com.zhipu.oapi.service.v4.deserialize
-
类 com.zhipu.oapi.service.v4.deserialize.BaseNodeDeserializer
class BaseNodeDeserializer extends com.fasterxml.jackson.databind.deser.std.StdDeserializer<T extends com.fasterxml.jackson.databind.JsonNode> implements Serializable-
序列化字段
-
_supportsUpdates
Boolean _supportsUpdates
-
-
-
类 com.zhipu.oapi.service.v4.deserialize.ChatFunctionCallDeserializer
class ChatFunctionCallDeserializer extends BaseNodeDeserializer<ChatFunctionCall> implements Serializable -
类 com.zhipu.oapi.service.v4.deserialize.ChatMessageDeserializer
-
类 com.zhipu.oapi.service.v4.deserialize.ChoiceDeserializer
-
类 com.zhipu.oapi.service.v4.deserialize.CodeGeexContextDeserializer
class CodeGeexContextDeserializer extends BaseNodeDeserializer<CodeGeexContext> implements Serializable -
类 com.zhipu.oapi.service.v4.deserialize.DeltaDeserializer
-
类 com.zhipu.oapi.service.v4.deserialize.ModelDataDeserializer
-
类 com.zhipu.oapi.service.v4.deserialize.ObjectDeserializer
class ObjectDeserializer extends BaseNodeDeserializer<com.fasterxml.jackson.databind.node.ObjectNode> implements Serializable- serialVersionUID:
- 1L
-
类 com.zhipu.oapi.service.v4.deserialize.ToolCallsDeserializer
-
-
程序包 com.zhipu.oapi.service.v4.deserialize.assistant
-
类 com.zhipu.oapi.service.v4.deserialize.assistant.AssistantChoiceDeserializer
class AssistantChoiceDeserializer extends BaseNodeDeserializer<AssistantChoice> implements Serializable -
类 com.zhipu.oapi.service.v4.deserialize.assistant.AssistantCompletionDeserializer
class AssistantCompletionDeserializer extends BaseNodeDeserializer<AssistantCompletion> implements Serializable -
类 com.zhipu.oapi.service.v4.deserialize.assistant.CompletionUsageDeserializer
class CompletionUsageDeserializer extends BaseNodeDeserializer<CompletionUsage> implements Serializable -
类 com.zhipu.oapi.service.v4.deserialize.assistant.ErrorInfoDeserializer
-
-
程序包 com.zhipu.oapi.service.v4.deserialize.embedding
-
类 com.zhipu.oapi.service.v4.deserialize.embedding.EmbeddingDeserializer
-
类 com.zhipu.oapi.service.v4.deserialize.embedding.EmbeddingResultDeserializer
class EmbeddingResultDeserializer extends BaseNodeDeserializer<EmbeddingResult> implements Serializable
-
-
程序包 com.zhipu.oapi.service.v4.deserialize.image
-
程序包 com.zhipu.oapi.service.v4.deserialize.knowledge
-
类 com.zhipu.oapi.service.v4.deserialize.knowledge.KnowledgeInfoDeserializer
-
类 com.zhipu.oapi.service.v4.deserialize.knowledge.KnowledgePageDeserializer
-
类 com.zhipu.oapi.service.v4.deserialize.knowledge.KnowledgeStatisticsDeserializer
class KnowledgeStatisticsDeserializer extends BaseNodeDeserializer<KnowledgeStatistics> implements Serializable -
类 com.zhipu.oapi.service.v4.deserialize.knowledge.KnowledgeUsedDeserializer
-
-
程序包 com.zhipu.oapi.service.v4.deserialize.knowledge.document
-
类 com.zhipu.oapi.service.v4.deserialize.knowledge.document.DocumentDataDeserializer
-
类 com.zhipu.oapi.service.v4.deserialize.knowledge.document.DocumentDataFailInfoDeserializer
class DocumentDataFailInfoDeserializer extends BaseNodeDeserializer<DocumentDataFailInfo> implements Serializable -
类 com.zhipu.oapi.service.v4.deserialize.knowledge.document.DocumentFailedInfoDeserializer
class DocumentFailedInfoDeserializer extends BaseNodeDeserializer<DocumentFailedInfo> implements Serializable -
类 com.zhipu.oapi.service.v4.deserialize.knowledge.document.DocumentObjectDeserializer
class DocumentObjectDeserializer extends BaseNodeDeserializer<DocumentObject> implements Serializable -
类 com.zhipu.oapi.service.v4.deserialize.knowledge.document.DocumentPageDeserializer
-
类 com.zhipu.oapi.service.v4.deserialize.knowledge.document.DocumentSuccessInfoDeserializer
class DocumentSuccessInfoDeserializer extends BaseNodeDeserializer<DocumentSuccessInfo> implements Serializable
-
-
程序包 com.zhipu.oapi.service.v4.deserialize.tools
-
类 com.zhipu.oapi.service.v4.deserialize.tools.ChoiceDeltaDeserializer
-
类 com.zhipu.oapi.service.v4.deserialize.tools.ChoiceDeltaToolCallDeserializer
class ChoiceDeltaToolCallDeserializer extends BaseNodeDeserializer<ChoiceDeltaToolCall> implements Serializable -
类 com.zhipu.oapi.service.v4.deserialize.tools.SearchChatMessageDeserializer
class SearchChatMessageDeserializer extends BaseNodeDeserializer<SearchChatMessage> implements Serializable -
类 com.zhipu.oapi.service.v4.deserialize.tools.SearchIntentDeserializer
-
类 com.zhipu.oapi.service.v4.deserialize.tools.SearchRecommendDeserializer
class SearchRecommendDeserializer extends BaseNodeDeserializer<SearchRecommend> implements Serializable -
类 com.zhipu.oapi.service.v4.deserialize.tools.SearchResultDeserializer
-
类 com.zhipu.oapi.service.v4.deserialize.tools.WebSearchChoiceDeserializer
class WebSearchChoiceDeserializer extends BaseNodeDeserializer<WebSearchChoice> implements Serializable -
类 com.zhipu.oapi.service.v4.deserialize.tools.WebSearchMessageDeserializer
class WebSearchMessageDeserializer extends BaseNodeDeserializer<WebSearchMessage> implements Serializable -
类 com.zhipu.oapi.service.v4.deserialize.tools.WebSearchMessageToolCallDeserializer
class WebSearchMessageToolCallDeserializer extends BaseNodeDeserializer<WebSearchMessageToolCall> implements Serializable -
类 com.zhipu.oapi.service.v4.deserialize.tools.WebSearchProDeserializer
-
-
程序包 com.zhipu.oapi.service.v4.deserialize.videos
-
程序包 com.zhipu.oapi.service.v4.embedding
-
类 com.zhipu.oapi.service.v4.embedding.Embedding
class Embedding extends com.fasterxml.jackson.databind.node.ObjectNode implements Serializable -
类 com.zhipu.oapi.service.v4.embedding.EmbeddingResult
class EmbeddingResult extends com.fasterxml.jackson.databind.node.ObjectNode implements Serializable
-
-
程序包 com.zhipu.oapi.service.v4.image
-
类 com.zhipu.oapi.service.v4.image.Image
class Image extends com.fasterxml.jackson.databind.node.ObjectNode implements Serializable -
类 com.zhipu.oapi.service.v4.image.ImageResult
class ImageResult extends com.fasterxml.jackson.databind.node.ObjectNode implements Serializable
-
-
程序包 com.zhipu.oapi.service.v4.knowledge
-
类 com.zhipu.oapi.service.v4.knowledge.KnowledgeInfo
class KnowledgeInfo extends com.fasterxml.jackson.databind.node.ObjectNode implements Serializable-
序列化字段
-
background
String background
背景颜色 'blue', 'red', 'orange', 'purple', 'sky' -
bucketId
String bucketId
桶id 限制32位 -
customerIdentifier
String customerIdentifier
用户标识 长度32位以内 -
description
String description
知识库描述 500字限制 -
embeddingId
String embeddingId
知识库绑定的向量化模型 -
icon
String icon
知识库图标 question: 问号、book: 书籍、seal: 印章、wrench: 扳手、tag: 标签、horn: 喇叭、house: 房子 -
id
String id
知识库唯一 id -
name
String name
知识库名称 100字限制
-
-
-
类 com.zhipu.oapi.service.v4.knowledge.KnowledgePage
class KnowledgePage extends com.fasterxml.jackson.databind.node.ObjectNode implements Serializable-
序列化字段
-
list
List<KnowledgeInfo> list
知识库信息列表 -
total
Integer total
对象类型
-
-
-
类 com.zhipu.oapi.service.v4.knowledge.KnowledgeStatistics
class KnowledgeStatistics extends com.fasterxml.jackson.databind.node.ObjectNode implements Serializable -
类 com.zhipu.oapi.service.v4.knowledge.KnowledgeUsed
class KnowledgeUsed extends com.fasterxml.jackson.databind.node.ObjectNode implements Serializable-
序列化字段
-
total
KnowledgeStatistics total
知识库总量 -
used
KnowledgeStatistics used
已使用量
-
-
-
-
程序包 com.zhipu.oapi.service.v4.knowledge.document
-
类 com.zhipu.oapi.service.v4.knowledge.document.DocumentData
class DocumentData extends com.fasterxml.jackson.databind.node.ObjectNode implements Serializable-
序列化字段
-
customSeparator
List<String> customSeparator
切片规则 -
embeddingStat
Integer embeddingStat
向量化状态 0: 向量化中 1: 向量化完成 2: 向量化失败 -
failInfo
DocumentDataFailInfo failInfo
失败原因,向量化失败时会有此值 -
id
String id
知识唯一id -
length
Integer length
文件大小(字节) -
name
String name
文件名 -
sentenceSize
String sentenceSize
切片大小 -
url
String url
文件下载链接 -
wordNum
Integer wordNum
文件字数
-
-
-
类 com.zhipu.oapi.service.v4.knowledge.document.DocumentDataFailInfo
class DocumentDataFailInfo extends com.fasterxml.jackson.databind.node.ObjectNode implements Serializable -
类 com.zhipu.oapi.service.v4.knowledge.document.DocumentFailedInfo
class DocumentFailedInfo extends com.fasterxml.jackson.databind.node.ObjectNode implements Serializable -
类 com.zhipu.oapi.service.v4.knowledge.document.DocumentObject
class DocumentObject extends com.fasterxml.jackson.databind.node.ObjectNode implements Serializable-
序列化字段
-
failedInfos
List<DocumentFailedInfo> failedInfos
上传失败的文件信息 -
successInfos
List<DocumentSuccessInfo> successInfos
上传成功的文件信息
-
-
-
类 com.zhipu.oapi.service.v4.knowledge.document.DocumentPage
class DocumentPage extends com.fasterxml.jackson.databind.node.ObjectNode implements Serializable-
序列化字段
-
list
List<DocumentData> list
List of document data entries. -
object
String object
The object type.
-
-
-
类 com.zhipu.oapi.service.v4.knowledge.document.DocumentSuccessInfo
class DocumentSuccessInfo extends com.fasterxml.jackson.databind.node.ObjectNode implements Serializable
-
-
程序包 com.zhipu.oapi.service.v4.model
-
类 com.zhipu.oapi.service.v4.model.ChatFunction
class ChatFunction extends com.fasterxml.jackson.databind.node.ObjectNode implements Serializable-
序列化字段
-
description
String description
-
name
String name
-
parameters
ChatFunctionParameters parameters
-
required
List<String> required
-
-
-
类 com.zhipu.oapi.service.v4.model.ChatFunctionCall
class ChatFunctionCall extends com.fasterxml.jackson.databind.node.ObjectNode implements Serializable-
序列化字段
-
arguments
com.fasterxml.jackson.databind.JsonNode arguments
模型生成的 JSON 格式的函数调用参数。请注意,模型生成的 JSON 并不总是有效的,可能会出现函数模式未定义的参数。在调用函数之前,请在代码中验证参数 -
name
String name
模型生成的应调用函数的名称
-
-
-
类 com.zhipu.oapi.service.v4.model.ChatFunctionParameters
class ChatFunctionParameters extends com.fasterxml.jackson.databind.node.ObjectNode implements Serializable -
类 com.zhipu.oapi.service.v4.model.ChatMessage
class ChatMessage extends com.fasterxml.jackson.databind.node.ObjectNode implements Serializable -
类 com.zhipu.oapi.service.v4.model.ChatTool
class ChatTool extends com.fasterxml.jackson.databind.node.ObjectNode implements Serializable-
序列化字段
-
function
ChatFunction function
-
retrieval
Retrieval retrieval
-
type
String type
-
web_search
WebSearch web_search
-
-
-
类 com.zhipu.oapi.service.v4.model.Choice
class Choice extends com.fasterxml.jackson.databind.node.ObjectNode implements Serializable-
序列化字段
-
delta
Delta delta
-
finishReason
String finishReason
-
index
Long index
-
message
ChatMessage message
-
-
-
类 com.zhipu.oapi.service.v4.model.Delta
class Delta extends com.fasterxml.jackson.databind.node.ObjectNode implements Serializable -
类 com.zhipu.oapi.service.v4.model.ModelData
class ModelData extends com.fasterxml.jackson.databind.node.ObjectNode implements Serializable -
类 com.zhipu.oapi.service.v4.model.Retrieval
class Retrieval extends com.fasterxml.jackson.databind.node.ObjectNode implements Serializable-
序列化字段
-
knowledge_id
String knowledge_id
当涉及到知识库ID时,请前往开放平台的知识库模块进行创建或获取。 -
prompt_template
String prompt_template
请求模型时的知识库模板,默认模板: 从文档 """ {{ knowledge}} """ 中找问题 """ {{question}} """ 的答案,找到答案就仅使用文档语句回答问题,找不到答案就用自身知识回答并且告诉用户该信息不是来自文档。 不要复述问题,直接开始回答 注意:用户自定义模板时,知识库内容占位符 和用户侧问题占位符必是{{ knowledge}} 和{{question}},其他模板内容用户可根据实际场景定义
-
-
-
类 com.zhipu.oapi.service.v4.model.SSEFormatException
class SSEFormatException extends Throwable implements Serializable -
类 com.zhipu.oapi.service.v4.model.ToolCalls
class ToolCalls extends com.fasterxml.jackson.databind.node.ObjectNode implements Serializable-
序列化字段
-
function
ChatFunctionCall function
-
id
String id
命中函数的唯一标识符 -
type
String type
模型调用工具的类型,目前仅支持functon
-
-
-
类 com.zhipu.oapi.service.v4.model.WebSearch
class WebSearch extends com.fasterxml.jackson.databind.node.ObjectNode implements Serializable -
异常错误 com.zhipu.oapi.service.v4.model.ZhiPuAiHttpException
class ZhiPuAiHttpException extends RuntimeException implements Serializable
-
-
程序包 com.zhipu.oapi.service.v4.model.params
-
类 com.zhipu.oapi.service.v4.model.params.CodeGeexContext
class CodeGeexContext extends com.fasterxml.jackson.databind.node.ObjectNode implements Serializable
-
-
程序包 com.zhipu.oapi.service.v4.tools
-
类 com.zhipu.oapi.service.v4.tools.ChoiceDelta
class ChoiceDelta extends com.fasterxml.jackson.databind.node.ObjectNode implements Serializable-
序列化字段
-
role
String role
角色 -
toolCalls
List<ChoiceDeltaToolCall> toolCalls
工具调用列表
-
-
-
类 com.zhipu.oapi.service.v4.tools.ChoiceDeltaToolCall
class ChoiceDeltaToolCall extends com.fasterxml.jackson.databind.node.ObjectNode implements Serializable-
序列化字段
-
id
String id
ID -
index
int index
索引 -
searchIntent
SearchIntent searchIntent
搜索意图 -
searchRecommend
SearchRecommend searchRecommend
推荐query -
searchResult
SearchResult searchResult
搜索结果 -
type
String type
Tool call 类型
-
-
-
类 com.zhipu.oapi.service.v4.tools.SearchChatMessage
class SearchChatMessage extends com.fasterxml.jackson.databind.node.ObjectNode implements Serializable -
类 com.zhipu.oapi.service.v4.tools.SearchIntent
class SearchIntent extends com.fasterxml.jackson.databind.node.ObjectNode implements Serializable -
类 com.zhipu.oapi.service.v4.tools.SearchRecommend
class SearchRecommend extends com.fasterxml.jackson.databind.node.ObjectNode implements Serializable-
序列化字段
-
index
int index
搜索轮次,默认为 0 -
query
String query
推荐query
-
-
-
类 com.zhipu.oapi.service.v4.tools.SearchResult
class SearchResult extends com.fasterxml.jackson.databind.node.ObjectNode implements Serializable -
类 com.zhipu.oapi.service.v4.tools.WebSearchChoice
class WebSearchChoice extends com.fasterxml.jackson.databind.node.ObjectNode implements Serializable-
序列化字段
-
delta
ChoiceDelta delta
delta -
finishReason
String finishReason
完成原因 -
index
int index
索引 -
message
WebSearchMessage message
消息
-
-
-
类 com.zhipu.oapi.service.v4.tools.WebSearchMessage
class WebSearchMessage extends com.fasterxml.jackson.databind.node.ObjectNode implements Serializable-
序列化字段
-
role
String role
角色 -
toolCalls
List<WebSearchMessageToolCall> toolCalls
工具调用列表
-
-
-
类 com.zhipu.oapi.service.v4.tools.WebSearchMessageToolCall
class WebSearchMessageToolCall extends com.fasterxml.jackson.databind.node.ObjectNode implements Serializable-
序列化字段
-
id
String id
Tool call ID -
searchIntent
List<SearchIntent> searchIntent
搜索意图 -
searchRecommend
SearchRecommend searchRecommend
推荐query -
searchResult
List<SearchResult> searchResult
搜索结果 -
type
String type
Tool call 类型
-
-
-
类 com.zhipu.oapi.service.v4.tools.WebSearchPro
class WebSearchPro extends com.fasterxml.jackson.databind.node.ObjectNode implements Serializable-
序列化字段
-
choices
List<WebSearchChoice> choices
选择项 -
created
Integer created
创建时间 -
id
String id
ID -
requestId
String requestId
请求ID
-
-
-
-
程序包 com.zhipu.oapi.service.v4.videos
-
类 com.zhipu.oapi.service.v4.videos.VideoObject
class VideoObject extends com.fasterxml.jackson.databind.node.ObjectNode implements Serializable-
序列化字段
-
id
String id
智谱 AI 开放平台生成的任务订单号,调用请求结果接口时请使用此订单号 -
model
String model
模型名称 -
optimizedPrompt
String optimizedPrompt
如进行bpo,返回优化后的prompt -
requestId
String requestId
用户在客户端请求时提交的任务编号或者平台生成的任务编号 -
taskStatus
String taskStatus
处理状态,PROCESSING(处理中),SUCCESS(成功),FAIL(失败) 注:处理中状态需通过查询获取结果 -
videoResult
List<VideoResult> videoResult
视频生成结果
-
-
-
类 com.zhipu.oapi.service.v4.videos.VideoResult
class VideoResult extends com.fasterxml.jackson.databind.node.ObjectNode implements Serializable
-