Skip to content

Commit ef187a0

Browse files
add description for language pairs
1 parent a965337 commit ef187a0

File tree

13 files changed

+41
-40
lines changed

13 files changed

+41
-40
lines changed

asposehtmlcloud/api/html_api.py

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -2323,7 +2323,7 @@ def get_recognize_and_import_to_html(self, name, **kwargs):
23232323
23242324
:param bool async: Asynchronous request
23252325
:param str name: The image file name. (required)
2326-
:param str ocr_engine_lang: OCR engine language - language
2326+
:param str ocr_engine_lang: OCR engine language - language. Allowed values is "en", "de", "fr", "ru".
23272327
:param str folder: The source image folder.
23282328
:param str storage: The source image storage.
23292329
:return: File. If the method is called asynchronously, returns the request thread.
@@ -2343,7 +2343,7 @@ def __get_recognize_and_import_to_html_with_http_info(self, name, **kwargs):
23432343
23442344
:param bool async: Asynchronous request
23452345
:param str name: The image file name. (required)
2346-
:param str ocr_engine_lang: OCR engine language - language
2346+
:param str ocr_engine_lang: OCR engine language - language. Allowed values is "en", "de", "fr", "ru".
23472347
:param str folder: The source image folder.
23482348
:param str storage: The source image storage.
23492349
:return: File. If the method is called asynchronously, returns the request thread.
@@ -2424,8 +2424,8 @@ def get_recognize_and_translate_to_html(self, name, src_lang, res_lang, **kwargs
24242424
24252425
:param bool async: Asynchronous request
24262426
:param str name: The image file name. (required)
2427-
:param str src_lang: Source language - also supposed as the OCR engine language. (required)
2428-
:param str res_lang: Result language. (required)
2427+
:param str src_lang: Source language - also supposed as the OCR engine language (required). Allowed values is "en", "de", "fr", "ru".
2428+
:param str res_lang: Result language (required). Allowed values is "en", "de", "fr", "ru".
24292429
:param str folder: The source image folder.
24302430
:param str storage: The source image storage.
24312431
:return: File. If the method is called asynchronously, returns the request thread.
@@ -2445,8 +2445,8 @@ def __get_recognize_and_translate_to_html_with_http_info(self, name, src_lang, r
24452445
24462446
:param bool async: Asynchronous request
24472447
:param str name: The image file name. (required)
2448-
:param str src_lang: Source language - also supposed as the OCR engine language. (required)
2449-
:param str res_lang: Result language. (required)
2448+
:param str src_lang: Source language - also supposed as the OCR engine language (required). Allowed values is "en", "de", "fr", "ru".
2449+
:param str res_lang: Result language (required). Allowed values is "en", "de", "fr", "ru".
24502450
:param str folder: The source image folder.
24512451
:param str storage: The source image storage.
24522452
:return: File. If the method is called asynchronously, returns the request thread.
@@ -2541,8 +2541,8 @@ def get_translate_document(self, name, src_lang, res_lang, **kwargs):
25412541
25422542
:param bool async: Asynchronous request
25432543
:param str name: Document name. (required)
2544-
:param str src_lang: Source language. (required)
2545-
:param str res_lang: Result language. (required)
2544+
:param str src_lang: Source language (required). Allowed values is "en" (alias "eng", "english"), "de" (alias "deu", "deutsch", "german"), "fr" (alias "fra", "french"), "ru" (alias "rus", "russian"), "zh", alias ("chinese").
2545+
:param str res_lang: Result language (required). Allowed values is "en" (alias "eng", "english"), "de" (alias "deu", "deutsch", "german"), "fr" (alias "fra", "french"), "ru" (alias "rus", "russian"), "zh", alias ("chinese").
25462546
:param str storage: The source document storage.
25472547
:param str folder: The source document folder.
25482548
:return: File. If the method is called asynchronously, returns the request thread.
@@ -2562,8 +2562,8 @@ def __get_translate_document_with_http_info(self, name, src_lang, res_lang, **kw
25622562
25632563
:param bool async: Asynchronous request
25642564
:param str name: Document name. (required)
2565-
:param str src_lang: Source language. (required)
2566-
:param str res_lang: Result language. (required)
2565+
:param str src_lang: Source language (required). Allowed values is "en" (alias "eng", "english"), "de" (alias "deu", "deutsch", "german"), "fr" (alias "fra", "french"), "ru" (alias "rus", "russian"), "zh", alias ("chinese").
2566+
:param str res_lang: Result language (required). Allowed values is "en" (alias "eng", "english"), "de" (alias "deu", "deutsch", "german"), "fr" (alias "fra", "french"), "ru" (alias "rus", "russian"), "zh", alias ("chinese").
25672567
:param str storage: The source document storage.
25682568
:param str folder: The source document folder.
25692569
:return: File. If the method is called asynchronously, returns the request thread.
@@ -2654,8 +2654,8 @@ def get_translate_document_by_url(self, source_url, src_lang, res_lang, **kwargs
26542654
26552655
:param bool async: Asynchronous request
26562656
:param str source_url: Source document URL. (required)
2657-
:param str src_lang: Source language. (required)
2658-
:param str res_lang: Result language. (required)
2657+
:param str src_lang: Source language (required). Allowed values is "en" (alias "eng", "english"), "de" (alias "deu", "deutsch", "german"), "fr" (alias "fra", "french"), "ru" (alias "rus", "russian"), "zh", alias ("chinese").
2658+
:param str res_lang: Result language (required). Allowed values is "en" (alias "eng", "english"), "de" (alias "deu", "deutsch", "german"), "fr" (alias "fra", "french"), "ru" (alias "rus", "russian"), "zh", alias ("chinese").
26592659
:return: File. If the method is called asynchronously, returns the request thread.
26602660
"""
26612661
kwargs['_return_http_data_only'] = True
@@ -2673,8 +2673,8 @@ def __get_translate_document_by_url_with_http_info(self, source_url, src_lang, r
26732673
26742674
:param bool async: Asynchronous request
26752675
:param str source_url: Source document URL. (required)
2676-
:param str src_lang: Source language. (required)
2677-
:param str res_lang: Result language. (required)
2676+
:param str src_lang: Source language (required). Allowed values is "en" (alias "eng", "english"), "de" (alias "deu", "deutsch", "german"), "fr" (alias "fra", "french"), "ru" (alias "rus", "russian"), "zh", alias ("chinese").
2677+
:param str res_lang: Result language (required). Allowed values is "en" (alias "eng", "english"), "de" (alias "deu", "deutsch", "german"), "fr" (alias "fra", "french"), "ru" (alias "rus", "russian"), "zh", alias ("chinese").
26782678
:return: File. If the method is called asynchronously, returns the request thread.
26792679
"""
26802680

Binary file not shown.
-1.98 KB
Binary file not shown.
1.52 KB
Binary file not shown.
-29 Bytes
Binary file not shown.

docs/html/_build/html/_modules/asposehtmlcloud/api/html_api.html

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -2334,7 +2334,7 @@ <h1>Source code for asposehtmlcloud.api.html_api</h1><div class="highlight"><pre
23342334

23352335
<span class="sd"> :param bool async: Asynchronous request</span>
23362336
<span class="sd"> :param str name: The image file name. (required)</span>
2337-
<span class="sd"> :param str ocr_engine_lang: OCR engine language - language</span>
2337+
<span class="sd"> :param str ocr_engine_lang: OCR engine language - language. Allowed values is &quot;en&quot;, &quot;de&quot;, &quot;fr&quot;, &quot;ru&quot;.</span>
23382338
<span class="sd"> :param str folder: The source image folder.</span>
23392339
<span class="sd"> :param str storage: The source image storage.</span>
23402340
<span class="sd"> :return: File. If the method is called asynchronously, returns the request thread.</span>
@@ -2354,7 +2354,7 @@ <h1>Source code for asposehtmlcloud.api.html_api</h1><div class="highlight"><pre
23542354

23552355
<span class="sd"> :param bool async: Asynchronous request</span>
23562356
<span class="sd"> :param str name: The image file name. (required)</span>
2357-
<span class="sd"> :param str ocr_engine_lang: OCR engine language - language</span>
2357+
<span class="sd"> :param str ocr_engine_lang: OCR engine language - language. Allowed values is &quot;en&quot;, &quot;de&quot;, &quot;fr&quot;, &quot;ru&quot;.</span>
23582358
<span class="sd"> :param str folder: The source image folder.</span>
23592359
<span class="sd"> :param str storage: The source image storage.</span>
23602360
<span class="sd"> :return: File. If the method is called asynchronously, returns the request thread.</span>
@@ -2435,8 +2435,8 @@ <h1>Source code for asposehtmlcloud.api.html_api</h1><div class="highlight"><pre
24352435

24362436
<span class="sd"> :param bool async: Asynchronous request</span>
24372437
<span class="sd"> :param str name: The image file name. (required)</span>
2438-
<span class="sd"> :param str src_lang: Source language - also supposed as the OCR engine language. (required)</span>
2439-
<span class="sd"> :param str res_lang: Result language. (required)</span>
2438+
<span class="sd"> :param str src_lang: Source language - also supposed as the OCR engine language (required). Allowed values is &quot;en&quot;, &quot;de&quot;, &quot;fr&quot;, &quot;ru&quot;.</span>
2439+
<span class="sd"> :param str res_lang: Result language (required). Allowed values is &quot;en&quot;, &quot;de&quot;, &quot;fr&quot;, &quot;ru&quot;.</span>
24402440
<span class="sd"> :param str folder: The source image folder.</span>
24412441
<span class="sd"> :param str storage: The source image storage.</span>
24422442
<span class="sd"> :return: File. If the method is called asynchronously, returns the request thread.</span>
@@ -2456,8 +2456,8 @@ <h1>Source code for asposehtmlcloud.api.html_api</h1><div class="highlight"><pre
24562456

24572457
<span class="sd"> :param bool async: Asynchronous request</span>
24582458
<span class="sd"> :param str name: The image file name. (required)</span>
2459-
<span class="sd"> :param str src_lang: Source language - also supposed as the OCR engine language. (required)</span>
2460-
<span class="sd"> :param str res_lang: Result language. (required)</span>
2459+
<span class="sd"> :param str src_lang: Source language - also supposed as the OCR engine language (required). Allowed values is &quot;en&quot;, &quot;de&quot;, &quot;fr&quot;, &quot;ru&quot;.</span>
2460+
<span class="sd"> :param str res_lang: Result language (required). Allowed values is &quot;en&quot;, &quot;de&quot;, &quot;fr&quot;, &quot;ru&quot;.</span>
24612461
<span class="sd"> :param str folder: The source image folder.</span>
24622462
<span class="sd"> :param str storage: The source image storage.</span>
24632463
<span class="sd"> :return: File. If the method is called asynchronously, returns the request thread.</span>
@@ -2552,8 +2552,8 @@ <h1>Source code for asposehtmlcloud.api.html_api</h1><div class="highlight"><pre
25522552

25532553
<span class="sd"> :param bool async: Asynchronous request</span>
25542554
<span class="sd"> :param str name: Document name. (required)</span>
2555-
<span class="sd"> :param str src_lang: Source language. (required)</span>
2556-
<span class="sd"> :param str res_lang: Result language. (required)</span>
2555+
<span class="sd"> :param str src_lang: Source language (required). Allowed values is &quot;en&quot; (alias &quot;eng&quot;, &quot;english&quot;), &quot;de&quot; (alias &quot;deu&quot;, &quot;deutsch&quot;, &quot;german&quot;), &quot;fr&quot; (alias &quot;fra&quot;, &quot;french&quot;), &quot;ru&quot; (alias &quot;rus&quot;, &quot;russian&quot;), &quot;zh&quot;, alias (&quot;chinese&quot;).</span>
2556+
<span class="sd"> :param str res_lang: Result language (required). Allowed values is &quot;en&quot; (alias &quot;eng&quot;, &quot;english&quot;), &quot;de&quot; (alias &quot;deu&quot;, &quot;deutsch&quot;, &quot;german&quot;), &quot;fr&quot; (alias &quot;fra&quot;, &quot;french&quot;), &quot;ru&quot; (alias &quot;rus&quot;, &quot;russian&quot;), &quot;zh&quot;, alias (&quot;chinese&quot;).</span>
25572557
<span class="sd"> :param str storage: The source document storage.</span>
25582558
<span class="sd"> :param str folder: The source document folder.</span>
25592559
<span class="sd"> :return: File. If the method is called asynchronously, returns the request thread.</span>
@@ -2573,8 +2573,8 @@ <h1>Source code for asposehtmlcloud.api.html_api</h1><div class="highlight"><pre
25732573

25742574
<span class="sd"> :param bool async: Asynchronous request</span>
25752575
<span class="sd"> :param str name: Document name. (required)</span>
2576-
<span class="sd"> :param str src_lang: Source language. (required)</span>
2577-
<span class="sd"> :param str res_lang: Result language. (required)</span>
2576+
<span class="sd"> :param str src_lang: Source language (required). Allowed values is &quot;en&quot; (alias &quot;eng&quot;, &quot;english&quot;), &quot;de&quot; (alias &quot;deu&quot;, &quot;deutsch&quot;, &quot;german&quot;), &quot;fr&quot; (alias &quot;fra&quot;, &quot;french&quot;), &quot;ru&quot; (alias &quot;rus&quot;, &quot;russian&quot;), &quot;zh&quot;, alias (&quot;chinese&quot;).</span>
2577+
<span class="sd"> :param str res_lang: Result language (required). Allowed values is &quot;en&quot; (alias &quot;eng&quot;, &quot;english&quot;), &quot;de&quot; (alias &quot;deu&quot;, &quot;deutsch&quot;, &quot;german&quot;), &quot;fr&quot; (alias &quot;fra&quot;, &quot;french&quot;), &quot;ru&quot; (alias &quot;rus&quot;, &quot;russian&quot;), &quot;zh&quot;, alias (&quot;chinese&quot;).</span>
25782578
<span class="sd"> :param str storage: The source document storage.</span>
25792579
<span class="sd"> :param str folder: The source document folder.</span>
25802580
<span class="sd"> :return: File. If the method is called asynchronously, returns the request thread.</span>
@@ -2665,8 +2665,8 @@ <h1>Source code for asposehtmlcloud.api.html_api</h1><div class="highlight"><pre
26652665

26662666
<span class="sd"> :param bool async: Asynchronous request</span>
26672667
<span class="sd"> :param str source_url: Source document URL. (required)</span>
2668-
<span class="sd"> :param str src_lang: Source language. (required)</span>
2669-
<span class="sd"> :param str res_lang: Result language. (required)</span>
2668+
<span class="sd"> :param str src_lang: Source language (required). Allowed values is &quot;en&quot; (alias &quot;eng&quot;, &quot;english&quot;), &quot;de&quot; (alias &quot;deu&quot;, &quot;deutsch&quot;, &quot;german&quot;), &quot;fr&quot; (alias &quot;fra&quot;, &quot;french&quot;), &quot;ru&quot; (alias &quot;rus&quot;, &quot;russian&quot;), &quot;zh&quot;, alias (&quot;chinese&quot;).</span>
2669+
<span class="sd"> :param str res_lang: Result language (required). Allowed values is &quot;en&quot; (alias &quot;eng&quot;, &quot;english&quot;), &quot;de&quot; (alias &quot;deu&quot;, &quot;deutsch&quot;, &quot;german&quot;), &quot;fr&quot; (alias &quot;fra&quot;, &quot;french&quot;), &quot;ru&quot; (alias &quot;rus&quot;, &quot;russian&quot;), &quot;zh&quot;, alias (&quot;chinese&quot;).</span>
26702670
<span class="sd"> :return: File. If the method is called asynchronously, returns the request thread.</span>
26712671
<span class="sd"> &quot;&quot;&quot;</span>
26722672
<span class="n">kwargs</span><span class="p">[</span><span class="s1">&#39;_return_http_data_only&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="kc">True</span>
@@ -2684,8 +2684,8 @@ <h1>Source code for asposehtmlcloud.api.html_api</h1><div class="highlight"><pre
26842684

26852685
<span class="sd"> :param bool async: Asynchronous request</span>
26862686
<span class="sd"> :param str source_url: Source document URL. (required)</span>
2687-
<span class="sd"> :param str src_lang: Source language. (required)</span>
2688-
<span class="sd"> :param str res_lang: Result language. (required)</span>
2687+
<span class="sd"> :param str src_lang: Source language (required). Allowed values is &quot;en&quot; (alias &quot;eng&quot;, &quot;english&quot;), &quot;de&quot; (alias &quot;deu&quot;, &quot;deutsch&quot;, &quot;german&quot;), &quot;fr&quot; (alias &quot;fra&quot;, &quot;french&quot;), &quot;ru&quot; (alias &quot;rus&quot;, &quot;russian&quot;), &quot;zh&quot;, alias (&quot;chinese&quot;).</span>
2688+
<span class="sd"> :param str res_lang: Result language (required). Allowed values is &quot;en&quot; (alias &quot;eng&quot;, &quot;english&quot;), &quot;de&quot; (alias &quot;deu&quot;, &quot;deutsch&quot;, &quot;german&quot;), &quot;fr&quot; (alias &quot;fra&quot;, &quot;french&quot;), &quot;ru&quot; (alias &quot;rus&quot;, &quot;russian&quot;), &quot;zh&quot;, alias (&quot;chinese&quot;).</span>
26892689
<span class="sd"> :return: File. If the method is called asynchronously, returns the request thread.</span>
26902690
<span class="sd"> &quot;&quot;&quot;</span>
26912691

docs/html/_build/html/_modules/asposehtmlcloud/configuration.html

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,7 @@ <h3>Navigation</h3>
3737

3838
<h1>Source code for asposehtmlcloud.configuration</h1><div class="highlight"><pre>
3939
<span></span><span class="c1"># coding: utf-8</span>
40+
4041
<span class="kn">from</span> <span class="nn">__future__</span> <span class="k">import</span> <span class="n">absolute_import</span>
4142
<span class="kn">import</span> <span class="nn">os</span>
4243
<span class="kn">import</span> <span class="nn">copy</span>

docs/html/_build/html/_sources/index.rst.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
.. asposehtmlcloud documentation master file, created by
2-
sphinx-quickstart on Wed Aug 29 17:39:27 2018.
2+
sphinx-quickstart on Mon Sep 17 12:52:09 2018.
33
You can adapt this file completely to your liking, but it should at least
44
contain the root `toctree` directive.
55

0 commit comments

Comments
 (0)