ToolResult Object in SuiteScript 2.1 for LLM Integration

The ToolResult object is a fundamental component in SuiteScript 2.1, facilitating interactions with large language models (LLM). This object encapsulates the results of tool calls, enhancing the integration between LLMs and SuiteScript, which is critical for dynamic business processes.

What is the ToolResult Object?

The ToolResult object serves to hold the output from executing a tool specified in an LLM interaction. It comprises key properties that can be accessed within server scripts to manage data flows between LLM requests and SuiteScript logic.

Key Properties of ToolResult

A ToolResult object includes the following properties:

Detailed Description of Properties

• ToolResult.call: This property holds the original request sent from the LLM, enabling context-aware interactions. The llm.ToolCall object provides the specifics needed for executing the defined tool.
• ToolResult.outputs: This property is an array of objects that includes results obtained from executing the tool defined in the LLM call, thus providing the necessary outputs for further processing or response generation.

How to Use ToolResult in Scripts

To effectively use the ToolResult property in server scripts, it is important to follow specific syntax. The following example illustrates how a ToolResult object is created and its properties accessed:

1// Example of creating a ToolResult object
2const toolResult = llm.createToolResult({
3    // Originating tool call request
4    call: toolCall,
5    // Outputs from running the specified tool
6    outputs: [{ result: handlerResult }]
7});
8 
9const toolResultCall = toolResult.call;

This syntax is not functional in isolation but serves to demonstrate how the ToolResult object can be utilized in real-world scenarios, such as LLM interactions that require defined tools to produce meaningful outputs.

Error Handling

When working with ToolResult, it is essential to note the error code READ_ONLY, which is thrown if an attempt is made to set the property after its creation. Proper handling of such errors can ensure robust script behavior.

Conclusion

In summary, the ToolResult object is a pivotal element for developers looking to implement sophisticated integrations with LLMs in SuiteScript 2.1. It provides critical encapsulation of tool calls and outputs, allowing for efficient data-driven interactions within the NetSuite platform.