该接口用于将文档上传到合同审查模块中,添加成功之后,系统会自动启动文件的解析,并返回对应的文件ID用于后续生成审查规则和审查结果。文件解析有排队机制,如果队列较长,文件可能需要等待一段时间才能解析完成。
接口说明
-
该接口需要开通法睿商品相关的后付费服务(开通免费),可以使用该账号的 AccessKey 和 AccessSecret 来调用我们的 OpenApi 服务
-
接口的调用需要百炼平台的工作空间权限。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
当前API暂无授权信息透出。
请求语法
POST /{WorkspaceId}/data/textFile HTTP/1.1
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
WorkspaceId | string | 否 | 阿里云百炼平台工作空间 ID | llm-9w5y60lseff0jiqm |
ClientToken | string | 否 | 客户端 Token,用于保证请求的幂等性。从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken 只支持 ASCII 字符。说明 若您未指定,则系统自动使用 API 请求的 RequestId 作为 ClientToken 标识。每次 API 请求的 RequestId 可能不一样。 | e9a93201-7e96-4dc1-9678-2832fc132d08 |
CreateTime | string | 否 | 创建时间 | 1714476549 |
TextFileName | string | 否 | 上传文件名(带后缀) | 测试文件.docx |
TextFileUrl | string | 否 | 上传文件的下载 url。需要通过文件直接上传的请使用 SDK 的 CreateFileAdvanceRequest 请求 | https://xx.测试文件.docx |
返回参数
示例
正常返回示例
JSON
格式
{
"Code": "null",
"Data": {
"TextFileId": "36d6447d277c4a1c9fd0def1d16341f1",
"TextFileName": "测试文件.docx",
"TextFileUrl": "https://xx.测试文件.docx"
},
"HttpStatusCode": 200,
"Message": "null",
"RequestId": "81E6F6D2-8ACB-5BDA-9C7C-4D6268CD9652",
"Success": true
}
错误码
访问错误中心查看更多错误码。