Skip to content

Commit 29b81f5

Browse files
add description for language pairs
1 parent b055fb8 commit 29b81f5

File tree

2 files changed

+6
-58
lines changed

2 files changed

+6
-58
lines changed

docs/OcrApi.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ apiInstance.GetRecognizeAndImportToHtml(name, opts, callback);
4343
Name | Type | Description | Notes
4444
------------- | ------------- | ------------- | -------------
4545
**name** | **String**| The image file name. |
46-
**ocrEngineLang** | **String**| OCR engine language - language | [optional] [default to en]
46+
**ocrEngineLang** | **String**| OCR engine language - language | [optional] [default to en] Allowed values is "en", "de", "fr", "ru".
4747
**folder** | **String**| The source image folder. | [optional]
4848
**storage** | **String**| The source image storage. | [optional]
4949

@@ -94,7 +94,7 @@ apiInstance.GetRecognizeAndTranslateToHtml(name, srcLang, resLang, opts, callbac
9494
Name | Type | Description | Notes
9595
------------- | ------------- | ------------- | -------------
9696
**name** | **String**| The image file name. |
97-
**srcLang** | **String**| Source language - also supposed as the OCR engine language. |
97+
**srcLang** | **String**| Source language - also supposed as the OCR engine language. | Allowed values is "en", "de", "fr", "ru".
9898
**resLang** | **String**| Result language. |
9999
**folder** | **String**| The source image folder. | [optional]
100100
**storage** | **String**| The source image storage. | [optional]

docs/TranslationApi.md

Lines changed: 4 additions & 56 deletions
Original file line numberDiff line numberDiff line change
@@ -46,8 +46,8 @@ apiInstance.GetTranslateDocument(name, srcLang, resLang, opts, callback);
4646
Name | Type | Description | Notes
4747
------------- | ------------- | ------------- | -------------
4848
**name** | **String**| Document name. |
49-
**srcLang** | **String**| Source language. |
50-
**resLang** | **String**| Result language. |
49+
**srcLang** | **String**| Source language. | Allowed values is "en" (alias "eng", "english"), "de" (alias "deu", "deutsch", "german"), "fr" (alias "fra", "french"), "ru" (alias "rus", "russian"), "zh", alias ("chinese").
50+
**resLang** | **String**| Result language. | Allowed values is "en" (alias "eng", "english"), "de" (alias "deu", "deutsch", "german"), "fr" (alias "fra", "french"), "ru" (alias "rus", "russian"), "zh", alias ("chinese").
5151
**storage** | **String**| The source document storage. | [optional]
5252
**folder** | **String**| The source document folder. | [optional]
5353

@@ -94,8 +94,8 @@ apiInstance.GetTranslateDocumentByUrl(sourceUrl, srcLang, resLang, callback);
9494
Name | Type | Description | Notes
9595
------------- | ------------- | ------------- | -------------
9696
**sourceUrl** | **String**| Source document URL. |
97-
**srcLang** | **String**| Source language. |
98-
**resLang** | **String**| Result language. |
97+
**srcLang** | **String**| Source language. | Allowed values is "en" (alias "eng", "english"), "de" (alias "deu", "deutsch", "german"), "fr" (alias "fra", "french"), "ru" (alias "rus", "russian"), "zh", alias ("chinese").
98+
**resLang** | **String**| Result language. | Allowed values is "en" (alias "eng", "english"), "de" (alias "deu", "deutsch", "german"), "fr" (alias "fra", "french"), "ru" (alias "rus", "russian"), "zh", alias ("chinese").
9999

100100
### Return type
101101

@@ -105,55 +105,3 @@ Name | Type | Description | Notes
105105

106106
- **Content-Type**: application/json
107107
- **Accept**: multipart/form-data
108-
109-
<a name="translationPutTranslateDocument"></a>
110-
# **translationPutTranslateDocument**
111-
> File translationPutTranslateDocument(name, srcLang, resLang, opts)
112-
113-
Translate the HTML document specified by the name from default or specified storage. Result document will be saved into the default or specified storage; result path will be like /{folder}/{name}_{lang_pair}.{extension}.
114-
115-
### Example
116-
```javascript
117-
var Asposehtmlcloud = require('asposehtmlcloud');
118-
119-
var apiInstance = new Asposehtmlcloud.TranslationApi();
120-
121-
var name = "name_example"; // String | Document name.
122-
123-
var srcLang = "srcLang_example"; // String | Source language.
124-
125-
var resLang = "resLang_example"; // String | Result language.
126-
127-
var opts = {
128-
'folder': "folder_example", // String | The source & result document folder.
129-
'storage': "storage_example" // String | The source & result document storage.
130-
};
131-
132-
var callback = function(error, data, response) {
133-
if (error) {
134-
console.error(error);
135-
} else {
136-
console.log('API called successfully. Returned data: ' + data);
137-
}
138-
};
139-
apiInstance.translationPutTranslateDocument(name, srcLang, resLang, opts, callback);
140-
```
141-
142-
### Parameters
143-
144-
Name | Type | Description | Notes
145-
------------- | ------------- | ------------- | -------------
146-
**name** | **String**| Document name. |
147-
**srcLang** | **String**| Source language. |
148-
**resLang** | **String**| Result language. |
149-
**folder** | **String**| The source &amp; result document folder. | [optional]
150-
**storage** | **String**| The source &amp; result document storage. | [optional]
151-
152-
### Return type
153-
154-
**File**
155-
156-
### HTTP request headers
157-
158-
- **Content-Type**: application/json
159-
- **Accept**: application/json

0 commit comments

Comments
 (0)