Merge pull request game-by-virtuals#70 from game-by-virtuals/model_selection

Add functionality to allow llm model selection for GAME when creating agents

Author: ai-virtual-b

README.md

@@ -32,6 +32,18 @@ cd plugins/twitter
 pip install -e .
 ```
 
+## Model Selection
+The foundation models which power the GAME framework can also be confgiured and selected. This can be specified when creating agents or workers. The default model used is "Llama-3.1-405B-Instruct".
+
+The models currently supported are:
+- "Llama-3.1-405B-Instruct" (default)
+- "Llama-3.3-70B-Instruct"
+- "DeepSeek-R1"
+- "DeepSeek-V3"
+- "Qwen-2.5-72B-Instruct"
+
+**Note: If model is not specified in the API call (REST API level) or on the SDK level when creating the agents, the default (Llama-3.1-405B-Instruct) model will be used.
+
 ## Usage
 1. `game`:
    - Request for a GAME API key in the Game Console https://console.game.virtuals.io/ 

examples/game/test_agent.py

@@ -274,7 +274,8 @@ def throw_furniture(object: str, **kwargs) -> Tuple[FunctionResultStatus, str, d
     agent_goal="Conquer the world by causing chaos.",
     agent_description="You are a mischievous master of chaos is very strong but with a very short attention span, and not so much brains",
     get_agent_state_fn=get_agent_state_fn,
-    workers=[fruit_thrower, furniture_thrower]
+    workers=[fruit_thrower, furniture_thrower],
+    model_name="Llama-3.1-405B-Instruct"
 )
 
 # # interact and instruct the worker to do something

examples/game/test_worker.py

@@ -107,7 +107,8 @@ def sit_on_object(object: str, **kwargs) -> Tuple[FunctionResultStatus, str, dic
     description="You are an evil NPC in a game.",
     instruction="Choose the evil-est actions.",  
     get_state_fn=get_state_fn,
-    action_space=action_space
+    action_space=action_space,
+    model_name="Llama-3.1-405B-Instruct"
 )
 
 # interact and instruct the worker to do something

src/game_sdk/game/agent.py

@@ -105,6 +105,7 @@ def __init__(self,
                  agent_description: str,
                  get_agent_state_fn: Callable,
                  workers: Optional[List[WorkerConfig]] = None,
+                 model_name: str = "Llama-3.1-405B-Instruct",
                  ):
 
         if api_key.startswith("apt-"):
@@ -114,6 +115,8 @@ def __init__(self,
 
         self._api_key: str = api_key
 
+        self._model_name: str = model_name
+
         # checks
         if not self._api_key:
             raise ValueError("API key not set")
@@ -238,6 +241,7 @@ def _get_action(
         response = self.client.get_agent_action(
             agent_id=self.agent_id,
             data=data,
+            model_name=self._model_name
         )
 
         return ActionResponse.model_validate(response)

src/game_sdk/game/api.py

@@ -1,5 +1,6 @@
 import requests
-from typing import List, Dict
+from typing import List, Dict, Optional
+
 
 class GAMEClient:
     def __init__(self, api_key: str):
@@ -13,7 +14,7 @@ def _get_access_token(self) -> str:
         response = requests.post(
             "https://api.virtuals.io/api/accesses/tokens",
             json={"data": {}},
-            headers={"x-api-key": self.api_key}
+            headers={"x-api-key": self.api_key},
         )
 
         if response.status_code != 200:
@@ -22,12 +23,21 @@ def _get_access_token(self) -> str:
         response_json = response.json()
         return response_json["data"]["accessToken"]
 
-    def _post(self, endpoint: str, data: dict) -> dict:
+    def _post(
+        self, endpoint: str, data: dict, extra_headers: Optional[Dict[str, str]] = None
+    ) -> dict:
         """
         Internal method to post data
         """
         access_token = self._get_access_token()
 
+        # Default headers with Authorization
+        headers = {"Authorization": f"Bearer {access_token}"}
+
+        # Merge additional headers if provided
+        if extra_headers:
+            headers.update(extra_headers)
+
         response = requests.post(
             f"{self.base_url}/prompts",
             json={
@@ -40,7 +50,7 @@ def _post(self, endpoint: str, data: dict) -> dict:
                     "data": data,
                 },
             },
-            headers={"Authorization": f"Bearer {access_token}"},
+            headers=headers,
         )
 
         if response.status_code != 200:
@@ -89,20 +99,28 @@ def set_worker_task(self, agent_id: str, task: str) -> Dict:
             data={"task": task},
         )
 
-    def get_worker_action(self, agent_id: str, submission_id: str, data: dict) -> Dict:
+    def get_worker_action(
+        self,
+        agent_id: str,
+        submission_id: str,
+        data: dict,
+        model_name: str,
+    ) -> Dict:
         """
         Get worker actions (for standalone worker)
         """
         return self._post(
             endpoint=f"/v2/agents/{agent_id}/tasks/{submission_id}/next",
             data=data,
+            extra_headers={"model_name": model_name},
         )
 
-    def get_agent_action(self, agent_id: str, data: dict) -> Dict:
+    def get_agent_action(self, agent_id: str, data: dict, model_name: str) -> Dict:
         """
         Get agent actions/next step (for agent)
         """
         return self._post(
             endpoint=f"/v2/agents/{agent_id}/actions",
             data=data,
+            extra_headers={"model_name": model_name},
         )

src/game_sdk/game/api_v2.py

@@ -84,13 +84,13 @@ def set_worker_task(self, agent_id: str, task: str) -> Dict:
 
         return response_json["data"]
 
-    def get_worker_action(self, agent_id: str, submission_id: str, data: dict) -> Dict:
+    def get_worker_action(self, agent_id: str, submission_id: str, data: dict, model_name: str) -> Dict:
         """
         API call to get worker actions (for standalone worker)
         """
         response = requests.post(
             f"{self.base_url}/agents/{agent_id}/tasks/{submission_id}/next",
-            headers=self.headers,
+            headers=self.headers | {"model_name": model_name},
             json={
                 "data": data
             }
@@ -103,13 +103,13 @@ def get_worker_action(self, agent_id: str, submission_id: str, data: dict) -> Di
 
         return response_json["data"]
 
-    def get_agent_action(self, agent_id: str, data: dict) -> Dict:
+    def get_agent_action(self, agent_id: str, data: dict, model_name: str) -> Dict:
         """
         API call to get agent actions/next step (for agent)
         """
         response = requests.post(
             f"{self.base_url}/agents/{agent_id}/actions",
-            headers=self.headers,
+            headers=self.headers | {"model_name": model_name},
             json={
                 "data": data
             }

src/game_sdk/game/custom_types.py

@@ -237,4 +237,4 @@ class ActionResponse(BaseModel):
     """
     action_type: ActionType
     agent_state: AgentStateResponse
-    action_args: Optional[Dict[str, Any]] = None
+    action_args: Optional[Dict[str, Any]] = None

src/game_sdk/game/worker.py

@@ -49,6 +49,7 @@ def __init__(
         action_space: List[Function],
         # specific additional instruction for the worker (PROMPT)
         instruction: Optional[str] = "",
+        model_name: str = "Llama-3.1-405B-Instruct",
     ):
 
         if api_key.startswith("apt-"):
@@ -58,6 +59,8 @@ def __init__(
 
         self._api_key: str = api_key
 
+        self._model_name: str = model_name
+
         # checks
         if not self._api_key:
             raise ValueError("API key not set")
@@ -156,7 +159,8 @@ def _get_action(
         response = self.client.get_worker_action(
             self._agent_id, 
             self._submission_id, 
-            data
+            data,
+            model_name=self._model_name
         )
 
         return ActionResponse.model_validate(response)