adds agent docs

Sage-Bionetworks · Jan 16, 2025 · 72cdff1 · 72cdff1
1 parent 33639a6
commit 72cdff1
Show file tree

Hide file tree

Showing 3 changed files with 38 additions and 0 deletions.
diff --git a/docs/reference/experimental/async/agent.md b/docs/reference/experimental/async/agent.md
@@ -0,0 +1,11 @@
+# Agent
+
+::: synapseclient.models.Agent
+    options:
+        members:
+        - register_async
+        - get_async
+        - start_session_async
+        - get_session_async
+        - prompt_async
+        - get_chat_history
diff --git a/docs/reference/experimental/sync/agent.md b/docs/reference/experimental/sync/agent.md
@@ -0,0 +1,23 @@
+# Agent
+
+## Example Script:
+
+<details class="quote">
+  <summary>Working with a Synapse Agent</summary>
+
+```python
+{!docs/scripts/object_orientated_programming_poc/oop_poc_agent.py!}
+```
+</details>
+
+## API Reference
+
+::: synapseclient.models.Agent
+    options:
+        members:
+        - register
+        - get
+        - start_session
+        - get_session
+        - prompt
+        - get_chat_history
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -75,6 +75,10 @@ nav:
       - Core: reference/core.md
       - REST Apis: reference/rest_apis.md
       - Experimental:
+          - Synchronous:
+              - Agent: reference/experimental/sync/agent.md
+          - Asynchronous:
+              - Agent: reference/experimental/async/agent.md
           - Object-Orientated Models: reference/oop/models.md
           - Async Object-Orientated Models: reference/oop/models_async.md
   - Further Reading: