知识库对话体验 | 大装置帮助中心
跳到主要内容

知识库对话体验​

知识库对话体验（包含不同LLM模型的参数选择、不同 retrieval 方法的参数选择）

Request Body required
    action enum required

    对话的动作

    content string

    用户输入内容

    conversation_id string

    指定进行对话的对话ID

    conversation object

    对话详情

    conversation_id string

    对话ID

    channel_id string required

    大模型渠道资源ID

    display_name string required

    显示名称，第一次对话后自动更新

    create_time date-time

    创建时间

    update_time date-time

    更新时间

    model string required

    模型名称

    search_config object required

    知识搜索配置

    dataset_list object[] required

    要搜索的知识库列表

  • Array [
    • id string required

    知识库ID

    display_name string

    知识库显示名称

  • ]
    • top_k int32 required

    返回结果的Top K值

    confidence float required

    置信度

    weight float required

    权重：表示两种方法之间的比例，取值范围为0到1。值越大，越倾向于全文检索；值越小，越倾向于语义检索。

    open_window boolean

    是否在提示中包含检索段的前后片段？如果是，检索将更加全面，但会消耗更多token。

    prompt string

    知识库提示，改写用户问题，增加知识库检索到的知识信息

    model_config object

    模型配置信息

    frequency_penalty float

    重复惩罚系数：1表示不惩罚，值大于1鼓励生成非重复的tokens，值小于1则倾向生成重复的tokens。推荐范围为[1, 1.2]。

    max_tokens int32

    在聊天补全中生成的最大token数，默认值为1024。

    n int32

    为每条输入消息生成的聊天补全选择数量。注意，你将根据生成的所有token数计费。将n设为1以减少成本。

    temperature float

    使用的采样温度，范围在0到2之间。较高的值（如0.8）会使输出更加随机，而较低的值（如0.2）会使其更集中和确定。我们通常建议修改此值或top_p，但不要同时修改。

    top_p float

    采样温度的替代方案，称为核采样，模型只考虑top_p概率质量的tokens结果。0.1表示只考虑前10%概率质量的tokens。我们通常建议修改此值或temperature，但不要同时修改。

    sys_prompt string

    人设提示，大模型所需要扮演的人设信息

    conversation_question_prompt_enabled boolean

    是否提供用户可能想问的三个问题

    user string

    用户名

    chat_times int32

    聊天次数

    total_feedback_like int32

    点赞反馈的总数

    total_feedback_unlike int32

    差评反馈的总数

    is_stream boolean

    是否为流模式对话

Responses

OK

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[]

    用户下一个问题的提示

Loading...