You need to enable JavaScript to run this app.
向量数据库VikingDB

向量数据库VikingDB

请输入
  • 文档首页
    • 向量数据库VikingDBViking 知识库SDK参考Java SDK知识库（Collection）chat_completions
复制全文
我的收藏
知识库（Collection）
chat_completions
复制全文
我的收藏
chat_completions

本节将说明如何基于多轮历史对话，使用大语言模型进行回答生成

概述

chat_completions 用于向大模型发起一次对话请求，与新升级的search_knowledge 联通，可以完成标准的检索生成链路。

请求参数

参数

子参数

类型

是否必选

默认值

参数说明

model

--

String

是

Doubao-1-5-pro-32k

想要用于在线生成的大模型

  • 当指定为 doubao 系列模型时默认使用系统的公共推理接入点，适合调试场景，有 tpm 限流
  • 或指定为在方舟上创建的推理接入点 ID，适合生产场景，tpm 配置可在创建推理接入点时自行调整

公共推理接入点模型可选范围见对话模型和图像理解模型。
私有推理接入点 ID 形如：
ep-202406040****-*****
注意当使用私有接入点时，需要配合传入 API key 进行鉴权

注：默认值可能随版本更新而变化。为确保产品效果稳定，建议用户指定模型版本

modelVersion

--

String

否

--

对话模型和图像理解模型的可选范围见对话模型和图像理解模型。

thinking

--

Object

否

enabled

控制模型是否开启深度思考模式
取值范围：

  • enabled：开启思考模式，模型一定先思考后回答。
  • disabled：关闭思考模式，模型直接回答问题，不会进行思考。
  • auto：自动思考模式，模型根据问题自主判断是否需要思考，简单题目直接回答。

当前支持的模型详情见：thinking
示例：

extra_body={
         "thinking": {
             "type": "disabled",  # 不使用深度思考能力
             # "type": "enabled", # 使用深度思考能力
             # "type": "auto", # 模型自行判断是否使用深度思考能力
         }
     }

apiKey

--

String

否

--

接入点 API Key
当需要使用私有模型接入点时，需传入对应 API key 进行鉴权

messages

--

List

是

--

发出消息的对话参与者角色，可选值包括：

  • system：System Message 系统消息
  • user：User Message 用户消息
  • assistant：Assistant Message 对话助手消息

多轮文本问答： 串联脚本示例可参考知识库多轮检索问答样例

[
     {"role": "system", "content": "你是一位在线客服，你的首要任务是通过巧妙的话术回复用户的问题，你需要根据「参考资料」来回答接下来的「用户问题」，这些信息在 <context></context> XML tags 之内，你需要根据参考资料给出准确，简洁的回答。"},
     {"role": "user", "content": "推荐一个适合 3 岁小孩的玩具"},
     {"role": "assistant", "content": "您好！3 岁宝宝正处于身体、智力、情感多方面快速发展的阶段，您可以看看以下几款类型的玩具：乐高积木、拼图、消防局与消防直升机套装、医疗玩具套装、儿童滑板车"}
     {"role": "user", "content": "详细介绍下乐高积木有哪些合适的系列"},
 ]

多轮图文理解：串联脚本示例可参考知识库图文问答样例

[
     {
         "role": "system",
         "content": "你是一位在线客服，你的首要任务是通过巧妙的话术回复用户的问题，你需要根据「参考资料」来回答接下来的「用户问题」，这些信息在 <context></context> XML tags 之内，你需要根据参考资料给出准确，简洁的回答。参考资料中可能会包含图片信息，图片的引用说明在<img></img>XML tags 之内，参考资料内的图片顺序与用户上传的图片顺序一致。"
     },
     {
         "role": "user",
         "content": [
             {
                 "type": "text",
                 "text": "推荐一个适合 3岁小孩的玩具"
             },
             {
                 "type": "image_url",
                 "image_url": {
                     "url": "https://ark-project.tos-cn-beijing.volces.XXX.jpeg" #从知识库中召回的 top1 图片 url
                 }
             },
             {
                 "type": "image_url",
                 "image_url": {
                     "url": "https://ark-project.tos-cn-beijing.volcess.XXX.jpeg" #从知识库中召回的 top2 图片 url
                 }
             }
         ]
     }
 ]

stream

--

Boolean

否

false

响应内容是否流式返回

  • false：模型生成完所有内容后一次性返回结果
  • true：按 SSE 协议逐块返回模型生成内容，并以一条 data: [DONE] 消息结束

maxTokens

--

Integer

否

4096

模型可以生成的最大 token 数量

注意

  • 模型回复最大长度（单位 token），取值范围各个模型不同，详细见模型列表。
  • 输入 token 和输出 token 的总长度还受模型的上下文长度限制。

returnTokenUsage

--

Boolean

否

false

是否返回token用量统计

temperature

--

Double

否

0.1

采样温度
控制了生成文本时对每个候选词的概率分布进行平滑的程度。取值范围为 [0, 1]。当取值为 0 时模型仅考虑对数概率最大的一个 token。
较高的值（如 0.8）会使输出更加随机，而较低的值（如 0.2）会使输出更加集中确定。通常建议仅调整 temperature 或 top_p 其中之一，不建议两者都修改。

对话模型

模型名称

可选版本

Doubao-1-5-thinking-pro

250415

Deepseek-V3-128k

250324, 241226

Deepseek-R1-128k

250528, 250120

Doubao-1-5-pro-256k

250115

Doubao-1-5-pro-32k

250115（默认）, character-250715, character-250228

Doubao-1-5-lite-32k

250115

Doubao-pro-256k

241115, 240828

Doubao-pro-32k

241215, 240828, 240615, character-241215, character-240828, character-240528

Doubao-pro-128k

240628, 240515（即将下线）

Doubao-lite-32k

240828，240628, 240428（即将下线）, character-250228, character-241015

Doubao-lite-128k

240828, 240428

图像理解模型

模型名称

可选版本

Doubao-seed-1-8

251228

Doubao-seed-1-6-vision

240428, 240828

Doubao-seed-1-6-thinking

250715, 250615

Doubao-seed-1-6

251015, 250615

Doubao-seed-1-6-flash

250828, 250715, 250615

Doubao-1-5-thinking-pro

m-250428, m-250415

Doubao-1-5-vision-pro

250328

Doubao-1-5-vision-lite

250315

Doubao-1-5-vision-pro-32k

250115

Doubao-vision-pro-32k

241028

响应消息

字段

类型

参数说明

code

Integer

状态码

message

String

返回信息

requestId

String

标识每个请求的唯一标识符

data

ChatCompletionResult

ChatCompletionResult

ChatCompletionResult

字段

类型

参数说明

reasoningContent

String

推理模型生成的内容

generatedAnswer

String

模型生成的回答

usage

String

token 用量统计

prompt

String

prompt 内容

model

String

模型名称

finishReason

String

结束原因

totalTokens

Object

总 token 数量

状态码说明

状态码

http状态码

返回信息

状态码说明

0

200

success

成功

1000001

401

unauthorized

缺乏鉴权信息

1000002

403

no permission

权限不足

1000003

400

invalid request：%s

非法参数

请求示例

首次使用知识库 SDK ，可参考 使用说明
请配置鉴权参数（VOLC_AK/VOLC_SK 或 VIKING_API_KEY），并可选配置 VIKING_CHAT_API_KEY（用于大模型服务鉴权）。

package com.volcengine.vikingdb.runtime.knowledge.examples.chat_completion;

import com.fasterxml.jackson.databind.ObjectWriter;
import com.volcengine.vikingdb.runtime.core.ApiClient;
import com.volcengine.vikingdb.runtime.core.RequestAddition;
import com.volcengine.vikingdb.runtime.core.auth.Auth;
import com.volcengine.vikingdb.runtime.core.auth.AuthWithAkSk;
import com.volcengine.vikingdb.runtime.core.auth.AuthWithApiKey;
import com.volcengine.vikingdb.runtime.enums.Scheme;
import com.volcengine.vikingdb.runtime.knowledge.model.request.ChatCompletionRequest;
import com.volcengine.vikingdb.runtime.knowledge.model.request.ChatMessage;
import com.volcengine.vikingdb.runtime.knowledge.model.response.ChatCompletionResponse;
import com.volcengine.vikingdb.runtime.knowledge.service.KnowledgeService;

import java.util.Collections;

public class Main {
    private static final ObjectWriter PRETTY_JSON = ApiClient.objectMapper.writerWithDefaultPrettyPrinter();
    private static final Scheme SCHEME = Scheme.HTTPS;
    private static final String HOST = "api-knowledgebase.mlp.cn-beijing.volces.com";
    private static final String REGION = "cn-beijing";

    public static void main(String[] args) throws Exception {
        Auth auth = preferAuth();
        if (auth == null) {
            System.out.println("missing_auth: set VOLC_AK/VOLC_SK or VIKING_API_KEY");
            return;
        }
        KnowledgeService service = newKnowledgeService(auth);

        String apiKey = getEnv("VIKING_CHAT_API_KEY");
        if (apiKey.isEmpty()) {
            apiKey = null;
        }

        ChatCompletionRequest req = ChatCompletionRequest.builder()
                .model("Doubao-1-5-pro-32k")
                .messages(Collections.singletonList(ChatMessage.builder()
                        .role("user")
                        .content("Your Query")
                        .build()))
                .maxTokens(1024)
                .temperature(0.1)
                .returnTokenUsage(true)
                .apiKey(apiKey)
                .stream(false)
                .build();

        ChatCompletionResponse resp = service.chatCompletion(req, new RequestAddition());
        printJson("chat_completion", resp);
    }

    private static KnowledgeService newKnowledgeService(Auth auth) {
        return new KnowledgeService(SCHEME, HOST, REGION, auth);
    }

    private static Auth preferAuth() {
        String ak = getEnv("VOLC_AK");
        String sk = getEnv("VOLC_SK");
        if (!ak.isEmpty() && !sk.isEmpty()) {
            return new AuthWithAkSk(ak, sk);
        }
        String apiKey = getEnv("VIKING_API_KEY");
        if (!apiKey.isEmpty()) {
            return new AuthWithApiKey(apiKey);
        }
        return null;
    }

    private static String getEnv(String name) {
        String v = System.getenv(name);
        if (v == null) {
            return "";
        }
        v = v.trim();
        return v.isEmpty() ? "" : v;
    }

    private static void printJson(String name, Object obj) throws Exception {
        if (obj == null) {
            System.out.println(name + ": null");
            return;
        }
        System.out.println(name + ": " + PRETTY_JSON.writeValueAsString(obj));
    }
}

package com.volcengine.vikingdb.runtime.knowledge.examples.chat_completion_stream;

import com.fasterxml.jackson.databind.ObjectWriter;
import com.volcengine.vikingdb.runtime.core.ApiClient;
import com.volcengine.vikingdb.runtime.core.RequestAddition;
import com.volcengine.vikingdb.runtime.core.auth.Auth;
import com.volcengine.vikingdb.runtime.core.auth.AuthWithAkSk;
import com.volcengine.vikingdb.runtime.core.auth.AuthWithApiKey;
import com.volcengine.vikingdb.runtime.enums.Scheme;
import com.volcengine.vikingdb.runtime.knowledge.model.request.ChatCompletionRequest;
import com.volcengine.vikingdb.runtime.knowledge.model.request.ChatMessage;
import com.volcengine.vikingdb.runtime.knowledge.model.response.ChatCompletionResponse;
import com.volcengine.vikingdb.runtime.knowledge.model.response.ChatCompletionResult;
import com.volcengine.vikingdb.runtime.knowledge.service.KnowledgeService;
import com.volcengine.vikingdb.runtime.knowledge.service.KnowledgeStream;

import java.util.Collections;

public class Main {
    private static final ObjectWriter PRETTY_JSON = ApiClient.objectMapper.writerWithDefaultPrettyPrinter();
    private static final Scheme SCHEME = Scheme.HTTPS;
    private static final String HOST = "api-knowledgebase.mlp.cn-beijing.volces.com";
    private static final String REGION = "cn-beijing";

    public static void main(String[] args) throws Exception {
        Auth auth = preferAuth();
        if (auth == null) {
            System.out.println("missing_auth: set VOLC_AK/VOLC_SK or VIKING_API_KEY");
            return;
        }
        KnowledgeService service = newKnowledgeService(auth);

        String apiKey = getEnv("VIKING_CHAT_API_KEY");
        if (apiKey.isEmpty()) {
            apiKey = null;
        }

        ChatCompletionRequest req = ChatCompletionRequest.builder()
                .model("Doubao-1-5-pro-32k")
                .messages(Collections.singletonList(ChatMessage.builder()
                        .role("user")
                        .content("Your Query")
                        .build()))
                .maxTokens(1024)
                .temperature(0.1)
                .returnTokenUsage(true)
                .apiKey(apiKey)
                .stream(true)
                .build();

        try (KnowledgeStream<ChatCompletionResponse> stream = service.chatCompletionStream(req,
                new RequestAddition())) {
            System.out.println("chat_completion_stream:");
            for (ChatCompletionResponse item : stream) {
                ChatCompletionResult data = item != null ? item.getData() : null;
                if (data != null && data.getGeneratedAnswer() != null) {
                    System.out.print(data.getGeneratedAnswer());
                }
                if (data != null && data.getFinishReason() != null && !data.getFinishReason().trim().isEmpty()) {
                    break;
                }
            }
            System.out.print("\n");
        }
    }

    private static KnowledgeService newKnowledgeService(Auth auth) {
        return new KnowledgeService(SCHEME, HOST, REGION, auth);
    }

    private static Auth preferAuth() {
        String ak = getEnv("VOLC_AK");
        String sk = getEnv("VOLC_SK");
        if (!ak.isEmpty() && !sk.isEmpty()) {
            return new AuthWithAkSk(ak, sk);
        }
        String apiKey = getEnv("VIKING_API_KEY");
        if (!apiKey.isEmpty()) {
            return new AuthWithApiKey(apiKey);
        }
        return null;
    }

    private static String getEnv(String name) {
        String v = System.getenv(name);
        if (v == null) {
            return "";
        }
        v = v.trim();
        return v.isEmpty() ? "" : v;
    }

    private static void printJson(String name, Object obj) throws Exception {
        if (obj == null) {
            System.out.println(name + ": null");
            return;
        }
        System.out.println(name + ": " + PRETTY_JSON.writeValueAsString(obj));
    }
}
最近更新时间：2026.03.26 17:20:14
这个页面对您有帮助吗？
有用
有用
无用
无用