Input and output parameters for calling Qwen-MT through the OpenAI compatible interface or the DashScope API.
References: Machine translation (Qwen-MT)
OpenAI compatible
- Beijing region
- Singapore region
- Virginia region
base_url for SDK: https://{WorkspaceId}.cn-beijing.maas.aliyuncs.com/compatible-mode/v1HTTP endpoint: POST https://{WorkspaceId}.cn-beijing.maas.aliyuncs.com/compatible-mode/v1/chat/completions- Singapore region
- Virginia region
- Beijing region
base_url for SDK: https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/compatible-mode/v1HTTP endpoint: POST https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/compatible-mode/v1/chat/completionsFirst, create an API key and configure it as an environment variable . If you use the OpenAI SDK, install the SDK .
Request body |
|
model string (Required)Model name. Supported: qwen-mt-plus, qwen-mt-flash, qwen-mt-lite, qwen-mt-turbo. | |
messages array (Required)Array of messages providing context to the model. Only user messages are supported.
Message type User Message object (Required)A user message that contains the sentence to be translated.
Properties content string (Required)Sentence to translate.role string (Required)User message role. Must be set to user. | |
stream boolean (Optional) Defaults to false.Enable streaming output mode.Valid values:
qwen-mt-flash and qwen-mt-lite return data incrementally (each chunk contains only new content). qwen-mt-plus and qwen-mt-turbo return data non-incrementally (each chunk contains entire sequence to date). This behavior cannot be changed. Example:II didnI didn'tI didn't laughI didn't laugh after... | |
stream_options object (Optional)The configuration items for streaming output. This parameter takes effect only when stream is set to true.
Properties include_usage boolean (Optional) Defaults to false.Include token consumption information in the last data chunk.Valid values:
| |
max_tokens integer (Optional)Maximum number of tokens to generate. If the output exceeds this value, the response is truncated.The default and maximum values are the maximum output length of the model. For more information, see Model selection. | |
seed integer (Optional)Random number seed for reproducible results. Using the same seed and parameters produces consistent output.Value range: [0, 2 31 -1]. | |
temperature float (Optional) Defaults to 0.65.Sampling temperature that controls the diversity of generated text.Higher values produce more diverse text. Lower values produce more deterministic text.Value range: [0, 2)Both temperature and top_p control text diversity. Set only one of them. | |
top_p float (Optional) Defaults to 0.8.Probability threshold for nucleus sampling that controls the diversity of generated text.Higher values produce more diverse text. Lower values produce more deterministic text.Value range: (0, 1.0]Both temperature and top_p control text diversity. Set only one of them. | |
top_k integer (Optional) Defaults to 1.Size of the candidate set for sampling during generation. For example, setting this to 50 means only the top 50 tokens by score form the sampling pool. Larger values increase randomness; smaller values increase determinism. If the value is None or greater than 100, top_k is disabled and only top_p takes effect.The value must be greater than or equal to 0.Non-standard OpenAI parameter. Python SDK: place in extra_body object extra_body={"top_k": xxx}. Node.js SDK or HTTP calls: pass as top-level parameter. | |
repetition_penalty float (Optional) Defaults to 1.0.Penalty for repetition in consecutive sequences. Higher values reduce repetition. A value of 1.0 applies no penalty. Must be greater than 0, with no strict upper limit.Non-standard OpenAI parameter. Python SDK: place in extra_body object extra_body={"repetition_penalty": xxx}. Node.js SDK or HTTP calls: pass as top-level parameter. | |
translation_options object (Required)Translation parameters.
Properties source_lang string (Required)The full English name of the source language. For more information, see Supported languages. If you set this to auto, the model automatically detects the input language.target_lang string (Required)The full English name of the target language. For more information, see Supported languages.terms arrays (Optional)The array of terms to set when you use the Term intervention feature.
Properties source string (Required)The term in the source language.target string (Required)The term in the target language.arrays (Optional)The array of translation memories to set when you use the Translation memory feature.
Properties source string (Required)The statement in the source language.target string (Required)The statement in the target language.string (Optional)The domain prompt to set when you use the Domain prompting feature.Domain prompts must be in English. extra_body={"translation_options": xxx}. Node.js SDK or HTTP calls: pass as top-level parameter. |
Chat response object (non-streaming output) | |
id stringUnique request ID. | |
choices arrayArray of model-generated content.
Properties finish_reason stringReason why the model stopped generating content.Possible values:
integerIndex of the current object in the choices array.message objectModel output message.
Properties content stringTranslation result.refusal stringCurrently fixed to null.role stringThe role of the message. This is fixed to assistant.audio objectCurrently fixed to null.function_call objectCurrently fixed to null.tool_calls arrayCurrently fixed to null. | |
created integerThe UNIX timestamp when the request was created. | |
model stringThe model used for the request. | |
object stringThis is always chat.completion. | |
service_tier stringCurrently fixed to null. | |
system_fingerprint stringCurrently fixed to null. | |
usage objectToken consumption for the request.
Properties completion_tokens integerNumber of tokens in the model output.prompt_tokens integerNumber of tokens in the input.total_tokens integerTotal tokens consumed, equal to prompt_tokens + completion_tokens.completion_tokens_details objectCurrently fixed to null.prompt_tokens_details objectCurrently fixed to null. |
Chat response chunk object (streaming output) | |
id stringThe unique ID of the call. Each chunk object has the same ID. | |
choices arrayAn array of content generated by the model. If include_usage is set to true, this array is empty in the last chunk.
Properties delta objectThe output content returned in streaming mode.
Properties content stringThe translation result. qwen-mt-flash and qwen-mt-lite provide incremental updates. qwen-mt-plus and qwen-mt-turbo provide non-incremental updates.function_call objectCurrently fixed to null.refusal objectCurrently fixed to null.role stringThe role of the message object. This has a value only in the first chunk.stringThe model stops generating for one of three reasons:
integerThe index of the current response in the choices array. | |
created integerThe UNIX timestamp when the request was created. Each chunk has the same timestamp. | |
model stringThe model used for the request. | |
object stringThis is always chat.completion.chunk. | |
service_tier stringCurrently fixed to null. | |
system_fingerprint stringCurrently fixed to null. | |
usage objectThe tokens consumed by the request. This is returned in the last chunk only when include_usage is true.
Properties completion_tokens integerThe number of tokens in the model output.prompt_tokens integerThe number of input tokens.total_tokens integerThe total number of tokens. This is the sum of prompt_tokens and completion_tokens.completion_tokens_details objectCurrently fixed to null.prompt_tokens_details objectCurrently fixed to null. |
DashScope
- Beijing
- Singapore
- Virginia
HTTP endpoint:
POST https://{WorkspaceId}.cn-beijing.maas.aliyuncs.com/api/v1/services/aigc/text-generation/generationYou do not need to configure base_url for SDK calls. The default value is https://{WorkspaceId}.cn-beijing.maas.aliyuncs.com/api/v1.- Singapore
- Virginia
- Beijing
HTTP endpoint:
POST https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v1/services/aigc/text-generation/generationSet base_url to:- Python code
- Java code
You must create an API key and export the API key as an environment variable . If using the DashScope SDK, install the DashScope SDK .
Request body |
|
model string (Required)Model name. Supported: qwen-mt-plus, qwen-mt-flash, qwen-mt-lite, qwen-mt-turbo. | |
messages array (Required)Array of messages providing context to the model. Only user messages are supported.
Message type User Message object (Required)A user message that contains the sentence to be translated.
Properties content string (Required)Sentence to translate.role string (Required)User message role. Must be set to user. | |
max_tokens integer (Optional)Maximum number of tokens to generate. If the output exceeds this value, the response is truncated.The default and maximum values are the maximum output length of the model. For more information, see Model selection.In the Java SDK, the parameter is maxTokens. For HTTP calls, place max_tokens in the parameters object. | |
seed integer (Optional)Random number seed for reproducible results. Using the same seed and parameters produces consistent output.Value range: [0, 2 31 -1].When you make an HTTP call, place seed in the parameters object. | |
temperature float (Optional) Defaults to 0.65.Sampling temperature that controls the diversity of generated text.Higher values produce more diverse text. Lower values produce more deterministic text.Value range: [0, 2)Both temperature and top_p control text diversity. Set only one of them.When you make an HTTP call, place temperature in the parameters object. | |
top_p float (Optional) Defaults to 0.8.Probability threshold for nucleus sampling that controls the diversity of generated text.Higher values produce more diverse text. Lower values produce more deterministic text.Value range: (0, 1.0]Both temperature and top_p control text diversity. Set only one of them.In the Java SDK, the parameter is topPparameters object. | |
repetition_penalty float (Optional) Defaults to 1.0.Penalty for repetition in consecutive sequences. Higher values reduce repetition. A value of 1.0 applies no penalty. Must be greater than 0, with no strict upper limit.In the Java SDK, the parameter is repetitionPenalty. For HTTP calls, add repetition_penalty to the parameters object. | |
top_k integer (Optional) Defaults to 1.Size of the candidate set for sampling during generation. For example, setting this to 50 means only the top 50 tokens by score form the sampling pool. Larger values increase randomness; smaller values increase determinism. If the value is None or greater than 100, top_k is disabled and only top_p takes effect.The value must be greater than or equal to 0.In the Java SDK, the parameter is topK. When you make an HTTP call, set top_k in the parameters object. | |
stream boolean (Optional)Enable streaming output mode.Valid values:
qwen-mt-flash and qwen-mt-lite return data incrementally (each chunk contains only new content). qwen-mt-plus and qwen-mt-turbo return data non-incrementally (each chunk contains entire sequence to date). This behavior cannot be changed. Example:II didnI didn'tI didn't laughI didn't laugh after... This parameter is supported only by the Python SDK. To implement streaming output with the Java SDK, call the | |
translation_options object (Required)Translation parameters.
Properties source_lang string (Required)The full English name of the source language. For more information, see Supported languages. If you set this to auto, the model automatically detects the input language.target_lang string (Required)The full English name of the target language. For more information, see Supported languages.terms arrays (Optional)The array of terms to set when you use the Term intervention feature.
Properties source string (Required)The term in the source language.target string (Required)The term in the target language.arrays (Optional)The array of translation memories to set when you use the Translation memory feature.
Properties source string (Required)The statement in the source language.target string (Required)The statement in the target language.string (Optional)The domain prompt to set when you use the Domain prompting feature.Domain prompts must be in English.
In the Java SDK, the parameter is |
Chat response object (same for streaming and non-streaming output) | |
status_code stringRequest status code. 200 indicates success; other values indicate failure.The Java SDK does not return this parameter. If the call fails, an exception is thrown. The exception message contains the content of status_code and message. | |
request_id stringUnique request ID.In the Java SDK, the returned parameter is requestId. | |
code stringError code. Empty on success.Only the Python SDK returns this parameter. | |
output objectCall result.
Properties text stringCurrently fixed to null.finish_reason stringReason why the model stopped generating content. Valid values:
arrayModel output.
Properties finish_reason stringValid values:
objectModel output message.
Properties role stringOutput message role. Fixed to assistant.content stringTranslation result.stringModel used for this request. | |
usage objectToken usage for the request.
Properties input_tokens integerNumber of input tokens.output_tokens integerNumber of output tokens.total_tokens integerTotal tokens, equal to input_tokens + output_tokens. |