API详情

模型概览

关于模型的限流条件，请参见限流。

SDK使用

您可以通过SDK实现单轮对话、多轮对话、流式输出等多种功能。

前提条件

• DashScope SDK提供了Python和Java两个版本，请确保您已安装最新版SDK：安装SDK。

• 已开通服务并获得API-KEY：获取API Key。

• 推荐您将API-KEY配置到环境变量中以降低API-KEY的泄露风险，详情请参见配置API Key到环境变量。您也可以在代码中配置API-KEY，但是泄露风险会提高。

单轮对话

您可以将通义法睿应用在法律咨询、文书生成、争议焦点识别等场景。您可以运行以下示例代码，体验通义法睿大模型的单轮对话能力。

from http import HTTPStatus
import dashscope


def call_with_messages():
    messages = [{'role': 'system',
                 'content': 'You are a helpful assistant.'},
                {'role': 'user', 'content': '我哥欠我10000块钱，给我生成起诉书。'}]
    response = dashscope.Generation.call(
        "farui-plus",
        messages=messages,
        result_format='message',  # set the result to be "message" format.
    )
    if response.status_code == HTTPStatus.OK:
        print(response)
    else:
        print('Request id: %s, Status code: %s, error code: %s, error message: %s' % (
            response.request_id, response.status_code,
            response.code, response.message
        ))


if __name__ == '__main__':
    call_with_messages()

import com.alibaba.dashscope.aigc.generation.Generation;
import com.alibaba.dashscope.aigc.generation.GenerationResult;
import com.alibaba.dashscope.aigc.generation.models.QwenParam;
import com.alibaba.dashscope.common.Message;
import com.alibaba.dashscope.common.MessageManager;
import com.alibaba.dashscope.common.Role;
import com.alibaba.dashscope.exception.ApiException;
import com.alibaba.dashscope.exception.InputRequiredException;
import com.alibaba.dashscope.exception.NoApiKeyException;


public class Example {
    public static void callWithMessage()
            throws NoApiKeyException, ApiException, InputRequiredException {
        Generation gen = new Generation();
        MessageManager msgManager = new MessageManager(10);
        Message systemMsg =
                Message.builder().role(
                        Role.SYSTEM.getValue())
                        .content("You are a helpful assistant.")
                        .build();
        Message userMsg = Message.builder().role(
                        Role.USER.getValue())
                        .content("我哥欠我10000块钱，给我生成起诉书。")
                        .build();
        msgManager.add(systemMsg);
        msgManager.add(userMsg);
        QwenParam param =
                QwenParam.builder().model("farui-plus").messages(msgManager.get())
                        .resultFormat(QwenParam.ResultFormat.MESSAGE)
                        .apiKey("xxx")
                        .build();
        GenerationResult result = gen.call(param);
        System.out.println(result);
    }


    public static void main(String[] args){
        try {
            callWithMessage();
        } catch (ApiException | NoApiKeyException | InputRequiredException e) {
            System.out.println(e.getMessage());
        }
        System.exit(0);
    }
}

运行结果的示例如下所示：

{
    "status_code": 200,
    "request_id": "32880e8b-dc0f-95e4-b88f-2ca0c41e8c7b",
    "code": "",
    "message": "",
    "output": {
        "text": null,
        "finish_reason": null,
        "choices": [
            {
                "finish_reason": "stop",
                "message": {
                    "role": "assistant",
                    "content": "【民事起诉状】\n\n原告：XXX，男/女，XXXX年XX月XX日出生，XXX族，住所地：XXX市XXX区XXX路XXX号，联系方式：XXX。\n委托诉讼代理人：XXX，（律所名称）。\n\n被告： XXX，男/女，XXXX年XX月XX日出生，XXX族，住所地：XXX市XXX区XXX路XXX号，联系方式：XXX。\n\n诉讼请求：\n一、判令被告归还原告借款10000元及利息；\n二、由被告承担本案全部诉讼费用。\n\n事实与理由：\n原告与被告是兄弟关系，被告于XXXX年XX月XX日向原告借款10000元，原告以现金形式交付给被告。被告承诺于XXXX年XX月XX日归还，但到期后并未归还。原告多次催要，被告以各种理由推脱，至今未归还借款。\n\n证据清单：\n1. 借条1份；\n2. 催要记录。\n\n此致\n\nXXX人民法院\n\n起诉人：（原告签名）\n\nXXXX年XX月XX日\n\n附：1.本诉状副本XXX份。\n  2.证据目录。"
                }
            }
        ]
    },
    "usage": {
        "input_tokens": 22,
        "output_tokens": 274,
        "total_tokens": 269
    }
}

多轮对话

您可以运行以下示例代码，体验通义法睿大模型的多轮对话能力。

from dashscope import Generation

messages = [{'role': 'system',
                'content': 'You are a helpful assistant.'},
            {'role': 'user', 'content': '我哥欠我10000块钱，给我生成起诉书。'}]
response = Generation.call(model="farui-plus",
                            messages=messages,
                            result_format='message')
print(response)
# 将assistant的回复添加到messages列表中
messages.append({'role': response.output.choices[0]['message']['role'],
                    'content': response.output.choices[0]['message']['content']})
# 将新一轮的user问题添加到messages列表中
messages.append({'role': 'user', 'content': '如果借款利率是4%，再重新生成一份起诉书'})
# 进行第二轮模型的响应
response = Generation.call(model="farui-plus",
                            messages=messages,
                            result_format='message')
print(response)

import java.util.ArrayList;
import java.util.List;
import com.alibaba.dashscope.aigc.generation.Generation;
import com.alibaba.dashscope.aigc.generation.GenerationParam;
import com.alibaba.dashscope.aigc.generation.GenerationResult;
import com.alibaba.dashscope.common.Message;
import com.alibaba.dashscope.common.Role;
import com.alibaba.dashscope.exception.ApiException;
import com.alibaba.dashscope.exception.InputRequiredException;
import com.alibaba.dashscope.exception.NoApiKeyException;
import com.alibaba.dashscope.utils.JsonUtils;

public class Main {
    public static GenerationParam createGenerationParam(List<Message> messages) {
        return GenerationParam.builder()
                .model("farui-plus")
                .messages(messages)
                .resultFormat(GenerationParam.ResultFormat.MESSAGE)
                .build();
    }
    public static GenerationResult callGenerationWithMessages(GenerationParam param) throws ApiException, NoApiKeyException, InputRequiredException {
        Generation gen = new Generation();
        return gen.call(param);
    }
    public static void main(String[] args) {
        try {
            List<Message> messages = new ArrayList<>();
            messages.add(createMessage(Role.SYSTEM, "You are a helpful assistant."));
            messages.add(createMessage(Role.USER, "我哥欠我10000块钱，给我生成起诉书。"));

            GenerationParam param = createGenerationParam(messages);
            GenerationResult result = callGenerationWithMessages(param);
            printResultAsJson(result);
            // 添加assistant返回的消息到列表
            messages.add(result.getOutput().getChoices().get(0).getMessage());
            // 添加新的用户消息
            messages.add(createMessage(Role.USER, "如果借款利率是4%，再重新生成一份起诉书"));
            result = callGenerationWithMessages(param);
            printResultAsJson(result);
        } catch (ApiException | NoApiKeyException | InputRequiredException e) {
            e.printStackTrace();
        }
        System.exit(0);
    }

    private static Message createMessage(Role role, String content) {
        return Message.builder().role(role.getValue()).content(content).build();
    }

    private static void printResultAsJson(GenerationResult result) {
        System.out.println(JsonUtils.toJson(result));
    }
}

运行结果的示例如下所示：

{
    "status_code": 200,
    "request_id": "0851caa1-232c-9b97-853f-be7810ecd36c",
    "code": "",
    "message": "",
    "output": {
        "text": null,
        "finish_reason": null,
        "choices": [
            {
                "finish_reason": "stop",
                "message": {
                    "role": "assistant",
                    "content": "【民事起诉状】\n\n原告：XXX，男/女，XXXX年XX月XX日出生，XXX族，住所地：XXX市XXX区XXX路XXX号，联系方式：XXX。\n委托诉讼代理人：XXX，（律所名称）。\n\n被告： XXX，男/女，XXXX年XX月XX日出生，XXX族，住所地：XXX市XXX区XXX路XXX号，联系方式：XXX。\n\n诉讼请求：\n一、要求被告归还原告借款10000元；\n二、由被告承担本案全部诉讼费用。\n\n事实与理由：\n原告与被告系兄弟关系。2019年9月10日，被告因急需用钱向原告借款10000元，并出具借条一份，约定借款期限为一个月。然而，借款期限届满后，被告并未按约定归还借款，原告多次催讨均无果。\n\n证据清单：\n1. 借条1份；\n2. 转账记录1份。\n\n此致\n\nXXX人民法院\n\n起诉人：（原告签名）\n\nXXXX年XX月XX日\n\n附：1.本诉状副本XXX份。\n  2.证据目录。\n\n请注意，这只是一个模板，具体情况可能需要根据实际情况进行调整。在实际操作中，建议您咨询专业律师或者法律工作者，以确保起诉书的准确性和合法性。"
                }
            }
        ]
    },
    "usage": {
        "input_tokens": 56,
        "output_tokens": 284,
        "total_tokens": 340
    }
}
{
    "status_code": 200,
    "request_id": "0d922f48-c975-965a-aab5-a3ec19191038",
    "code": "",
    "message": "",
    "output": {
        "text": null,
        "finish_reason": null,
        "choices": [
            {
                "finish_reason": "stop",
                "message": {
                    "role": "assistant",
                    "content": "【民事起诉状】\n\n原告：XXX，男/女，XXXX年XX月XX日出生，XXX族，住所地：XXX市XXX区XXX路XXX号，联系方式：XXX。\n委托诉讼代理人：XXX，（律所名称）。\n\n被告： XXX，男/女，XXXX年XX月XX日出生，XXX族，住所地：XXX市XXX区XXX路XXX号，联系方式：XXX。\n\n诉讼请求：\n一、要求被告归还原告借款本金10000元；\n二、要求被告支付原告借款利息，以10000元为基数，按照年利率4%计算，从2019年9月10日起至实际清偿之日止；\n三、由被告承担本案全部诉讼费用。\n\n事实与理由：\n原告与被告系兄弟关系。2019年9月10日，被告因急需用钱向原告借款10000元，并出具借条一份，约定借款期限为一个月，借款利率为年利率4%。然而，借款期限届满后，被告并未按约定归还借款，原告多次催讨均无果。\n\n证据清单：\n1. 借条1份；\n2. 转账记录1份。\n\n此致\n\nXXX人民法院\n\n起诉人：（原告签名）\n\nXXXX年XX月XX日\n\n附：1.本诉状副本XXX份。\n  2.证据目录。\n\n请注意，这只是一个模板，具体情况可能需要根据实际情况进行调整。在实际操作中，建议您咨询专业律师或者法律工作者，以确保起诉书的准确性和合法性。"
                }
            }
        ]
    },
    "usage": {
        "input_tokens": 22,
        "output_tokens": 338,
        "total_tokens": 690
    }
}

流式输出

大模型并不是一次性生成最终结果，而是逐步地生成中间结果，最终结果由中间结果拼接而成。非流式输出方式等待模型生成结束后再将生成的中间结果拼接后返回，而流式输出可以实时地将中间结果返回，您可以在模型进行输出的同时进行阅读，减少等待模型回复的时间。使用流式输出需要您进行一些配置，DashScope Python SDK中需要设置stream为True，DashScope Java SDK中需要使用streamCall接口调用。

import os
import dashscope

messages = [
    {'role':'system','content':'you are a helpful assistant'},
    {'role': 'user','content': '你是谁？'}
    ]
responses = dashscope.Generation.call(
    # 若没有配置环境变量，请用百炼API Key将下行替换为：api_key="sk-xxx",
    api_key=os.getenv('DASHSCOPE_API_KEY'),
    model="farui-plus",
    messages=messages,
    result_format='message',
    stream=True,
    incremental_output=True
    )
for response in responses:
    print(response)

import java.util.Arrays;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import com.alibaba.dashscope.aigc.generation.Generation;
import com.alibaba.dashscope.aigc.generation.GenerationParam;
import com.alibaba.dashscope.aigc.generation.GenerationResult;
import com.alibaba.dashscope.common.Message;
import com.alibaba.dashscope.common.Role;
import com.alibaba.dashscope.exception.ApiException;
import com.alibaba.dashscope.exception.InputRequiredException;
import com.alibaba.dashscope.exception.NoApiKeyException;
import com.alibaba.dashscope.utils.JsonUtils;
import io.reactivex.Flowable;
import java.lang.System;

public class Main {
    private static final Logger logger = LoggerFactory.getLogger(Main.class);
    private static void handleGenerationResult(GenerationResult message) {
        System.out.println(JsonUtils.toJson(message));
    }
    public static void streamCallWithMessage(Generation gen, Message userMsg)
            throws NoApiKeyException, ApiException, InputRequiredException {
        GenerationParam param = buildGenerationParam(userMsg);
        Flowable<GenerationResult> result = gen.streamCall(param);
        result.blockingForEach(message -> handleGenerationResult(message));
    }
    private static GenerationParam buildGenerationParam(Message userMsg) {
        return GenerationParam.builder()
                // 若没有配置环境变量，请用百炼API Key将下行替换为：.apiKey("sk-xxx")
                .apiKey(System.getenv("DASHSCOPE_API_KEY"))
                .model("farui-plus")
                .messages(Arrays.asList(userMsg))
                .resultFormat(GenerationParam.ResultFormat.MESSAGE)
                .incrementalOutput(true)
                .build();
    }
    public static void main(String[] args) {
        try {
            Generation gen = new Generation();
            Message userMsg = Message.builder().role(Role.USER.getValue()).content("你是谁？").build();
            streamCallWithMessage(gen, userMsg);
        } catch (ApiException | NoApiKeyException | InputRequiredException  e) {
            logger.error("An exception occurred: {}", e.getMessage());
        }
        System.exit(0);
    }
}

流式输出示例如下所示：

{"status_code": 200, "request_id": "f741ea2e-e997-9d33-ae8d-da3c56b26a4e", "code": "", "message": "", "output": {"text": null, "finish_reason": null, "choices": [{"finish_reason": "null", "message": {"role": "assistant", "content": "我是"}}]}, "usage": {"input_tokens": 21, "output_tokens": 1, "total_tokens": 22}}
{"status_code": 200, "request_id": "f741ea2e-e997-9d33-ae8d-da3c56b26a4e", "code": "", "message": "", "output": {"text": null, "finish_reason": null, "choices": [{"finish_reason": "null", "message": {"role": "assistant", "content": "通"}}]}, "usage": {"input_tokens": 21, "output_tokens": 2, "total_tokens": 23}}
{"status_code": 200, "request_id": "f741ea2e-e997-9d33-ae8d-da3c56b26a4e", "code": "", "message": "", "output": {"text": null, "finish_reason": null, "choices": [{"finish_reason": "null", "message": {"role": "assistant", "content": "义"}}]}, "usage": {"input_tokens": 21, "output_tokens": 3, "total_tokens": 24}}
{"status_code": 200, "request_id": "f741ea2e-e997-9d33-ae8d-da3c56b26a4e", "code": "", "message": "", "output": {"text": null, "finish_reason": null, "choices": [{"finish_reason": "null", "message": {"role": "assistant", "content": "法"}}]}, "usage": {"input_tokens": 21, "output_tokens": 4, "total_tokens": 25}}
{"status_code": 200, "request_id": "f741ea2e-e997-9d33-ae8d-da3c56b26a4e", "code": "", "message": "", "output": {"text": null, "finish_reason": null, "choices": [{"finish_reason": "null", "message": {"role": "assistant", "content": "睿，一个由"}}]}, "usage": {"input_tokens": 21, "output_tokens": 8, "total_tokens": 29}}
{"status_code": 200, "request_id": "f741ea2e-e997-9d33-ae8d-da3c56b26a4e", "code": "", "message": "", "output": {"text": null, "finish_reason": null, "choices": [{"finish_reason": "null", "message": {"role": "assistant", "content": "阿里巴巴通义实验室"}}]}, "usage": {"input_tokens": 21, "output_tokens": 12, "total_tokens": 33}}
{"status_code": 200, "request_id": "f741ea2e-e997-9d33-ae8d-da3c56b26a4e", "code": "", "message": "", "output": {"text": null, "finish_reason": null, "choices": [{"finish_reason": "null", "message": {"role": "assistant", "content": "开发的虚拟助手"}}]}, "usage": {"input_tokens": 21, "output_tokens": 16, "total_tokens": 37}}
{"status_code": 200, "request_id": "f741ea2e-e997-9d33-ae8d-da3c56b26a4e", "code": "", "message": "", "output": {"text": null, "finish_reason": null, "choices": [{"finish_reason": "null", "message": {"role": "assistant", "content": "，旨在提供友好"}}]}, "usage": {"input_tokens": 21, "output_tokens": 20, "total_tokens": 41}}
{"status_code": 200, "request_id": "f741ea2e-e997-9d33-ae8d-da3c56b26a4e", "code": "", "message": "", "output": {"text": null, "finish_reason": null, "choices": [{"finish_reason": "null", "message": {"role": "assistant", "content": "、有帮助的服务"}}]}, "usage": {"input_tokens": 21, "output_tokens": 24, "total_tokens": 45}}
{"status_code": 200, "request_id": "f741ea2e-e997-9d33-ae8d-da3c56b26a4e", "code": "", "message": "", "output": {"text": null, "finish_reason": null, "choices": [{"finish_reason": "null", "message": {"role": "assistant", "content": "。我可以帮助解答"}}]}, "usage": {"input_tokens": 21, "output_tokens": 28, "total_tokens": 49}}
{"status_code": 200, "request_id": "f741ea2e-e997-9d33-ae8d-da3c56b26a4e", "code": "", "message": "", "output": {"text": null, "finish_reason": null, "choices": [{"finish_reason": "null", "message": {"role": "assistant", "content": "法律问题、提供"}}]}, "usage": {"input_tokens": 21, "output_tokens": 32, "total_tokens": 53}}
{"status_code": 200, "request_id": "f741ea2e-e997-9d33-ae8d-da3c56b26a4e", "code": "", "message": "", "output": {"text": null, "finish_reason": null, "choices": [{"finish_reason": "null", "message": {"role": "assistant", "content": "信息查询、进行"}}]}, "usage": {"input_tokens": 21, "output_tokens": 36, "total_tokens": 57}}
{"status_code": 200, "request_id": "f741ea2e-e997-9d33-ae8d-da3c56b26a4e", "code": "", "message": "", "output": {"text": null, "finish_reason": null, "choices": [{"finish_reason": "null", "message": {"role": "assistant", "content": "简单的逻辑推理等"}}]}, "usage": {"input_tokens": 21, "output_tokens": 40, "total_tokens": 61}}
{"status_code": 200, "request_id": "f741ea2e-e997-9d33-ae8d-da3c56b26a4e", "code": "", "message": "", "output": {"text": null, "finish_reason": null, "choices": [{"finish_reason": "null", "message": {"role": "assistant", "content": "。如果你有任何问题"}}]}, "usage": {"input_tokens": 21, "output_tokens": 44, "total_tokens": 65}}
{"status_code": 200, "request_id": "f741ea2e-e997-9d33-ae8d-da3c56b26a4e", "code": "", "message": "", "output": {"text": null, "finish_reason": null, "choices": [{"finish_reason": "null", "message": {"role": "assistant", "content": "，欢迎随时提问"}}]}, "usage": {"input_tokens": 21, "output_tokens": 48, "total_tokens": 69}}
{"status_code": 200, "request_id": "f741ea2e-e997-9d33-ae8d-da3c56b26a4e", "code": "", "message": "", "output": {"text": null, "finish_reason": null, "choices": [{"finish_reason": "null", "message": {"role": "assistant", "content": "。请注意，我的"}}]}, "usage": {"input_tokens": 21, "output_tokens": 52, "total_tokens": 73}}
{"status_code": 200, "request_id": "f741ea2e-e997-9d33-ae8d-da3c56b26a4e", "code": "", "message": "", "output": {"text": null, "finish_reason": null, "choices": [{"finish_reason": "null", "message": {"role": "assistant", "content": "回答不能代替专业"}}]}, "usage": {"input_tokens": 21, "output_tokens": 56, "total_tokens": 77}}
{"status_code": 200, "request_id": "f741ea2e-e997-9d33-ae8d-da3c56b26a4e", "code": "", "message": "", "output": {"text": null, "finish_reason": null, "choices": [{"finish_reason": "null", "message": {"role": "assistant", "content": "法律意见。"}}]}, "usage": {"input_tokens": 21, "output_tokens": 59, "total_tokens": 80}}
{"status_code": 200, "request_id": "f741ea2e-e997-9d33-ae8d-da3c56b26a4e", "code": "", "message": "", "output": {"text": null, "finish_reason": null, "choices": [{"finish_reason": "stop", "message": {"role": "assistant", "content": ""}}]}, "usage": {"input_tokens": 21, "output_tokens": 59, "total_tokens": 80}}

输入参数配置

返回结果

当您将result_format设置为message时的结果示例：

{
    "status_code": 200,
    "request_id": "0bcab0eb-ee6b-983d-9479-9814cff59096",
    "code": "",
    "message": "",
    "output": {
        "text": null,
        "finish_reason": null,
        "choices": [
            {
                "finish_reason": "stop",
                "message": {
                    "role": "assistant",
                    "content": "【民事起诉状】\n\n原告：XXX，男/女，XXXX年XX月XX日出生，XXX族，住所地：XXX市XXX区XXX路XXX号，联系方式：XXX。\n委托诉讼代理人：XXX，（律所名称）。\n\n被告： XXX，男/女，XXXX年XX月XX日出生，XXX族，住所地：XXX市XXX区XXX路XXX号，联系方式：XXX。\n\n诉讼请求：\n一、要求被告归还原告借款10000元；\n二、由被告承担本案全部诉讼费用。\n\n事实与理由：\n原告与被告系兄弟关系。2019年9月10日，被告因急需用钱向原告借款10000元，并出具借条一份，约定借款期限为一个月。然而，借款期限届满后，被告并未按约定归还借款，原告多次催讨均无果。\n\n证据清单：\n1. 借条1份；\n2. 转账记录1份。\n\n此致\n\nXXX人民法院\n\n起诉人：（原告签名）\n\nXXXX年XX月XX日\n\n附：1.本诉状副本XXX份。\n  2.证据目录。\n\n请注意，这只是一个模板，具体情况可能需要根据实际情况进行调整。在实际操作中，建议您咨询专业律师或者法律工作者，以确保起诉书的准确性和合法性。"
                }
            }
        ]
    },
    "usage": {
        "input_tokens": 56,
        "output_tokens": 284,
        "total_tokens": 340
    }
}

HTTP调用接口

功能描述

通义法睿大模型同时支持HTTP调用来完成客户的响应，目前提供普通HTTP和HTTP SSE两种协议，您可根据自己的需求自行选择。

前提条件

已开通服务并获得API-KEY：获取API Key。

提交接口调用

POST https://dashscope.aliyuncs.com/api/v1/services/aigc/text-generation/generation

入参描述

出参描述

请求示例（SSE 关闭）

以下示例展示通过CURL命令来调用通义法睿大模型的脚本（SSE 关闭）。

curl -X POST https://dashscope.aliyuncs.com/api/v1/services/aigc/text-generation/generation \
-H "Authorization: Bearer $DASHSCOPE_API_KEY" \
-H 'Content-Type: application/json' \
--data '{
    "model": "farui-plus",
    "input": {
        "messages": [
            {
                "role": "system",
                "content": "You are a helpful assistant."
            },
            {
                "role": "user",
                "content": "我哥欠我10000块钱，给我生成起诉书。"
            }
        ]
    },
    "parameters": {
        "result_format": "message"
    }
}'