通义千问 API详情

通义千问模型API调用需"申请体验"并通过后才可使用，否则API调用将返回错误状态码。

Python 示例

# coding=utf-8
# For prerequisites running the following sample, visit https://help.aliyun.com/document_detail/611472.html

import dashscope
from dashscope import Generation
from http import HTTPStatus
import json

dashscope.api_key='your-dashscope-api-key'

response=Generation.call(
    model='qwen-v1',
    prompt='就当前的海洋污染的情况，写一份限塑的倡议书提纲，需要有理有据地号召大家克制地使用塑料制品'
    )

if response.status_code==HTTPStatus.OK:
    print(json.dumps(response.output, indent=4, ensure_ascii=False))
else:
    print('Code: %d, status: %s, message: %s' % (response.status_code, response.code, response.message))

Java 示例

import com.alibaba.dashscope.aigc.conversation.Conversation;
import com.alibaba.dashscope.aigc.conversation.ConversationResult;
import com.alibaba.dashscope.aigc.conversation.qwen.QWenConversationParam;

public class Main {

    public static void main(String[] args) {
        Conversation conversation = new Conversation();

        QWenConversationParam param =
                QWenConversationParam.builder()
                        .model(QWenConversationParam.QWEN_V1)
                        .prompt("就当前的海洋污染的情况，写一份限塑的倡议书提纲，需要有理有据地号召大家克制地使用塑料制品")
                        .apiKey("<your-dashscope-api-key>")
                        .build();
        // 如果正常返回即可以直接使用
        // 否则会抛出ApiException异常，检查e.getStatus()即可拿到错误信息
        ConversationResult result = conversation.call(param);
        System.out.println(result.getMessage().getPayload());
        System.exit(0);
    }
}

多轮会话

您也可以通过history参数传入对话历史，已达到与模型进行多轮交互的目的。

对话历史是以列表的形式，按时间正序组织的。列表中的一个元素为字典形式记录的人机交互的一轮对话记录，用户的输入用“user”表示，模型生成的输出用“bot”。

Python 示例

# coding=utf-8
# For prerequisites running the following sample, visit https://help.aliyun.com/document_detail/611472.html

import dashscope
from dashscope import Generation
from http import HTTPStatus
import json

dashscope.api_key='your-dashscope-api-key'

response=Generation.call(
    model='qwen-v1',
    prompt='能否缩短一些，只讲三点',
    history=[
        {
            "user": "就当前的海洋污染的情况，写一份限塑的倡议书提纲，需要有理有据地号召大家克制地使用塑料制品",
            "bot": "好的，以下是一份限塑的倡议书提纲，以理有据地号召大家克制地使用塑料制品：\n\n一、限塑背景\n塑料污染已成为全球环境问题之一，海洋污染更是其中严重的一环。塑料制品 的过量使用已经对海洋生态环境造成了严重破坏，对海洋生物的生存和繁殖造成了严重影响，威胁到了人类的生存环境和健康。因此，我们需要采取行动来限制塑料的使用，保护我们的海洋家园。\n\n二、塑料污染的危害\n1. 对海洋生态环境的破坏：塑料垃圾污染海洋，导致海洋生物生存环境恶化，尤其是对海鸟等候鸟的危害极大。\n2. 对海洋资源的影响：塑料垃圾会阻碍海洋生态系统中的光合作用和营养物质的循环，对海洋生物的生长和繁殖产生负面影响。\n3. 对人体健康的威胁：塑料垃圾会对人类的健康产生长期影响，例如通过食物链传递给人类。\n\n三、限塑的建议\n1. 减少使用塑料制品：除了餐具和厨具等必须使用塑料制品外，其他塑料制品的使用量应该尽量减少。\n2. 减少一次性塑料制品的使用：一次性塑料制品对环境造成的危害很大，应该尽量减少使 用。\n3. 购买可重复使用的商品：购买可重复使用的商品，例如纸袋和水瓶，以减少对塑料的需求。\n\n四、限塑的实践方式\n1. 节约使用塑料制品：可以选择自备餐具、带布袋子购物等方式减少塑料制品的使用。\n2. 推广环保理念：可以通过社交媒体和宣传资料等途径，宣传环保理念，鼓励更多人加入到限塑行动中来。\n\n五、总结\n限塑行动是我们保护海洋生态环境和生物多样性 的重要举措。让我们一起行动起来，从自己做起，克制地使用塑料制品，共同保护我们的地球家园。"
        }
     ]
  )

if response.status_code==HTTPStatus.OK:
    print(json.dumps(response.output, indent=4, ensure_ascii=False))
else:
    print('Code: %d, status: %s, message: %s' % (response.status_code, response.code, response.message))

Java 示例

import com.alibaba.dashscope.aigc.conversation.Conversation;
import com.alibaba.dashscope.aigc.conversation.ConversationResult;
import com.alibaba.dashscope.aigc.conversation.qwen.QWenConversationParam;

public class Main {

    public static void main(String[] args) {
        Conversation conversation = new Conversation();

        QWenConversationParam param =
                QWenConversationParam.builder()
                        .model(QWenConversationParam.QWEN_V1)
                        .prompt("就当前的海洋污染的情况，写一份限塑的倡议书提纲，需要有理有据地号召大家克制地使用塑料制品")
                        .apiKey("<your-dashscope-api-key>")
                        .build();

        ConversationResult result = conversation.call(param);
        System.out.println(result.getMessage().getPayload());
        param.setPrompt("能否缩短一些，只讲三点");
        // 使用同一个Conversation对象无需手动传递history
        // 也可以传递history参数，这样就不会使用内部记录的history
        result = conversation.call(param);
        System.out.println(result.getMessage().getPayload());
        System.exit(0);
    }
}

流式输出

Python 示例

# coding=utf-8
# For prerequisites running the following sample, visit https://help.aliyun.com/document_detail/611472.html

import dashscope
from dashscope import Generation
from http import HTTPStatus
import json

dashscope.api_key='your-dashscope-api-key'

responses=Generation.call(
    model='qwen-v1',
    prompt='就当前的海洋污染的情况，写一份限塑的倡议书提纲，需要有理有据地号召大家克制地使用塑料制品',
    stream=True)

for response in responses:
    if response.status_code==HTTPStatus.OK:
        print(json.dumps(response.output, indent=4, ensure_ascii=False))
    else:
        print('Code: %d, status: %s, message: %s' % (response.status_code, response.code, response.message))

Java 示例

import com.alibaba.dashscope.aigc.conversation.Conversation;
import com.alibaba.dashscope.aigc.conversation.ConversationResult;
import com.alibaba.dashscope.aigc.conversation.qwen.QWenConversationParam;
import com.alibaba.dashscope.common.Protocol;
import com.alibaba.dashscope.common.StreamingMode;
import com.alibaba.dashscope.utils.JsonUtils;
import io.reactivex.Flowable;

public class Main {

    public static void main(String[] args) {
        Conversation conversation = new Conversation(Protocol.WEBSOCKET.getValue());

        QWenConversationParam param =
                QWenConversationParam.builder()
                        .model(QWenConversationParam.QWEN_V1)
                        .prompt("就当前的海洋污染的情况，写一份限塑的倡议书提纲，需要有理有据地号召大家克制地使用塑料制品")
                        .mode(StreamingMode.OUT)
                        .apiKey("<your-dashscope-api-key>")
                        .build();

        Flowable<ConversationResult> flowable = conversation.streamCall(param);
        // 如果正常返回即可以直接使用
        // 否则blockingForEach会抛出ApiException异常，检查e.getStatus()即可拿到错误信息
        flowable.blockingForEach(msg -> System.out.println(JsonUtils.toJson(msg.getMessage().getPayload())));
        System.exit(0);
    }
}

{
    "status_code": 200,
    "request_id": "39a41abe-1bed-430a-b9b5-277130c7eb82",
    "code": "",
    "message": "",
    "output": {
        "text": "好的，以下是一份限塑的倡议书提纲：\n\nI. 引言\n\n- 阐明海洋污染的严重性，并介绍倡议书的目的和主要内容\n\nII. 海洋塑料污染的严重性\n\n- 详细描述海洋中塑料垃圾对海洋生态环境的危害，如何对海洋生态环境造成不可逆转的损害\n\n- 引用相关的研究和数据，让读者更加深入地了解海洋塑料污染的严重性\n\nIII. 推广限塑行动\n\n- 介绍限塑行动的必 要性和重要性，以及塑料制品的优点和缺点\n\n- 分析目前市场上可以使用的替代品，并向读者推荐可以减少使用塑料制品的替代品\n\n- 鼓励读者参与限塑行动，从小做起，做到减少塑料垃圾的贡献\n\nIV. 号召更多人加入限塑行动\n\n- 鼓励读者与身边的朋友和家人分享限塑行动的相关知识，让更多的人了解限塑行动的必要性\n\n- 号召更多企业加入限塑行动，为海洋环保做出贡献\n\n- 提供更多资源和渠道，让读者更加深入地了解限塑行动，并积极参与到这个行动中\n\nV. 结语\n\n- 总结限塑行动的必要性和重要性，并向读者表示感谢和祝福\n\n- 呼吁更多的人加入限塑 行动，为保护海洋环境做出自己的贡献\n\n希望这份限塑的倡议书提纲能够帮助您号召更多的人关注海洋环境保护，为建设美丽的海洋家园做出自己的贡献。",
    		"finish_reason": "stop"
    },
    "usage": {
        "input_tokens": 633,
        "output_tokens": 491
    }
}

• 返回参数说明

curl --location 'https://dashscope.aliyuncs.com/api/v1/services/aigc/text-generation/generation' \
--header 'Authorization: Bearer <your-dashscope-api-key>' \
--header 'Content-Type: application/json' \
--data '{
    "model": "qwen-v1",
    "input":{
        "prompt":"哪个公园距离我最近",
        "history":[
            {
                "user":"今天天气好吗？",
                "bot":"今天天气不错，要出去玩玩嘛？"
            },
            {
                "user":"那你有什么地方推荐？",
                "bot":"我建议你去公园，春天来了，花朵开了，很美丽。"
            }
        ]
    },
    "parameters": {
    }
}'

响应示例（SSE关闭）

{
    "output":{
        "text":"如果你在中国，我推荐你去北京的颐和园 ... ... 适合散步和欣赏景色。",
        "finish_reason":"stop"    
    },
    "usage":{
        "output_tokens":380,
        "input_tokens":633
    },
    "request_id":"d89c06fb-46a1-47b6-acb9-bfb17f814969"
}

请求示例（SSE开启）

以下示例展示通过CURL命令来调用通义千问模型的脚本（SSE 开启）。

说明 

需要使用您的API-KEY替换示例中的 your-dashscope-api-key ，代码才能正常运行。

curl --location 'https://dashscope.aliyuncs.com/api/v1/services/aigc/text-generation/generation' \
--header 'Authorization: Bearer <your-dashscope-api-key>' \
--header 'Content-Type: application/json' \
--header 'X-DashScope-SSE: enable' \
--data '{
    "model": "qwen-v1",
    "input":{
        "prompt":"哪个公园距离我最近",
        "history":[
            {
                "user":"今天天气好吗？",
                "bot":"今天天气不错，要出去玩玩嘛？"
            },
            {
                "user":"那你有什么地方推荐？",
                "bot":"我建议你去公园，春天来了，花朵开了，很美丽。"
            }
        ]
    },
    "parameters": {
    }
}'

响应示例（SSE开启）

id:1
event:result
data:{"output":{"finish_reason":"null","text":"最近"},"usage":{"output_tokens":3,"input_tokens":85},"request_id":"1117fb64-5dd9-9df0-a5ca-d7ee0e97032d"}

id:2
event:result
data:{"output":{"finish_reason":"null","text":"最近的公园是公园，它"},"usage":{"output_tokens":11,"input_tokens":85},"request_id":"1117fb64-5dd9-9df0-a5ca-d7ee0e97032d"}

... ... ... ...
... ... ... ...

id:8
event:result
data:{"output":{"finish_reason":"stop","text":"最近的公园是公园，它距离你的家大约1.5公里。你可以使用Google地图或者百度地图来查看具体的路线和距离。"},"usage":{"output_tokens":51,"input_tokens":85},"request_id":"1117fb64-5dd9-9df0-a5ca-d7ee0e97032d"}

异常响应示例

在访问请求出错的情况下，输出的结果中会通过 code 和 message 指明出错原因。

{
    "code":"InvalidApiKey",
    "message":"Invalid API-key provided.",
    "request_id":"fb53c4ec-1c12-4fc4-a580-cdb7c3261fc1"
}

状态码说明

DashScope灵积模型服务通用状态码请查阅：返回状态码说明