RunDocTranslation - 文档翻译

妙读文档翻译接口

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
aimiaobi:RunDocTranslationget
*全部资源
*

请求语法

POST /miaodu/stream/runDocTranslation HTTP/1.1

请求参数

名称类型必填描述示例值
WorkspaceIdstring

业务空间 id

llm-xxx
SessionIdstring

对话 ID

2e6b3987-f743-4d4c-8326-d9c41a6af3ee
DocIdstring

文档 ID

12345
TransTypestring

翻译方式

toChinese toEnglish
RecommendContentstring

要翻译的内容

要翻译的内容

返回参数

名称类型描述示例值
object

Schema of Response

Headerobject

响应头

ErrorCodestring

错误码

success
ErrorMessagestring

错误码消息

success
Eventstring

事件类型

task-started
EventInfostring

事件描述

模型生成事件
SessionIdstring

会话 ID

411c4dfa-2168-4379-a902-675d67f453f8
TaskIdstring

任务 ID

50a1cc8e-717e-4a2b-a76b-dc9734a8564b
TraceIdstring

全链路 ID

ebd19b12-0cae-488f-9e41-5a1c825f545b
Payloadobject

响应体

Outputobject

输出

Contentstring

翻译内容

翻译内容
Usageobject

token 用量

InputTokenslong

输入使用的 Token 数量

100
OutputTokenslong

输出使用的 Token 数量

100
TotalTokenslong

本次调用使用的所有 Token 数总和

200
RequestIdstring

请求 Id

1813ceee-7fe5-41b4-87e5-982a4d18cca5

示例

正常返回示例

JSON格式

{
  "Header": {
    "ErrorCode": "success",
    "ErrorMessage": "success",
    "Event": "task-started",
    "EventInfo": "模型生成事件",
    "SessionId": "411c4dfa-2168-4379-a902-675d67f453f8",
    "TaskId": "50a1cc8e-717e-4a2b-a76b-dc9734a8564b",
    "TraceId": "ebd19b12-0cae-488f-9e41-5a1c825f545b"
  },
  "Payload": {
    "Output": {
      "Content": "翻译内容"
    },
    "Usage": {
      "InputTokens": 100,
      "OutputTokens": 100,
      "TotalTokens": 200
    }
  },
  "RequestId": "1813ceee-7fe5-41b4-87e5-982a4d18cca5"
}

错误码

HTTP status code错误码错误信息描述
403NoPermissionYou are not authorized to perform this action.请检查workspaceId的赋值

访问错误中心查看更多错误码。