本文介紹通過OpenAI相容介面 或 DashScopeAPI 調用 Qwen-MT 模型的輸入與輸出參數。
相關文檔: 翻譯能力(Qwen-MT)
OpenAI 相容
- 新加坡地區
- 美國(維吉尼亞)地區
- 北京地區
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}.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之和。 |