polish the schema of tool definitions

Author: Cirilla-zmh

docs/gen-ai/non-normative/models.ipynb

@@ -117,24 +117,7 @@
     "        description=\"List of message parts that make up the message content.\")\n",
     "\n",
     "    class Config:\n",
-    "        extra = \"allow\"\n",
-    "\n",
-    "class ToolType(str, Enum):\n",
-    "    FUNCTION = \"function\"\n",
-    "    CUSTOM = \"custom\"\n",
-    "\n",
-    "class ToolDefinition(BaseModel):\n",
-    "    \"\"\"\n",
-    "    Represents a tool definition.\n",
-    "    \"\"\"\n",
-    "    type: Union[ToolType, str] = Field(description=\"Type of the tool.\")\n",
-    "    name: str = Field(description=\"Name of the tool.\")\n",
-    "    description: str = Field(description=\"Description of the tool.\")\n",
-    "    parameters: Any = Field(description=\"Format of the tool parameters. Maybe it is a JSON schema.\")\n",
-    "    response: Any = Field(description=\"Format of the tool response. Maybe it is a JSON schema.\")\n",
-    "\n",
-    "    class Config:\n",
-    "        extra = \"allow\"\n"
+    "        extra = \"allow\""
    ]
   },
   {
@@ -156,6 +139,42 @@
    "metadata": {},
    "outputs": [],
    "source": [
+    "class ToolType(str, Enum):\n",
+    "    FUNCTION = \"function\"\n",
+    "    CUSTOM = \"custom\"\n",
+    "\n",
+    "class JSONSchema(BaseModel):\n",
+    "    \"\"\"\n",
+    "    Represents a JSON schema to define the format of the tool parameters or response.\n",
+    "    \"\"\"\n",
+    "    type: str = Field(description=\"Type of the overall data.\")\n",
+    "\n",
+    "    class Config:\n",
+    "        extra = \"allow\"\n",
+    "\n",
+    "class ToolDefinition(BaseModel):\n",
+    "    \"\"\"\n",
+    "    Represents a tool definition.\n",
+    "    \"\"\"\n",
+    "    type: Union[ToolType, str] = Field(description=\"Type of the tool.\")\n",
+    "    name: str = Field(description=\"Name of the tool.\")\n",
+    "    description: str = Field(description=\"Description of the tool.\")\n",
+    "    parameters: Optional[Union[JSONSchema, Any]] = Field(\n",
+    "        description=(\n",
+    "            \"Format of the tool parameters the function expects. \"\n",
+    "            \"The RECOMMENDED data type is JSON Schema. \"\n",
+    "        )\n",
+    "    )\n",
+    "    response: Optional[Union[JSONSchema, Any]] = Field(\n",
+    "        description=(\n",
+    "            \"Format of the tool response the function returns. \"\n",
+    "            \"The RECOMMENDED data type is JSON Schema. \"\n",
+    "        )\n",
+    "    )\n",
+    "\n",
+    "    class Config:\n",
+    "        extra = \"allow\"\n",
+    "\n",
     "class InputMessages(RootModel[List[ChatMessage]]):\n",
     "    \"\"\"\n",
     "    Represents the list of input messages sent to the model.\n",

model/gen-ai/registry.yaml

@@ -316,9 +316,6 @@ groups:
           it's RECOMMENDED to only populate required fields of the definition objects
           by default. Otherwise, it's NOT RECOMMENDED to populate it by default.
           Instrumentations MAY provide a way to enable populating this attribute.
-
-          > [!Warning]
-          > This attribute is likely to contain sensitive information including user/PII data.
         examples:
           - |
               [