Class ActionAiTool

constructor

• new ActionAiTool(
      name: string | String,
      description: string | String,
      parametersJsonSchema: string | String,
      callback: ToolCallback,
  ): Spotfire.Dxp.Framework.Ai.ActionAiTool

  Initializes a new instance of the Spotfire.Dxp.Framework.Ai.ActionAiTool class. This overload accepts a dynamic callback object, which allows ClearScript to marshal a JavaScript function directly without requiring an explicit delegate conversion.

  Parameters

  • name: string | String

    The name of the tool. Must be a valid function name for the AI model.

  • description: string | String

    A description of what the tool does, used by the model to decide when to call it.

  • parametersJsonSchema: string | String

    A JSON Schema string describing the parameters the tool accepts. Example: {"properties": {"query": {"type": "string", "description": "The search query"}}, "required": ["query"]}

  • callback: ToolCallback

    A callback object that is invoked when the model calls this tool. The argument is the JSON-serialized arguments from the model. The return value is serialized and sent back to the model as the tool result. This overload exists to support ClearScript interop where JavaScript functions cannot be automatically marshalled to System.Func.

  Returns Spotfire.Dxp.Framework.Ai.ActionAiTool

  Since

  2.5