Serialized Form (Alibaba Cloud SFM SDK for Java 1.3.0 API)

Package com.aliyun.broadscope.bailian.sdk
- Class com.aliyun.broadscope.bailian.sdk.BaiLianSdkException extends RuntimeException implements Serializable
  - Serialized Fields
    - code
```
int code
```
Package com.aliyun.broadscope.bailian.sdk.models
- Class com.aliyun.broadscope.bailian.sdk.models.ChatAssistantMessage extends ChatRequestMessage implements Serializable
  - Serialized Fields
    - role
```
String role
```
      message发送对象
    - content
```
String content
```
      message消息体
- Class com.aliyun.broadscope.bailian.sdk.models.ChatRequestMessage extends Object implements Serializable
- Class com.aliyun.broadscope.bailian.sdk.models.ChatSystemMessage extends ChatRequestMessage implements Serializable
  - Serialized Fields
    - role
```
String role
```
      message发送对象
    - content
```
String content
```
      message消息体
- Class com.aliyun.broadscope.bailian.sdk.models.ChatUserMessage extends ChatRequestMessage implements Serializable
  - Serialized Fields
    - role
```
String role
```
      message发送对象
    - content
```
String content
```
      message消息体
- Class com.aliyun.broadscope.bailian.sdk.models.CompletionsRequest extends Object implements Serializable
  - Serialized Fields
    - requestId
```
String requestId
```
      请求唯一标识
    - sessionId
```
String sessionId
```
      上下文sessionId, 若传入了history, 则优先以history作为多轮对话历史, 上下文sessionId会失效
    - appId
```
String appId
```
      百炼应用的code
    - prompt
```
String prompt
```
      提示词
    - topP
```
Double topP
```
      随机性参数取值范围从0-1的浮点型值越大表示准确性越高，随机性越差
    - stream
```
Boolean stream
```
      是否流式输出
    - bizParams
```
com.alibaba.fastjson.JSONObject bizParams
```
      调用api插件的业务透传参数
    - hasThoughts
```
Boolean hasThoughts
```
      是否包含大模型thoughts结果
    - history
```
List<E> history
```
      多轮对话历史
    - docReferenceType
```
String docReferenceType
```
      文档引用类型, 取值为simple、indexed simple: 简单模式的doc reference, 在返回数据包含文档引用的基本信息, 不包含文档在文本中的索引位置 indexed: indexed模式的doc reference, 在返回数据包含文档引用的基本信息, 同时包含文档在文本中的索引位置
    - parameters
```
CompletionsRequest.Parameter parameters
```
    - docTagIds
```
List<E> docTagIds
```
      Deprecated.
      
      文档标签ID
    - docTagCodes
```
List<E> docTagCodes
```
      文档标签codes
    - messages
```
List<E> messages
```
      消息列表
- Class com.aliyun.broadscope.bailian.sdk.models.CompletionsRequest.ChatQaPair extends Object implements Serializable
  
  serialVersionUID:
  
  -3051114257693095299L
  - Serialized Fields
    - user
```
String user
```
      用户的query
    - bot
```
String bot
```
      模型的答案
- Class com.aliyun.broadscope.bailian.sdk.models.CompletionsRequest.Parameter extends Object implements Serializable
  
  serialVersionUID:
  
  8408299257902302971L
  - Serialized Fields
    - topK
```
Integer topK
```
      模型参数
    - seed
```
Integer seed
```
      随机种子
    - useRawPrompt
```
Boolean useRawPrompt
```
      是否使用原始的prompt
    - temperature
```
Double temperature
```
      采样温度采样温度在0到2之间。较高的值(如0.8)将使输出更加随机，而较低的值(如0.2)将使输出更加集中和确定。我们通常建议修改temperature或top_p，但不建议两者都修改。
    - maxTokens
```
Integer maxTokens
```
      模型生成内容的最大长度生成的token的最大数量。输入token数量和生成token数量的总长度受模型上下文长度的限制。
    - stop
```
List<E> stop
```
      API将停止生成token，最多支持4个停用词（停用句）。
    - incrementalOutput
```
Boolean incrementalOutput
```
      true 逐个增量输出非叠加模式 false 增量输出叠加模式
    - resultFormat
```
String resultFormat
```
      返回结果类型 [text|message] 默认为text 当为message时，输出参考message结果示例。推荐优先使用message格式。
- Class com.aliyun.broadscope.bailian.sdk.models.CompletionsResponse extends Object implements Serializable
  - Serialized Fields
    - success
```
Boolean success
```
      请求处理是否成功
    - code
```
String code
```
      请求失败code
    - message
```
String message
```
      请求失败描述
    - requestId
```
String requestId
```
      请求Id
    - data
```
CompletionsResponse.Data data
```
      请求处理结果
- Class com.aliyun.broadscope.bailian.sdk.models.CompletionsResponse.Data extends Object implements Serializable
  
  serialVersionUID:
  
  -2717404558710025579L
  - Serialized Fields
    - responseId
```
String responseId
```
      大模型请求id
    - sessionId
```
String sessionId
```
      上下文sessionId
    - text
```
String text
```
      文本生成的内容
    - thoughts
```
List<E> thoughts
```
      将Debug信息存储下来
    - docReferences
```
List<E> docReferences
```
      文档引用
    - usage
```
List<E> usage
```
      应用级别的token消耗
    - choices
```
List<E> choices
```
      多个生成内容
- Class com.aliyun.broadscope.bailian.sdk.models.CompletionsResponse.DocReference extends Object implements Serializable
  
  serialVersionUID:
  
  -5771627478159312044L
  - Serialized Fields
    - indexId
```
String indexId
```
      引用的角标索引
    - title
```
String title
```
      引用的文档标题
    - docId
```
String docId
```
      引用的文档Id
    - docName
```
String docName
```
      引用的文档名
    - docUrl
```
String docUrl
```
      文档下载地址
    - text
```
String text
```
      引用的文档内容
    - bizId
```
String bizId
```
      biz Id
- Class com.aliyun.broadscope.bailian.sdk.models.CompletionsResponse.Thought extends Object implements Serializable
  
  serialVersionUID:
  
  -3740672347955312773L
  - Serialized Fields
    - thought
```
String thought
```
      模型思考过程
    - actionType
```
String actionType
```
      action的类型 type : response 代表最终结果 - 对应response type : api 代表调用api - 对应action, actionInput, observation
    - response
```
String response
```
      响应返回
    - actionName
```
String actionName
```
      插件名称
    - action
```
String action
```
      大模型产生的api code，用于标识调用哪个api
    - actionInputStream
```
String actionInputStream
```
      入参的流式结果
    - actionInput
```
com.alibaba.fastjson.JSONObject actionInput
```
      大模型产生的api调用的入参
    - observation
```
String observation
```
      api的返回结果
- Class com.aliyun.broadscope.bailian.sdk.models.CompletionsResponse.Usage extends Object implements Serializable
  
  serialVersionUID:
  
  1169681422970782335L
  - Serialized Fields
    - inputTokens
```
Integer inputTokens
```
      input消耗的token
    - outputTokens
```
Integer outputTokens
```
      output消耗的token
    - modelId
```
String modelId
```
      模型id

Serialized Form

Package com.aliyun.broadscope.bailian.sdk

Class com.aliyun.broadscope.bailian.sdk.BaiLianSdkException extends RuntimeException implements Serializable

Serialized Fields

code

Package com.aliyun.broadscope.bailian.sdk.models

Class com.aliyun.broadscope.bailian.sdk.models.ChatAssistantMessage extends ChatRequestMessage implements Serializable

Serialized Fields

role

content

Class com.aliyun.broadscope.bailian.sdk.models.ChatRequestMessage extends Object implements Serializable

Class com.aliyun.broadscope.bailian.sdk.models.ChatSystemMessage extends ChatRequestMessage implements Serializable

Serialized Fields

role

content

Class com.aliyun.broadscope.bailian.sdk.models.ChatUserMessage extends ChatRequestMessage implements Serializable

Serialized Fields

role

content

Class com.aliyun.broadscope.bailian.sdk.models.CompletionsRequest extends Object implements Serializable

Serialized Fields

requestId

sessionId

appId

prompt

topP

stream

bizParams

hasThoughts

history

docReferenceType

parameters

docTagIds

docTagCodes

messages

Class com.aliyun.broadscope.bailian.sdk.models.CompletionsRequest.ChatQaPair extends Object implements Serializable

Serialized Fields

user

bot

Class com.aliyun.broadscope.bailian.sdk.models.CompletionsRequest.Parameter extends Object implements Serializable

Serialized Fields

topK

seed

useRawPrompt

temperature

maxTokens

stop

incrementalOutput

resultFormat

Class com.aliyun.broadscope.bailian.sdk.models.CompletionsResponse extends Object implements Serializable

Serialized Fields

success

code

message

requestId

data

Class com.aliyun.broadscope.bailian.sdk.models.CompletionsResponse.Data extends Object implements Serializable

Serialized Fields

responseId

sessionId

text

thoughts

docReferences

usage

choices

Class com.aliyun.broadscope.bailian.sdk.models.CompletionsResponse.DocReference extends Object implements Serializable

Serialized Fields

indexId

title

docId

docName

docUrl

text

bizId

Class com.aliyun.broadscope.bailian.sdk.models.CompletionsResponse.Thought extends Object implements Serializable

Serialized Fields

thought

actionType

response

actionName