Merge pull request #74 from game-by-virtuals/chat_agent

Chat agent

Author: ai-virtual-b

examples/game/chat_agent.py

@@ -0,0 +1,83 @@
+import os
+from typing import Any, Tuple
+from game_sdk.game.chat_agent import ChatAgent
+from game_sdk.game.custom_types import Argument, Function, FunctionResultStatus
+
+# ACTION SPACE
+
+def generate_picture(prompt: str) -> Tuple[FunctionResultStatus, str, dict[str, Any]]:
+    print(f"Generated picture with prompt: {prompt}")
+    return FunctionResultStatus.DONE, "Picture generated and presented to the user", {}
+
+def generate_music(prompt: str) -> Tuple[FunctionResultStatus, str, dict[str, Any]]:
+    print(f"Generated music with prompt: {prompt}")
+    return FunctionResultStatus.DONE, "Music generated and presented to the user", {}
+
+
+def check_crypto_price(currency: str):
+    prices = {
+        "bitcoin": 100000,
+        "ethereum": 20000,
+    }
+    result = prices[currency.lower()]
+    if result is None:
+        return FunctionResultStatus.FAILED, "The price of the currency is not available", {}
+    return FunctionResultStatus.DONE, f"The price of {currency} is {result}", {}
+
+
+action_space = [
+    Function(
+        fn_name="generate_picture",
+        fn_description="Generate a picture",
+        args=[Argument(name="prompt", description="The prompt for the picture")],
+        executable=generate_picture,
+    ),
+    Function(
+        fn_name="generate_music",
+        fn_description="Generate a music",
+        args=[Argument(name="prompt", description="The prompt for the music")],
+        executable=generate_music,
+    ),
+    Function(
+        fn_name="check_crypto_price",
+        fn_description="Check the price of a crypto currency",
+        args=[Argument(name="currency", description="The currency to check the price of")],
+        executable=check_crypto_price,
+    ),
+]
+
+api_key = os.environ.get("GAME_API_KEY")
+if not api_key:
+    raise ValueError("GAME_API_KEY is not set")
+
+
+# CREATE AGENT
+agent = ChatAgent(
+    prompt="You are helpful assistant",
+    api_key=api_key
+)
+
+chat = agent.create_chat(
+    partner_id="tom",
+    partner_name="Tom",
+    action_space=action_space,
+)
+
+chat_continue = True
+while chat_continue:
+
+    user_message = input("Enter a message: ")
+
+    response = chat.next(user_message)
+
+    if response.function_call:
+        print(f"Function call: {response.function_call.fn_name}")
+
+    if response.message:
+        print(f"Response: {response.message}")
+
+    if response.is_finished:
+        chat_continue = False
+        break
+
+print("Chat ended")

src/game_sdk/game/README.md

@@ -110,3 +110,65 @@ worker = agent.get_worker("worker_id")
 worker.run("Bring me some fruits")
 ```
 
+### 5. Chat Agents
+
+Chat Agents enable interactive conversations with AI agents that can execute functions. They are simpler to use than full Agents and are ideal for chatbot-like interactions where the agent can perform actions.
+
+```python
+# Initialize the chat agent
+chat_agent = ChatAgent(
+    prompt="You are helpful assistant",
+    api_key="your_api_key"
+)
+
+# Define functions
+```python
+def generate_picture(prompt: str):
+    # Implementation
+    return FunctionResultStatus.DONE, "Picture generated", {}
+
+action_space = [
+    Function(
+        fn_name="generate_picture",
+        fn_description="Generate a picture",
+        args=[Argument(name="prompt", description="The prompt for the picture")],
+        executable=generate_picture
+    )
+]
+
+# Create a chat session
+chat = chat_agent.create_chat(
+    partner_id="user123",
+    partner_name="User Name",
+    action_space=[list_of_functions],  # Optional
+    get_state_fn=lambda: {...}  # Optional, allows to push state of the environment to the agent
+)
+
+# Run conversation
+chat_continue = True
+while chat_continue:
+    user_message = input("Enter a message: ")
+    response = chat.next(user_message)
+    ...
+    if response.is_finished:
+        chat_continue = False
+
+# End chat
+chat.end("Optional ending message")
+```
+
+### Chat Termination
+
+The chat can be terminated in two ways:
+
+1. **Agent-initiated**: The agent may decide to end the chat on its own when it determines the conversation is complete. In this case, `chat.next()` will return `False`.
+
+2. **Client-initiated**: The client can manually end the chat at any time by calling:
+```python
+chat.end("Optional farewell message")
+```
+
+### Chat Memory
+
+ChatAgent maintains a simple short-term memory by keeping track of recent messages in the conversation. This allows the agent to maintain context and provide coherent responses based on the conversation history. The memory is temporary and limited to the current chat session.
+

src/game_sdk/game/agent.py

@@ -342,6 +342,7 @@ def step(self):
                 "is_global": True
             }
 
+        return action_response, self._session.function_result
 
     def run(self):
         self._session = Session()

src/game_sdk/game/api_v2.py

@@ -28,12 +28,7 @@ def create_agent(self, name: str, description: str, goal: str) -> str:
             json=payload
         )
 
-        if response.status_code != 200:
-            raise ValueError(f"Failed to create agent (status {response.status_code}). Response: {response.text}")
-
-        response_json = response.json()
-
-        return response_json["data"]["id"]
+        return self._get_response_body(response)["id"]
 
     def create_workers(self, workers: List) -> str:
         """
@@ -54,12 +49,7 @@ def create_workers(self, workers: List) -> str:
             json=payload
         )
 
-        if response.status_code != 200:
-            raise ValueError(f"Failed to get token (status {response.status_code}). Response: {response.text}")
-
-        response_json = response.json()
-
-        return response_json["data"]["id"]
+        return self._get_response_body(response)["id"]
 
     def set_worker_task(self, agent_id: str, task: str) -> Dict:
         """
@@ -77,12 +67,7 @@ def set_worker_task(self, agent_id: str, task: str) -> Dict:
             json=payload
         )
 
-        if response.status_code != 200:
-            raise ValueError(f"Failed to set worker task (status {response.status_code}). Response: {response.text}")
-
-        response_json = response.json()
-
-        return response_json["data"]
+        return self._get_response_body(response)
 
     def get_worker_action(self, agent_id: str, submission_id: str, data: dict, model_name: str) -> Dict:
         """
@@ -120,4 +105,64 @@ def get_agent_action(self, agent_id: str, data: dict, model_name: str) -> Dict:
 
         response_json = response.json()
 
+        return response_json["data"]
+    
+    def create_chat(self, data: dict) -> str:
+        response = requests.post(
+            f"{self.base_url}/conversation",
+            headers=self.headers,
+            json={
+                "data": data
+            }
+        )
+        
+        chat_id = self._get_response_body(response).get("conversation_id")
+        if not chat_id:
+            raise Exception("Agent did not return a conversation_id for the chat.")
+        return chat_id
+    
+    def update_chat(self, conversation_id: str, data: dict) -> dict:
+        response = requests.post(
+            f"{self.base_url}/conversation/{conversation_id}/next",
+            headers=self.headers,
+            json={
+                "data": data
+            }
+        )
+        
+        if response.status_code != 200:
+            raise ValueError(f"Failed to update conversation (status {response.status_code}). Response: {response.text}")
+
+        response_json = response.json()
+
+        return response_json["data"]
+    
+    def report_function(self, conversation_id: str, data: dict) -> dict:
+        response = requests.post(
+            f"{self.base_url}/conversation/{conversation_id}/function/result",
+            headers=self.headers,
+            json={
+                "data": data
+            }
+        )
+
+        return self._get_response_body(response)
+    
+    def end_chat(self, conversation_id: str, data: dict) -> dict:
+        response = requests.post(
+            f"{self.base_url}/conversation/{conversation_id}/end",
+            headers=self.headers,
+            json={
+                "data": data
+            }
+        )
+
+        return self._get_response_body(response)
+    
+    def _get_response_body(self, response: requests.Response) -> dict:
+        if response.status_code != 200:
+            raise ValueError(f"Failed to get response body (status {response.status_code}). Response: {response.text}")
+
+        response_json = response.json()
+
         return response_json["data"]