set_tool_response | SignalWire

Set the structured form of the response, separating what the tool did from what the model should say next. The response becomes an object with up to two keys:

{
  "tool_result": "status: on hold",
  "tool_prompt": "Tell the caller you are placing them on hold."
}

Splitting them keeps the model from reading a status line aloud, and keeps the spoken instruction from being mistaken for data. For a single instruction string, use set_response().

Parameters

tool_result

str | NoneDefaults to None

What the tool did: a factual status line for the model to reason from, such as "payment declined" or "3 seats left". Omit it when there is nothing to report beyond the instruction.

tool_prompt

str | NoneDefaults to None

What the model should now say, as an instruction in the second person. Omit it for a silent, status-only result.

Returns

FunctionResult — self, for chaining.

Example

from signalwire import AgentBase
from signalwire import FunctionResult
agent = AgentBase(name="my-agent", route="/agent")
agent.set_prompt_text("You are a helpful assistant.")
@agent.tool(name="check_seats", description="Check remaining seats for a showing")
def check_seats(args, raw_data):
    seats = 3  # look this up in your booking system
    return FunctionResult().set_tool_response(
        tool_result=f"seats remaining: {seats}",
        tool_prompt="Tell the caller how many seats are left and ask how many they want.",
    )
agent.serve()