Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[SYNPY-1544] Synapse Agent OOP Model #1152

Open
wants to merge 53 commits into
base: develop
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
53 commits
Select commit Hold shift + click to select a range
7f6022e
Adds async convenience functions
BWMac Jan 6, 2025
60dc255
expose convenience functions
BWMac Jan 7, 2025
3fd345c
updates convenience functions
BWMac Jan 7, 2025
9c2c6d9
updates agent_services
BWMac Jan 8, 2025
52078b3
removes rest_get_async exception handling
BWMac Jan 8, 2025
fbcfcef
pre-commit fixes
BWMac Jan 8, 2025
079a02c
delete accidentally committed script
BWMac Jan 8, 2025
5ae3257
adds initial agent implementation
BWMac Jan 8, 2025
84edb76
clean up agent
BWMac Jan 8, 2025
88c6f06
adds missing docstrings
BWMac Jan 8, 2025
f34e9cc
pre-commit
BWMac Jan 8, 2025
05e73f3
updates agent_services
BWMac Jan 10, 2025
9b6e035
updates agent.py
BWMac Jan 10, 2025
dadbac3
Updates alias ID handling
BWMac Jan 10, 2025
9c7547a
adds syncronous interface
BWMac Jan 10, 2025
7f44822
prevent cicular import in storable_entity_components
BWMac Jan 14, 2025
691799a
remove promt sending and receiving from agent_service
BWMac Jan 14, 2025
389dd86
adds initial (dirty) async job mixin
BWMac Jan 14, 2025
15db364
pre-commit run
BWMac Jan 14, 2025
165570c
[SYNPY-1544] potential changes to mixin (#1153)
BryanFauble Jan 14, 2025
8adf5e5
cleans up agent logic
BWMac Jan 15, 2025
3360390
adds async job unit tests
BWMac Jan 15, 2025
40842b2
updates async job tests
BWMac Jan 15, 2025
05cc2dd
adds agent unit tests
BWMac Jan 16, 2025
e1b00cd
adds integration tests
BWMac Jan 16, 2025
717b695
pre-commit
BWMac Jan 16, 2025
f294cdd
adds examples to agent.py
BWMac Jan 16, 2025
fdd665f
removes todos
BWMac Jan 16, 2025
6197f38
adds POC script
BWMac Jan 16, 2025
33639a6
add to mixins
BWMac Jan 16, 2025
72cdff1
adds agent docs
BWMac Jan 16, 2025
7a3fd13
updates agent docs
BWMac Jan 16, 2025
2bcc349
reorganize documentation
BWMac Jan 16, 2025
0082ea6
updates poc script
BWMac Jan 17, 2025
6adde6a
clean up
BWMac Jan 17, 2025
c20b952
add docstring
BWMac Jan 17, 2025
6d80b59
removes unused imports
BWMac Jan 17, 2025
89db642
split too long lines
BWMac Jan 17, 2025
066504a
force synapse_client kwarg
BWMac Jan 17, 2025
807287f
updates agent.py
BWMac Jan 17, 2025
6274364
updates synapse_client docstring description
BWMac Jan 17, 2025
6750ef6
updates asynchronous_job
BWMac Jan 17, 2025
af56bee
updates integration tests
BWMac Jan 17, 2025
724a8b0
pre-commit
BWMac Jan 17, 2025
a96b1a9
agent inherited members
BWMac Jan 17, 2025
f860fa6
updates docs for inherited members
BWMac Jan 17, 2025
1ca93d8
missing inherited members
BWMac Jan 17, 2025
7537f4e
updates doc formatting
BWMac Jan 17, 2025
d2f4ade
try team formatting change
BWMac Jan 17, 2025
9b4a168
updates script description
BWMac Jan 17, 2025
f567d4c
adds Annotation lazy import
BWMac Jan 17, 2025
aede05f
try team formatting change
BWMac Jan 17, 2025
34be93d
more formatting changes
BWMac Jan 17, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions docs/reference/experimental/async/activity.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# Activity

## API Reference

::: synapseclient.models.Activity
options:
members:
- from_parent_async
- store_async
- delete_async
---
::: synapseclient.models.UsedEntity
options:
filters:
- "!"
---
::: synapseclient.models.UsedURL
options:
filters:
- "!"
28 changes: 28 additions & 0 deletions docs/reference/experimental/async/agent.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
# Agent

## API reference

::: synapseclient.models.Agent
options:
members:
- register_async
- get_async
- start_session_async
- get_session_async
- prompt_async
- get_chat_history
---
::: synapseclient.models.AgentSession
options:
members:
- start_async
- get_async
- update_async
- prompt_async
---
::: synapseclient.models.AgentPrompt
options:
inherited_members: true
members:
- send_job_and_wait_async
---
23 changes: 23 additions & 0 deletions docs/reference/experimental/async/file.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# File

## API Reference

::: synapseclient.models.File
options:
inherited_members: true
members:
- get_async
- store_async
- copy_async
- delete_async
- from_id_async
- from_path_async
- change_metadata_async
- get_permissions_async
- get_acl_async
- set_permissions_async
---
::: synapseclient.models.file.FileHandle
options:
filters:
- "!"
16 changes: 16 additions & 0 deletions docs/reference/experimental/async/folder.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# Folder

## API Reference

::: synapseclient.models.Folder
options:
inherited_members: true
members:
- get_async
- store_async
- delete_async
- copy_async
- sync_from_synapse_async
- get_permissions_async
- get_acl_async
- set_permissions_async
15 changes: 15 additions & 0 deletions docs/reference/experimental/async/project.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# Project

## API reference

::: synapseclient.models.Project
options:
inherited_members: true
members:
- get_async
- store_async
- delete_async
- sync_from_synapse_async
- get_permissions_async
- get_acl_async
- set_permissions_async
17 changes: 17 additions & 0 deletions docs/reference/experimental/async/table.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# Table

## API Reference

::: synapseclient.models.Table
options:
inherited_members: true
members:
- get_async
- store_schema_async
- store_rows_from_csv_async
- delete_rows_async
- query_async
- delete_async
- get_permissions_async
- get_acl_async
- set_permissions_async
15 changes: 15 additions & 0 deletions docs/reference/experimental/async/team.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# Team

## API Reference

::: synapseclient.models.Team
options:
members:
- create_async
- delete_async
- from_id_async
- from_name_async
- members_async
- invite_async
- open_invitations_async
---
15 changes: 15 additions & 0 deletions docs/reference/experimental/async/user_profile.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# UserProfile

## API Reference

::: synapseclient.models.UserProfile
options:
inherited_members: true
members:
- get_async
- from_id_async
- from_username_async
- is_certified_async
---
::: synapseclient.models.UserPreference
---
3 changes: 3 additions & 0 deletions docs/reference/experimental/mixins/access_controllable.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# AccessControllable

::: synapseclient.models.mixins.AccessControllable
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# AsynchronousCommunicator

::: synapseclient.models.mixins.AsynchronousCommunicator
3 changes: 3 additions & 0 deletions docs/reference/experimental/mixins/failure_strategy.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# FailureStrategy

::: synapseclient.models.FailureStrategy
3 changes: 3 additions & 0 deletions docs/reference/experimental/mixins/storable_container.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# StorableContainer

::: synapseclient.models.mixins.StorableContainer
31 changes: 31 additions & 0 deletions docs/reference/experimental/sync/activity.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
# Activity

## Example Script

<details class="quote">
<summary>Working with activities</summary>

```python
{!docs/scripts/object_orientated_programming_poc/oop_poc_activity.py!}
```
</details>

## API Reference

::: synapseclient.models.Activity
options:
inherited_members: true
members:
- from_parent
- store
- delete
---
::: synapseclient.models.UsedEntity
options:
filters:
- "!"
---
::: synapseclient.models.UsedURL
options:
filters:
- "!"
38 changes: 38 additions & 0 deletions docs/reference/experimental/sync/agent.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
# Agent

## Example Script:

<details class="quote">
<summary>Working with Synapse agents</summary>

```python
{!docs/scripts/object_orientated_programming_poc/oop_poc_agent.py!}
```
</details>

## API Reference

::: synapseclient.models.Agent
options:
inherited_members: true
members:
- register
- get
- start_session
- get_session
- prompt
- get_chat_history
---
::: synapseclient.models.AgentSession
options:
inherited_members: true
members:
- start
- get
- update
- prompt
---
::: synapseclient.models.AgentPrompt
options:
inherited_members: true
---
33 changes: 33 additions & 0 deletions docs/reference/experimental/sync/file.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
# File

## Example Script

<details class="quote">
<summary>Working with files</summary>

```python
{!docs/scripts/object_orientated_programming_poc/oop_poc_file.py!}
```
</details>

## API Reference

::: synapseclient.models.File
options:
inherited_members: true
members:
- get
- store
- copy
- delete
- from_id
- from_path
- change_metadata
- get_permissions
- get_acl
- set_permissions
---
::: synapseclient.models.file.FileHandle
options:
filters:
- "!"
26 changes: 26 additions & 0 deletions docs/reference/experimental/sync/folder.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
# Folder

## Example Script

<details class="quote">
<summary>Working with folders</summary>

```python
{!docs/scripts/object_orientated_programming_poc/oop_poc_folder.py!}
```
</details>

## API Reference

::: synapseclient.models.Folder
options:
inherited_members: true
members:
- get
- store
- delete
- copy
- sync_from_synapse
- get_permissions
- get_acl
- set_permissions
25 changes: 25 additions & 0 deletions docs/reference/experimental/sync/project.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# Project

## Example Script

<details class="quote">
<summary>Working with a project</summary>

```python
{!docs/scripts/object_orientated_programming_poc/oop_poc_project.py!}
```
</details>

## API reference

::: synapseclient.models.Project
options:
inherited_members: true
members:
- get
- store
- delete
- sync_from_synapse
- get_permissions
- get_acl
- set_permissions
27 changes: 27 additions & 0 deletions docs/reference/experimental/sync/table.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# Table

## Example Script

<details class="quote">
<summary>Working with tables</summary>

```python
{!docs/scripts/object_orientated_programming_poc/oop_poc_table.py!}
```
</details>

## API Reference

::: synapseclient.models.Table
options:
inherited_members: true
members:
- get
- store_schema
- store_rows_from_csv
- delete_rows
- query
- delete
- get_permissions
- get_acl
- set_permissions
26 changes: 26 additions & 0 deletions docs/reference/experimental/sync/team.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
# Team

## Example Script

<details class="quote">
<summary>Working with teams</summary>

```python
{!docs/scripts/object_orientated_programming_poc/oop_poc_team.py!}
```
</details>

## API Reference

::: synapseclient.models.Team
options:
inherited_members: true
members:
- create
- delete
- from_id
- from_name
- members
- invite
- open_invitations
---
Loading
Loading