本文介绍通过OpenAI兼容接口 或 DashScopeAPI 调用 Qwen-MT 模型的输入与输出参数。
相关文档: 翻译能力(Qwen-MT)
OpenAI 兼容
- 北京地域
- 新加坡地域
- 美国(弗吉尼亚)地域
SDK 调用配置的
base_url为:https://{WorkspaceId}.cn-beijing.maas.aliyuncs.com/compatible-mode/v1HTTP 请求地址:POST https://{WorkspaceId}.cn-beijing.maas.aliyuncs.com/compatible-mode/v1/chat/completions- 新加坡地域
- 美国(弗吉尼亚)地域
- 北京地域
SDK 调用配置的
base_url为:https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/compatible-mode/v1HTTP 请求地址:POST https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/compatible-mode/v1/chat/completions您需要已 获取与配置 API Key 并 配置API Key到环境变量 。若通过OpenAI SDK进行调用,需要 安装SDK 。
请求体 |
|
modelstring(必选)模型名称。支持的模型:qwen-mt-plus、qwen-mt-flash、qwen-mt-lite、qwen-mt-turbo。 | |
messagesarray(必选)消息数组,用于向大模型传递上下文。仅支持传入 User Message。
消息类型 User Message object(必选)用户消息,用于传递待翻译的句子。
属性 content string(必选)待翻译的句子。rolestring(必选)用户消息的角色,必须设为user。 | |
streamboolean(可选) 默认值为 false是否以流式方式输出回复。可选值:
当前仅qwen-mt-flash、qwen-mt-lite模型支持以增量形式返回数据,每次返回仅包含新生成的内容。qwen-mt-plus和qwen-mt-turbo模型以非增量形式返回数据,每次返回当前已经生成的整个序列,暂时无法修改。如:II didnI didn'tI didn't laughI didn't laugh after... | |
stream_optionsobject(可选)流式输出的配置项,仅在 stream 为 true 时生效。
属性 include_usage boolean(可选)默认值为 false是否在最后一个数据块包含Token消耗信息。可选值:
| |
max_tokensinteger(可选)用于限制模型输出的最大 Token 数。若生成内容超过此值,响应将被截断。默认值与最大值均为模型的最大输出长度,请参见模型选型。 | |
seedinteger(可选)随机数种子。用于确保在相同输入和参数下生成结果可复现。若调用时传入相同的 seed 且其他参数不变,模型将尽可能返回相同结果。取值范围:[0,2 31 −1]。 | |
temperaturefloat(可选)默认值为0.65采样温度,控制模型生成文本的多样性。temperature越高,生成的文本更多样,反之,生成的文本更确定。取值范围: [0, 2)temperature与top_p均可以控制生成文本的多样性,建议只设置其中一个值。 | |
top_pfloat(可选)默认值为0.8核采样的概率阈值,控制模型生成文本的多样性。top_p越高,生成的文本更多样。反之,生成的文本更确定。取值范围:(0,1.0]temperature与top_p均可以控制生成文本的多样性,建议只设置其中一个值。 | |
top_kinteger(可选)默认值为1生成过程中采样候选集的大小。例如,取值为50时,仅将单次生成中得分最高的50个Token组成随机采样的候选集。取值越大,生成的随机性越高;取值越小,生成的确定性越高。取值为None或当top_k大于100时,表示不启用top_k策略,此时仅有top_p策略生效。取值需要大于或等于0。该参数非OpenAI标准参数。通过 Python SDK调用时,请放入 extra_body 对象中,配置方式为:extra_body={"top_k": xxx};通过 Node.js SDK或HTTP方式调用时,请作为顶层参数传递。 | |
repetition_penaltyfloat(可选)默认值为1.0模型生成时连续序列中的重复度。提高repetition_penalty时可以降低模型生成的重复度,1.0表示不做惩罚。没有严格的取值范围,只要大于0即可。该参数非OpenAI标准参数。通过 Python SDK调用时,请放入 extra_body 对象中,配置方式为:extra_body={"repetition_penalty": xxx};通过 Node.js SDK或HTTP方式调用时,请作为顶层参数传递。 | |
translation_optionsobject(必选)需配置的翻译参数。
属性 source_lang string (必选)源语言的英文全称,详情请参见支持的语言。若设为auto,模型会自动识别输入的语种。target_lang string (必选)目标语言的英文全称,详情请参见支持的语言。terms arrays (可选)使用术语干预功能时需设置的术语数组。
属性 source string (必选)源语言的术语。target string (必选)目标语言的术语。arrays (可选)使用翻译记忆功能时需设置的翻译记忆数组。
属性 source string (必选)源语言的语句。target string (必选)目标语言的语句。string (可选)使用领域提示功能时需设置的领域提示语句。领域提示语句暂时只支持英文。 extra_body={"translation_options": xxx};通过 Node.js SDK或HTTP方式调用时,请作为顶层参数传递。 |
chat响应对象(非流式输出) | |
idstring本次请求的唯一标识符。 | |
choicesarray模型生成内容的数组。
属性 finish_reason string模型停止生成的原因。有两种情况:
integer当前对象在choices数组中的索引。messageobject模型输出的消息。
属性 content string模型翻译结果。refusal string该参数当前固定为null。role string消息的角色,固定为assistant。audio object该参数当前固定为null。function_call object该参数当前固定为null。tool_calls array该参数当前固定为null。 | |
createdinteger本次请求被创建时的时间戳。 | |
modelstring本次请求使用的模型。 | |
object string始终为chat.completion。 | |
service_tier string该参数当前固定为null。 | |
system_fingerprintstring该参数当前固定为null。 | |
usage object本次请求的 Token 消耗信息。
属性 completion_tokens integer模型输出的 Token 数。prompt_tokens integer输入的 Token 数。total_tokens integer消耗的总 Token 数,为prompt_tokens与completion_tokens的总和。completion_tokens_details object该参数当前固定为null。prompt_tokens_details object该参数当前固定为null。 |
chat响应chunk对象(流式输出) | |
idstring本次调用的唯一标识符。每个chunk对象有相同的 id。 | |
choicesarray模型生成内容的数组。若设置include_usage参数为true,则在最后一个chunk中为空。
属性 delta object流式返回的输出内容。
属性 content string翻译结果,qwen-mt-flash和qwen-mt-lite为增量式更新,qwen-mt-plus和qwen-mt-turbo为非增量式更新。function_call object该参数当前固定为null。refusal object该参数当前固定为null。role string消息对象的角色,只在第一个chunk中有值。string模型停止生成的原因。有三种情况:
integer当前响应在choices数组中的索引。 | |
createdinteger本次请求被创建时的时间戳。每个chunk有相同的时间戳。 | |
modelstring本次请求使用的模型。 | |
object string始终为chat.completion.chunk。 | |
service_tier string该参数当前固定为null。 | |
system_fingerprintstring该参数当前固定为null。 | |
usage object本次请求消耗的Token。只在include_usage为true时,在最后一个chunk返回。
属性 completion_tokens integer模型输出的 Token 数。prompt_tokens integer输入 Token 数。total_tokens integer总 Token 数,为prompt_tokens与completion_tokens的总和。completion_tokens_details object该参数当前固定为null。prompt_tokens_details object该参数当前固定为null。 |
DashScope
- 北京地域
- 新加坡地域
- 美国(弗吉尼亚)地域
HTTP 请求地址:
POST https://{WorkspaceId}.cn-beijing.maas.aliyuncs.com/api/v1/services/aigc/text-generation/generationSDK 调用无需配置 base_url,其默认值为https://{WorkspaceId}.cn-beijing.maas.aliyuncs.com/api/v1。- 新加坡地域
- 美国(弗吉尼亚)地域
- 北京地域
HTTP 请求地址:
POST https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v1/services/aigc/text-generation/generationSDK调用配置的base_url:- Python代码
- Java代码
您需要已 获取与配置 API Key 并 配置API Key到环境变量 。若通过DashScope SDK进行调用,需要 安装DashScope SDK 。
请求体 |
|
modelstring(必选)模型名称。支持的模型:qwen-mt-plus、qwen-mt-flash、qwen-mt-lite、qwen-mt-turbo。 | |
messagesarray(必选)消息数组,用于向大模型传递上下文。仅支持传入 User Message。
消息类型 User Message object(必选)用户消息,用于传递待翻译的句子。
属性 content string(必选)待翻译的句子。rolestring(必选)用户消息的角色,必须设为user。 | |
max_tokensinteger(可选)用于限制模型输出的最大 Token 数。若生成内容超过此值,响应将被截断。默认值与最大值均为模型的最大输出长度,请参见模型选型。Java SDK中为maxTokens*。*通过HTTP调用时,请将 max_tokens放入 parameters 对象中。 | |
seedinteger(可选)随机数种子。用于确保在相同输入和参数下生成结果可复现。若调用时传入相同的 seed 且其他参数不变,模型将尽可能返回相同结果。取值范围:[0,2 31 −1]。通过HTTP调用时,请将 seed放入 parameters 对象中。 | |
temperaturefloat(可选)默认值为0.65采样温度,控制模型生成文本的多样性。temperature越高,生成的文本更多样,反之,生成的文本更确定。取值范围: [0, 2)temperature与top_p均可以控制生成文本的多样性,建议只设置其中一个值。通过HTTP调用时,请将 temperature放入 parameters 对象中。 | |
top_pfloat(可选)默认值为0.8核采样的概率阈值,控制模型生成文本的多样性。top_p越高,生成的文本更多样。反之,生成的文本更确定。取值范围:(0,1.0]temperature与top_p均可以控制生成文本的多样性,建议只设置其中一个值。Java SDK中为topP*。*通过HTTP调用时,请将 top_p放入 parameters 对象中。 | |
repetition_penaltyfloat(可选)默认值为1.0模型生成时连续序列中的重复度。提高repetition_penalty时可以降低模型生成的重复度,1.0表示不做惩罚。没有严格的取值范围,只要大于0即可。Java SDK中为repetitionPenalty*。*通过HTTP调用时,请将 repetition_penalty放入 parameters 对象中。 | |
top_kinteger(可选)默认值为1生成过程中采样候选集的大小。例如,取值为50时,仅将单次生成中得分最高的50个Token组成随机采样的候选集。取值越大,生成的随机性越高;取值越小,生成的确定性越高。取值为None或当top_k大于100时,表示不启用top_k策略,此时仅有top_p策略生效。取值需要大于或等于0。Java SDK中为topK*。*通过HTTP调用时,请将 top_k放入 parameters 对象中。 | |
streamboolean(可选)是否以流式方式输出回复。可选值:
当前仅qwen-mt-flash、qwen-mt-lite模型支持以增量形式返回数据,每次返回仅包含新生成的内容。qwen-mt-plus和qwen-mt-turbo模型以非增量形式返回数据,每次返回当前已经生成的整个序列,暂时无法修改。如:II didnI didn'tI didn't laughI didn't laugh after... 该参数仅支持Python SDK。通过Java SDK实现流式输出请通过 | |
translation_optionsobject(必选)需配置的翻译参数。
属性 source_lang string (必选)源语言的英文全称,详情请参见支持的语言。若设为auto,模型会自动识别输入的语种。target_lang string (必选)目标语言的英文全称,详情请参见支持的语言。terms arrays (可选)使用术语干预功能时需设置的术语数组。
属性 source string (必选)源语言的术语。target string (必选)目标语言的术语。arrays (可选)使用翻译记忆功能时需设置的翻译记忆数组。
属性 source string (必选)源语言的语句。target string (必选)目标语言的语句。string (可选)使用领域提示功能时需设置的领域提示语句。领域提示语句暂时只支持英文。
Java SDK中为 |
chat响应对象(流式与非流式输出格式一致) | |
status_codestring本次请求的状态码。200 表示请求成功,否则表示请求失败。Java SDK 通过 | |
request_idstring本次调用的唯一标识符。Java SDK返回参数为requestId。 | |
codestring错误码,调用成功时为空值。只有Python SDK返回该参数。 | |
outputobject调用结果信息。
属性 text string该参数当前固定为null。finish_reasonstring模型结束生成的原因。有以下情况:
array模型的输出信息。
属性 finish_reason string有以下情况:
object模型输出的消息对象。
属性 role string输出消息的角色,固定为assistant。contentstring翻译的结果。string本次请求使用的模型名称。 | |
usageobject本次请求使用的Token信息。
属性 input_tokens integer输入 Token 数。output_tokens integer输出 Token 数。total_tokens integer总 Token 数,为input_tokens与output_tokens之和。 |