Upload README.md
Browse files
README.md
ADDED
|
@@ -0,0 +1,64 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
# Bayan Search API
|
| 2 |
+
|
| 3 |
+
## Supported Languages
|
| 4 |
+
|
| 5 |
+
The `search_bayan()` function supports the following values for the `target_type` parameter:
|
| 6 |
+
|
| 7 |
+
```python
|
| 8 |
+
languages = [
|
| 9 |
+
"تدقيق الايات",
|
| 10 |
+
"english",
|
| 11 |
+
"french",
|
| 12 |
+
"turkish",
|
| 13 |
+
"persian",
|
| 14 |
+
"urdu",
|
| 15 |
+
"russian",
|
| 16 |
+
"spanish",
|
| 17 |
+
"german",
|
| 18 |
+
"indonesian",
|
| 19 |
+
"malay",
|
| 20 |
+
"bengali",
|
| 21 |
+
"bosnian",
|
| 22 |
+
"portuguese",
|
| 23 |
+
"uzbek"
|
| 24 |
+
]
|
| 25 |
+
```
|
| 26 |
+
|
| 27 |
+
## Language Descriptions
|
| 28 |
+
|
| 29 |
+
| Value | Output |
|
| 30 |
+
| ------------ | ------------------------------------- |
|
| 31 |
+
| تدقيق الايات | Quran text in Uthmani script (Arabic) |
|
| 32 |
+
| english | English translation |
|
| 33 |
+
| french | French translation |
|
| 34 |
+
| turkish | Turkish translation |
|
| 35 |
+
| persian | Persian (Farsi) translation |
|
| 36 |
+
| urdu | Urdu translation |
|
| 37 |
+
| russian | Russian translation |
|
| 38 |
+
| spanish | Spanish translation |
|
| 39 |
+
| german | German translation |
|
| 40 |
+
| indonesian | Indonesian translation |
|
| 41 |
+
| malay | Malay translation |
|
| 42 |
+
| bengali | Bengali translation |
|
| 43 |
+
| bosnian | Bosnian translation |
|
| 44 |
+
| portuguese | Portuguese translation |
|
| 45 |
+
| uzbek | Uzbek translation |
|
| 46 |
+
|
| 47 |
+
## Example Usage
|
| 48 |
+
|
| 49 |
+
```python
|
| 50 |
+
result = search_bayan(
|
| 51 |
+
"ولله المشرق والمغرب فأينما تولوا فثم وجه الله",
|
| 52 |
+
target_type="english"
|
| 53 |
+
)
|
| 54 |
+
|
| 55 |
+
print(result["matched_segment"])
|
| 56 |
+
print(result["full_verse"])
|
| 57 |
+
```
|
| 58 |
+
|
| 59 |
+
## Notes
|
| 60 |
+
|
| 61 |
+
* If `target_type` is omitted, the default value is `"تدقيق الايات"`.
|
| 62 |
+
* The search engine supports fuzzy matching and can handle minor spelling mistakes.
|
| 63 |
+
* Quranic Uthmani text is returned when using `"تدقيق الايات"`.
|
| 64 |
+
* Translations are returned when using any of the supported language names above.
|