Rename .json_schema into .signature and use the openAI tool description format

Signed-off-by: Louis Mandel <[email protected]>

Author: mandel

pdl-live-react/src/pdl_ast.d.ts

@@ -2869,10 +2869,10 @@ export type Return =
   | EmptyBlock
   | null
 /**
- * Function schema computed from the function definition.
+ * Function signature computed from the function definition.
  *
  */
-export type JsonSchema = string | null
+export type Signature = string | null
 export type PdlBlock =
   | boolean
   | number
@@ -2941,7 +2941,7 @@ export interface FunctionBlock {
   kind?: Kind20
   function: Function
   return: Return
-  json_schema?: JsonSchema
+  signature?: Signature
 }
 /**
  * Enumerated type.

src/pdl/pdl-schema.json

@@ -3764,7 +3764,7 @@
           "description": "Body of the function.\n    ",
           "title": "Return"
         },
-        "json_schema": {
+        "signature": {
           "anyOf": [
             {
               "contentMediaType": "application/json",
@@ -3776,8 +3776,8 @@
             }
           ],
           "default": null,
-          "description": "Function schema computed from the function definition.\n    ",
-          "title": "Json Schema"
+          "description": "Function signature computed from the function definition.\n    ",
+          "title": "Signature"
         }
       },
       "required": [

src/pdl/pdl_ast.py

@@ -420,8 +420,8 @@ class FunctionBlock(LeafBlock):
     returns: "BlockType" = Field(..., alias="return")
     """Body of the function.
     """
-    json_schema: Optional[Json] = None
-    """Function schema computed from the function definition.
+    signature: Optional[Json] = None
+    """Function signature computed from the function definition.
     """
 
     # Field for internal use

src/pdl/pdl_interpreter.py

@@ -895,16 +895,16 @@ def process_block_body(
             if block.def_ is not None:
                 scope = scope | {block.def_: closure}
             closure.pdl__scope = scope
-            json_schema: dict[str, Any] = {}
+            signature: dict[str, Any] = {"type": "function"}
             if block.def_ is not None:
-                json_schema |= {"name": block.def_}
+                signature["name"] = block.def_
             if block.description is not None:
-                json_schema |= {"description": block.description}
+                signature["description"] = block.description
             if block.function is not None:
-                json_schema |= get_json_schema(block.function, False) or {}
+                signature["parameters"] = get_json_schema(block.function, False) or {}
             else:
-                json_schema |= {"type": "object"}
-            closure.json_schema = json_schema
+                signature["parameters"] = {}
+            closure.signature = signature
             result = PdlConst(closure)
             background = PdlList([])
             trace = closure.model_copy(update={})

tests/test_function.py

@@ -20,13 +20,14 @@ def test_function_call():
     assert text == "Hello world!"
 
 
-def test_hello_json_schema():
+def test_hello_signature():
     result = exec_dict(hello_def, output="all")
     closure = result["scope"]["hello"]
-    assert closure.json_schema == {
+    assert closure.signature == {
         "name": hello_def["def"],
         "description": hello_def["description"],
-        "type": "object",
+        "type": "function",
+        "parameters": {},
     }
 
 
@@ -49,16 +50,19 @@ def test_function_params():
     assert text == "Hello World!"
 
 
-def test_hello_params_json_schema():
+def test_hello_params_signature():
     result = exec_dict(hello_params, output="all")
     closure = result["scope"]["hello"]
-    assert closure.json_schema == {
+    assert closure.signature == {
         "name": hello_params["text"][0]["def"],
         "description": hello_params["text"][0]["description"],
-        "type": "object",
-        "properties": {"name": {"type": "string"}},
-        "required": ["name"],
-        "additionalProperties": False,
+        "type": "function",
+        "parameters": {
+            "type": "object",
+            "properties": {"name": {"type": "string"}},
+            "required": ["name"],
+            "additionalProperties": False,
+        },
     }