nc-py-api 0.16.0__py3-none-any.whl → 0.17.0__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- nc_py_api/_version.py +1 -1
- nc_py_api/ex_app/providers/providers.py +0 -21
- nc_py_api/talk_bot.py +5 -0
- {nc_py_api-0.16.0.dist-info → nc_py_api-0.17.0.dist-info}/METADATA +15 -16
- {nc_py_api-0.16.0.dist-info → nc_py_api-0.17.0.dist-info}/RECORD +8 -11
- nc_py_api/ex_app/providers/speech_to_text.py +0 -128
- nc_py_api/ex_app/providers/text_processing.py +0 -135
- nc_py_api/ex_app/providers/translations.py +0 -165
- {nc_py_api-0.16.0.dist-info → nc_py_api-0.17.0.dist-info}/WHEEL +0 -0
- {nc_py_api-0.16.0.dist-info → nc_py_api-0.17.0.dist-info}/licenses/AUTHORS +0 -0
- {nc_py_api-0.16.0.dist-info → nc_py_api-0.17.0.dist-info}/licenses/LICENSE.txt +0 -0
nc_py_api/_version.py
CHANGED
|
@@ -1,45 +1,24 @@
|
|
|
1
1
|
"""Nextcloud API for AI Providers."""
|
|
2
2
|
|
|
3
3
|
from ..._session import AsyncNcSessionApp, NcSessionApp
|
|
4
|
-
from .speech_to_text import _AsyncSpeechToTextProviderAPI, _SpeechToTextProviderAPI
|
|
5
4
|
from .task_processing import _AsyncTaskProcessingProviderAPI, _TaskProcessingProviderAPI
|
|
6
|
-
from .text_processing import _AsyncTextProcessingProviderAPI, _TextProcessingProviderAPI
|
|
7
|
-
from .translations import _AsyncTranslationsProviderAPI, _TranslationsProviderAPI
|
|
8
5
|
|
|
9
6
|
|
|
10
7
|
class ProvidersApi:
|
|
11
8
|
"""Class that encapsulates all AI Providers functionality."""
|
|
12
9
|
|
|
13
|
-
speech_to_text: _SpeechToTextProviderAPI
|
|
14
|
-
"""SpeechToText Provider API."""
|
|
15
|
-
text_processing: _TextProcessingProviderAPI
|
|
16
|
-
"""TextProcessing Provider API."""
|
|
17
|
-
translations: _TranslationsProviderAPI
|
|
18
|
-
"""Translations Provider API."""
|
|
19
10
|
task_processing: _TaskProcessingProviderAPI
|
|
20
11
|
"""TaskProcessing Provider API."""
|
|
21
12
|
|
|
22
13
|
def __init__(self, session: NcSessionApp):
|
|
23
|
-
self.speech_to_text = _SpeechToTextProviderAPI(session)
|
|
24
|
-
self.text_processing = _TextProcessingProviderAPI(session)
|
|
25
|
-
self.translations = _TranslationsProviderAPI(session)
|
|
26
14
|
self.task_processing = _TaskProcessingProviderAPI(session)
|
|
27
15
|
|
|
28
16
|
|
|
29
17
|
class AsyncProvidersApi:
|
|
30
18
|
"""Class that encapsulates all AI Providers functionality."""
|
|
31
19
|
|
|
32
|
-
speech_to_text: _AsyncSpeechToTextProviderAPI
|
|
33
|
-
"""SpeechToText Provider API."""
|
|
34
|
-
text_processing: _AsyncTextProcessingProviderAPI
|
|
35
|
-
"""TextProcessing Provider API."""
|
|
36
|
-
translations: _AsyncTranslationsProviderAPI
|
|
37
|
-
"""Translations Provider API."""
|
|
38
20
|
task_processing: _AsyncTaskProcessingProviderAPI
|
|
39
21
|
"""TaskProcessing Provider API."""
|
|
40
22
|
|
|
41
23
|
def __init__(self, session: AsyncNcSessionApp):
|
|
42
|
-
self.speech_to_text = _AsyncSpeechToTextProviderAPI(session)
|
|
43
|
-
self.text_processing = _AsyncTextProcessingProviderAPI(session)
|
|
44
|
-
self.translations = _AsyncTranslationsProviderAPI(session)
|
|
45
24
|
self.task_processing = _AsyncTaskProcessingProviderAPI(session)
|
nc_py_api/talk_bot.py
CHANGED
|
@@ -29,6 +29,11 @@ class TalkBotMessage:
|
|
|
29
29
|
def __init__(self, raw_data: dict):
|
|
30
30
|
self._raw_data = raw_data
|
|
31
31
|
|
|
32
|
+
@property
|
|
33
|
+
def message_type(self) -> str:
|
|
34
|
+
"""The type of message like Join, Leave, Create, Activity, etc."""
|
|
35
|
+
return self._raw_data["type"]
|
|
36
|
+
|
|
32
37
|
@property
|
|
33
38
|
def actor_id(self) -> str:
|
|
34
39
|
"""One of the attendee types followed by the ``/`` character and a unique identifier within the given type.
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
Metadata-Version: 2.3
|
|
2
2
|
Name: nc-py-api
|
|
3
|
-
Version: 0.
|
|
3
|
+
Version: 0.17.0
|
|
4
4
|
Summary: Nextcloud Python Framework
|
|
5
5
|
Project-URL: Changelog, https://github.com/cloud-py-api/nc_py_api/blob/main/CHANGELOG.md
|
|
6
6
|
Project-URL: Documentation, https://cloud-py-api.github.io/nc_py_api/
|
|
@@ -101,23 +101,22 @@ Python library that provides a robust and well-documented API that allows develo
|
|
|
101
101
|
* **Sync + Async**: Provides both sync and async APIs.
|
|
102
102
|
|
|
103
103
|
### Capabilities
|
|
104
|
-
| **_Capability_**
|
|
105
|
-
|
|
106
|
-
| Calendar
|
|
107
|
-
| File System & Tags
|
|
108
|
-
| Nextcloud Talk
|
|
109
|
-
| Notifications
|
|
110
|
-
| Shares
|
|
111
|
-
| Users & Groups
|
|
112
|
-
| User & Weather status
|
|
113
|
-
| Other APIs
|
|
114
|
-
| Talk Bot API*
|
|
115
|
-
| Settings UI API*
|
|
116
|
-
|
|
|
104
|
+
| **_Capability_** | Nextcloud 27 | Nextcloud 28 | Nextcloud 29 | Nextcloud 30 |
|
|
105
|
+
|------------------------------|:------------:|:------------:|:------------:|:------------:|
|
|
106
|
+
| Calendar | ✅ | ✅ | ✅ | ✅ |
|
|
107
|
+
| File System & Tags | ✅ | ✅ | ✅ | ✅ |
|
|
108
|
+
| Nextcloud Talk | ✅ | ✅ | ✅ | ✅ |
|
|
109
|
+
| Notifications | ✅ | ✅ | ✅ | ✅ |
|
|
110
|
+
| Shares | ✅ | ✅ | ✅ | ✅ |
|
|
111
|
+
| Users & Groups | ✅ | ✅ | ✅ | ✅ |
|
|
112
|
+
| User & Weather status | ✅ | ✅ | ✅ | ✅ |
|
|
113
|
+
| Other APIs** | ✅ | ✅ | ✅ | ✅ |
|
|
114
|
+
| Talk Bot API* | ✅ | ✅ | ✅ | ✅ |
|
|
115
|
+
| Settings UI API* | N/A | N/A | ✅ | ✅ |
|
|
116
|
+
| TaskProcessing Provider API* | N/A | N/A | N/A | ✅ |
|
|
117
117
|
|
|
118
118
|
*_available only for **NextcloudApp**_<br>
|
|
119
|
-
**
|
|
120
|
-
***_Activity, Notes_
|
|
119
|
+
**_Activity, Notes_
|
|
121
120
|
|
|
122
121
|
### Differences between the Nextcloud and NextcloudApp classes
|
|
123
122
|
|
|
@@ -7,7 +7,7 @@ nc_py_api/_preferences_ex.py,sha256=tThj6U0ZZMaBZ-jUkjrbaI0xDnafWsBowQKsC6gjOQs,
|
|
|
7
7
|
nc_py_api/_session.py,sha256=iFv8_xkPA_erhUNvSvjUJvhKL3yCnq2xHNkL8PHLbrA,20180
|
|
8
8
|
nc_py_api/_talk_api.py,sha256=0Uo7OduYniuuX3UQPb468RyGJJ-PWBCgJ5HoPuz5Qa0,51068
|
|
9
9
|
nc_py_api/_theming.py,sha256=hTr3nuOemSuRFZaPy9iXNmBM7rDgQHECH43tHMWGqEY,1870
|
|
10
|
-
nc_py_api/_version.py,sha256=
|
|
10
|
+
nc_py_api/_version.py,sha256=_pjKF0hkoXonN1SDrjQ6d8jqIlDIO7d7dM2a4Dh-wog,52
|
|
11
11
|
nc_py_api/activity.py,sha256=t9VDSnnaXRNOvALqOSGCeXSQZ-426pCOMSfQ96JHys4,9574
|
|
12
12
|
nc_py_api/apps.py,sha256=tc3Qg-V7au0inUQGOv1Mj7Td5sEGiHOjCjRq1mN41x0,9763
|
|
13
13
|
nc_py_api/calendar.py,sha256=-T6CJ8cRbJZTLtxSEDWuuYpD29DMJGCTfLONmtxZV9w,1445
|
|
@@ -17,7 +17,7 @@ nc_py_api/notes.py,sha256=ljO3TOe-Qg0bJ0mlFQwjg--Pxmj-XFknoLbcbJmII0A,15106
|
|
|
17
17
|
nc_py_api/notifications.py,sha256=WgzV21TuLOhLk-UEjhBSbMsIi2isa5MmAx6cbe0pc2Y,9187
|
|
18
18
|
nc_py_api/options.py,sha256=K5co-fIfFVbwF6r3sqWsJF3cKgAbS2CjLAXdyTOkP9s,1717
|
|
19
19
|
nc_py_api/talk.py,sha256=OZFemYkDOaM6o4xAK3EvQbjMFiK75E5qnsCDyihIElg,29368
|
|
20
|
-
nc_py_api/talk_bot.py,sha256=
|
|
20
|
+
nc_py_api/talk_bot.py,sha256=_RuImwb3jYvUKX3ywcX095ucOjECCxsuc59heIxNoTM,16725
|
|
21
21
|
nc_py_api/user_status.py,sha256=I101nwYS8X1WvC8AnLa2f3qJUCPDPHrbq-ke0h1VT4E,13282
|
|
22
22
|
nc_py_api/users.py,sha256=ixMHBFJtrlvqmZqJ73VdbOZ6CbRnppdsRpjIJnMUtYY,15488
|
|
23
23
|
nc_py_api/users_groups.py,sha256=IPxw-Ks5NjCm6r8_HC9xmf3IYptH00ulITbp5iazhAo,6289
|
|
@@ -32,11 +32,8 @@ nc_py_api/ex_app/occ_commands.py,sha256=hb2BJuvFKIigvLycSCyAe9v6hedq4Gfu2junQZTa
|
|
|
32
32
|
nc_py_api/ex_app/persist_transformers_cache.py,sha256=ZoEBb1RnNaQrtxK_CjSZ8LZ36Oakz2Xciau_ZpNp8Ic,213
|
|
33
33
|
nc_py_api/ex_app/uvicorn_fastapi.py,sha256=WLtNmWXMBKN6CMip2uhKcgy4mC2Ch9AmNfwRScBUsP0,752
|
|
34
34
|
nc_py_api/ex_app/providers/__init__.py,sha256=jmUBdbAgzUCdYyHl8V5UCNYJI-FFpxPQQ4iEAoURKQs,43
|
|
35
|
-
nc_py_api/ex_app/providers/providers.py,sha256=
|
|
36
|
-
nc_py_api/ex_app/providers/speech_to_text.py,sha256=JFD1ksdhXjpr5UFm5npqCxepqB5x-kdHG9CpPoGofx0,4959
|
|
35
|
+
nc_py_api/ex_app/providers/providers.py,sha256=uGo02dXpxlMOtBpPr_gH4ZPt7foQx_MB5iTlJHEllNA,786
|
|
37
36
|
nc_py_api/ex_app/providers/task_processing.py,sha256=h-H3fGK30c9M-VUpk7I9WGc730t9OCoSZ6vf7lB7xdA,9874
|
|
38
|
-
nc_py_api/ex_app/providers/text_processing.py,sha256=VUZMZ2fof-c6JD7mTKHTZBWbDMOqxDllMCNQFOlHXXk,5265
|
|
39
|
-
nc_py_api/ex_app/providers/translations.py,sha256=io8UgVhdQXFmP7KnrJQx5Vtl8Dz0Z0EVZ0bt3hV7C7A,6112
|
|
40
37
|
nc_py_api/ex_app/ui/__init__.py,sha256=jUMU7_miFF-Q8BQNT90KZYQiLy_a3OvEyK6y8eRMKRk,38
|
|
41
38
|
nc_py_api/ex_app/ui/files_actions.py,sha256=pKe0VSSy5Zl0NwPe8rwdL_NL374n-0_XBf6M5HmKoIU,7384
|
|
42
39
|
nc_py_api/ex_app/ui/resources.py,sha256=Vwx69oZ93Ouh6HJtGUqaKFUr4Reo74H4vT1YCpb-7j0,12492
|
|
@@ -48,8 +45,8 @@ nc_py_api/files/_files.py,sha256=_s_f8xbzQPEH2F2LNwomI9CxscYHryus1pMZ_vW00C4,136
|
|
|
48
45
|
nc_py_api/files/files.py,sha256=DuAMkfmRGtNJntMIo-yEYhZ-a3KhhhnwKATcGqpxJL4,24569
|
|
49
46
|
nc_py_api/files/files_async.py,sha256=rEIT6P1Pb7TeTub1dAB5IKpR4LDqHWc5LclAEzpiHEQ,25410
|
|
50
47
|
nc_py_api/files/sharing.py,sha256=VRZCl-TYK6dbu9rUHPs3_jcVozu1EO8bLGZwoRpiLsU,14439
|
|
51
|
-
nc_py_api-0.
|
|
52
|
-
nc_py_api-0.
|
|
53
|
-
nc_py_api-0.
|
|
54
|
-
nc_py_api-0.
|
|
55
|
-
nc_py_api-0.
|
|
48
|
+
nc_py_api-0.17.0.dist-info/METADATA,sha256=PbVWj54KBmHs3Q2_Eqnw2CAQZADlj46RX50mGEu_JU8,9455
|
|
49
|
+
nc_py_api-0.17.0.dist-info/WHEEL,sha256=1yFddiXMmvYK7QYTqtRNtX66WJ0Mz8PYEiEUoOUUxRY,87
|
|
50
|
+
nc_py_api-0.17.0.dist-info/licenses/AUTHORS,sha256=Y1omFHyI8ned9k4jJXs2ATgmgi1GmQ7EZ6S1gxqnX2k,572
|
|
51
|
+
nc_py_api-0.17.0.dist-info/licenses/LICENSE.txt,sha256=OLEMh401fAumGHfRSna365MLIfnjdTcdOHZ6QOzMjkg,1551
|
|
52
|
+
nc_py_api-0.17.0.dist-info/RECORD,,
|
|
@@ -1,128 +0,0 @@
|
|
|
1
|
-
"""Nextcloud API for declaring SpeechToText provider."""
|
|
2
|
-
|
|
3
|
-
import contextlib
|
|
4
|
-
import dataclasses
|
|
5
|
-
|
|
6
|
-
from ..._exceptions import NextcloudException, NextcloudExceptionNotFound
|
|
7
|
-
from ..._misc import require_capabilities
|
|
8
|
-
from ..._session import AsyncNcSessionApp, NcSessionApp
|
|
9
|
-
|
|
10
|
-
_EP_SUFFIX: str = "ai_provider/speech_to_text"
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
@dataclasses.dataclass
|
|
14
|
-
class SpeechToTextProvider:
|
|
15
|
-
"""Speech2Text provider description."""
|
|
16
|
-
|
|
17
|
-
def __init__(self, raw_data: dict):
|
|
18
|
-
self._raw_data = raw_data
|
|
19
|
-
|
|
20
|
-
@property
|
|
21
|
-
def name(self) -> str:
|
|
22
|
-
"""Unique ID for the provider."""
|
|
23
|
-
return self._raw_data["name"]
|
|
24
|
-
|
|
25
|
-
@property
|
|
26
|
-
def display_name(self) -> str:
|
|
27
|
-
"""Providers display name."""
|
|
28
|
-
return self._raw_data["display_name"]
|
|
29
|
-
|
|
30
|
-
@property
|
|
31
|
-
def action_handler(self) -> str:
|
|
32
|
-
"""Relative ExApp url which will be called by Nextcloud."""
|
|
33
|
-
return self._raw_data["action_handler"]
|
|
34
|
-
|
|
35
|
-
def __repr__(self):
|
|
36
|
-
return f"<{self.__class__.__name__} name={self.name}, handler={self.action_handler}>"
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
class _SpeechToTextProviderAPI:
|
|
40
|
-
"""API for Speech2Text providers, avalaible as **nc.providers.text_processing.<method>**."""
|
|
41
|
-
|
|
42
|
-
def __init__(self, session: NcSessionApp):
|
|
43
|
-
self._session = session
|
|
44
|
-
|
|
45
|
-
def register(self, name: str, display_name: str, callback_url: str) -> None:
|
|
46
|
-
"""Registers or edit the SpeechToText provider."""
|
|
47
|
-
require_capabilities("app_api", self._session.capabilities)
|
|
48
|
-
params = {
|
|
49
|
-
"name": name,
|
|
50
|
-
"displayName": display_name,
|
|
51
|
-
"actionHandler": callback_url,
|
|
52
|
-
}
|
|
53
|
-
self._session.ocs("POST", f"{self._session.ae_url}/{_EP_SUFFIX}", json=params)
|
|
54
|
-
|
|
55
|
-
def unregister(self, name: str, not_fail=True) -> None:
|
|
56
|
-
"""Removes SpeechToText provider."""
|
|
57
|
-
require_capabilities("app_api", self._session.capabilities)
|
|
58
|
-
try:
|
|
59
|
-
self._session.ocs("DELETE", f"{self._session.ae_url}/{_EP_SUFFIX}", params={"name": name})
|
|
60
|
-
except NextcloudExceptionNotFound as e:
|
|
61
|
-
if not not_fail:
|
|
62
|
-
raise e from None
|
|
63
|
-
|
|
64
|
-
def get_entry(self, name: str) -> SpeechToTextProvider | None:
|
|
65
|
-
"""Get information of the SpeechToText."""
|
|
66
|
-
require_capabilities("app_api", self._session.capabilities)
|
|
67
|
-
try:
|
|
68
|
-
return SpeechToTextProvider(
|
|
69
|
-
self._session.ocs("GET", f"{self._session.ae_url}/{_EP_SUFFIX}", params={"name": name})
|
|
70
|
-
)
|
|
71
|
-
except NextcloudExceptionNotFound:
|
|
72
|
-
return None
|
|
73
|
-
|
|
74
|
-
def report_result(self, task_id: int, result: str = "", error: str = "") -> None:
|
|
75
|
-
"""Report results of speech to text task to Nextcloud."""
|
|
76
|
-
require_capabilities("app_api", self._session.capabilities)
|
|
77
|
-
with contextlib.suppress(NextcloudException):
|
|
78
|
-
self._session.ocs(
|
|
79
|
-
"PUT",
|
|
80
|
-
f"{self._session.ae_url}/{_EP_SUFFIX}",
|
|
81
|
-
json={"taskId": task_id, "result": result, "error": error},
|
|
82
|
-
)
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
class _AsyncSpeechToTextProviderAPI:
|
|
86
|
-
"""Async API for Speech2Text providers."""
|
|
87
|
-
|
|
88
|
-
def __init__(self, session: AsyncNcSessionApp):
|
|
89
|
-
self._session = session
|
|
90
|
-
|
|
91
|
-
async def register(self, name: str, display_name: str, callback_url: str) -> None:
|
|
92
|
-
"""Registers or edit the SpeechToText provider."""
|
|
93
|
-
require_capabilities("app_api", await self._session.capabilities)
|
|
94
|
-
params = {
|
|
95
|
-
"name": name,
|
|
96
|
-
"displayName": display_name,
|
|
97
|
-
"actionHandler": callback_url,
|
|
98
|
-
}
|
|
99
|
-
await self._session.ocs("POST", f"{self._session.ae_url}/{_EP_SUFFIX}", json=params)
|
|
100
|
-
|
|
101
|
-
async def unregister(self, name: str, not_fail=True) -> None:
|
|
102
|
-
"""Removes SpeechToText provider."""
|
|
103
|
-
require_capabilities("app_api", await self._session.capabilities)
|
|
104
|
-
try:
|
|
105
|
-
await self._session.ocs("DELETE", f"{self._session.ae_url}/{_EP_SUFFIX}", params={"name": name})
|
|
106
|
-
except NextcloudExceptionNotFound as e:
|
|
107
|
-
if not not_fail:
|
|
108
|
-
raise e from None
|
|
109
|
-
|
|
110
|
-
async def get_entry(self, name: str) -> SpeechToTextProvider | None:
|
|
111
|
-
"""Get information of the SpeechToText."""
|
|
112
|
-
require_capabilities("app_api", await self._session.capabilities)
|
|
113
|
-
try:
|
|
114
|
-
return SpeechToTextProvider(
|
|
115
|
-
await self._session.ocs("GET", f"{self._session.ae_url}/{_EP_SUFFIX}", params={"name": name})
|
|
116
|
-
)
|
|
117
|
-
except NextcloudExceptionNotFound:
|
|
118
|
-
return None
|
|
119
|
-
|
|
120
|
-
async def report_result(self, task_id: int, result: str = "", error: str = "") -> None:
|
|
121
|
-
"""Report results of speech to text task to Nextcloud."""
|
|
122
|
-
require_capabilities("app_api", await self._session.capabilities)
|
|
123
|
-
with contextlib.suppress(NextcloudException):
|
|
124
|
-
await self._session.ocs(
|
|
125
|
-
"PUT",
|
|
126
|
-
f"{self._session.ae_url}/{_EP_SUFFIX}",
|
|
127
|
-
json={"taskId": task_id, "result": result, "error": error},
|
|
128
|
-
)
|
|
@@ -1,135 +0,0 @@
|
|
|
1
|
-
"""Nextcloud API for declaring TextProcessing provider."""
|
|
2
|
-
|
|
3
|
-
import contextlib
|
|
4
|
-
import dataclasses
|
|
5
|
-
|
|
6
|
-
from ..._exceptions import NextcloudException, NextcloudExceptionNotFound
|
|
7
|
-
from ..._misc import require_capabilities
|
|
8
|
-
from ..._session import AsyncNcSessionApp, NcSessionApp
|
|
9
|
-
|
|
10
|
-
_EP_SUFFIX: str = "ai_provider/text_processing"
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
@dataclasses.dataclass
|
|
14
|
-
class TextProcessingProvider:
|
|
15
|
-
"""TextProcessing provider description."""
|
|
16
|
-
|
|
17
|
-
def __init__(self, raw_data: dict):
|
|
18
|
-
self._raw_data = raw_data
|
|
19
|
-
|
|
20
|
-
@property
|
|
21
|
-
def name(self) -> str:
|
|
22
|
-
"""Unique ID for the provider."""
|
|
23
|
-
return self._raw_data["name"]
|
|
24
|
-
|
|
25
|
-
@property
|
|
26
|
-
def display_name(self) -> str:
|
|
27
|
-
"""Providers display name."""
|
|
28
|
-
return self._raw_data["display_name"]
|
|
29
|
-
|
|
30
|
-
@property
|
|
31
|
-
def action_handler(self) -> str:
|
|
32
|
-
"""Relative ExApp url which will be called by Nextcloud."""
|
|
33
|
-
return self._raw_data["action_handler"]
|
|
34
|
-
|
|
35
|
-
@property
|
|
36
|
-
def task_type(self) -> str:
|
|
37
|
-
"""The TaskType provided by this provider."""
|
|
38
|
-
return self._raw_data["task_type"]
|
|
39
|
-
|
|
40
|
-
def __repr__(self):
|
|
41
|
-
return f"<{self.__class__.__name__} name={self.name}, type={self.task_type}, handler={self.action_handler}>"
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
class _TextProcessingProviderAPI:
|
|
45
|
-
"""API for TextProcessing providers, avalaible as **nc.providers.speech_to_text.<method>**."""
|
|
46
|
-
|
|
47
|
-
def __init__(self, session: NcSessionApp):
|
|
48
|
-
self._session = session
|
|
49
|
-
|
|
50
|
-
def register(self, name: str, display_name: str, callback_url: str, task_type: str) -> None:
|
|
51
|
-
"""Registers or edit the TextProcessing provider."""
|
|
52
|
-
require_capabilities("app_api", self._session.capabilities)
|
|
53
|
-
params = {
|
|
54
|
-
"name": name,
|
|
55
|
-
"displayName": display_name,
|
|
56
|
-
"actionHandler": callback_url,
|
|
57
|
-
"taskType": task_type,
|
|
58
|
-
}
|
|
59
|
-
self._session.ocs("POST", f"{self._session.ae_url}/{_EP_SUFFIX}", json=params)
|
|
60
|
-
|
|
61
|
-
def unregister(self, name: str, not_fail=True) -> None:
|
|
62
|
-
"""Removes TextProcessing provider."""
|
|
63
|
-
require_capabilities("app_api", self._session.capabilities)
|
|
64
|
-
try:
|
|
65
|
-
self._session.ocs("DELETE", f"{self._session.ae_url}/{_EP_SUFFIX}", params={"name": name})
|
|
66
|
-
except NextcloudExceptionNotFound as e:
|
|
67
|
-
if not not_fail:
|
|
68
|
-
raise e from None
|
|
69
|
-
|
|
70
|
-
def get_entry(self, name: str) -> TextProcessingProvider | None:
|
|
71
|
-
"""Get information of the TextProcessing."""
|
|
72
|
-
require_capabilities("app_api", self._session.capabilities)
|
|
73
|
-
try:
|
|
74
|
-
return TextProcessingProvider(
|
|
75
|
-
self._session.ocs("GET", f"{self._session.ae_url}/{_EP_SUFFIX}", params={"name": name})
|
|
76
|
-
)
|
|
77
|
-
except NextcloudExceptionNotFound:
|
|
78
|
-
return None
|
|
79
|
-
|
|
80
|
-
def report_result(self, task_id: int, result: str = "", error: str = "") -> None:
|
|
81
|
-
"""Report results of the text processing to Nextcloud."""
|
|
82
|
-
require_capabilities("app_api", self._session.capabilities)
|
|
83
|
-
with contextlib.suppress(NextcloudException):
|
|
84
|
-
self._session.ocs(
|
|
85
|
-
"PUT",
|
|
86
|
-
f"{self._session.ae_url}/{_EP_SUFFIX}",
|
|
87
|
-
json={"taskId": task_id, "result": result, "error": error},
|
|
88
|
-
)
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
class _AsyncTextProcessingProviderAPI:
|
|
92
|
-
"""Async API for TextProcessing providers."""
|
|
93
|
-
|
|
94
|
-
def __init__(self, session: AsyncNcSessionApp):
|
|
95
|
-
self._session = session
|
|
96
|
-
|
|
97
|
-
async def register(self, name: str, display_name: str, callback_url: str, task_type: str) -> None:
|
|
98
|
-
"""Registers or edit the TextProcessing provider."""
|
|
99
|
-
require_capabilities("app_api", await self._session.capabilities)
|
|
100
|
-
params = {
|
|
101
|
-
"name": name,
|
|
102
|
-
"displayName": display_name,
|
|
103
|
-
"actionHandler": callback_url,
|
|
104
|
-
"taskType": task_type,
|
|
105
|
-
}
|
|
106
|
-
await self._session.ocs("POST", f"{self._session.ae_url}/{_EP_SUFFIX}", json=params)
|
|
107
|
-
|
|
108
|
-
async def unregister(self, name: str, not_fail=True) -> None:
|
|
109
|
-
"""Removes TextProcessing provider."""
|
|
110
|
-
require_capabilities("app_api", await self._session.capabilities)
|
|
111
|
-
try:
|
|
112
|
-
await self._session.ocs("DELETE", f"{self._session.ae_url}/{_EP_SUFFIX}", params={"name": name})
|
|
113
|
-
except NextcloudExceptionNotFound as e:
|
|
114
|
-
if not not_fail:
|
|
115
|
-
raise e from None
|
|
116
|
-
|
|
117
|
-
async def get_entry(self, name: str) -> TextProcessingProvider | None:
|
|
118
|
-
"""Get information of the TextProcessing."""
|
|
119
|
-
require_capabilities("app_api", await self._session.capabilities)
|
|
120
|
-
try:
|
|
121
|
-
return TextProcessingProvider(
|
|
122
|
-
await self._session.ocs("GET", f"{self._session.ae_url}/{_EP_SUFFIX}", params={"name": name})
|
|
123
|
-
)
|
|
124
|
-
except NextcloudExceptionNotFound:
|
|
125
|
-
return None
|
|
126
|
-
|
|
127
|
-
async def report_result(self, task_id: int, result: str = "", error: str = "") -> None:
|
|
128
|
-
"""Report results of the text processing to Nextcloud."""
|
|
129
|
-
require_capabilities("app_api", await self._session.capabilities)
|
|
130
|
-
with contextlib.suppress(NextcloudException):
|
|
131
|
-
await self._session.ocs(
|
|
132
|
-
"PUT",
|
|
133
|
-
f"{self._session.ae_url}/{_EP_SUFFIX}",
|
|
134
|
-
json={"taskId": task_id, "result": result, "error": error},
|
|
135
|
-
)
|
|
@@ -1,165 +0,0 @@
|
|
|
1
|
-
"""Nextcloud API for declaring Translations provider."""
|
|
2
|
-
|
|
3
|
-
import contextlib
|
|
4
|
-
import dataclasses
|
|
5
|
-
|
|
6
|
-
from ..._exceptions import NextcloudException, NextcloudExceptionNotFound
|
|
7
|
-
from ..._misc import require_capabilities
|
|
8
|
-
from ..._session import AsyncNcSessionApp, NcSessionApp
|
|
9
|
-
|
|
10
|
-
_EP_SUFFIX: str = "ai_provider/translation"
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
@dataclasses.dataclass
|
|
14
|
-
class TranslationsProvider:
|
|
15
|
-
"""Translations provider description."""
|
|
16
|
-
|
|
17
|
-
def __init__(self, raw_data: dict):
|
|
18
|
-
self._raw_data = raw_data
|
|
19
|
-
|
|
20
|
-
@property
|
|
21
|
-
def name(self) -> str:
|
|
22
|
-
"""Unique ID for the provider."""
|
|
23
|
-
return self._raw_data["name"]
|
|
24
|
-
|
|
25
|
-
@property
|
|
26
|
-
def display_name(self) -> str:
|
|
27
|
-
"""Providers display name."""
|
|
28
|
-
return self._raw_data["display_name"]
|
|
29
|
-
|
|
30
|
-
@property
|
|
31
|
-
def from_languages(self) -> dict[str, str]:
|
|
32
|
-
"""Input languages supported by provider."""
|
|
33
|
-
return self._raw_data["from_languages"]
|
|
34
|
-
|
|
35
|
-
@property
|
|
36
|
-
def to_languages(self) -> dict[str, str]:
|
|
37
|
-
"""Output languages supported by provider."""
|
|
38
|
-
return self._raw_data["to_languages"]
|
|
39
|
-
|
|
40
|
-
@property
|
|
41
|
-
def action_handler(self) -> str:
|
|
42
|
-
"""Relative ExApp url which will be called by Nextcloud."""
|
|
43
|
-
return self._raw_data["action_handler"]
|
|
44
|
-
|
|
45
|
-
@property
|
|
46
|
-
def action_handler_detect_lang(self) -> str:
|
|
47
|
-
"""Relative ExApp url which will be called by Nextcloud to detect language."""
|
|
48
|
-
return self._raw_data.get("action_detect_lang", "")
|
|
49
|
-
|
|
50
|
-
def __repr__(self):
|
|
51
|
-
return f"<{self.__class__.__name__} name={self.name}, handler={self.action_handler}>"
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
class _TranslationsProviderAPI:
|
|
55
|
-
"""API for Translations providers, avalaible as **nc.providers.translations.<method>**."""
|
|
56
|
-
|
|
57
|
-
def __init__(self, session: NcSessionApp):
|
|
58
|
-
self._session = session
|
|
59
|
-
|
|
60
|
-
def register(
|
|
61
|
-
self,
|
|
62
|
-
name: str,
|
|
63
|
-
display_name: str,
|
|
64
|
-
callback_url: str,
|
|
65
|
-
from_languages: dict[str, str],
|
|
66
|
-
to_languages: dict[str, str],
|
|
67
|
-
detect_lang_callback_url: str = "",
|
|
68
|
-
) -> None:
|
|
69
|
-
"""Registers or edit the Translations provider."""
|
|
70
|
-
require_capabilities("app_api", self._session.capabilities)
|
|
71
|
-
params = {
|
|
72
|
-
"name": name,
|
|
73
|
-
"displayName": display_name,
|
|
74
|
-
"fromLanguages": from_languages,
|
|
75
|
-
"toLanguages": to_languages,
|
|
76
|
-
"actionHandler": callback_url,
|
|
77
|
-
"actionDetectLang": detect_lang_callback_url,
|
|
78
|
-
}
|
|
79
|
-
self._session.ocs("POST", f"{self._session.ae_url}/{_EP_SUFFIX}", json=params)
|
|
80
|
-
|
|
81
|
-
def unregister(self, name: str, not_fail=True) -> None:
|
|
82
|
-
"""Removes Translations provider."""
|
|
83
|
-
require_capabilities("app_api", self._session.capabilities)
|
|
84
|
-
try:
|
|
85
|
-
self._session.ocs("DELETE", f"{self._session.ae_url}/{_EP_SUFFIX}", params={"name": name})
|
|
86
|
-
except NextcloudExceptionNotFound as e:
|
|
87
|
-
if not not_fail:
|
|
88
|
-
raise e from None
|
|
89
|
-
|
|
90
|
-
def get_entry(self, name: str) -> TranslationsProvider | None:
|
|
91
|
-
"""Get information of the TranslationsProvider."""
|
|
92
|
-
require_capabilities("app_api", self._session.capabilities)
|
|
93
|
-
try:
|
|
94
|
-
return TranslationsProvider(
|
|
95
|
-
self._session.ocs("GET", f"{self._session.ae_url}/{_EP_SUFFIX}", params={"name": name})
|
|
96
|
-
)
|
|
97
|
-
except NextcloudExceptionNotFound:
|
|
98
|
-
return None
|
|
99
|
-
|
|
100
|
-
def report_result(self, task_id: int, result: str = "", error: str = "") -> None:
|
|
101
|
-
"""Report results of translation task to Nextcloud."""
|
|
102
|
-
require_capabilities("app_api", self._session.capabilities)
|
|
103
|
-
with contextlib.suppress(NextcloudException):
|
|
104
|
-
self._session.ocs(
|
|
105
|
-
"PUT",
|
|
106
|
-
f"{self._session.ae_url}/{_EP_SUFFIX}",
|
|
107
|
-
json={"taskId": task_id, "result": result, "error": error},
|
|
108
|
-
)
|
|
109
|
-
|
|
110
|
-
|
|
111
|
-
class _AsyncTranslationsProviderAPI:
|
|
112
|
-
"""Async API for Translations providers."""
|
|
113
|
-
|
|
114
|
-
def __init__(self, session: AsyncNcSessionApp):
|
|
115
|
-
self._session = session
|
|
116
|
-
|
|
117
|
-
async def register(
|
|
118
|
-
self,
|
|
119
|
-
name: str,
|
|
120
|
-
display_name: str,
|
|
121
|
-
callback_url: str,
|
|
122
|
-
from_languages: dict[str, str],
|
|
123
|
-
to_languages: dict[str, str],
|
|
124
|
-
detect_lang_callback_url: str = "",
|
|
125
|
-
) -> None:
|
|
126
|
-
"""Registers or edit the Translations provider."""
|
|
127
|
-
require_capabilities("app_api", await self._session.capabilities)
|
|
128
|
-
params = {
|
|
129
|
-
"name": name,
|
|
130
|
-
"displayName": display_name,
|
|
131
|
-
"fromLanguages": from_languages,
|
|
132
|
-
"toLanguages": to_languages,
|
|
133
|
-
"actionHandler": callback_url,
|
|
134
|
-
"actionDetectLang": detect_lang_callback_url,
|
|
135
|
-
}
|
|
136
|
-
await self._session.ocs("POST", f"{self._session.ae_url}/{_EP_SUFFIX}", json=params)
|
|
137
|
-
|
|
138
|
-
async def unregister(self, name: str, not_fail=True) -> None:
|
|
139
|
-
"""Removes Translations provider."""
|
|
140
|
-
require_capabilities("app_api", await self._session.capabilities)
|
|
141
|
-
try:
|
|
142
|
-
await self._session.ocs("DELETE", f"{self._session.ae_url}/{_EP_SUFFIX}", params={"name": name})
|
|
143
|
-
except NextcloudExceptionNotFound as e:
|
|
144
|
-
if not not_fail:
|
|
145
|
-
raise e from None
|
|
146
|
-
|
|
147
|
-
async def get_entry(self, name: str) -> TranslationsProvider | None:
|
|
148
|
-
"""Get information of the TranslationsProvider."""
|
|
149
|
-
require_capabilities("app_api", await self._session.capabilities)
|
|
150
|
-
try:
|
|
151
|
-
return TranslationsProvider(
|
|
152
|
-
await self._session.ocs("GET", f"{self._session.ae_url}/{_EP_SUFFIX}", params={"name": name})
|
|
153
|
-
)
|
|
154
|
-
except NextcloudExceptionNotFound:
|
|
155
|
-
return None
|
|
156
|
-
|
|
157
|
-
async def report_result(self, task_id: int, result: str = "", error: str = "") -> None:
|
|
158
|
-
"""Report results of translation task to Nextcloud."""
|
|
159
|
-
require_capabilities("app_api", await self._session.capabilities)
|
|
160
|
-
with contextlib.suppress(NextcloudException):
|
|
161
|
-
await self._session.ocs(
|
|
162
|
-
"PUT",
|
|
163
|
-
f"{self._session.ae_url}/{_EP_SUFFIX}",
|
|
164
|
-
json={"taskId": task_id, "result": result, "error": error},
|
|
165
|
-
)
|
|
File without changes
|
|
File without changes
|
|
File without changes
|