Giới thiệu
Module TTS là một service của Fcloud được phát triển bởi Ftech. Module sử dụng công nghệ để phân biệt các ký tự văn bản được in hoặc viết tay bên trong hình ảnh kỹ thuật số của tài liệu vật lý, chẳng hạn như tài liệu giấy được quét. Để tích hợp và sử dụng dịch vụ này phải sử dụng SDK của Fcloud. Và sau đây là hướng dân tích hợp SDK.
Xác thực
Để gọi được các API chúng ta sẽ phải init SDK tham số truyền vào là ClientID và SecretKey được lấy khi bạn tạo Application trên CMS dành cho đối tác theo hướng dẫn sau:
- Đăng nhập CMS Partner với username/password được cung cấp (https://fcloud-partner-cms.ftech.ai)
- Mua gói dịch vụ
- Tạo App
Server Integrator
Sau khi tích hợp SDK, service Fcloud hỗ trợ callback server-server giúp hỗ trợ việc lấy thông tin request nhanh và chính xác nhất.
Web SDK
Android SDK
Install SDK Android
Setup gradle maven
- Với Gradle v1.x - v5.x
Mở thư mục
build.grade
và thêm vàomaven
allprojects {
repositories {
google()
mavenCentral()
maven { url 'https://jitpack.io' } <- add this line
}
}
- Với Gradle v6.x+
Mở thư mục
build.grade
và thêm vàomaven
dependencyResolutionManagement {
repositoriesMode.set(RepositoriesMode.PREFER_SETTINGS)
repositories {
google()
mavenCentral()
maven { url 'https://jitpack.io' } <- add this line
}
}
Open file app/build.grade
then add sdk
dependencies {
...
implementation 'com.github.FTechMobile:focr-android:1.0.1'
}
Init in file Application
- Java
@Override
public void onCreate(@Nullable Bundle savedInstanceState, @Nullable PersistableBundle persistentState) {
super.onCreate(savedInstanceState, persistentState);
...
OCRManager.init(getApplicationContext());
}
- Kotlin
override fun onCreate() {
super.onCreate()
...
OCRManager.init(applicationContext)
}
SDK Android Feature
Init
Tham số | Kiểu | Mô tả |
---|---|---|
appId | String | Application id |
secretKey | String | IOE secret key |
- Java
OCRManager.initGateway(appId, secretKey, new IInitGatewayCallback() {
@Override
public void onSuccess() {
}
@Override
public void onFail(@Nullable AppException error) {
}
});
- Kotlin
OCRManager.initGateway(appId, secretKey, object : IInitGatewayCallback {
override fun onSuccess() {
}
override fun onFail(error: AppException?) {
}
})
Register callback
Sau khi đăng ký, SDK sẽ trả về trạng thái tương ứng trong callback
Trạng thái | Mô tả |
---|---|
onStart | Được gọi khi bắt đầu |
onSuccess | Được gọi khi trả về kết quả |
onFail | Được gọi khi xảy ra lỗi trong quá trình |
- Java
OCRManager.registerOCRCallback(new IOCRCallback() {
@Override
public void onStart() {
}
@Override
public void onFail(@Nullable AppException error) {
}
@Override
public void onSuccess(@NonNull OCRData result) {
}
});
- Kotlin
OCRManager.registerOCRCallback(object : IOCRCallback {
override fun onStart() {
}
override fun onFail(error: AppException?) {
}
override fun onSuccess(result: OCRData) {
})
})
Get config
- Nhận danh sách cấu hình được sử dụng cho thông số ocr
- Khi thành công, kết quả
listConfig
, nó sẽ được trả ởonSuccess()
callback Khi thất bại,
onFail()
callback sẽ được gọiJava
OCRManager.getConfig(new IOCRConfigCallback() {
@Override
public void onSuccess(@NonNull List<OCRConfigData> listConfig) {
}
@Override
public void onFail(@Nullable AppException error) {
}
});
- Kotlin
OCRManager.getConfig(object : IOCRConfigCallback {
override fun onSuccess(listConfig: List<OCRConfigData>) {
}
override fun onFail(error: AppException?) {
}
})
Start
- Được sử dụng để khởi động OCR
- Khi bắt đầu thành công,
onStart()
callback sẽ được gọi - Khi có kết quả
result
sẽ được trả về trênonSuccess()
callback Khi không thành công,
onFail()
callback sẽ được gọiJava
//use file
OCRManager.startOCR(documentType, responseFormat, toMathMl, file);
...
//use file path
OCRManager.startOCR(documentType, responseFormat, toMathMl, absoluteFilePath);
- Kotlin
//use file
OCRManager.startOCR(documentType, responseFormat, toMathMl, file)
...
//use file path
OCRManager.startOCR(documentType, responseFormat, toMathMl, absoluteFilePath)
Export data
- Được sử dụng để xuất dữ liệu OCR sang tệp csv hoặc excel
- Khi xuất thành công
data
sẽ được trả vềonSuccess()
callback - Khi không thành công,
onFail()
callback sẽ được gọi
Param | Description |
---|---|
requestId | Request id |
exportType | Loại tệp dữ liệu (OCRExportType.CSV, OCRExportType.EXCEL) |
- Java
OCRManager.export(requestId, exportType, new IExportCallback() {
@Override
public void onSuccess(@NonNull String data) {
}
@Override
public void onFail(@Nullable AppException error) {
}
});
- Kotlin
OCRManager.export(requestId, exportType, object : IExportCallback {
override fun onSuccess(data: String) {
}
override fun onFail(error: AppException?) {
}
})
UI Preview OCR data
<ai.ftech.focrsdk.sdk.FOCRView
android:id="@+id/ocrView"
android:layout_width="match_parent"
android:layout_height="match_parent" />
Sau đó đặt OCRData từ onSuccess để xem
ocrView.setData(ocrData)
IOS SDK
Install SDK IOS
[IOS] SDK FOCR Hỗ trợ các thiết bị có Apple Neural Engine trong iOS 14 và iPadOS 14, đồng thời yêu cầu thiết bị có camera TrueDepth trên iOS 13 và iPadOS 13 trở xuống
Add package dependencies
https://github.com/FTechMobile/focr-sdk-ios.git
SDK IOS Integration
Init
Tham số | Kiểu | Mô tả |
---|---|---|
appId | String | Application id |
key | String | Secret key |
FtechOCRManager.instance().initSDK(appID: "103211", key: "dbfabc2ebf87889ec1e580e5de07b85e") {
//Handle success
} onFailure: { error in
// Handle Failure
}
SDK IOS Feature
Get config
- Nhận danh sách cấu hình được sử dụng để đưa vào tham số ocr
- Khi thành công, kết quả là
ConfigData
, nó sẽ được gọi trênonSuccess()
callback - Khi thất bại, nó sẽ gọi
onFailure()
callback
FtechOCRManager.instance().getConfig { listConfig in
//Handle success
} onFailure: { error in
//Handle Failure
}
Start OCR
Tham số | Kiểu | Mô tả |
---|---|---|
file | URL | URL phải trỏ đến tài nguyên mà người quản lý OCR có thể truy cập và đọc |
config | ConfigMode | Loại và giá trị chính xác mà tham số này có thể nhận sẽ phụ thuộc vào việc triển khai OCR |
FtechOCRManager.instance().startOCR(with: URL, config) { data in
} onFailure: { error in
//Handle Failure
}
Export file
Tham số | Kiểu | Mô tả |
---|---|---|
requestID | String | Được lấy trong CORData |
fileType | String | Hỗ trợ 2 định dạng csv, excel |
FtechOCRManager.instance().export(with: requestID, fileType: String) { data in
// Handle success
} onFailure: { error in
//Handle Failure
}
UI Preview OCR data
- Implement
FOCRViewController
với dữ liệuOCRData