序列化表格 (zhipu sdk for GLM open api release-V4-2.1.0 API)

程序包 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.DeltaDeserializer扩展BaseNodeDeserializer<Delta>实现可序列化
- 类com.zhipu.oapi.service.v4.deserialize.ModelDataDeserializer扩展BaseNodeDeserializer<ModelData>实现可序列化
- 类com.zhipu.oapi.service.v4.deserialize.ToolCallsDeserializer扩展BaseNodeDeserializer<ToolCalls>实现可序列化
程序包 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
```
    - error
```
ChatError error
```
- 类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.deserialize

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

序列化字段

_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.DeltaDeserializer扩展BaseNodeDeserializer<Delta>实现可序列化

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

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

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

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

序列化字段

name

description

parameters

required

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

序列化字段

name

arguments

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

序列化字段

type

properties

required

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

序列化字段

role

content

name

tool_calls

tool_call_id

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

序列化字段

type

function

retrieval

web_search

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

序列化字段

finishReason

index

message

delta

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

序列化字段

role

content

tool_calls

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

序列化字段

choices

usage

requestId

taskStatus

created

model

id

error

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

序列化字段

knowledge_id

prompt_template

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

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

序列化字段

function

id

type

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

序列化字段

enable

search_result

search_query

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

序列化字段

statusCode

code