提取文档文件正文中的文本。
接口说明
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
imm:ExtractDocumentText | none | *Project acs:imm:{#regionId}:{#accountId}:project/{#ProjectName} |
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
ProjectName | string | 是 | 项目名称,获取方式请参见创建项目。 | immtest |
SourceURI | string | 是 | 源数据的存储地址。 OSS 地址规则为 oss://${Bucket}/${Object},其中 注意 当前仅支持 http 协议地址。 | oss://test-bucket/test-object |
SourceType | string | 否 | 源数据的后缀类型。默认根据输入对象的后缀名确定源数据的类型。当输入对象没有后缀名时,可以设置此参数,可选值如下。
| docx |
CredentialConfig | CredentialConfig | 否 | 如无特殊需求,请保持留空即可。 链式授权配置,非必填。更多信息,请参见使用链式授权访问其他实体资源。 |
返回参数
示例
正常返回示例
JSON
格式
{
"RequestId": "94D6F994-E298-037E-8E8B-0090F27*****",
"DocumentText": "测试内容。"
}
错误码
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|---|---|
2023-12-13 | OpenAPI 入参发生变更 | 查看变更详情 |