feat: update uagents version and chat protocol (#68)

* feat: update uagents version and chat protocol

* Update 6-deployed-agents/finance/company-overview-agent/functions.py

Co-authored-by: Archento <[email protected]>

* Update 6-deployed-agents/knowledge-base/claude.ai-agent/chat_proto.py

Co-authored-by: Archento <[email protected]>

* Update 6-deployed-agents/knowledge-base/openai-agent/chat_proto.py

Co-authored-by: Archento <[email protected]>

---------

Co-authored-by: Archento <[email protected]>

Author: jrriehl

6-deployed-agents/finance/company-overview-agent/agent.py

@@ -1,29 +1,17 @@
 import os
 import time
 from enum import Enum
-from typing import Dict
 
-import requests
+from chat_proto import chat_proto, struct_output_client_proto
 from uagents import Agent, Context, Model
 from uagents.experimental.quota import QuotaProtocol, RateLimit
-from uagents.models import ErrorMessage
+from uagents_core.models import ErrorMessage
+
+from functions import CompanyOverviewResponse, CompanyOverviewRequest, fetch_overview_json
 
 AGENT_SEED = os.getenv("AGENT_SEED", "company-overview")
 AGENT_NAME = os.getenv("AGENT_NAME", "Company Overview Agent")
 
-ALPHAVANTAGE_API_KEY = os.getenv("ALPHAVANTAGE_API_KEY")
-
-if ALPHAVANTAGE_API_KEY is None:
-    raise ValueError("You need to provide an API key for Alpha Vantage.")
-
-
-class CompanyOverviewRequest(Model):
-    ticker: str
-
-
-class CompanyOverviewResponse(Model):
-    overview: Dict[str, str]
-
 
 PORT = 8000
 agent = Agent(
@@ -41,24 +29,6 @@ class CompanyOverviewResponse(Model):
 )
 
 
-def fetch_overview_json(ticker: str) -> dict:
-    url = f"https://www.alphavantage.co/query?function=OVERVIEW&symbol={ticker}&apikey={ALPHAVANTAGE_API_KEY}"
-
-    try:
-        response = requests.get(url, timeout=10)
-    except requests.exceptions.Timeout:
-        return {"error": "The request timed out. Please try again."}
-    except requests.exceptions.RequestException as e:
-        return {"error": f"An error occurred: {e}"}
-
-    data = response.json()
-
-    if not data or "Symbol" not in data:
-        return {"error": "No valid data found in the response."}
-
-    return data
-
-
 @proto.on_message(
     CompanyOverviewRequest, replies={CompanyOverviewResponse, ErrorMessage}
 )
@@ -91,6 +61,8 @@ async def handle_request(ctx: Context, sender: str, msg: CompanyOverviewRequest)
 
 
 agent.include(proto, publish_manifest=True)
+agent.include(chat_proto, publish_manifest=True)
+agent.include(struct_output_client_proto, publish_manifest=True)
 
 
 # Health check related code

6-deployed-agents/finance/company-overview-agent/chat_proto.py

@@ -0,0 +1,138 @@
+from datetime import datetime
+import os
+import time
+from typing import Any
+from uagents import Context, Model, Protocol
+from uagents_core.contrib.protocols.chat import (
+    ChatAcknowledgement,
+    ChatMessage,
+    EndSessionContent,
+    StartSessionContent,
+    TextContent,
+    chat_protocol_spec,
+)
+
+from uuid import uuid4
+
+from functions import CompanyOverviewRequest, fetch_overview_json
+
+
+AI_AGENT_ADDRESS = os.getenv("AI_AGENT_ADDRESS")
+
+
+def create_text_chat(text: str, end_session: bool = True) -> ChatMessage:
+    content = [TextContent(type="text", text=text)]
+    if end_session:
+        content.append(EndSessionContent(type="end-session"))
+    return ChatMessage(
+        timestamp=datetime.utcnow(),
+        msg_id=uuid4(),
+        content=content,
+    )
+
+
+chat_proto = Protocol(spec=chat_protocol_spec)
+
+struct_output_client_proto = Protocol(
+    name="StructuredOutputClientProtocol", version="0.1.0"
+)
+
+
+class StructuredOutputPrompt(Model):
+    prompt: str
+    output_schema: dict[str, Any]
+
+
+class StructuredOutputResponse(Model):
+    output: dict[str, Any]
+
+
+@chat_proto.on_message(ChatMessage)
+async def handle_message(ctx: Context, sender: str, msg: ChatMessage):
+    await ctx.send(
+        sender,
+        ChatAcknowledgement(
+            timestamp=datetime.utcnow(), acknowledged_msg_id=msg.msg_id
+        ),
+    )
+    for item in msg.content:
+        if isinstance(item, StartSessionContent):
+            ctx.logger.info(f"Got a start session message from {sender}")
+            continue
+        elif isinstance(item, TextContent):
+            ctx.logger.info(f"Got a message from {sender}: {item.text}")
+            ctx.storage.set(str(ctx.session), sender)
+            await ctx.send(
+                AI_AGENT_ADDRESS,
+                StructuredOutputPrompt(
+                    prompt=item.text, output_schema=CompanyOverviewRequest.schema()
+                ),
+            )
+        else:
+            ctx.logger.info(f"Got unexpected content from {sender}")
+
+
+@chat_proto.on_message(ChatAcknowledgement)
+async def handle_ack(ctx: Context, sender: str, msg: ChatAcknowledgement):
+    ctx.logger.info(
+        f"Got an acknowledgement from {sender} for {msg.acknowledged_msg_id}"
+    )
+
+
+@struct_output_client_proto.on_message(StructuredOutputResponse)
+async def handle_structured_output_response(
+    ctx: Context, sender: str, msg: StructuredOutputResponse
+):
+    prompt = CompanyOverviewRequest.parse_obj(msg.output)
+    session_sender = ctx.storage.get(str(ctx.session))
+    if session_sender is None:
+        ctx.logger.error(
+            "Discarding message because no session sender found in storage"
+        )
+        return
+
+    cache = ctx.storage.get(prompt.ticker) or None
+    if cache:
+        if int(time.time()) - cache["timestamp"] < 86400:
+            cache.pop("timestamp")
+            chat_message = create_text_chat(
+                f"Company: {cache['Name']} ({cache['Symbol']})\n"
+                f"Exchange: {cache['Exchange']} | Currency: {cache['Currency']}\n"
+                f"Industry: {cache['Industry']} | Sector: {cache['Sector']}\n"
+                f"Market Cap: {cache['Currency']} {cache['MarketCapitalization']}\n"
+                f"PE Ratio: {cache['PERatio']} | EPS: {cache['EPS']}\n"
+                f"Website: {cache['OfficialSite']}\n\n"
+                f"Description: {cache['Description']}"
+            )
+            await ctx.send(session_sender, chat_message)
+            return
+
+    try:
+        output_json = fetch_overview_json(prompt.ticker)
+    except Exception as err:
+        ctx.logger.error(err)
+        await ctx.send(
+            session_sender,
+            create_text_chat(
+                "Sorry, I couldn't process your request. Please try again later."
+            ),
+        )
+        return
+
+    if "error" in output_json:
+        await ctx.send(session_sender, create_text_chat(str(output_json["error"])))
+        return
+
+    chat_message = create_text_chat(
+        f"Company: {output_json['Name']} ({output_json['Symbol']})\n"
+        f"Exchange: {output_json['Exchange']} | Currency: {output_json['Currency']}\n"
+        f"Industry: {output_json['Industry']} | Sector: {output_json['Sector']}\n"
+        f"Market Cap: {output_json['Currency']} {output_json['MarketCapitalization']}\n"
+        f"PE Ratio: {output_json['PERatio']} | EPS: {output_json['EPS']}\n"
+        f"Website: {output_json['OfficialSite']}\n\n"
+        f"Description: {output_json['Description']}"
+    )
+
+    output_json["timestamp"] = int(time.time())
+    ctx.storage.set(prompt.ticker, output_json)
+    await ctx.send(session_sender, chat_message)

6-deployed-agents/finance/company-overview-agent/functions.py

@@ -0,0 +1,37 @@
+import os
+import requests
+from typing import Dict
+from uagents import Model, Field
+
+ALPHAVANTAGE_API_KEY = os.getenv("ALPHAVANTAGE_API_KEY")
+
+if ALPHAVANTAGE_API_KEY is None:
+    raise ValueError("You need to provide an API key for Alpha Vantage.")
+
+
+class CompanyOverviewRequest(Model):
+    ticker: str = Field(
+        description="The stock ticker symbol (e.g., AAPL for Apple Inc.) used to identify the company on financial markets.", 
+    )
+
+
+class CompanyOverviewResponse(Model):
+    overview: Dict[str, str]
+
+
+def fetch_overview_json(ticker: str) -> dict:
+    url = f"https://www.alphavantage.co/query?function=OVERVIEW&symbol={ticker}&apikey={ALPHAVANTAGE_API_KEY}"
+
+    try:
+        response = requests.get(url, timeout=10)
+    except requests.exceptions.Timeout:
+        return {"error": "The request timed out. Please try again."}
+    except requests.exceptions.RequestException as e:
+        return {"error": f"An error occurred: {e}"}
+
+    data = response.json()
+
+    if not data or "Symbol" not in data:
+        return {"error": "No valid data found in the response."}
+
+    return data

6-deployed-agents/finance/company-overview-agent/pyproject.toml

@@ -7,7 +7,7 @@ readme = "README.md"
 
 [tool.poetry.dependencies]
 python = "^3.10,<3.13"
-uagents = "^0.15.2"
+uagents = "^0.22.0"
 requests = "^2.32.3"
 
 [build-system]

6-deployed-agents/finance/company-ticker-resolver-agent/agent.py

@@ -6,7 +6,7 @@
 import requests
 from uagents import Agent, Context, Model
 from uagents.experimental.quota import QuotaProtocol, RateLimit
-from uagents.models import ErrorMessage
+from uagents_core.models import ErrorMessage
 
 AGENT_SEED = os.getenv("AGENT_SEED", "ticker-agent")
 AGENT_NAME = os.getenv("AGENT_NAME", "Company Ticker Resolver Agent")

6-deployed-agents/finance/finance-q&a-agent/agent.py

@@ -5,7 +5,7 @@
 from chat_proto import chat_proto
 from uagents import Agent, Context, Model
 from uagents.experimental.quota import QuotaProtocol, RateLimit
-from uagents.models import ErrorMessage
+from uagents_core.models import ErrorMessage
 
 AGENT_SEED = os.getenv("AGENT_SEED", "finance_qa_agent")
 AGENT_NAME = os.getenv("AGENT_NAME", "Finance Q&A Agent")