From 72cdff1a9dd11a7e0f1dff6dc59dc3af5e4982a0 Mon Sep 17 00:00:00 2001 From: bwmac Date: Thu, 16 Jan 2025 16:31:43 -0500 Subject: [PATCH] adds agent docs --- docs/reference/experimental/async/agent.md | 11 +++++++++++ docs/reference/experimental/sync/agent.md | 23 ++++++++++++++++++++++ mkdocs.yml | 4 ++++ 3 files changed, 38 insertions(+) create mode 100644 docs/reference/experimental/async/agent.md create mode 100644 docs/reference/experimental/sync/agent.md diff --git a/docs/reference/experimental/async/agent.md b/docs/reference/experimental/async/agent.md new file mode 100644 index 000000000..050775205 --- /dev/null +++ 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 new file mode 100644 index 000000000..8aae41bda --- /dev/null +++ b/docs/reference/experimental/sync/agent.md @@ -0,0 +1,23 @@ +# Agent + +## Example Script: + +
+ Working with a Synapse Agent + +```python +{!docs/scripts/object_orientated_programming_poc/oop_poc_agent.py!} +``` +
+ +## 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 index 768dcd0e3..516d4a2f0 100644 --- 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: