提取文檔文件正文中的文本。
接口說(shuō)明
-
請(qǐng)確保在使用該接口前,已充分了解智能媒體管理產(chǎn)品的收費(fèi)方式和價(jià)格。
-
調(diào)用該接口前,請(qǐng)確保當(dāng)前 Region 已經(jīng)存在可用的項(xiàng)目( Project ),詳見(jiàn)項(xiàng)目管理。
-
支持常見(jiàn)的 Word、Excel、PPT、PDF、TXT 文檔。
-
文件大小最大不超過(guò) 200 MB。提取后的純文本文件大小不超過(guò) 2 MB(約合 60 萬(wàn)中文字)。
調(diào)試
您可以在OpenAPI Explorer中直接運(yùn)行該接口,免去您計(jì)算簽名的困擾。運(yùn)行成功后,OpenAPI Explorer可以自動(dòng)生成SDK代碼示例。
授權(quán)信息
下表是API對(duì)應(yīng)的授權(quán)信息,可以在RAM權(quán)限策略語(yǔ)句的Action
元素中使用,用來(lái)給RAM用戶或RAM角色授予調(diào)用此API的權(quán)限。具體說(shuō)明如下:
- 操作:是指具體的權(quán)限點(diǎn)。
- 訪問(wèn)級(jí)別:是指每個(gè)操作的訪問(wèn)級(jí)別,取值為寫入(Write)、讀取(Read)或列出(List)。
- 資源類型:是指操作中支持授權(quán)的資源類型。具體說(shuō)明如下:
- 對(duì)于必選的資源類型,用背景高亮的方式表示。
- 對(duì)于不支持資源級(jí)授權(quán)的操作,用
全部資源
表示。
- 條件關(guān)鍵字:是指云產(chǎn)品自身定義的條件關(guān)鍵字。
- 關(guān)聯(lián)操作:是指成功執(zhí)行操作所需要的其他權(quán)限。操作者必須同時(shí)具備關(guān)聯(lián)操作的權(quán)限,操作才能成功。
操作 | 訪問(wèn)級(jí)別 | 資源類型 | 條件關(guān)鍵字 | 關(guān)聯(lián)操作 |
---|---|---|---|---|
imm:ExtractDocumentText | none |
|
| 無(wú) |
請(qǐng)求參數(shù)
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
ProjectName | string | 是 | 項(xiàng)目名稱,獲取方式請(qǐng)參見(jiàn)創(chuàng)建項(xiàng)目。 | immtest |
SourceURI | string | 是 | 源數(shù)據(jù)的存儲(chǔ)地址。 OSS 地址規(guī)則為 oss://${Bucket}/${Object},其中 | oss://test-bucket/test-object |
SourceType | string | 否 | 源數(shù)據(jù)的后綴類型。默認(rèn)根據(jù)輸入對(duì)象的后綴名確定源數(shù)據(jù)的類型。當(dāng)輸入對(duì)象沒(méi)有后綴名時(shí),可以設(shè)置此參數(shù),可選值如下。
| docx |
CredentialConfig | CredentialConfig | 否 | 如無(wú)特殊需求,請(qǐng)保持留空即可。 鏈?zhǔn)绞跈?quán)配置,非必填。更多信息,請(qǐng)參見(jiàn)使用鏈?zhǔn)绞跈?quán)訪問(wèn)其他實(shí)體資源。 |
返回參數(shù)
示例
正常返回示例
JSON
格式
{
"RequestId": "94D6F994-E298-037E-8E8B-0090F27*****",
"DocumentText": "測(cè)試內(nèi)容。"
}
錯(cuò)誤碼
訪問(wèn)錯(cuò)誤中心查看更多錯(cuò)誤碼。
變更歷史
變更時(shí)間 | 變更內(nèi)容概要 | 操作 |
---|---|---|
2023-12-13 | OpenAPI 入?yún)l(fā)生變更 | 查看變更詳情 |