Apertium-apy - Revision history

Marcriera: /* Usage */

2025-09-21T17:24:49Z

Usage

Marcriera: Add details about language code fallback mechanism

2025-04-07T15:27:25Z

Add details about language code fallback mechanism

Marcriera: /* Usage */

2025-04-07T15:03:51Z

Usage

Marcriera: Add /pipeDebug

2025-04-07T15:01:40Z

Add /pipeDebug

Harikrishna at 19:54, 1 August 2024

2024-08-01T19:54:50Z

Harikrishna at 19:26, 1 August 2024

2024-08-01T19:26:36Z

Tino Didriksen: /* Test it! */

2020-06-05T16:36:51Z

Test it!

Tino Didriksen: /* Test it! */

2020-06-05T16:36:01Z

Test it!

Tino Didriksen: Remove Oqaa reference

2020-04-30T09:18:02Z

Remove Oqaa reference

Firespeaker: /* Please cite */

2019-11-06T03:30:44Z

Please cite

@@ Line 362: / Line 362: @@
 </pre>
 |-
-| '''/pipeDebug'''
+| '''/pipedebug'''
 | Translates text showing detailed information about the translation pipeline.
 |
@@ Line 374: / Line 374: @@
 | The returned JS Object contains a <code>responseData</code> key with an JS Object that has keys <code>output</code> and <code>pipeline</code>. <code>output</code> is an array with the initial text and the text after each module, and <code>pipeline</code> is an array of the commands and arguments used in the pipeline.
 <pre>
-$ curl 'http://localhost:2737/pipeDebug?q=test&langpair=eng|cat'
+$ curl 'http://localhost:2737/pipedebug?q=test&langpair=eng|cat'
 {"responseData":
 {"output":

@@ Line 419: / Line 419: @@
 </pre>
 |}
+== Language/pair code fallback ==
+When a request with 2-letter language codes is received, APY will match them to the corresponding 3-letter codes (e.g. <code>en-ca</code>, <code>eng-ca</code> and <code>en-cat</code> will all be matched to <code>eng-cat</code>.
+In addition, APY implements a fallback mechanism when unknown language/pair codes are requested. For example, a user may want to translate a text with the <code>eng_US-cat_ES</code> pair, but the pair installed is <code>eng-cat</code> (which could provide a valid translation). APY will look for the following pairs, in order:
+* <code>eng_US-cat_ES</code>
+* <code>eng-cat_ES</code>
+* <code>eng_US-cat</code>
+* <code>eng-cat</code>
+Fallback codes are stored in memory the first time an unknown code is requested and persist while the APY is running, so subsequent requests for a code do not trigger the checks again.
 == SSL ==

@@ Line 93: / Line 93: @@
 == Usage ==
 APY supports three types of requests: GET, POST, and JSONP. Using GET/POST are possible only if APY is running on the same server as the client due to cross-site scripting restrictions; however, JSONP requests are permitted in any context and will be useful. Using curl, APY can easily be tested:
-<code>
+<pre>
-<pre>curl -G --data "lang=kaz-tat&modes=morph&q=алдым" http://localhost:2737/perWord</pre>
+curl -G --data "lang=kaz-tat&modes=morph&q=алдым" http://localhost:2737/perWord
+</pre>
-</code> It can also be tested through your browser or through HTTP calls. Unfortunately, curl does '''not''' decode JSON output by default and to make testing easier, a APY Sandbox is provided with [[Apertium-html-tools]].
+It can also be tested through your browser or through HTTP calls. Unfortunately, curl does '''not''' decode JSON output by default and to make testing easier, a APY Sandbox is provided with [[Apertium-html-tools]].
 {| class="wikitable" border="1"

@@ Line 346: / Line 346: @@
 *'''lang''': The language of the text (String, Required, e.g., `kaz`)
 *'''spellchecker''': The spell checker to use (String, Optional, Defaults to `voikko`, e.g., `divvun`)
-| The output is a JSON array where each element represents a token from the input text. Each token includes the following information:
+| The output is an object with the key  where each element represents a token from the input text. Each token includes the following information:
 <pre>
 $ curl 'http://localhost:2737/spellCheck?q=қазақша билмеймін&lang=kaz'
@@ Line 360: / Line 360: @@
 ]
 </pre>
+|-
+| '''/pipeDebug'''
+| Translates text showing detailed information about the translation pipeline.
+|
+*'''langpair''': language pair to use for translation
+*'''q''': text to translate
+*'''markUnknown=no''' (optional): include this to remove "*" in front of unknown words
+*'''deformat''': deformatter to be used: one of html (default), txt, rtf
+*'''reformat''': deformatter to be used: one of html, html-noent (default), txt, rtf
+*'''format''': if deformatter and reformatter are the same, they can be specified here
+For more about formatting, please see [http://wiki.apertium.org/wiki/Format_handling Format Handling].
+| The returned JS Object contains a <code>responseData</code> key with an JS Object that has keys <code>output</code> and <code>pipeline</code>. <code>output</code> is an array with the initial text and the text after each module, and <code>pipeline</code> is an array of the commands and arguments used in the pipeline.
+<pre>
+$ curl 'http://localhost:2737/pipeDebug?q=test&langpair=eng|cat'
+{"responseData":
+{"output":
+  ["test",
+  "test.[]",
+  "^test/test<vblex><inf>/test<vblex><pres>/test<vblex><imp>/test<n><sg>$^./.<sent>$[]",
+  "^test/test<n><sg>$^./.<sent>$[]",
+  "^test<n><sg>$^.<sent>$[]",
+  "^test<n><sg>$^.<sent>$[]",
+  "^test<n><sg>$^.<sent>$[]",
+  "^test<n><sg>/prova<n><f><sg>$^.<sent>/.<sent>$[]",
+  "^test<n><sg>/prova<n><f><sg>$^.<sent>/.<sent>$[]",
+  "^test<n><sg>/prova<n><f><sg>/$^.<sent>/.<sent>/$[]",
+  "^nom<SN><UNDET><f><sg>{^prova<n><3><4>$}$^punt<sent>{^.<sent>$}$[]",
+  "^nom<SN><UNDET><f><sg>{^prova<n><3><4>$}$^punt<sent>{^.<sent>$}$[]",
+  "^nom<SN><UNDET><f><sg>{^prova<n><3><4>$}$^punt<sent>{^.<sent>$}$[]",
+  "^prova<n><f><sg>$^.<sent>$[]",
+  "^prova<n><f><sg>$^.<sent>$[]",
+  "^prova<n><f><sg>/prova$^.<sent>/.$[]",
+  "prova.[]",
+  "prova.[]",
+  "prova"],
+"pipeline":
+  ["apertium-deshtml",
+  ["lt-proc", "-z", "-w", "/usr/share/apertium/apertium-eng-cat/eng-cat.automorf.bin"],
+  ["cg-proc", "-z", "-w", "/usr/share/apertium/apertium-eng-cat/eng-cat.rlx.bin"],
+  ["apertium-tagger", "-z", "-g", "/usr/share/apertium/apertium-eng-cat/eng-cat.prob"],
+  ["apertium-pretransfer", "-z"],
+  ["lsx-proc", "-z", "/usr/share/apertium/apertium-eng-cat/eng-cat.autoseq.bin"],
+  ["lt-proc", "-z", "-b", "/usr/share/apertium/apertium-eng-cat/eng-cat.autobil.bin"],
+  ["lrx-proc", "-z", "-m", "/usr/share/apertium/apertium-eng-cat/eng-cat.autolex.bin"],
+  ["apertium-anaphora", "-z", "/usr/share/apertium/apertium-eng-cat/apertium-eng-cat.eng-cat.arx"],
+  ["apertium-transfer", "-z", "-b", "/usr/share/apertium/apertium-eng-cat/apertium-eng-cat.eng-cat.t1x", "/usr/share/apertium/apertium-eng-cat/eng-cat.t1x.bin"],
+  ["apertium-interchunk", "-z", "/usr/share/apertium/apertium-eng-cat/apertium-eng-cat.eng-cat.t2x", "/usr/share/apertium/apertium-eng-cat/eng-cat.t2x.bin"],
+  ["apertium-interchunk", "-z", "/usr/share/apertium/apertium-eng-cat/apertium-eng-cat.eng-cat.t3x", "/usr/share/apertium/apertium-eng-cat/eng-cat.t3x.bin"],
+  ["apertium-postchunk", "-z", "/usr/share/apertium/apertium-eng-cat/apertium-eng-cat.eng-cat.t4x", "/usr/share/apertium/apertium-eng-cat/eng-cat.t4x.bin"],
+  ["lsx-proc", "-z", "/usr/share/apertium/apertium-eng-cat/eng-cat.revautoseq.bin"],
+  ["lt-proc", "-z", "-g", "-b", "/usr/share/apertium/apertium-eng-cat/eng-cat.autogen.bin"],
+  ["cg-proc", "-z", "-n", "-g", "/usr/share/apertium/apertium-eng-cat/eng-cat.prefs.rlx.bin"],
+  ["lt-proc", "-z", "-p", "/usr/share/apertium/apertium-eng-cat/eng-cat.autopgen.bin"],
+  "apertium-rehtml-noent"]},
+"responseDetails": null,
+"responseStatus": 200}
+</pre>
 |}

@@ Line 341: / Line 341: @@
 |-
 | '''/spellCheck'''
-| Handles spell-checking requests using Voikko or Divvun spell checkers.
+| '''Note: This endpoint is not yet available in the main branch.''' Handles spell-checking requests using Voikko or Divvun spell checkers.
 |
 *'''q''': The text to be spell-checked (String, Required, e.g., `қазақша билмеймін`)

@@ Line 10: / Line 10: @@
 <pre>
 $ curl -G --data "lang=kir&modes=morph&q=алдым" https://beta.apertium.org/apy/analyse
 [["алдым/алд<n><px1sg><nom>/алд<n><px1sg><nom>+э<cop><aor><p3><pl>/алд<n><px1sg><nom>+э<cop><aor><p3><sg>/ал<v><tv><ifi><p1><sg>/ал<vaux><ifi><p1><sg>", "алдым"]]
 </pre>

@@ Line 9: / Line 9: @@
 <pre>
-$ curl -G --data "lang=kir&modes=morph&q=алдым" http://turkic.apertium.org:8080/perWord
+$ curl -G --data "lang=kir&modes=morph&q=алдым" https://beta.apertium.org/apy/analyse
-[{"input": "\u0430\u043b\u0434\u044b\u043c", "morph": ["\u0430\u043b\u0434<n><px1sg><nom>", "\u0430\u043b\u0434<n><px1sg><nom>+\u044d<cop><aor><p3><pl>", "\u0430\u043b\u0434<n><px1sg><nom>+\u044d<cop><aor><p3><sg>", "\u0430\u043b<v><iv><ifi><p1><sg>", "\u0430\u043b<v><tv><ifi><p1><sg>", "\u0430\u043b<vaux><ifi><p1><sg>"]}]
+[["алдым/алд<n><px1sg><nom>/алд<n><px1sg><nom>+э<cop><aor><p3><pl>/алд<n><px1sg><nom>+э<cop><aor><p3><sg>/ал<v><tv><ifi><p1><sg>/ал<vaux><ifi><p1><sg>", "алдым"]]
 </pre>

← Older revision		Revision as of 09:18, 30 April 2020
Line 4:		Line 4:


	The ~~http~~://apertium.org page uses ~~the~~ installation ~~at http://apy.projectjj.com~~ which currently only runs ''released'' language pairs (also available from https://~~www.~~apertium.org/apy if you prefer). However, APY is very easy to set up on your own server, where you can run all the development pairs and even analysers and taggers (like what http://turkic.apertium.org does), read on for how to do that.		The https://apertium.org page uses an installation which currently only runs ''released'' language pairs (also available from https://apertium.org/apy if you prefer). However, APY is very easy to set up on your own server, where you can run all the development pairs and even analysers and taggers (like what http://turkic.apertium.org does), read on for how to do that.

	== Test it! ==		== Test it! ==

@@ Line 637: / Line 637: @@
 [[Category:Tools]]
+[[Category:Services]]
+[[Category:Documentation]]