API详情

Ziya-LLaMA

说明

支持的领域 / 任务:aigc

Ziya-LLaMA通用大模型是由IDEA研究院出品的大规模语言模型,它在DashScope上的模型名称为"ziya-llama-13b-v1"。Ziya-LLaMA大模型V1是基于LLaMa的130亿参数的大规模预训练模型,具备翻译,编程,文本分类,信息抽取,摘要,文案生成,常识问答和数学计算等能力。目前Ziya-LLaMA通用大模型已完成大规模预训练、多任务有监督微调和人类反馈学习三阶段的训练过程。

当前在DashScope部署服务时使用的ModelScope社区模型id:Fengshenbang/Ziya-LLaMA-13B-v1,模型版本:v1.0.3。

更多信息可以参考ModelScope上姜子牙模型的开源repo

Ziya-LLaMA以用户文本形式输入的指令(prompt)作为输入,返回模型生成的回复作为输出。在这一过程中,文本将被转换为语言模型可以处理的token序列。Token是模型用来表示自然语言文本的基本单位,可以直观的理解为“字”或“词”。对于中文文本来说,1个token通常对应一个汉字;对于英文文本来说,1个token通常对应3至4个字母或1个单词。例如,中文文本“你好。”会被转换成序列['你', '好', '。'],而英文文本"Nice to meet you."则会被转换成['Nice', ' to', ' meet', ' you', '.']。

由于模型调用的计算量与token序列长度相关,输入或输出token数量越多,模型的计算时间越长,我们将根据模型输入和输出的token数量计费。可以从API返回结果的 usage 字段中了解到您每次调用时使用的token数量。

模型概览

模型名

模型简介

ziya-llama-13b-v1

姜子牙通用大模型V1是大规模预训练语言模型,支持中文英文等不同语言输入。

SDK使用

前提条件

文本生成

以下示例展示了调用Ziya-LLaMA模型对一个用户指令进行响应的代码。

说明

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

设置API KEY

export DASHSCOPE_API_KEY=YOUR_DASHSCOPE_API_KEY

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

response=Generation.call(
    model='ziya-llama-13b-v1',
    prompt='<human>:帮我写一份去西安的旅游计划\n<bot>:'
  )

if response.status_code==HTTPStatus.OK:
    print(json.dumps(response, indent=4, ensure_ascii=False))
else:
    print('Code: %d, status: %s, message: %s' % (response.status_code, response.code, response.message))
// Copyright (c) Alibaba, Inc. and its affiliates.

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.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 void usage()
      throws NoApiKeyException, ApiException, InputRequiredException {
    Generation gen = new Generation();
    GenerationParam param = GenerationParam
    .builder()
    .model("ziya-llama-13b-v1")
    .prompt("<human>:帮我写一份去西安的旅游计划\n<bot>:")
    .build();
    GenerationResult result = gen.call(param);
    System.out.println(JsonUtils.toJson(result));
  }

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

参数配置

参数

类型

默认值

说明

model

string

-

指定用于对话的Ziya-LLaMA模型名,目前仅支持 ziya-llama-13b-v1

prompt

string

-

用户当前输入的期望模型执行指令。

返回结果

  • 返回结果示例

{
    "status_code": 200,
    "request_id": "249e9a26-44fd-9e70-ae58-ad9cff921051",
    "code": "",
    "message": "",
    "output": {
        "text": "<s><human> :帮我写一份去西安的旅游计划\n<bot> : 好的,以下是一份去西安的旅游计划:\n第一天:抵达西安,入住酒店后前往市中心参观大雁塔、华清池等著名景点。晚上可以品尝当地美食,如肉夹馍、羊肉泡馍等。\n第二天:上午前往秦始皇陵,参观秦俑一号坑等景点。下午前往兵马俑博物馆,观赏精美的陶俑。晚上可以前往回民街品尝小吃。\n第三天:上午前往华清池公园,欣赏池塘景色。下午前往西安城墙,徒步登上城墙,欣赏城市全景。晚上可以前往大雁塔广场,观赏烟火表演。\n第四天:上午前往大唐芙蓉园,参观唐代建筑群。下午前往陕西历史博物馆,了解陕西历史文化。晚上可以前往酒吧一条街,感受西安夜生活。\n第五天:上午前往骊山风景区,徒步登山,欣赏山水景色。下午可以前往临潼葡萄园,品尝当地葡萄。晚上返回西安,结束旅程。\n以上是一份简单的西安旅游计划,希望对您有所帮助。如果您需要更详细的旅游计划,请随时联系我。</s>"
    },
    "usage": {
        "input_tokens": 0,
        "output_tokens": 0
    }
}
  • 返回参数说明

返回参数

类型

说明

status_code

int

200(HTTPStatus.OK)表示请求成功,否则表示请求失败,可以通过code获取错误码,通过message字段获取错误详细信息。

request_Id

string

系统生成的标志本次调用的id。

code

string

表示请求失败,表示错误码,成功忽略。

message

string

失败,表示失败详细信息,成功忽略。

output

dict

调用结果信息,包含输出text。

text

string

模型生成回复。

usage

dict

计量信息,表示本次请求计量数据,当前模型无计量信息,此处为默认值。

input_tokens

int

用户输入文本转换成Token后的长度。

output_tokens

int

模型生成回复转换为Token后的长度。

HTTP调用接口

功能描述

Ziya-LLaMA模型同时支持 HTTP 调用来完成客户的响应。

前提条件

提交接口调用

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

入参描述

传参方式

字段

类型

必选

描述

示例值

Header

Content-Type

String

请求类型:application/json

application/json

Authorization

String

API-Key,例如:Bearer d1**2a

Bearer d1**2a

Body

model

String

指明需要调用的模型,固定取值ziya-llama-13b-v1

ziya-llama-13b-v1

input.prompt

String

用户当前输入的期望模型执行指令,支持中英文。

<human>:帮我写一份去西安的旅游计划\n<bot>:

出参描述

字段

类型

描述

示例值

output.text

String

本次请求的算法输出内容。

我建议你去颐和园

request_id

String

本次请求的系统唯一码

7574ee8f-38a3-4b1e-9280-11c33ab46e51

请求示例

以下示例展示通过CURL命令来调用ziya-llama-13b-v1模型的脚本。

说明

需要使用您的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' \
--data '{
    "model": "ziya-llama-13b-v1",
    "input": {
        "prompt": "<human>:帮我写一份去西安的旅游计划\n<bot>:"
    },
    "parameters":{
    }
}'

响应示例

{
    "output":{
        "text":"<s><human> :帮我写一份去西安的旅游计划\n<bot> : 好的,以下是一份去西安旅游的详细计划:\nDay 1:到达西安\n- 前往酒店入住\n- 游览大雁塔和钟楼\n- 晚餐尝试当地特色小吃\nDay 2:探索古城\n- 参观华清池和周围的古迹\n- 游览回民街和小吃一条街\n- 晚上参加秦岭风情大剧场表演\nDay 3:历史遗迹之旅\n- 前往兵马俑博物馆参观\n- 游览华清池和临潼古城\n- 晚上观赏《大唐芙蓉园》文艺表演\nDay 4:美食之旅\n- 前往陕西历史博物馆参观\n- 品尝陕西风味小吃\n- 晚上游览明城墙和周围夜市\nDay 5:离开西安\n- 前往机场离开西安\n希望您在西安有一个愉快的旅程!</s>"
    },
    "request_id":"d89c06fb-46a1-47b6-acb9-bfb17f814969"
}

异常响应示例

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

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

状态码说明

DashScope通用状态码请查阅:返回状态码说明