donobu 1.0.0

package/dist/esm/assets/generated/parameter-schemas.json

@@ -0,0 +1,1518 @@
+{
+  "Protocol.Target.exposeDevToolsProtocolParameters": {
+    "description": "Inject object to the target's main frame that provides a communication\nchannel with browser target.\n\nInjected object will be available as `window[bindingName]`.\n\nThe object has the following API:\n- `binding.send(json)` - a method to send messages over the remote debugging protocol\n- `binding.onmessage = json => handleMessage(json)` - a callback that will be called for the protocol notifications and command responses.",
+    "type": "object",
+    "properties": {
+      "targetId": {
+        "type": "string"
+      },
+      "bindingName": {
+        "description": "Binding name, 'cdp' if not specified.",
+        "type": ["string", "null"]
+      }
+    },
+    "additionalProperties": false,
+    "required": ["targetId", "bindingName"]
+  },
+  "BaseToolGptParameters": {
+    "description": "This interface is intended to be the base for all tool parameters that are generated by a GPT.",
+    "type": "object",
+    "properties": {
+      "rationale": {
+        "description": "The reason why this particular action is being taken. It MUST relate to the overall objective.",
+        "type": "string"
+      }
+    },
+    "additionalProperties": false,
+    "required": ["rationale"]
+  },
+  "ChooseSelectOptionToolCoreParameters": {
+    "type": "object",
+    "properties": {
+      "optionValues": {
+        "description": "The <option> values to choose.",
+        "type": "array",
+        "items": {
+          "type": "string"
+        }
+      }
+    },
+    "additionalProperties": false,
+    "required": ["optionValues"]
+  },
+  "SelectorBasedChooseSelectOptionToolParameters": {
+    "type": "object",
+    "properties": {
+      "selector": {
+        "description": "A query structure used to resolve specific a HTML element in a webpage.",
+        "type": "object",
+        "properties": {
+          "element": {
+            "description": "An ordered list of element selectors, going from most specific to least specific.",
+            "type": "array",
+            "items": {
+              "type": "string"
+            }
+          },
+          "frame": {
+            "description": "A selector for the corresponding frame of the element to select.\nIf null, this means the primary frame of the page is used.",
+            "type": "string"
+          }
+        },
+        "additionalProperties": false,
+        "required": ["element", "frame"]
+      },
+      "optionValues": {
+        "description": "The <option> values to choose.",
+        "type": "array",
+        "items": {
+          "type": "string"
+        }
+      }
+    },
+    "additionalProperties": false,
+    "required": ["optionValues", "selector"]
+  },
+  "AnnotationBasedChooseSelectOptionToolParameters": {
+    "type": "object",
+    "properties": {
+      "whyThisAnnotation": {
+        "description": "The reason why this particular numbered annotation was chosen.",
+        "type": "string"
+      },
+      "annotation": {
+        "description": "The numbered annotation of the element to click.",
+        "type": "string"
+      },
+      "rationale": {
+        "description": "The reason why this particular action is being taken. It MUST relate to the overall objective.",
+        "type": "string"
+      },
+      "optionValues": {
+        "description": "The <option> values to choose.",
+        "type": "array",
+        "items": {
+          "type": "string"
+        }
+      }
+    },
+    "additionalProperties": false,
+    "required": ["annotation", "optionValues", "rationale", "whyThisAnnotation"]
+  },
+  "ClickToolCoreParameters": {
+    "type": "object",
+    "additionalProperties": false,
+    "required": [],
+    "properties": {}
+  },
+  "SelectorBasedClickToolParameters": {
+    "type": "object",
+    "properties": {
+      "selector": {
+        "description": "A query structure used to resolve specific a HTML element in a webpage.",
+        "type": "object",
+        "properties": {
+          "element": {
+            "description": "An ordered list of element selectors, going from most specific to least specific.",
+            "type": "array",
+            "items": {
+              "type": "string"
+            }
+          },
+          "frame": {
+            "description": "A selector for the corresponding frame of the element to select.\nIf null, this means the primary frame of the page is used.",
+            "type": "string"
+          }
+        },
+        "additionalProperties": false,
+        "required": ["element", "frame"]
+      }
+    },
+    "additionalProperties": false,
+    "required": ["selector"]
+  },
+  "AnnotationBasedClickToolParameters": {
+    "type": "object",
+    "properties": {
+      "whyThisAnnotation": {
+        "description": "The reason why this particular numbered annotation was chosen.",
+        "type": "string"
+      },
+      "annotation": {
+        "description": "The numbered annotation of the element to click.",
+        "type": "string"
+      },
+      "rationale": {
+        "description": "The reason why this particular action is being taken. It MUST relate to the overall objective.",
+        "type": "string"
+      }
+    },
+    "additionalProperties": false,
+    "required": ["annotation", "rationale", "whyThisAnnotation"]
+  },
+  "InputTextToolCoreParameters": {
+    "type": "object",
+    "properties": {
+      "text": {
+        "description": "The text to input.",
+        "type": "string"
+      },
+      "finalizeWithSubmit": {
+        "description": "Attempt to submit the data after inputting the text (i.e. hitting 'Enter' at the end).\nThis can be useful if doing something like using a webpage's search box, etc.",
+        "type": "boolean"
+      }
+    },
+    "additionalProperties": false,
+    "required": ["finalizeWithSubmit", "text"]
+  },
+  "SelectorBasedInputTextToolParameters": {
+    "type": "object",
+    "properties": {
+      "selector": {
+        "description": "A query structure used to resolve specific a HTML element in a webpage.",
+        "type": "object",
+        "properties": {
+          "element": {
+            "description": "An ordered list of element selectors, going from most specific to least specific.",
+            "type": "array",
+            "items": {
+              "type": "string"
+            }
+          },
+          "frame": {
+            "description": "A selector for the corresponding frame of the element to select.\nIf null, this means the primary frame of the page is used.",
+            "type": "string"
+          }
+        },
+        "additionalProperties": false,
+        "required": ["element", "frame"]
+      },
+      "text": {
+        "description": "The text to input.",
+        "type": "string"
+      },
+      "finalizeWithSubmit": {
+        "description": "Attempt to submit the data after inputting the text (i.e. hitting 'Enter' at the end).\nThis can be useful if doing something like using a webpage's search box, etc.",
+        "type": "boolean"
+      }
+    },
+    "additionalProperties": false,
+    "required": ["finalizeWithSubmit", "selector", "text"]
+  },
+  "AnnotationBasedInputTextToolParameters": {
+    "type": "object",
+    "properties": {
+      "whyThisAnnotation": {
+        "description": "The reason why this particular numbered annotation was chosen.",
+        "type": "string"
+      },
+      "annotation": {
+        "description": "The numbered annotation of the element to click.",
+        "type": "string"
+      },
+      "rationale": {
+        "description": "The reason why this particular action is being taken. It MUST relate to the overall objective.",
+        "type": "string"
+      },
+      "text": {
+        "description": "The text to input.",
+        "type": "string"
+      },
+      "finalizeWithSubmit": {
+        "description": "Attempt to submit the data after inputting the text (i.e. hitting 'Enter' at the end).\nThis can be useful if doing something like using a webpage's search box, etc.",
+        "type": "boolean"
+      }
+    },
+    "additionalProperties": false,
+    "required": [
+      "annotation",
+      "finalizeWithSubmit",
+      "rationale",
+      "text",
+      "whyThisAnnotation"
+    ]
+  },
+  "InputRandomizedEmailAddressToolCoreParameters": {
+    "type": "object",
+    "properties": {
+      "baseEmail": {
+        "description": "The base email to create a derived email from.",
+        "type": "string"
+      },
+      "finalizeWithSubmit": {
+        "description": "Attempt to submit the data after inputting the randomized email (i.e. hitting 'Enter' at the end).",
+        "type": "boolean"
+      }
+    },
+    "additionalProperties": false,
+    "required": ["baseEmail", "finalizeWithSubmit"]
+  },
+  "SelectorBasedInputRandomizedEmailAddressToolParameters": {
+    "type": "object",
+    "properties": {
+      "selector": {
+        "description": "A query structure used to resolve specific a HTML element in a webpage.",
+        "type": "object",
+        "properties": {
+          "element": {
+            "description": "An ordered list of element selectors, going from most specific to least specific.",
+            "type": "array",
+            "items": {
+              "type": "string"
+            }
+          },
+          "frame": {
+            "description": "A selector for the corresponding frame of the element to select.\nIf null, this means the primary frame of the page is used.",
+            "type": "string"
+          }
+        },
+        "additionalProperties": false,
+        "required": ["element", "frame"]
+      },
+      "baseEmail": {
+        "description": "The base email to create a derived email from.",
+        "type": "string"
+      },
+      "finalizeWithSubmit": {
+        "description": "Attempt to submit the data after inputting the randomized email (i.e. hitting 'Enter' at the end).",
+        "type": "boolean"
+      }
+    },
+    "additionalProperties": false,
+    "required": ["baseEmail", "finalizeWithSubmit", "selector"]
+  },
+  "AnnotationBasedInputRandomizedEmailAddressToolParameters": {
+    "type": "object",
+    "properties": {
+      "whyThisAnnotation": {
+        "description": "The reason why this particular numbered annotation was chosen.",
+        "type": "string"
+      },
+      "annotation": {
+        "description": "The numbered annotation of the element to click.",
+        "type": "string"
+      },
+      "rationale": {
+        "description": "The reason why this particular action is being taken. It MUST relate to the overall objective.",
+        "type": "string"
+      },
+      "baseEmail": {
+        "description": "The base email to create a derived email from.",
+        "type": "string"
+      },
+      "finalizeWithSubmit": {
+        "description": "Attempt to submit the data after inputting the randomized email (i.e. hitting 'Enter' at the end).",
+        "type": "boolean"
+      }
+    },
+    "additionalProperties": false,
+    "required": [
+      "annotation",
+      "baseEmail",
+      "finalizeWithSubmit",
+      "rationale",
+      "whyThisAnnotation"
+    ]
+  },
+  "PressKeyToolCoreParameters": {
+    "type": "object",
+    "properties": {
+      "key": {
+        "description": "The key to press.",
+        "type": "string"
+      }
+    },
+    "additionalProperties": false,
+    "required": ["key"]
+  },
+  "SelectorBasedPressKeyToolParameters": {
+    "type": "object",
+    "properties": {
+      "selector": {
+        "description": "A query structure used to resolve specific a HTML element in a webpage.",
+        "type": "object",
+        "properties": {
+          "element": {
+            "description": "An ordered list of element selectors, going from most specific to least specific.",
+            "type": "array",
+            "items": {
+              "type": "string"
+            }
+          },
+          "frame": {
+            "description": "A selector for the corresponding frame of the element to select.\nIf null, this means the primary frame of the page is used.",
+            "type": "string"
+          }
+        },
+        "additionalProperties": false,
+        "required": ["element", "frame"]
+      },
+      "key": {
+        "description": "The key to press.",
+        "type": "string"
+      }
+    },
+    "additionalProperties": false,
+    "required": ["key", "selector"]
+  },
+  "AnnotationBasedPressKeyToolParameters": {
+    "type": "object",
+    "properties": {
+      "whyThisAnnotation": {
+        "description": "The reason why this particular numbered annotation was chosen.",
+        "type": "string"
+      },
+      "annotation": {
+        "description": "The numbered annotation of the element to click.",
+        "type": "string"
+      },
+      "rationale": {
+        "description": "The reason why this particular action is being taken. It MUST relate to the overall objective.",
+        "type": "string"
+      },
+      "key": {
+        "description": "The key to press.",
+        "type": "string"
+      }
+    },
+    "additionalProperties": false,
+    "required": ["annotation", "key", "rationale", "whyThisAnnotation"]
+  },
+  "HandleBrowserDialogToolCoreParameters": {
+    "description": "The parameters for handling browser dialogs",
+    "type": "object",
+    "properties": {
+      "text": {
+        "description": "If this is a \"confirm\" dialog, a string of \"true\" will accept the dialog and a string of \"false\" will dismiss it.\nHowever, if this is a \"prompt\" dialog, any non-null string will accept it, and a null value will dismiss it.",
+        "type": ["string", "null"]
+      }
+    },
+    "additionalProperties": false,
+    "required": ["text"]
+  },
+  "HandleBrowserDialogToolGptParameters": {
+    "type": "object",
+    "properties": {
+      "rationale": {
+        "description": "The reason why this particular action is being taken. It MUST relate to the overall objective.",
+        "type": "string"
+      },
+      "text": {
+        "description": "If this is a \"confirm\" dialog, a string of \"true\" will accept the dialog and a string of \"false\" will dismiss it.\nHowever, if this is a \"prompt\" dialog, any non-null string will accept it, and a null value will dismiss it.",
+        "type": ["string", "null"]
+      }
+    },
+    "additionalProperties": false,
+    "required": ["rationale", "text"]
+  },
+  "MarkObjectiveCompleteToolCoreParameters": {
+    "description": "Parameters for marking an objective as complete",
+    "type": "object",
+    "additionalProperties": false,
+    "required": [],
+    "properties": {}
+  },
+  "MarkObjectiveCompleteToolGptParameters": {
+    "description": "Parameters for marking an objective as complete",
+    "type": "object",
+    "properties": {
+      "details": {
+        "description": "Relevant details for the completed objective.",
+        "type": "string"
+      },
+      "rationale": {
+        "description": "The reason why this particular action is being taken. It MUST relate to the overall objective.",
+        "type": "string"
+      }
+    },
+    "additionalProperties": false,
+    "required": ["details", "rationale"]
+  },
+  "GoToWebpageToolCoreParameters": {
+    "type": "object",
+    "properties": {
+      "url": {
+        "description": "The URL to navigate to. Must use the http, https, or file protocol (example is https://google.com).",
+        "type": "string"
+      }
+    },
+    "additionalProperties": false,
+    "required": ["url"]
+  },
+  "GoToWebpageToolGptParameters": {
+    "type": "object",
+    "properties": {
+      "rationale": {
+        "description": "The reason why this particular action is being taken. It MUST relate to the overall objective.",
+        "type": "string"
+      },
+      "url": {
+        "description": "The URL to navigate to. Must use the http, https, or file protocol (example is https://google.com).",
+        "type": "string"
+      }
+    },
+    "additionalProperties": false,
+    "required": ["rationale", "url"]
+  },
+  "RunAccessibilityTestToolCoreParameters": {
+    "type": "object",
+    "additionalProperties": false,
+    "required": [],
+    "properties": {}
+  },
+  "RunAccessibilityTestToolGptParameters": {
+    "type": "object",
+    "properties": {
+      "rationale": {
+        "description": "The reason why this particular action is being taken. It MUST relate to the overall objective.",
+        "type": "string"
+      }
+    },
+    "additionalProperties": false,
+    "required": ["rationale"]
+  },
+  "ScrollPageToolCoreParameters": {
+    "type": "object",
+    "properties": {
+      "direction": {
+        "description": "The direction to scroll - either UP or DOWN",
+        "enum": ["DOWN", "UP"],
+        "type": "string"
+      }
+    },
+    "additionalProperties": false,
+    "required": ["direction"]
+  },
+  "ScrollPageToolGptParameters": {
+    "type": "object",
+    "properties": {
+      "rationale": {
+        "description": "The reason why this particular action is being taken. It MUST relate to the overall objective.",
+        "type": "string"
+      },
+      "direction": {
+        "description": "The direction to scroll - either UP or DOWN",
+        "enum": ["DOWN", "UP"],
+        "type": "string"
+      }
+    },
+    "additionalProperties": false,
+    "required": ["direction", "rationale"]
+  },
+  "AssertToolCoreParameters": {
+    "type": "object",
+    "properties": {
+      "assertionToTestFor": {
+        "description": "The assertion that will be tested for, using plain English.\n\nExamples:\n- 'Assert that this webpage includes a product summary.'\n- 'Assert there are more than 3 search results.'",
+        "type": "string"
+      }
+    },
+    "additionalProperties": false,
+    "required": ["assertionToTestFor"]
+  },
+  "AssertToolGptParameters": {
+    "type": "object",
+    "properties": {
+      "rationale": {
+        "description": "The reason why this particular action is being taken. It MUST relate to the overall objective.",
+        "type": "string"
+      },
+      "assertionToTestFor": {
+        "description": "The assertion that will be tested for, using plain English.\n\nExamples:\n- 'Assert that this webpage includes a product summary.'\n- 'Assert there are more than 3 search results.'",
+        "type": "string"
+      }
+    },
+    "additionalProperties": false,
+    "required": ["assertionToTestFor", "rationale"]
+  },
+  "AnalyzePageTextToolCoreParameters": {
+    "type": "object",
+    "properties": {
+      "analysisToRun": {
+        "description": "The analysis to run on the text of the current page.",
+        "type": "string"
+      },
+      "additionalRelevantContext": {
+        "description": "Additional relevant context for running the analysis.",
+        "type": "string"
+      }
+    },
+    "additionalProperties": false,
+    "required": ["additionalRelevantContext", "analysisToRun"]
+  },
+  "AnalyzePageTextToolGptParameters": {
+    "type": "object",
+    "properties": {
+      "rationale": {
+        "description": "The reason why this particular action is being taken. It MUST relate to the overall objective.",
+        "type": "string"
+      },
+      "analysisToRun": {
+        "description": "The analysis to run on the text of the current page.",
+        "type": "string"
+      },
+      "additionalRelevantContext": {
+        "description": "Additional relevant context for running the analysis.",
+        "type": "string"
+      }
+    },
+    "additionalProperties": false,
+    "required": ["additionalRelevantContext", "analysisToRun", "rationale"]
+  },
+  "CreateBrowserCookieReportToolCoreParameters": {
+    "type": "object",
+    "additionalProperties": false,
+    "required": [],
+    "properties": {}
+  },
+  "CreateBrowserCookieReportToolGptParameters": {
+    "type": "object",
+    "properties": {
+      "rationale": {
+        "description": "The reason why this particular action is being taken. It MUST relate to the overall objective.",
+        "type": "string"
+      }
+    },
+    "additionalProperties": false,
+    "required": ["rationale"]
+  },
+  "MarkObjectiveNotCompletableToolCoreParameters": {
+    "type": "object",
+    "additionalProperties": false,
+    "required": [],
+    "properties": {}
+  },
+  "MarkObjectiveNotCompletableToolGptParameters": {
+    "type": "object",
+    "properties": {
+      "rationale": {
+        "description": "The reason why this particular action is being taken. It MUST relate to the overall objective.",
+        "type": "string"
+      }
+    },
+    "additionalProperties": false,
+    "required": ["rationale"]
+  },
+  "RunInlineJavaScriptCodeToolCoreParameters": {
+    "type": "object",
+    "properties": {
+      "javaScriptCode": {
+        "description": "The JavaScript code to run.",
+        "type": "string"
+      }
+    },
+    "additionalProperties": false,
+    "required": ["javaScriptCode"]
+  },
+  "RunInlineJavaScriptCodeToolGptParameters": {
+    "additionalProperties": false,
+    "type": "object",
+    "properties": {
+      "rationale": {
+        "description": "The reason why this particular action is being taken. It MUST relate to the overall objective.",
+        "type": "string"
+      },
+      "javaScriptCode": {
+        "description": "The JavaScript code to run.",
+        "type": "string"
+      }
+    },
+    "required": ["javaScriptCode", "rationale"]
+  },
+  "RunSandboxedJavaScriptCodeToolCoreParameters": {
+    "type": "object",
+    "properties": {
+      "javaScriptCode": {
+        "description": "The JavaScript code to run.",
+        "type": "string"
+      }
+    },
+    "additionalProperties": false,
+    "required": ["javaScriptCode"]
+  },
+  "RunSandboxedJavaScriptCodeToolGptParameters": {
+    "type": "object",
+    "properties": {
+      "rationale": {
+        "description": "The reason why this particular action is being taken. It MUST relate to the overall objective.",
+        "type": "string"
+      },
+      "javaScriptCode": {
+        "description": "The JavaScript code to run.",
+        "type": "string"
+      }
+    },
+    "additionalProperties": false,
+    "required": ["javaScriptCode", "rationale"]
+  },
+  "SummarizeLearningsToolCoreParameters": {
+    "type": "object",
+    "additionalProperties": false,
+    "required": [],
+    "properties": {}
+  },
+  "SummarizeLearningsToolGptParameters": {
+    "type": "object",
+    "properties": {
+      "summary": {
+        "description": "The summary to make.",
+        "type": "string"
+      },
+      "rationale": {
+        "description": "The reason why this particular action is being taken. It MUST relate to the overall objective.",
+        "type": "string"
+      }
+    },
+    "additionalProperties": false,
+    "required": ["rationale", "summary"]
+  },
+  "TriggerDonobuFlowToolCoreParameters": {
+    "type": "object",
+    "properties": {
+      "donobuFlowParameters": {
+        "description": "The parameters to use for the new Donobu flow.",
+        "type": "object",
+        "properties": {
+          "targetWebsite": {
+            "description": "The initial website to load",
+            "type": "string"
+          },
+          "overallObjective": {
+            "description": "The overall objective to pursue; can only be omitted if `initialRunMode`\nhas an effective value of `INSTRUCT` or `DETEMINISTIC`.",
+            "type": ["string", "null"]
+          },
+          "name": {
+            "description": "The name for this flow; if present, must be fewer than 256 characters.",
+            "type": ["string", "null"]
+          },
+          "initialBrowserState": {
+            "description": "When starting the flow, initialize the browser state from the given flow\nby its ID or name.",
+            "anyOf": [
+              {
+                "type": "object",
+                "properties": {
+                  "type": {
+                    "type": "string",
+                    "const": "id"
+                  },
+                  "value": {
+                    "type": "string"
+                  }
+                },
+                "additionalProperties": false,
+                "required": ["type", "value"]
+              },
+              {
+                "type": "object",
+                "properties": {
+                  "type": {
+                    "type": "string",
+                    "const": "name"
+                  },
+                  "value": {
+                    "type": "string"
+                  }
+                },
+                "additionalProperties": false,
+                "required": ["type", "value"]
+              }
+            ]
+          },
+          "persistBrowserState": {
+            "description": "If set to true, saves the browser state at the end of the flow.",
+            "type": ["boolean", "null"]
+          },
+          "deviceName": {
+            "description": "The name of the device to run the flow with. See `devices.json` for details.\nIf not specified, defaults to DonobuFlowsManager.DEFAULT_DEVICE_NAME unless\nremoteBrowserInstanceUrl is specified. If this is non-null, then\nremoteBrowserInstanceUrl must be null.",
+            "type": ["string", "null"]
+          },
+          "remoteBrowserInstanceUrl": {
+            "description": "The URL of a remote browser instance to connect to using the Chrome DevTools\nProtocol (CDP). If this is non-null, then deviceName must be null. If the URL\ncontains \"${env.VARIABLE_NAME}\", then it will be expanded to the value of the\nspecified environment variable.",
+            "type": ["string", "null"]
+          },
+          "callbackUrl": {
+            "description": "The URL to HTTP POST to when the flow completes. The body will contain a\nJSON object with single field, \"id\", of which is the ID of the flow that\ncompleted.",
+            "type": ["string", "null"]
+          },
+          "headless": {
+            "description": "If true, will not open a real browser window to perform the flow.\nIf remoteBrowserInstanceUrl is non-null, this parameter is ignored.",
+            "type": ["boolean", "null"]
+          },
+          "customTools": {
+            "description": "Custom tools to enable for this flow. Any tools specified here will be\nimplicitly added to allowedTools.",
+            "type": ["array", "null"],
+            "items": {
+              "description": "A definition of a user-defined tool to use for a DonobuFlow.",
+              "type": "object",
+              "properties": {
+                "name": {
+                  "type": "string"
+                },
+                "description": {
+                  "type": "string"
+                },
+                "jsonSchema": {
+                  "type": "object",
+                  "additionalProperties": false,
+                  "required": [],
+                  "properties": {}
+                },
+                "javascript": {
+                  "type": "string"
+                }
+              },
+              "additionalProperties": false,
+              "required": ["description", "javascript", "jsonSchema", "name"]
+            }
+          },
+          "maxIterations": {
+            "description": "The maximum number of times to iterate with the underlying GPT.",
+            "type": ["number", "null"]
+          },
+          "gptConfigNameOverride": {
+            "description": "The name of a specific GPT configuration to use. If the corresponding GPT\nconfiguration is not defined or unresolvable, the default flow agent\nconfiguration will be used.",
+            "type": ["string", "null"]
+          },
+          "defaultToolTipDurationMilliseconds": {
+            "description": "The default amount of time a tool tip should show (in milliseconds).",
+            "type": ["number", "null"]
+          },
+          "initialRunMode": {
+            "description": "The initial run mode of the flow. If not specified, defaults to\nAUTONOMOUS if gptPlatform is non-null, otherwise, defaults to INSTRUCT.",
+            "type": ["string", "null"],
+            "enum": ["AUTONOMOUS", "INSTRUCT", "DETERMINISTIC"]
+          },
+          "isControlPanelEnabled": {
+            "description": "Set to true if the in-browser control panel should be enabled.\nIf the headless parameter is true, then this parameter is ignored.",
+            "type": ["boolean", "null"]
+          },
+          "allowedTools": {
+            "description": "If present and non-empty, will constrain the flow to only use these tools (by\nTool.name()). If null or empty, then there are no constraints on the types of\ntools used. Note that all tools in customTools are implicitly added here.",
+            "type": ["array", "null"],
+            "items": {
+              "type": "string"
+            }
+          },
+          "toolCallsOnStart": {
+            "description": "An ordered series of tool calls to invoke when starting the flow.",
+            "type": ["array", "null"],
+            "items": {
+              "description": "A proposed (i.e. yet to be executed) tool call.",
+              "type": "object",
+              "properties": {
+                "name": {
+                  "description": "The name of the tool to call.",
+                  "type": "string"
+                },
+                "parameters": {
+                  "description": "The parameters to supply to the tool's call method.\nMust conform to the tool's expected parameters type."
+                },
+                "toolCallId": {
+                  "description": "The ID used by the GPT model to track a proposed tool call to tool a call result.\nThis maps to the toolCallId in ToolCallResultMessage.",
+                  "type": ["string", "null"]
+                }
+              },
+              "additionalProperties": false,
+              "required": ["name", "parameters", "toolCallId"]
+            }
+          },
+          "resultJsonSchema": {
+            "$ref": "#/definitions/JSONSchema7",
+            "description": "If non-null, the Donobu flow will attempt to save its result using this JSON-schema."
+          }
+        },
+        "additionalProperties": false,
+        "required": [
+          "targetWebsite",
+          "overallObjective",
+          "name",
+          "initialBrowserState",
+          "persistBrowserState",
+          "deviceName",
+          "remoteBrowserInstanceUrl",
+          "callbackUrl",
+          "headless",
+          "customTools",
+          "maxIterations",
+          "gptConfigNameOverride",
+          "defaultToolTipDurationMilliseconds",
+          "initialRunMode",
+          "isControlPanelEnabled",
+          "allowedTools",
+          "toolCallsOnStart",
+          "resultJsonSchema"
+        ]
+      },
+      "rationale": {
+        "description": "The reason why this particular action is being taken. It MUST relate to the overall objective.",
+        "type": "string"
+      }
+    },
+    "additionalProperties": false,
+    "required": ["donobuFlowParameters", "rationale"]
+  },
+  "TriggerDonobuFlowToolGptParameters": {
+    "type": "object",
+    "properties": {
+      "rationale": {
+        "description": "The reason why this particular action is being taken. It MUST relate to the overall objective.",
+        "type": "string"
+      },
+      "donobuFlowParameters": {
+        "description": "The parameters to use for the new Donobu flow.",
+        "type": "object",
+        "properties": {
+          "targetWebsite": {
+            "description": "The initial website to load",
+            "type": "string"
+          },
+          "overallObjective": {
+            "description": "The overall objective to pursue; can only be omitted if `initialRunMode`\nhas an effective value of `INSTRUCT` or `DETEMINISTIC`.",
+            "type": ["string", "null"]
+          },
+          "name": {
+            "description": "The name for this flow; if present, must be fewer than 256 characters.",
+            "type": ["string", "null"]
+          },
+          "initialBrowserState": {
+            "description": "When starting the flow, initialize the browser state from the given flow\nby its ID or name.",
+            "anyOf": [
+              {
+                "type": "object",
+                "properties": {
+                  "type": {
+                    "type": "string",
+                    "const": "id"
+                  },
+                  "value": {
+                    "type": "string"
+                  }
+                },
+                "additionalProperties": false,
+                "required": ["type", "value"]
+              },
+              {
+                "type": "object",
+                "properties": {
+                  "type": {
+                    "type": "string",
+                    "const": "name"
+                  },
+                  "value": {
+                    "type": "string"
+                  }
+                },
+                "additionalProperties": false,
+                "required": ["type", "value"]
+              }
+            ]
+          },
+          "persistBrowserState": {
+            "description": "If set to true, saves the browser state at the end of the flow.",
+            "type": ["boolean", "null"]
+          },
+          "deviceName": {
+            "description": "The name of the device to run the flow with. See `devices.json` for details.\nIf not specified, defaults to DonobuFlowsManager.DEFAULT_DEVICE_NAME unless\nremoteBrowserInstanceUrl is specified. If this is non-null, then\nremoteBrowserInstanceUrl must be null.",
+            "type": ["string", "null"]
+          },
+          "remoteBrowserInstanceUrl": {
+            "description": "The URL of a remote browser instance to connect to using the Chrome DevTools\nProtocol (CDP). If this is non-null, then deviceName must be null. If the URL\ncontains \"${env.VARIABLE_NAME}\", then it will be expanded to the value of the\nspecified environment variable.",
+            "type": ["string", "null"]
+          },
+          "callbackUrl": {
+            "description": "The URL to HTTP POST to when the flow completes. The body will contain a\nJSON object with single field, \"id\", of which is the ID of the flow that\ncompleted.",
+            "type": ["string", "null"]
+          },
+          "headless": {
+            "description": "If true, will not open a real browser window to perform the flow.\nIf remoteBrowserInstanceUrl is non-null, this parameter is ignored.",
+            "type": ["boolean", "null"]
+          },
+          "customTools": {
+            "description": "Custom tools to enable for this flow. Any tools specified here will be\nimplicitly added to allowedTools.",
+            "type": ["array", "null"],
+            "items": {
+              "description": "A definition of a user-defined tool to use for a DonobuFlow.",
+              "type": "object",
+              "properties": {
+                "name": {
+                  "type": "string"
+                },
+                "description": {
+                  "type": "string"
+                },
+                "jsonSchema": {
+                  "type": "object",
+                  "additionalProperties": false,
+                  "required": [],
+                  "properties": {}
+                },
+                "javascript": {
+                  "type": "string"
+                }
+              },
+              "additionalProperties": false,
+              "required": ["description", "javascript", "jsonSchema", "name"]
+            }
+          },
+          "maxIterations": {
+            "description": "The maximum number of times to iterate with the underlying GPT.",
+            "type": ["number", "null"]
+          },
+          "gptConfigNameOverride": {
+            "description": "The name of a specific GPT configuration to use. If the corresponding GPT\nconfiguration is not defined or unresolvable, the default flow agent\nconfiguration will be used.",
+            "type": ["string", "null"]
+          },
+          "defaultToolTipDurationMilliseconds": {
+            "description": "The default amount of time a tool tip should show (in milliseconds).",
+            "type": ["number", "null"]
+          },
+          "initialRunMode": {
+            "description": "The initial run mode of the flow. If not specified, defaults to\nAUTONOMOUS if gptPlatform is non-null, otherwise, defaults to INSTRUCT.",
+            "type": ["string", "null"],
+            "enum": ["AUTONOMOUS", "INSTRUCT", "DETERMINISTIC"]
+          },
+          "isControlPanelEnabled": {
+            "description": "Set to true if the in-browser control panel should be enabled.\nIf the headless parameter is true, then this parameter is ignored.",
+            "type": ["boolean", "null"]
+          },
+          "allowedTools": {
+            "description": "If present and non-empty, will constrain the flow to only use these tools (by\nTool.name()). If null or empty, then there are no constraints on the types of\ntools used. Note that all tools in customTools are implicitly added here.",
+            "type": ["array", "null"],
+            "items": {
+              "type": "string"
+            }
+          },
+          "toolCallsOnStart": {
+            "description": "An ordered series of tool calls to invoke when starting the flow.",
+            "type": ["array", "null"],
+            "items": {
+              "description": "A proposed (i.e. yet to be executed) tool call.",
+              "type": "object",
+              "properties": {
+                "name": {
+                  "description": "The name of the tool to call.",
+                  "type": "string"
+                },
+                "parameters": {
+                  "description": "The parameters to supply to the tool's call method.\nMust conform to the tool's expected parameters type."
+                },
+                "toolCallId": {
+                  "description": "The ID used by the GPT model to track a proposed tool call to tool a call result.\nThis maps to the toolCallId in ToolCallResultMessage.",
+                  "type": ["string", "null"]
+                }
+              },
+              "additionalProperties": false,
+              "required": ["name", "parameters", "toolCallId"]
+            }
+          },
+          "resultJsonSchema": {
+            "$ref": "#/definitions/JSONSchema7",
+            "description": "If non-null, the Donobu flow will attempt to save its result using this JSON-schema."
+          }
+        },
+        "additionalProperties": false,
+        "required": [
+          "targetWebsite",
+          "overallObjective",
+          "name",
+          "initialBrowserState",
+          "persistBrowserState",
+          "deviceName",
+          "remoteBrowserInstanceUrl",
+          "callbackUrl",
+          "headless",
+          "customTools",
+          "maxIterations",
+          "gptConfigNameOverride",
+          "defaultToolTipDurationMilliseconds",
+          "initialRunMode",
+          "isControlPanelEnabled",
+          "allowedTools",
+          "toolCallsOnStart",
+          "resultJsonSchema"
+        ]
+      }
+    },
+    "additionalProperties": false,
+    "required": ["donobuFlowParameters", "rationale"]
+  },
+  "ChangeWebBrowserTabToolCoreParameters": {
+    "type": "object",
+    "properties": {
+      "tabUrl": {
+        "description": "The URL for the tab to bring focus to.",
+        "type": "string"
+      }
+    },
+    "additionalProperties": false,
+    "required": ["tabUrl"]
+  },
+  "ChangeWebBrowserTabToolGptParameters": {
+    "type": "object",
+    "properties": {
+      "rationale": {
+        "description": "The reason why this particular action is being taken. It MUST relate to the overall objective.",
+        "type": "string"
+      },
+      "tabUrl": {
+        "description": "The URL for the tab to bring focus to.",
+        "type": "string"
+      }
+    },
+    "additionalProperties": false,
+    "required": ["rationale", "tabUrl"]
+  },
+  "GoToGoogleMapsStreetViewToolCoreParameters": {
+    "description": "Parameters for the GoToGoogleMapsStreetViewTool",
+    "type": "object",
+    "properties": {
+      "entityName": {
+        "description": "The name of the business/entity to find.",
+        "type": "string"
+      },
+      "entityLocation": {
+        "description": "The address of the business/entity to find.",
+        "type": "string"
+      }
+    },
+    "additionalProperties": false,
+    "required": ["entityLocation", "entityName"]
+  },
+  "GoToGoogleMapsStreetViewToolGptParameters": {
+    "type": "object",
+    "properties": {
+      "rationale": {
+        "description": "The reason why this particular action is being taken. It MUST relate to the overall objective.",
+        "type": "string"
+      },
+      "entityName": {
+        "description": "The name of the business/entity to find.",
+        "type": "string"
+      },
+      "entityLocation": {
+        "description": "The address of the business/entity to find.",
+        "type": "string"
+      }
+    },
+    "additionalProperties": false,
+    "required": ["entityLocation", "entityName", "rationale"]
+  },
+  "NavigateWithinStreetViewToolCoreParameters": {
+    "type": "object",
+    "properties": {
+      "action": {
+        "description": "Choose a value that will most likely help towards the current objective.\n- A value of ZOOM_IN will zoom in on current street maps view.\n- A value of ZOOM_OUT will zoom out on current street maps view.\n- A value of ROTATE_CLOCKWISE will rotate the current street maps view clockwise.\n- A value of ROTATE_COUNTERCLOCKWISE will rotate the current street maps view counterclockwise.",
+        "type": "string",
+        "enum": [
+          "ROTATE_CLOCKWISE",
+          "ROTATE_COUNTERCLOCKWISE",
+          "ZOOM_IN",
+          "ZOOM_OUT"
+        ]
+      }
+    },
+    "additionalProperties": false,
+    "required": ["action"]
+  },
+  "NavigateWithinStreetViewToolGptParameters": {
+    "type": "object",
+    "properties": {
+      "rationale": {
+        "description": "The reason why this particular action is being taken. It MUST relate to the overall objective.",
+        "type": "string"
+      },
+      "action": {
+        "description": "Choose a value that will most likely help towards the current objective.\n- A value of ZOOM_IN will zoom in on current street maps view.\n- A value of ZOOM_OUT will zoom out on current street maps view.\n- A value of ROTATE_CLOCKWISE will rotate the current street maps view clockwise.\n- A value of ROTATE_COUNTERCLOCKWISE will rotate the current street maps view counterclockwise.",
+        "type": "string",
+        "enum": [
+          "ROTATE_CLOCKWISE",
+          "ROTATE_COUNTERCLOCKWISE",
+          "ZOOM_IN",
+          "ZOOM_OUT"
+        ]
+      }
+    },
+    "additionalProperties": false,
+    "required": ["action", "rationale"]
+  },
+  "ExtractGoogleStreetviewEntityDataToolCoreParameters": {
+    "type": "object",
+    "properties": {
+      "entityName": {
+        "description": "The target business/entity to keep a careful eye out for.",
+        "type": "string"
+      }
+    },
+    "additionalProperties": false,
+    "required": ["entityName"]
+  },
+  "ExtractGoogleStreetviewEntityDataToolGptParameters": {
+    "type": "object",
+    "properties": {
+      "rationale": {
+        "description": "The reason why this particular action is being taken. It MUST relate to the overall objective.",
+        "type": "string"
+      },
+      "entityName": {
+        "description": "The target business/entity to keep a careful eye out for.",
+        "type": "string"
+      }
+    },
+    "additionalProperties": false,
+    "required": ["entityName", "rationale"]
+  },
+  "ExtractPaymentProviderToolCoreParameters": {
+    "type": "object",
+    "additionalProperties": false,
+    "required": [],
+    "properties": {}
+  },
+  "ExtractPaymentProviderToolGptParameters": {
+    "type": "object",
+    "properties": {
+      "rationale": {
+        "description": "The reason why this particular action is being taken. It MUST relate to the overall objective.",
+        "type": "string"
+      }
+    },
+    "additionalProperties": false,
+    "required": ["rationale"]
+  },
+  "ExtractPublicFacebookEntityDataToolCoreParameters": {
+    "type": "object",
+    "properties": {
+      "facebookEntityName": {
+        "description": "The name of the entity's public Facebook page used in its URL. For example, passing a value of 'TheCocaColaCo'\nwould cause Donobu to inspect https://www.facebook.com/TheCocaColaCo.",
+        "type": ["string", "null"]
+      },
+      "facebookEntityUrl": {
+        "description": "The URL of the entity's public Facebook page. For example, https://www.facebook.com/TheCocaColaCo.",
+        "type": ["string", "null"]
+      },
+      "rationale": {
+        "description": "The reason why this particular action is being taken. It MUST relate to the overall objective.",
+        "type": "string"
+      }
+    },
+    "additionalProperties": false,
+    "required": ["rationale", "facebookEntityName", "facebookEntityUrl"]
+  },
+  "ExtractPublicFacebookEntityDataToolGptParameters": {
+    "type": "object",
+    "properties": {
+      "rationale": {
+        "description": "The reason why this particular action is being taken. It MUST relate to the overall objective.",
+        "type": "string"
+      },
+      "facebookEntityName": {
+        "description": "The name of the entity's public Facebook page used in its URL. For example, passing a value of 'TheCocaColaCo'\nwould cause Donobu to inspect https://www.facebook.com/TheCocaColaCo.",
+        "type": ["string", "null"]
+      },
+      "facebookEntityUrl": {
+        "description": "The URL of the entity's public Facebook page. For example, https://www.facebook.com/TheCocaColaCo.",
+        "type": ["string", "null"]
+      }
+    },
+    "additionalProperties": false,
+    "required": ["rationale", "facebookEntityName", "facebookEntityUrl"]
+  },
+  "GetEntityDataFromGoogleMapResultToolCoreParameters": {
+    "type": "object",
+    "additionalProperties": false,
+    "required": [],
+    "properties": {}
+  },
+  "GetEntityDataFromGoogleMapResultToolGptParameters": {
+    "type": "object",
+    "properties": {
+      "entityName": {
+        "description": "The name of the business/entity at the current Google Maps location.",
+        "type": "string"
+      },
+      "entityAddress": {
+        "description": "The address of the business/entity at the current Google Maps location.",
+        "type": "string"
+      },
+      "rationale": {
+        "description": "The reason why this particular action is being taken. It MUST relate to the overall objective.",
+        "type": "string"
+      }
+    },
+    "additionalProperties": false,
+    "required": ["entityAddress", "entityName", "rationale"]
+  },
+  "GoForwardOrBackToolCoreParameters": {
+    "type": "object",
+    "properties": {
+      "direction": {
+        "description": "The direction to navigate - either FORWARD or BACK",
+        "type": "string",
+        "enum": ["FORWARD", "BACK"]
+      }
+    },
+    "additionalProperties": false,
+    "required": ["direction"]
+  },
+  "GoForwardOrBackToolGptParameters": {
+    "type": "object",
+    "properties": {
+      "rationale": {
+        "description": "The reason why this particular action is being taken. It MUST relate to the overall objective.",
+        "type": "string"
+      },
+      "direction": {
+        "description": "The direction to navigate - either FORWARD or BACK",
+        "type": "string",
+        "enum": ["FORWARD", "BACK"]
+      }
+    },
+    "additionalProperties": false,
+    "required": ["direction", "rationale"]
+  },
+  "MakeCommentToolCoreParameters": {
+    "type": "object",
+    "additionalProperties": false,
+    "required": [],
+    "properties": {}
+  },
+  "MakeCommentToolGptParameters": {
+    "type": "object",
+    "properties": {
+      "comment": {
+        "description": "The comment to make.",
+        "type": "string"
+      },
+      "rationale": {
+        "description": "The reason why this particular action is being taken. It MUST relate to the overall objective.",
+        "type": "string"
+      }
+    },
+    "additionalProperties": false,
+    "required": ["comment", "rationale"]
+  },
+  "PauseForUserInteractionToolCoreParameters": {
+    "type": "object",
+    "additionalProperties": false,
+    "required": [],
+    "properties": {}
+  },
+  "PauseForUserInteractionToolGptParameters": {
+    "type": "object",
+    "properties": {
+      "rationale": {
+        "description": "The reason why this particular action is being taken. It MUST relate to the overall objective.",
+        "type": "string"
+      }
+    },
+    "additionalProperties": false,
+    "required": ["rationale"]
+  },
+  "ReloadPageToolCoreParameters": {
+    "type": "object",
+    "additionalProperties": false,
+    "required": [],
+    "properties": {}
+  },
+  "ReloadPageToolGptParameters": {
+    "type": "object",
+    "properties": {
+      "rationale": {
+        "description": "The reason why this particular action is being taken. It MUST relate to the overall objective.",
+        "type": "string"
+      }
+    },
+    "additionalProperties": false,
+    "required": ["rationale"]
+  },
+  "SaveWebpageAsPdfToolCoreParameters": {
+    "type": "object",
+    "additionalProperties": false,
+    "required": [],
+    "properties": {}
+  },
+  "SaveWebpageAsPdfToolGptParameters": {
+    "type": "object",
+    "properties": {
+      "rationale": {
+        "description": "The reason why this particular action is being taken. It MUST relate to the overall objective.",
+        "type": "string"
+      }
+    },
+    "additionalProperties": false,
+    "required": ["rationale"]
+  },
+  "SetRunModeToolCoreParameters": {
+    "type": "object",
+    "properties": {
+      "runMode": {
+        "description": "The value of the run mode to set.",
+        "type": "string",
+        "enum": ["AUTONOMOUS", "INSTRUCT", "DETERMINISTIC"]
+      }
+    },
+    "additionalProperties": false,
+    "required": ["runMode"]
+  },
+  "SetRunModeToolGptParameters": {
+    "type": "object",
+    "properties": {
+      "rationale": {
+        "description": "The reason why this particular action is being taken. It MUST relate to the overall objective.",
+        "type": "string"
+      },
+      "runMode": {
+        "description": "The value of the run mode to set.",
+        "type": "string",
+        "enum": ["AUTONOMOUS", "INSTRUCT", "DETERMINISTIC"]
+      }
+    },
+    "additionalProperties": false,
+    "required": ["rationale", "runMode"]
+  },
+  "DownloadPdfToolCoreParameters": {
+    "type": "object",
+    "properties": {
+      "url": {
+        "description": "The URL of the PDF file to be downloaded.",
+        "type": "string"
+      }
+    },
+    "additionalProperties": false,
+    "required": ["url"]
+  },
+  "DownloadPdfToolGptParameters": {
+    "type": "object",
+    "properties": {
+      "rationale": {
+        "description": "The reason why this particular action is being taken. It MUST relate to the overall objective.",
+        "type": "string"
+      },
+      "url": {
+        "description": "The URL of the PDF file to be downloaded.",
+        "type": "string"
+      }
+    },
+    "additionalProperties": false,
+    "required": ["rationale", "url"]
+  },
+  "WaitToolCoreParameters": {
+    "type": "object",
+    "properties": {
+      "seconds": {
+        "description": "The number of seconds to wait.",
+        "type": "number"
+      }
+    },
+    "additionalProperties": false,
+    "required": ["seconds"]
+  },
+  "WaitToolGptParameters": {
+    "type": "object",
+    "properties": {
+      "rationale": {
+        "description": "The reason why this particular action is being taken. It MUST relate to the overall objective.",
+        "type": "string"
+      },
+      "seconds": {
+        "description": "The number of seconds to wait.",
+        "type": "number"
+      }
+    },
+    "additionalProperties": false,
+    "required": ["rationale", "seconds"]
+  },
+  "HoverOverElementToolCoreParameters": {
+    "type": "object",
+    "additionalProperties": false,
+    "required": [],
+    "properties": {}
+  },
+  "SelectorBasedHoverOverElementToolParameters": {
+    "type": "object",
+    "properties": {
+      "selector": {
+        "description": "A query structure used to resolve specific a HTML element in a webpage.",
+        "type": "object",
+        "properties": {
+          "element": {
+            "description": "An ordered list of element selectors, going from most specific to least specific.",
+            "type": "array",
+            "items": {
+              "type": "string"
+            }
+          },
+          "frame": {
+            "description": "A selector for the corresponding frame of the element to select.\nIf null, this means the primary frame of the page is used.",
+            "type": "string"
+          }
+        },
+        "additionalProperties": false,
+        "required": ["element", "frame"]
+      }
+    },
+    "additionalProperties": false,
+    "required": ["selector"]
+  },
+  "AnnotationBasedHoverOverElementToolParameters": {
+    "type": "object",
+    "properties": {
+      "whyThisAnnotation": {
+        "description": "The reason why this particular numbered annotation was chosen.",
+        "type": "string"
+      },
+      "annotation": {
+        "description": "The numbered annotation of the element to click.",
+        "type": "string"
+      },
+      "rationale": {
+        "description": "The reason why this particular action is being taken. It MUST relate to the overall objective.",
+        "type": "string"
+      }
+    },
+    "additionalProperties": false,
+    "required": ["annotation", "rationale", "whyThisAnnotation"]
+  },
+  "DetectBrokenLinksToolCoreParameters": {
+    "type": "object",
+    "properties": {
+      "captureScreenshots": {
+        "description": "(Optional) Whether to capture screenshots for dead links for visual verification.",
+        "type": ["boolean", "null"]
+      }
+    },
+    "additionalProperties": false,
+    "required": ["captureScreenshots"]
+  },
+  "DetectBrokenLinksToolGptParameters": {
+    "type": "object",
+    "properties": {
+      "rationale": {
+        "description": "The reason why this particular action is being taken. It MUST relate to the overall objective.",
+        "type": "string"
+      },
+      "captureScreenshots": {
+        "description": "(Optional) Whether to capture screenshots for dead links for visual verification.",
+        "type": ["boolean", "null"]
+      }
+    },
+    "additionalProperties": false,
+    "required": ["rationale", "captureScreenshots"]
+  },
+  "AggregateExtractedStreetviewDataToolCoreParameters": {
+    "type": "object",
+    "additionalProperties": false,
+    "required": [],
+    "properties": {}
+  },
+  "AggregateExtractedStreetviewDataToolGptParameters": {
+    "type": "object",
+    "properties": {
+      "rationale": {
+        "description": "The reason why this particular action is being taken. It MUST relate to the overall objective.",
+        "type": "string"
+      }
+    },
+    "additionalProperties": false,
+    "required": ["rationale"]
+  }
+}