Update custom features example for object workspace_options (#93)

* custom features agent

* readme and tests

* Update openbb-ai

---------

Co-authored-by: Theodore Aptekarev <aptekarev@gmail.com>

Author: DidierRLopes

37-vanilla-agent-custom-features/README.md

@@ -6,16 +6,18 @@ This is a simple example agent that demonstrates how to detect and report which
 
 This agent:
 - Greets users with a friendly hello message
-- Reports the status of custom features (Deep Research and Web Search) 
-- Shows whether each feature is enabled (✅) or disabled (❌) based on the UI settings
+- Reports the status of custom features (Deep Research and Web Search)
+- Shows boolean, text, and select option values based on the UI settings
 
 ## Features
 
-The agent defines two custom features in its configuration:
+The agent defines four custom features in its configuration:
 - **Deep Research**: Allows the agent to perform deep research (default: disabled)
 - **Web Search**: Allows the agent to search the web (default: enabled)
+- **Model**: Selects the model value sent to the agent
+- **Agent Name**: Sets the display name the agent uses in its response
 
-Users can toggle these features on/off in the OpenBB Workspace UI, and the agent will detect and report the current status.
+Users can update these options in the OpenBB Workspace UI, and the agent will detect and report the current values from `workspace_options`.
 
 ## Getting started
 
@@ -61,4 +63,4 @@ pytest tests
 
 ### Accessing the Documentation
 
-Once the API server is running, you can view the documentation and interact with the API by visiting: http://localhost:7777/docs
+Once the API server is running, you can view the documentation and interact with the API by visiting: http://localhost:7777/docs

37-vanilla-agent-custom-features/tests/test_agent.py

@@ -57,7 +57,12 @@ def test_query_with_workspace_options():
     """Test query with workspace options to verify feature detection."""
     test_payload = {
         "messages": [{"role": "human", "content": "Hello, what features are enabled?"}],
-        "workspace_options": {"deep-research": True, "web-search": False},
+        "workspace_options": {
+            "deep-research": True,
+            "web-search": False,
+            "model": "gpt-4o",
+            "agent-name": "Test Agent",
+        },
     }
 
     with mock.patch("openai.AsyncOpenAI") as mock_openai:
@@ -73,6 +78,8 @@ async def mock_create(**kwargs):
             # Check that the system message contains the feature status
             assert "Deep Research: ✅ Enabled" in system_message
             assert "Web Search: ❌ Disabled" in system_message
+            assert "Model: gpt-4o" in system_message
+            assert "Agent Name: Test Agent" in system_message
 
             # Return a mock stream
             class MockEvent:
@@ -84,7 +91,10 @@ class Delta:
 
                 choices = [Choice()]
 
-            yield MockEvent()
+            async def stream():
+                yield MockEvent()
+
+            return stream()
 
         mock_client.chat.completions.create = mock_create
 
@@ -109,6 +119,8 @@ async def mock_create(**kwargs):
             # Check that defaults are used (deep-research: False, web-search: True)
             assert "Deep Research: ❌ Disabled" in system_message
             assert "Web Search: ✅ Enabled" in system_message
+            assert "Model: claude-sonnet-4-20250514" in system_message
+            assert "Agent Name: Example Agent" in system_message
 
             # Return a mock stream
             class MockEvent:
@@ -120,7 +132,10 @@ class Delta:
 
                 choices = [Choice()]
 
-            yield MockEvent()
+            async def stream():
+                yield MockEvent()
+
+            return stream()
 
         mock_client.chat.completions.create = mock_create
 

37-vanilla-agent-custom-features/vanilla_agent_custom_features/main.py

@@ -87,25 +87,18 @@ def get_copilot_description():
 async def query(request: QueryRequest) -> EventSourceResponse:
     """Stream a simple greeting with feature status."""
 
-    # Check workspace_options from request payload
-    # workspace_options is a list like ["web-search"] or ["deep-research", "web-search"]
-    # Text/select features are sent as "key=value" entries
-    workspace_options = getattr(request, "workspace_options", [])
-
-    # Helper to extract a value from "key=value" entries
-    def get_option_value(key: str, default: str = "") -> str:
-        for opt in workspace_options:
-            if opt.startswith(f"{key}="):
-                return opt.split("=", 1)[1]
-        return default
+    # Check workspace_options from request payload.
+    # workspace_options is a dictionary like:
+    # {"deep-research": true, "web-search": false, "model": "gpt-4o"}
+    workspace_options = getattr(request, "workspace_options", {}) or {}
 
     # Check which features are enabled
-    deep_research_enabled = "deep-research" in workspace_options
-    web_search_enabled = "web-search" in workspace_options
+    deep_research_enabled = bool(workspace_options.get("deep-research", False))
+    web_search_enabled = bool(workspace_options.get("web-search", True))
 
     # Read text/select feature values
-    model = get_option_value("model", "claude-sonnet-4-20250514")
-    agent_name = get_option_value("agent-name", "Example Agent")
+    model = workspace_options.get("model", "claude-sonnet-4-20250514")
+    agent_name = workspace_options.get("agent-name", "Example Agent")
 
     # Build the feature status message
     features_msg = (