Skip to content

Commit aaa9c50

Browse files
BWMacBryanFauble
BWMac
and
BryanFauble
authored
[SYNPY-1544] Synapse Agent OOP Model (#1152)
* Adds async convenience functions * expose convenience functions * updates convenience functions * updates agent_services * removes rest_get_async exception handling * pre-commit fixes * delete accidentally committed script * adds initial agent implementation * clean up agent * adds missing docstrings * pre-commit * updates agent_services * updates agent.py * Updates alias ID handling * adds syncronous interface * prevent cicular import in storable_entity_components * remove promt sending and receiving from agent_service * adds initial (dirty) async job mixin * pre-commit run * [SYNPY-1544] potential changes to mixin (#1153) * Changes for async mixin * Remove arg * bug fix * generalizes send_job_and_wait_async * removes typing.Self --------- Co-authored-by: bwmac <[email protected]> * cleans up agent logic * adds async job unit tests * updates async job tests * adds agent unit tests * adds integration tests * pre-commit * adds examples to agent.py * removes todos * adds POC script * add to mixins * adds agent docs * updates agent docs * reorganize documentation * updates poc script * clean up * add docstring * removes unused imports * split too long lines * force synapse_client kwarg * updates agent.py * updates synapse_client docstring description * updates asynchronous_job * updates integration tests * pre-commit * agent inherited members * updates docs for inherited members * missing inherited members * updates doc formatting * try team formatting change * updates script description * adds Annotation lazy import * try team formatting change * more formatting changes * address review comments in agent.py * move synchronous docs up a layer * adds syn login * adds warning message to docs * updates docstring examples * updates docstrings * adds error handling for agent.get * async integration tests * fix conditional * disables integration tests * updates docstring for clarity --------- Co-authored-by: BryanFauble <[email protected]>
1 parent 8bd5e19 commit aaa9c50

39 files changed

+4538
-286
lines changed

‎docs/reference/experimental/async/activity.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
# Activity
2+
3+
Contained within this file are experimental interfaces for working with the Synapse Python
4+
Client. Unless otherwise noted these interfaces are subject to change at any time. Use
5+
at your own risk.
6+
7+
## API Reference
8+
9+
::: synapseclient.models.Activity
10+
options:
11+
members:
12+
- from_parent_async
13+
- store_async
14+
- delete_async
15+
---
16+
::: synapseclient.models.UsedEntity
17+
options:
18+
filters:
19+
- "!"
20+
---
21+
::: synapseclient.models.UsedURL
22+
options:
23+
filters:
24+
- "!"

‎docs/reference/experimental/async/agent.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
# Agent
2+
3+
Contained within this file are experimental interfaces for working with the Synapse Python
4+
Client. Unless otherwise noted these interfaces are subject to change at any time. Use
5+
at your own risk.
6+
7+
## API reference
8+
9+
::: synapseclient.models.Agent
10+
options:
11+
members:
12+
- register_async
13+
- get_async
14+
- start_session_async
15+
- get_session_async
16+
- prompt_async
17+
- get_chat_history
18+
---
19+
::: synapseclient.models.AgentSession
20+
options:
21+
members:
22+
- start_async
23+
- get_async
24+
- update_async
25+
- prompt_async
26+
---
27+
::: synapseclient.models.AgentPrompt
28+
options:
29+
inherited_members: true
30+
members:
31+
- send_job_and_wait_async
32+
---

‎docs/reference/experimental/async/file.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# File
2+
3+
Contained within this file are experimental interfaces for working with the Synapse Python
4+
Client. Unless otherwise noted these interfaces are subject to change at any time. Use
5+
at your own risk.
6+
7+
## API Reference
8+
9+
::: synapseclient.models.File
10+
options:
11+
inherited_members: true
12+
members:
13+
- get_async
14+
- store_async
15+
- copy_async
16+
- delete_async
17+
- from_id_async
18+
- from_path_async
19+
- change_metadata_async
20+
- get_permissions_async
21+
- get_acl_async
22+
- set_permissions_async
23+
---
24+
::: synapseclient.models.file.FileHandle
25+
options:
26+
filters:
27+
- "!"

‎docs/reference/experimental/async/folder.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# Folder
2+
3+
Contained within this file are experimental interfaces for working with the Synapse Python
4+
Client. Unless otherwise noted these interfaces are subject to change at any time. Use
5+
at your own risk.
6+
7+
## API Reference
8+
9+
::: synapseclient.models.Folder
10+
options:
11+
inherited_members: true
12+
members:
13+
- get_async
14+
- store_async
15+
- delete_async
16+
- copy_async
17+
- sync_from_synapse_async
18+
- get_permissions_async
19+
- get_acl_async
20+
- set_permissions_async

‎docs/reference/experimental/async/project.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# Project
2+
3+
Contained within this file are experimental interfaces for working with the Synapse Python
4+
Client. Unless otherwise noted these interfaces are subject to change at any time. Use
5+
at your own risk.
6+
7+
## API reference
8+
9+
::: synapseclient.models.Project
10+
options:
11+
inherited_members: true
12+
members:
13+
- get_async
14+
- store_async
15+
- delete_async
16+
- sync_from_synapse_async
17+
- get_permissions_async
18+
- get_acl_async
19+
- set_permissions_async

‎docs/reference/experimental/async/table.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# Table
2+
3+
Contained within this file are experimental interfaces for working with the Synapse Python
4+
Client. Unless otherwise noted these interfaces are subject to change at any time. Use
5+
at your own risk.
6+
7+
## API Reference
8+
9+
::: synapseclient.models.Table
10+
options:
11+
inherited_members: true
12+
members:
13+
- get_async
14+
- store_schema_async
15+
- store_rows_from_csv_async
16+
- delete_rows_async
17+
- query_async
18+
- delete_async
19+
- get_permissions_async
20+
- get_acl_async
21+
- set_permissions_async

‎docs/reference/experimental/async/team.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# Team
2+
3+
Contained within this file are experimental interfaces for working with the Synapse Python
4+
Client. Unless otherwise noted these interfaces are subject to change at any time. Use
5+
at your own risk.
6+
7+
## API Reference
8+
9+
::: synapseclient.models.Team
10+
options:
11+
members:
12+
- create_async
13+
- delete_async
14+
- from_id_async
15+
- from_name_async
16+
- members_async
17+
- invite_async
18+
- open_invitations_async
19+
---

‎docs/reference/experimental/async/user_profile.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# UserProfile
2+
3+
Contained within this file are experimental interfaces for working with the Synapse Python
4+
Client. Unless otherwise noted these interfaces are subject to change at any time. Use
5+
at your own risk.
6+
7+
## API Reference
8+
9+
::: synapseclient.models.UserProfile
10+
options:
11+
inherited_members: true
12+
members:
13+
- get_async
14+
- from_id_async
15+
- from_username_async
16+
- is_certified_async
17+
---
18+
::: synapseclient.models.UserPreference
19+
---

‎docs/reference/experimental/mixins/access_controllable.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# AccessControllable
2+
3+
::: synapseclient.models.mixins.AccessControllable

‎docs/reference/experimental/mixins/asynchronous_communicator.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# AsynchronousCommunicator
2+
3+
::: synapseclient.models.mixins.AsynchronousCommunicator

0 commit comments

Comments
 (0)