应用发布后的会话接口

发布后的会话接口是直接服务用户的核心部分

application/json

Request Body required

action enum required

聊天的操作类型。

content string required

用户输入的内容。

conversation_id string

聊天的对话ID。

release_key string required

发布应用的密钥。

Responses

• 200
• default

---

OK

application/json

Schema

Example (from schema)

---

Schema

conversation_id string

对话ID

seq int32

对话中的序列号

message string

非流式请求生成的响应内容

delta string

流式请求生成的响应内容

finish_reason enum

停止生成的原因

knowledge_base_results object[]
知识检索的中间结果
Array [
page_content string
页面内容
document object
知识详细信息。
document_id string
知识ID
display_name string
知识名称
type enum
知识类型
document_size int64
知识大小
token_count int64
令牌计数
segment_count int64
段落计数
dataset_id string
知识库ID
dataset_display string
知识库名称
p_id string
父知识ID
data_source_type enum
数据源类型
creator string
知识创建者
create_time date-time
创建时间。
update_time date-time
更新时间
segments object[]
段落详细信息列表
Array [
segment_id string
段ID
dataset_id string
知识库ID
document_id string
知识ID
content string
段内容
token_count int32
令牌数量
number int32
段编号
metadata object
元数据
key_words string[]
关键词
image_name_value string
图片名称
image_size int32
图片大小
table_name_value string
表格名称
table_rows int32
表格行数
table_columns string[]
表格列
score float
分数
words int32
单词数量
segment_type enum
段落类型
table_content string
表格内容
image_key string
图片键值
image_uri string
图片URI
display_type enum
显示类型
image_keys string
图片键值列表
display_content string
展示内容
]
uri string
文档在OSS中的预签名URI
confidence float
结果置信度
token_count int64
内容的token数量
segment_number int32
段落数量
words int32
段落的字数
type enum
段落类型
display_type enum
显示类型
table_content string
表格内容
image_uri string
图片URI
image_key string
图片键
image_keys string[]
图片键集合
display_content string
显示内容
]
history_id string

聊天历史ID

prompt_questions string[]

用户下一个问题的提示

{
  "conversation_id": "string",
  "seq": 0,
  "message": "string",
  "delta": "string",
  "finish_reason": 0,
  "knowledge_base_results": [
    {
      "page_content": "string",
      "document": {
        "document_id": "string",
        "display_name": "string",
        "type": 0,
        "document_size": 0,
        "token_count": 0,
        "segment_count": 0,
        "dataset_id": "string",
        "dataset_display": "string",
        "p_id": "string",
        "data_source_type": 0,
        "creator": "string",
        "create_time": "2024-11-04T06:28:49.416Z",
        "update_time": "2024-11-04T06:28:49.416Z",
        "segments": [
          {
            "segment_id": "string",
            "dataset_id": "string",
            "document_id": "string",
            "content": "string",
            "token_count": 0,
            "number": 0,
            "metadata": {
              "key_words": [
                "string"
              ],
              "image_name_value": "string",
              "image_size": 0,
              "table_name_value": "string",
              "table_rows": 0,
              "table_columns": [
                "string"
              ],
              "score": 0
            },
            "words": 0,
            "segment_type": 0,
            "table_content": "string",
            "image_key": "string",
            "image_uri": "string",
            "display_type": 0,
            "image_keys": "string",
            "display_content": "string"
          }
        ],
        "uri": "string"
      },
      "confidence": 0,
      "token_count": 0,
      "segment_number": 0,
      "words": 0,
      "type": 0,
      "display_type": 0,
      "table_content": "string",
      "image_uri": "string",
      "image_key": "string",
      "image_keys": [
        "string"
      ],
      "display_content": "string"
    }
  ],
  "history_id": "string",
  "prompt_questions": [
    "string"
  ]
}

Default error response

application/json

Schema

Example (from schema)

---

Schema

code int32

The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].

message string

A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.

details object[]
A list of messages that carry the error details. There is a common set of message types for APIs to use.
Array [
@type string
The type of the serialized message.
]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

Loading...