PDF轉Word接口可以將單個PDF文檔轉換為可編輯的Word文檔,精準識別文本內容,并保留原始文檔的版面樣式信息。本文介紹了PDF轉Word接口的調用方式,在調用OpenAPI接口前,請先閱讀API使用指南。
調用方式
PDF轉Word接口為異步接口,需要先調用PDF轉Word異步提交服務SubmitConvertPdfToWordJob或SubmitConvertPdfToWordJobAdvance接口進行異步任務提交,然后調用文檔轉換結果查詢服務GetDocumentConvertResult接口進行結果輪詢。
建議每10秒輪詢一次,最多輪詢120分鐘,如果120分鐘還未查詢到處理完成結果,則視為處理超時。
當異步任務處理提交后,用戶可以在處理結束后的24小時之內查詢處理結果,超過24小時后將無法查詢到處理結果。
支持的文檔格式:單個PDF文件。
步驟一:調用PDF轉Word異步提交服務SubmitConvertPdfToWordJob接口
異步提交服務支持本地文件上傳和url文件上傳兩種方式:
本地文件上傳的異步提交服務接口為:SubmitConvertPdfToWordJobAdvance接口。
url文件上傳的異步提交服務接口為:SubmitConvertPdfToWordJob接口。
請求參數
名稱 | 類型 | 必填 | 描述 | 示例值 |
FileUrl | string | 是 | 單個文檔的url(不支持1000頁以上的PDF文件,不支持100MB以上的PDF文件)。 如果需要本地上傳文件方式,SDK會提供單獨入參支持文件流上傳。 | https://example.com/example.pdf |
FileName | string | 否 | 文件名,需帶文件類型后綴。該接口只支持PDF文件。 | example.pdf |
返回參數
名稱 | 類型 | 描述 | 示例值 |
RequestId | string | 唯一請求ID。 | 43A29C77-405E-4CC0-BC55-EE694AD0**** |
Data | object | 返回數據。 | {"Id": "docmind-20220712-b15f****"} |
Id | string | 業務訂單號,用于后續查詢接口進行查詢的唯一標識。 | docmind-20220712-b15f**** |
Code | string | 狀態碼。 | 200 |
Message | string | 詳細信息。 | Message |
使用示例
本接口支持本地文件上傳和url文件上傳這兩種調用方式。
本地文件上傳:以Java SDK為例,本地文件上傳調用方式的請求示例代碼如下,調用PDF轉Word異步提交服務SubmitConvertPdfToWordJobAdvance接口,通過fileUrlObject參數實現本地文檔上傳。
說明獲取并使用AccessKey信息的方式,可參考SDK概述中不同語言的SDK使用指南。
import com.aliyun.docmind_api20220711.models.*; import com.aliyun.teaopenapi.models.Config; import com.aliyun.docmind_api20220711.Client; import com.aliyun.teautil.models.RuntimeOptions; import java.io.File; import java.io.FileInputStream; public static void main(String[] args) throws Exception { submit(); } public static void submit() throws Exception { // 使用默認憑證初始化Credentials Client。 com.aliyun.credentials.Client credentialClient = new com.aliyun.credentials.Client(); Config config = new Config() // 通過credentials獲取配置中的AccessKey ID .setAccessKeyId(credentialClient.getAccessKeyId()) // 通過credentials獲取配置中的AccessKey Secret .setAccessKeySecret(credentialClient.getAccessKeySecret()); // 訪問的域名,支持ipv4和ipv6兩種方式,ipv6請使用docmind-api-dualstack.cn-hangzhou.aliyuncs.com config.endpoint = "docmind-api.cn-hangzhou.aliyuncs.com"; Client client = new Client(config); // 創建RuntimeObject實例并設置運行參數 RuntimeOptions runtime = new RuntimeOptions(); SubmitConvertPdfToWordJobAdvanceRequest advanceRequest = new SubmitConvertPdfToWordJobAdvanceRequest(); File file = new File("D:\\example.pdf"); advanceRequest.fileUrlObject = new FileInputStream(file); advanceRequest.fileName = "example.pdf"; // 發起請求并處理應答或異常。 SubmitConvertPdfToWordJobResponse response = client.submitConvertPdfToWordJobAdvance(advanceRequest, runtime); System.out.println(JSON.toJSON(response.getBody())); }
const Client = require('@alicloud/docmind-api20220711'); const Util = require('@alicloud/tea-util'); const fs = require('fs'); const getResult = async () => { // 使用默認憑證初始化Credentials Client const cred = new Credential.default(); const client = new Client.default({ // 訪問的域名,支持ipv4和ipv6兩種方式,ipv6請使用docmind-api-dualstack.cn-hangzhou.aliyuncs.com endpoint: 'docmind-api.cn-hangzhou.aliyuncs.com', // 通過credentials獲取配置中的AccessKey ID accessKeyId: cred.credential.accessKeyId, // 通過credentials獲取配置中的AccessKey Secret accessKeySecret: cred.credential.accessKeySecret, type: 'access_key', regionId: 'cn-hangzhou' }); const advanceRequest = new Client.SubmitConvertPdfToWordJobAdvanceRequest(); const file = fs.createReadStream('./example.pdf'); advanceRequest.fileUrlObject = file; advanceRequest.fileName = 'example.pdf'; const runtimeObject = new Util.RuntimeOptions({}); const response = await client.submitConvertPdfToWordJobAdvance(advanceRequest, runtimeObject); return response.body; }
from alibabacloud_docmind_api20220711.client import Client as docmind_api20220711Client from alibabacloud_tea_openapi import models as open_api_models from alibabacloud_docmind_api20220711 import models as docmind_api20220711_models from alibabacloud_tea_util.client import Client as UtilClient from alibabacloud_tea_util import models as util_models from alibabacloud_credentials.client import Client as CredClient if __name__ == '__main__': cred=CredClient() config = open_api_models.Config( # 通過credentials獲取配置中的AccessKey ID access_key_id=cred.get_credential().get_access_key_id(), # 通過credentials獲取配置中的AccessKey Secret access_key_secret=cred.get_credential().get_access_key_secret() ) # 訪問的域名 config.endpoint = f'docmind-api.cn-hangzhou.aliyuncs.com' client = docmind_api20220711Client(config) request = docmind_api20220711_models.SubmitConvertPdfToWordJobAdvanceRequest( # file_url_object : 本地文件流 file_url_object=open("./example.pdf", "rb"), # file_name :文件名稱。名稱必須包含文件類型 file_name='123.pdf', ) runtime = util_models.RuntimeOptions() try: # 復制代碼運行請自行打印 API 的返回值 response = client.submit_convert_pdf_to_word_job_advance(request, runtime) # API返回值格式層級為 body -> data -> 具體屬性。可根據業務需要打印相應的結果。如下示例為打印返回的業務id格式 # 獲取屬性值均以小寫開頭, print(response.body) except Exception as error: # 如有需要,請打印 error UtilClient.assert_as_string(error.message)
using Newtonsoft.Json; using System; using System.Collections; using System.Collections.Generic; using System.IO; using System.Threading.Tasks; using Tea; using Tea.Utils; public static void SubmitFile() { // 使用默認憑證初始化Credentials Client。 var akCredential = new Aliyun.Credentials.Client(null); AlibabaCloud.OpenApiClient.Models.Config config = new AlibabaCloud.OpenApiClient.Models.Config { // 通過credentials獲取配置中的AccessKey Secret AccessKeyId = akCredential.GetAccessKeyId(), // 通過credentials獲取配置中的AccessKey Secret AccessKeySecret = akCredential.GetAccessKeySecret(), }; // 訪問的域名 config.Endpoint = "docmind-api.cn-hangzhou.aliyuncs.com"; //需要安裝額外的依賴庫--> AlibabaCloud.DarabonbaStream AlibabaCloud.SDK.Docmind_api20220711.Client client = new AlibabaCloud.SDK.Docmind_api20220711.Client(config); Stream bodySyream = AlibabaCloud.DarabonbaStream.StreamUtil.ReadFromFilePath("<YOUR-FILE-PATH>"); AlibabaCloud.SDK.Docmind_api20220711.Models.SubmitConvertPdfToWordJobAdvanceRequest request = new AlibabaCloud.SDK.Docmind_api20220711.Models.SubmitConvertPdfToWordJobAdvanceRequest { FileUrlObject = bodySyream, FileName = "example.pdf" }; AlibabaCloud.TeaUtil.Models.RuntimeOptions runtime = new AlibabaCloud.TeaUtil.Models.RuntimeOptions(); try { // 復制代碼運行請自行打印 API 的返回值 client.SubmitConvertPdfToWordJobAdvance(request, runtime); } catch (TeaException error) { // 如有需要,請打印 error AlibabaCloud.TeaUtil.Common.AssertAsString(error.Message); } catch (Exception _error) { TeaException error = new TeaException(new Dictionary<string, object> { { "message", _error.Message } }); // 如有需要,請打印 error AlibabaCloud.TeaUtil.Common.AssertAsString(error.Message); } }
import ( "fmt" "os" openClient "github.com/alibabacloud-go/darabonba-openapi/v2/client" "github.com/alibabacloud-go/docmind-api-20220711/client" "github.com/alibabacloud-go/tea-utils/v2/service" "github.com/aliyun/credentials-go/credentials" ) func submit(){ // 使用默認憑證初始化Credentials Client。 credential, err := credentials.NewCredential(nil) // 通過credentials獲取配置中的AccessKey ID accessKeyId, err := credential.GetAccessKeyId() // 通過credentials獲取配置中的AccessKey Secret accessKeySecret, err := credential.GetAccessKeySecret() // 訪問的域名,支持ipv4和ipv6兩種方式,ipv6請使用docmind-api-dualstack.cn-hangzhou.aliyuncs.com var endpoint string = "docmind-api.cn-hangzhou.aliyuncs.com" config := openClient.Config{AccessKeyId: accessKeyId, AccessKeySecret: accessKeySecret, Endpoint: &endpoint} // 初始化client cli, err := client.NewClient(&config) if err != nil { panic(err) } // 上傳本地文檔調用接口 filename := "D:\\example.pdf" f, err := os.Open(filename) if err != nil { panic(err) } // 初始化接口request request := client.SubmitConvertPdfToWordJobAdvanceRequest{ FileName: &filename, FileUrlObject: f, } // 創建RuntimeObject實例并設置運行參數 options := service.RuntimeOptions{} response, err := cli.SubmitConvertPdfToWordJobAdvance(&request, &options) if err != nil { panic(err) } // 打印結果 fmt.Println(response.Body.String()) }
url文件上傳:以Java SDK為例,傳入文檔url調用方式的請求示例代碼如下,調用PDF轉Word異步提交服務SubmitConvertPdfToWordJob接口,通過fileUrl參數實現傳入文檔url。請注意,您傳入的文檔url必須為公網可訪問下載的url地址,無跨域限制,url不帶特殊轉義字符。
說明獲取并使用AccessKey信息的方式,可參考SDK概述中不同語言的SDK使用指南。
import com.aliyun.docmind_api20220711.models.*; import com.aliyun.teaopenapi.models.Config; import com.aliyun.docmind_api20220711.Client; public static void main(String[] args) throws Exception { submit(); } public static void submit() throws Exception { // 使用默認憑證初始化Credentials Client。 com.aliyun.credentials.Client credentialClient = new com.aliyun.credentials.Client(); Config config = new Config() // 通過credentials獲取配置中的AccessKey ID .setAccessKeyId(credentialClient.getAccessKeyId()) // 通過credentials獲取配置中的AccessKey Secret .setAccessKeySecret(credentialClient.getAccessKeySecret()); // 訪問的域名,支持ipv4和ipv6兩種方式,ipv6請使用docmind-api-dualstack.cn-hangzhou.aliyuncs.com config.endpoint = "docmind-api.cn-hangzhou.aliyuncs.com"; Client client = new Client(config); SubmitConvertPdfToWordJobRequest request = new SubmitConvertPdfToWordJobRequest(); request.fileName = "example.pdf"; request.fileUrl = "https://example.com/example.pdf"; SubmitConvertPdfToWordJobResponse response = client.submitConvertPdfToWordJob(request); System.out.println(JSON.toJSON(response.getBody())); }
const Client = require('@alicloud/docmind-api20220711'); const getResult = async () => { // 使用默認憑證初始化Credentials Client const cred = new Credential.default(); const client = new Client.default({ // 訪問的域名,支持ipv4和ipv6兩種方式,ipv6請使用docmind-api-dualstack.cn-hangzhou.aliyuncs.com endpoint: 'docmind-api.cn-hangzhou.aliyuncs.com', // 通過credentials獲取配置中的AccessKey ID accessKeyId: cred.credential.accessKeyId, // 通過credentials獲取配置中的AccessKey Secret accessKeySecret: cred.credential.accessKeySecret, type: 'access_key', regionId: 'cn-hangzhou' }); const request = new Client.SubmitConvertPdfToWordJobRequest(); request.fileName = 'example.pdf'; request.fileUrl = 'https://example.com/example.pdf'; const response = await client.submitConvertPdfToWordJob(request); return response.body; }
from alibabacloud_docmind_api20220711.client import Client as docmind_api20220711Client from alibabacloud_tea_openapi import models as open_api_models from alibabacloud_docmind_api20220711 import models as docmind_api20220711_models from alibabacloud_tea_util.client import Client as UtilClient from alibabacloud_credentials.client import Client as CredClient if __name__ == '__main__': cred=CredClient() config = open_api_models.Config( # 通過credentials獲取配置中的AccessKey ID access_key_id=cred.get_credential().get_access_key_id(), # 通過credentials獲取配置中的AccessKey Secret access_key_secret=cred.get_credential().get_access_key_secret() ) # 訪問的域名 config.endpoint = f'docmind-api.cn-hangzhou.aliyuncs.com' client = docmind_api20220711Client(config) request = docmind_api20220711_models.SubmitConvertPdfToWordJobRequest( # file_url : 文件url地址 file_url='https://example.com/example.pdf', # file_name :文件名稱。名稱必須包含文件類型 file_name='123.pdf', ) try: # 復制代碼運行請自行打印 API 的返回值 response = client.submit_convert_pdf_to_word_job(request) # API返回值格式層級為 body -> data -> 具體屬性。可根據業務需要打印相應的結果。如下示例為打印返回的業務id格式 # 獲取屬性值均以小寫開頭, print(response.body) except Exception as error: # 如有需要,請打印 error UtilClient.assert_as_string(error.message)
using Newtonsoft.Json; using System; using System.Collections; using System.Collections.Generic; using System.IO; using System.Threading.Tasks; using Tea; using Tea.Utils; public static void SubmitUrl() { // 使用默認憑證初始化Credentials Client。 var akCredential = new Aliyun.Credentials.Client(null); AlibabaCloud.OpenApiClient.Models.Config config = new AlibabaCloud.OpenApiClient.Models.Config { // 通過credentials獲取配置中的AccessKey Secret AccessKeyId = akCredential.GetAccessKeyId(), // 通過credentials獲取配置中的AccessKey Secret AccessKeySecret = akCredential.GetAccessKeySecret(), }; // 訪問的域名 config.Endpoint = "docmind-api.cn-hangzhou.aliyuncs.com"; AlibabaCloud.SDK.Docmind_api20220711.Client client = new AlibabaCloud.SDK.Docmind_api20220711.Client(config); AlibabaCloud.SDK.Docmind_api20220711.Models.SubmitConvertPdfToWordJobRequest request = new AlibabaCloud.SDK.Docmind_api20220711.Models.SubmitConvertPdfToWordJobRequest { FileUrl = "https://example.pdf", FileName = "example.pdf" }; try { // 復制代碼運行請自行打印 API 的返回值 client.SubmitConvertPdfToWordJob(request); } catch (TeaException error) { // 如有需要,請打印 error AlibabaCloud.TeaUtil.Common.AssertAsString(error.Message); } catch (Exception _error) { TeaException error = new TeaException(new Dictionary<string, object> { { "message", _error.Message } }); // 如有需要,請打印 error AlibabaCloud.TeaUtil.Common.AssertAsString(error.Message); } }
import ( "fmt" openClient "github.com/alibabacloud-go/darabonba-openapi/v2/client" "github.com/alibabacloud-go/docmind-api-20220711/client" "github.com/aliyun/credentials-go/credentials" ) func submit(){ // 使用默認憑證初始化Credentials Client。 credential, err := credentials.NewCredential(nil) // 通過credentials獲取配置中的AccessKey ID accessKeyId, err := credential.GetAccessKeyId() // 通過credentials獲取配置中的AccessKey Secret accessKeySecret, err := credential.GetAccessKeySecret() // 訪問的域名,支持ipv4和ipv6兩種方式,ipv6請使用docmind-api-dualstack.cn-hangzhou.aliyuncs.com var endpoint string = "docmind-api.cn-hangzhou.aliyuncs.com" config := openClient.Config{AccessKeyId: accessKeyId, AccessKeySecret: accessKeySecret, Endpoint: &endpoint} // 初始化client cli, err := client.NewClient(&config) if err != nil { panic(err) } // 文件URL fileURL := "https://example.com/example.pdf" // 文件名 fileName := "example.pdf" // 初始化接口request request := client.SubmitConvertPdfToWordJobRequest{ FileUrl: &fileURL, FileName: &fileName, } response, err := cli.SubmitConvertPdfToWordJob(&request) if err != nil { panic(err) } // 打印結果 fmt.Println(response.Body.String()) }
use AlibabaCloud\SDK\Docmindapi\V20220711\Docmindapi; use AlibabaCloud\SDK\Docmindapi\V20220711\Models\SubmitConvertPdfToWordJobRequest; use Darabonba\OpenApi\Models\Config; use AlibabaCloud\Tea\Utils\Utils\RuntimeOptions; use AlibabaCloud\Tea\Exception\TeaUnableRetryError; use AlibabaCloud\Credentials\Credential; // 使用默認憑證初始化Credentials Client。 $bearerToken = new Credential(); $config = new Config(); // 訪問的域名,支持ipv4和ipv6兩種方式,ipv6請使用docmind-api-dualstack.cn-hangzhou.aliyuncs.com $config->endpoint = "docmind-api.cn-hangzhou.aliyuncs.com"; // 通過credentials獲取配置中的AccessKey ID $config->accessKeyId = $bearerToken->getCredential()->getAccessKeyId(); // 通過credentials獲取配置中的AccessKey Secret $config->accessKeySecret = $bearerToken->getCredential()->getAccessKeySecret(); $config->type = "access_key"; $config->regionId = "cn-hangzhou"; $client = new Docmindapi($config); $request = new SubmitConvertPdfToWordJobRequest(); $runtime = new RuntimeOptions(); $runtime->maxIdleConns = 3; $runtime->connectTimeout = 10000; $runtime->readTimeout = 10000; $request->fileName = "example.pdf"; $request->fileUrl = "https://example.com/example.pdf"; try { $response = $client->submitConvertPdfToWordJob($request, $runtime); var_dump($response->toMap()); } catch (TeaUnableRetryError $e) { var_dump($e->getMessage()); var_dump($e->getErrorInfo()); var_dump($e->getLastException()); var_dump($e->getLastRequest()); }
返回結果
{
"RequestId": "43A29C77-405E-4CC0-BC55-EE694AD0****",
"Data": {
"Id": "docmind-20220712-b15f****"
}
}
步驟二:調用文檔轉換結果查詢服務GetDocumentConvertResult接口
調用查詢接口的入參ID就是前面異步任務提交接口返回的出參ID,查詢結果有處理中、處理成功、處理失敗三種情況。
請求參數
名稱 | 類型 | 必填 | 描述 | 示例值 |
Id | string | 是 | 需要查詢的業務訂單號,訂單號從提交接口的返回結果中獲取。 | docmind-20220712-b15f**** |
返回參數
名稱 | 類型 | 描述 | 示例值 |
RequestId | string | 請求唯一ID。 | 43A29C77-405E-4CC0-BC55-EE694AD0**** |
Completed | boolean | 異步任務是否處理完成,false表示任務仍在處理中,true代表任務處理完成,有處理成功或處理失敗的明確結果。 | true |
Status | string | 異步任務處理完成的狀態,最終處理結束后的狀態。Success為處理成功,Fail為處理失敗。 | Success |
Data | object | 文檔轉換的結果,具體參數詳情見下表。 | 是個列表 |
Data參數列表:
名稱 | 類型 | 描述 | 示例值 |
Code | string | 狀態碼。 | 200 |
Message | string | 詳細信息。 | message |
Url | String | 轉換后的文件url地址。 | https://example.com/example.pdf |
Size | Integer | 轉換后的文件大小,單位為字節。 | 1345488 |
Type | String | 轉換后的文件后綴名,pdf轉word是docx。 | |
Md5 | String | 轉換后的文件md5值,調用者可以用于校驗。 | 2d49eb7705f9f93ed857874db247**** |
使用示例
以Java SDK為例,調用文檔智能解析接口的結果查詢類API示例代碼如下,調用文檔轉換結果查詢服務getDocumentConvertResult接口,通過傳入ID查詢流水號。
獲取并使用AccessKey信息的方式,可參考SDK概述中不同語言的SDK使用指南。
import com.aliyun.docmind_api20220711.models.*;
import com.aliyun.teaopenapi.models.Config;
import com.aliyun.docmind_api20220711.Client;
public static void main(String[] args) throws Exception {
submit();
}
public static void submit() throws Exception {
// 使用默認憑證初始化Credentials Client。
com.aliyun.credentials.Client credentialClient = new com.aliyun.credentials.Client();
Config config = new Config()
// 通過credentials獲取配置中的AccessKey ID
.setAccessKeyId(credentialClient.getAccessKeyId())
// 通過credentials獲取配置中的AccessKey Secret
.setAccessKeySecret(credentialClient.getAccessKeySecret());
// 訪問的域名,支持ipv4和ipv6兩種方式,ipv6請使用docmind-api-dualstack.cn-hangzhou.aliyuncs.com
config.endpoint = "docmind-api.cn-hangzhou.aliyuncs.com";
Client client = new Client(config);
GetDocumentConvertResultRequest resultRequest = new GetDocumentConvertResultRequest();
resultRequest.id = "docmind-20220902-824b****";
GetDocumentConvertResultResponse response = client.getDocumentConvertResult(resultRequest);
System.out.println(JSON.toJSON(response.getBody()));
}
const Client = require('@alicloud/docmind-api20220711');
const getResult = async () => {
// 使用默認憑證初始化Credentials Client
const cred = new Credential.default();
const client = new Client.default({
// 訪問的域名,支持ipv4和ipv6兩種方式,ipv6請使用docmind-api-dualstack.cn-hangzhou.aliyuncs.com
endpoint: 'docmind-api.cn-hangzhou.aliyuncs.com',
// 通過credentials獲取配置中的AccessKey ID
accessKeyId: cred.credential.accessKeyId,
// 通過credentials獲取配置中的AccessKey Secret
accessKeySecret: cred.credential.accessKeySecret,
type: 'access_key',
regionId: 'cn-hangzhou'
});
const resultRequest = new Client.GetDocumentConvertResultRequest();
resultRequest.id = "docmind-20220902-824b****";
const response = await client.getDocumentConvertResult(resultRequest);
return response.body;
}
from alibabacloud_docmind_api20220711.client import Client as docmind_api20220711Client
from alibabacloud_tea_openapi import models as open_api_models
from alibabacloud_docmind_api20220711 import models as docmind_api20220711_models
from alibabacloud_tea_util.client import Client as UtilClient
from alibabacloud_credentials.client import Client as CredClient
if __name__ == '__main__':
cred=CredClient()
config = open_api_models.Config(
# 通過credentials獲取配置中的AccessKey ID
access_key_id=cred.get_credential().get_access_key_id(),
# 通過credentials獲取配置中的AccessKey Secret
access_key_secret=cred.get_credential().get_access_key_secret()
)
# 訪問的域名
config.endpoint = f'docmind-api.cn-hangzhou.aliyuncs.com'
client = docmind_api20220711Client(config)
request = docmind_api20220711_models.GetDocumentConvertResultRequest(
# id : 任務提交接口返回的id
id='docmind-20220902-824b****'
)
try:
# 復制代碼運行請自行打印 API 的返回值
response = client.get_document_convert_result(request)
# API返回值格式層級為 body -> data -> 具體屬性。可根據業務需要打印相應的結果。獲取屬性值均以小寫開頭
# 獲取異步任務處理情況,可根據response.body.completed判斷是否需要繼續輪詢結果
print(response.body.completed)
# 獲取返回結果。建議先把response.body.data轉成json,然后再從json里面取具體需要的值。
print(response.body)
except Exception as error:
# 如有需要,請打印 error
UtilClient.assert_as_string(error.message)
using Newtonsoft.Json;
using System;
using System.Collections;
using System.Collections.Generic;
using System.IO;
using System.Threading.Tasks;
using Tea;
using Tea.Utils;
public static void GetResult()
{
// 使用默認憑證初始化Credentials Client。
var akCredential = new Aliyun.Credentials.Client(null);
AlibabaCloud.OpenApiClient.Models.Config config = new AlibabaCloud.OpenApiClient.Models.Config
{
// 通過credentials獲取配置中的AccessKey Secret
AccessKeyId = akCredential.GetAccessKeyId(),
// 通過credentials獲取配置中的AccessKey Secret
AccessKeySecret = akCredential.GetAccessKeySecret(),
};
// 訪問的域名
config.Endpoint = "docmind-api.cn-hangzhou.aliyuncs.com";
AlibabaCloud.SDK.Docmind_api20220711.Client client = new AlibabaCloud.SDK.Docmind_api20220711.Client(config);
AlibabaCloud.SDK.Docmind_api20220711.Models.GetDocumentConvertResultRequest request = new AlibabaCloud.SDK.Docmind_api20220711.Models.GetDocumentConvertResultRequest
{
Id = "docmind-20220902-824b****"
};
AlibabaCloud.TeaUtil.Models.RuntimeOptions runtime = new AlibabaCloud.TeaUtil.Models.RuntimeOptions();
try
{
// 復制代碼運行請自行打印 API 的返回值
client.GetDocumentConvertResult(request);
}
catch (TeaException error)
{
// 如有需要,請打印 error
AlibabaCloud.TeaUtil.Common.AssertAsString(error.Message);
}
catch (Exception _error)
{
TeaException error = new TeaException(new Dictionary<string, object>
{
{ "message", _error.Message }
});
// 如有需要,請打印 error
AlibabaCloud.TeaUtil.Common.AssertAsString(error.Message);
}
}
import (
"fmt"
openClient "github.com/alibabacloud-go/darabonba-openapi/v2/client"
"github.com/alibabacloud-go/docmind-api-20220711/client"
"github.com/aliyun/credentials-go/credentials"
)
func submit(){
// 使用默認憑證初始化Credentials Client。
credential, err := credentials.NewCredential(nil)
// 通過credentials獲取配置中的AccessKey ID
accessKeyId, err := credential.GetAccessKeyId()
// 通過credentials獲取配置中的AccessKey Secret
accessKeySecret, err := credential.GetAccessKeySecret()
// 訪問的域名,支持ipv4和ipv6兩種方式,ipv6請使用docmind-api-dualstack.cn-hangzhou.aliyuncs.com
var endpoint string = "docmind-api.cn-hangzhou.aliyuncs.com"
config := openClient.Config{AccessKeyId: accessKeyId, AccessKeySecret: accessKeySecret, Endpoint: &endpoint}
// 初始化client
cli, err := client.NewClient(&config)
if err != nil {
panic(err)
}
id := "docmind-20220925-76b1****"
// 調用查詢接口
request := client.GetDocumentConvertResultRequest{Id: &id}
response, err := cli.GetDocumentConvertResult(&request)
if err != nil {
panic(err)
}
// 打印查詢結果
fmt.Println(response.Body)
//注意,使用go語言sdk會將返回結果中Url中的特殊字符&做Unicode轉碼,轉碼成\u0026,需要調用者手動將\u0026進行Unicode轉碼回&,才可以正常下載URL
//go語言sdk的Url返回示例如下http://docmind-api-cn-hangzhou.oss-cn-hangzhou.aliyuncs.com/convert/docmind-20220927-87ad**/example.pdf?Expires=XX\u0026OSSAccessKeyId=YY\u0026Signature=ZZ
}
use AlibabaCloud\SDK\Docmindapi\V20220711\Docmindapi;
use AlibabaCloud\SDK\Docmindapi\V20220711\Models\GetDocumentConvertResultRequest;
use Darabonba\OpenApi\Models\Config;
use AlibabaCloud\Tea\Utils\Utils\RuntimeOptions;
use AlibabaCloud\Tea\Exception\TeaUnableRetryError;
use AlibabaCloud\Credentials\Credential;
// 使用默認憑證初始化Credentials Client。
$bearerToken = new Credential();
$config = new Config();
// 訪問的域名,支持ipv4和ipv6兩種方式,ipv6請使用docmind-api-dualstack.cn-hangzhou.aliyuncs.com
$config->endpoint = "docmind-api.cn-hangzhou.aliyuncs.com";
// 通過credentials獲取配置中的AccessKey ID
$config->accessKeyId = $bearerToken->getCredential()->getAccessKeyId();
// 通過credentials獲取配置中的AccessKey Secret
$config->accessKeySecret = $bearerToken->getCredential()->getAccessKeySecret();
$config->type = "access_key";
$config->regionId = "cn-hangzhou";
$client = new Docmindapi($config);
$request = new GetDocumentConvertResultRequest();
$request->id = "docmind-20220902-824b****";
$runtime = new RuntimeOptions();
$runtime->maxIdleConns = 3;
$runtime->connectTimeout = 10000;
$runtime->readTimeout = 10000;
try {
$response = $client->getDocumentConvertResult($request, $runtime);
var_dump($response->toMap());
} catch (TeaUnableRetryError $e) {
var_dump($e->getMessage());
var_dump($e->getErrorInfo());
var_dump($e->getLastException());
var_dump($e->getLastRequest());
}
返回結果
返回結果有處理中、處理成功、處理失敗三種情況,分別說明每種情況的返回結果示例。
處理中的返回結果如下所示:
{ "RequestId": "2AABD2C2-D24F-12F7-875D-683A27C3****", "Completed": false, "Code": "DocProcessing", "Message": "Document processing", "HostId": "ocr-api.cn-hangzhou.aliyuncs.com", "Recommend": "https://next.api.aliyun.com/troubleshoot?q=DocProcessing&product=docmind-api" }
處理中Completed返回值為false,表示任務沒有處理結束,仍在處理中。這種情況需要繼續輪詢,直到明確返回Completed返回值為true或者超過輪詢最大時間。
處理失敗的返回結果如下所示:
{ "RequestId": "A8EF3A36-1380-1116-A39E-B377BE27****", "Completed": true, "Status": "Fail", "Code": "UrlNotLegal", "Message": "Failed to process the document. The document url you provided is not legal.", "HostId": "docmind-api.cn-hangzhou.aliyuncs.com", "Recommend": "https://next.api.aliyun.com/troubleshoot?q=IDP.UrlNotLegal&product=docmind-api" }
處理失敗Completed返回值為true,表示任務處理結束,同時Status返回值為Fail,表示處理失敗,同時會返回失敗Code和詳細原因Message。訪問錯誤碼可以查看錯誤碼詳細介紹。
處理成功的返回結果如下所示:
{ "Status": "Success", "RequestId": "73134E1A-E281-1B2C-A105-D0ECFE2D****", "Completed": true, "Data": [ { "Type": "docx", "Size": 7940, "Url": "http://docmind-api-cn-hangzhou.oss-cn-hangzhou.aliyuncs.com/convert/docmind-20220902-57de****/example.docx?Expires=1662190830&OSSAccessKeyId=XX&Signature=YY", "Md5": "36256a4c2db8e31e056aeeb8b871****" } ] }
處理成功Completed返回值為true,表示任務處理結束,同時會返回Status為字符串的Success,表示處理成功。具體的處理結果在Data節點中,Data節點是個列表,該節點只會有1個元素,如下所示為Data節點中每個元素的具體格式:
Type:轉換后文檔的文檔類型,例如該pdf轉word接口返回的是docx格式的word文檔。
Url:轉換后文檔的下載鏈接,每次查詢請求返回的Url下載鏈接的有效期為60分鐘,超期后該Url會失效,需要重新調用查詢接口拿到新的Url下載鏈接。
Size:轉換后文檔的文件大小,單位是字節,可以用于對用戶下載的轉換后文檔做合法性校驗,比較下載的轉換后文檔的文件大小和接口返回的Size是否相等。
Md5:轉換后文檔的文件Md5摘要值,可以用于對用戶下載的轉換后文檔做合法性校驗,比較下載的轉換后文檔的Md5摘要值和接口返回的Md5是否相等。