calculate

expression

type: str

description: The mathematical expression to calculate, such as '2 + 2'.

result

description: The result of the mathematical expression.

domain: retail

frontmatter:
Tool: calculate
Description: Calculate the result of a mathematical expression.
Inputs: expression:str
Outputs: result:str


description: The order id, such as '#W0000000'.

reason

description: The reason for cancellation, either 'no longer needed' or 'ordered by mistake'.

order

type: order

description: The order details after the cancellation.

frontmatter:
Tool: cancel_pending_order
Description: Cancel a pending order and refund its payment.
Inputs: order_id:str, reason:str
Outputs: order:order


description: The order id, such as '#W0000000'.

type: list(str)

description: The item ids to be exchanged.

description: The new item ids to exchange for, matching each old item by position and product.

description: The payment method id to pay or receive the price difference.

description: The order details after the exchange.

frontmatter:
Tool: exchange_delivered_order_items
Description: Exchange items in a delivered order for new items of the same product type.
Inputs: order_id:str, item_ids:list(str), new_item_ids:list(str), payment_method_id:str
Outputs: order:order


description: Find a user id by their email address.

email

description: The email of the user.

description: The user id if found.

frontmatter:
Tool: find_user_id_by_email
Description: Find a user id by their email address.
Inputs: email:str
Outputs: user_id:str


description: The first name of the customer.

description: The last name of the customer.

zip

description: The zip code of the customer.

description: The user id if found.

frontmatter:
Tool: find_user_id_by_name_zip
Description: Find a user id by first name, last name, and zip code.
Inputs: first_name:str, last_name:str, zip:str
Outputs: user_id:str


description: Get the inventory details of an item.

description: The item id, which is different from the product id.

item

type: variant

description: The item details.

frontmatter:
Tool: get_item_details
Description: Get the inventory details of an item.
Inputs: item_id:str
Outputs: item:variant


description: Get the status and details of an order.

description: The order id, such as '#W0000000'.

order

description: The order details.

frontmatter:
Tool: get_order_details
Description: Get the status and details of an order.
Inputs: order_id:str
Outputs: order:order


description: Get the inventory details of a product.

description: The product id, which is different from the item id.

product

type: product

description: The product details.

frontmatter:
Tool: get_product_details
Description: Get the inventory details of a product.
Inputs: product_id:str
Outputs: product:product


description: The user id, such as 'sara_doe_496'.

user

type: user

description: The user details.

frontmatter:
Tool: get_user_details
Description: Get the details of a user, including their orders.
Inputs: user_id:str
Outputs: user:user


description: A JSON string mapping product names to their product ids.

frontmatter:
Tool: list_all_product_types
Description: List the name and product id of all product types.
Outputs: product_types:str


description: The order id, such as '#W0000000'.

description: The first line of the address.

description: The second line of the address, or an empty string.

city

description: The city.

state

description: The state.

country

description: The country.

zip

description: The zip code.

order

description: The order details after the modification.

frontmatter:
Tool: modify_pending_order_address
Description: Modify the shipping address of a pending order.
Inputs: order_id:str, address1:str, address2:str, city:str, state:str, country:str, zip:str
Outputs: order:order


description: The order id, such as '#W0000000'.

description: The item ids to be modified.

description: The new item ids to modify to, matching each old item by position and product.

frontmatter:
Tool: modify_pending_order_items
Description: Modify items in a pending order to new items of the same product type.
Inputs: order_id:str, item_ids:list(str), new_item_ids:list(str), payment_method_id:str
Outputs: order:order


description: The order id, such as '#W0000000'.

description: The payment method id to use for the order.

frontmatter:
Tool: modify_pending_order_payment
Description: Modify the payment method of a pending order.
Inputs: order_id:str, payment_method_id:str
Outputs: order:order


description: Modify the default address of a user.

description: The user id, such as 'sara_doe_496'.

description: The first line of the address.

city

description: The city.

state

description: The state.

country

description: The country.

zip

description: The zip code.

user

description: The user details after the modification.

frontmatter:
Tool: modify_user_address
Description: Modify the default address of a user.
Inputs: user_id:str, address1:str, address2:str, city:str, state:str, country:str, zip:str
Outputs: user:user


description: Return some items of a delivered order.

description: The order id, such as '#W0000000'.

description: The item ids to be returned.

description: The payment method id to receive the refund.

order

description: The order details after requesting the return.

frontmatter:
Tool: return_delivered_order_items
Description: Return some items of a delivered order.
Inputs: order_id:str, item_ids:list(str), payment_method_id:str
Outputs: order:order


summary

description: A summary of the user's issue.

message

description: A message indicating the user has been transferred.

frontmatter:
Tool: transfer_to_human_agents
Description: Transfer the user to a human agent with a summary of their issue.
Inputs: summary:str
Outputs: message:str


description: Find a user id by their phone number.

phone

description: The phone number of the user.

description: The user id if found.

frontmatter:
Tool: find_user_id_by_phone
Description: Find a user id by their phone number.
Inputs: phone:str
Outputs: user_id:str


username

description: The username of the user.

description: The user id if found.

frontmatter:
Tool: find_user_id_by_username
Description: Find a user id by their account username.
Inputs: username:str
Outputs: user_id:str


description: The order id, such as '#W0000000'.

invoice

description: The invoice details for the order.

frontmatter:
Tool: get_order_invoice
Description: Get the formatted billing invoice document for an order, itemizing charges and tax (not the order's live status or item list).
Inputs: order_id:str
Outputs: invoice:str


description: The order id, such as '#W0000000'.

reason

description: The reason for the cancellation.

order

description: The order details after cancellation.

frontmatter:
Tool: cancel_delivered_order
Description: Cancel an order that has ALREADY been delivered (unlike cancelling a still-pending order).
Inputs: order_id:str, reason:str
Outputs: order:order


description: The order id, such as '#W0000000'.

description: The item ids to be returned.

description: The order details after the return.

frontmatter:
Tool: return_pending_order_items
Description: Return items from a still-PENDING order before it ships (distinct from returning an already-delivered order's items).
Inputs: order_id:str, item_ids:list(str)
Outputs: order:order


reviews

description: The customer reviews for the product.

frontmatter:
Tool: get_product_reviews
Description: Get customer star-ratings and written reviews for a product (not its specifications, price, or variants).
Inputs: product_id:str
Outputs: reviews:str


description: The user id, such as 'sara_doe_496'.

email

description: The new email address.

frontmatter:
Tool: modify_user_email
Description: Change the EMAIL address on a user's account (a contact field, not the shipping address).
Inputs: user_id:str, email:str
Outputs: user:user


description: The user id, such as 'sara_doe_496'.

description: The new first name.

description: The new last name.

frontmatter:
Tool: modify_user_name
Description: Change the first and last NAME on a user's account (not the shipping address).
Inputs: user_id:str, first_name:str, last_name:str
Outputs: user:user


description: The user id, such as 'sara_doe_496'.

phone

description: The new phone number.

frontmatter:
Tool: modify_user_phone
Description: Change the PHONE number on a user's account (not the shipping address).
Inputs: user_id:str, phone:str
Outputs: user:user


description: The order id, such as '#W0000000'.

description: The gift card id to apply.

order

description: The order details after applying the gift card.

frontmatter:
Tool: apply_gift_card
Description: Apply a GIFT CARD balance to a pending order (not switch the order's saved payment method).
Inputs: order_id:str, gift_card_id:str
Outputs: order:order


domain: telecom-dummy

frontmatter:
Tool: can_send_mms
Description: Check whether a line can send MMS messages.
Inputs: customer_id:str?, device_id:str?, line_id:str?, phone_number:str?


frontmatter:
Tool: check_apn_settings
Description: Check the APN (access point name) configuration for a line.
Inputs: customer_id:str?, device_id:str?, line_id:str?


frontmatter:
Tool: check_app_permissions
Description: Check the permissions granted to an app on a device.
Inputs: app_name:str, device_id:str?


frontmatter:
Tool: check_data_restriction_status
Description: Check whether data restrictions are active on the device.


frontmatter:
Tool: check_network_mode_preference
Description: Check the preferred network mode (e.g. 4G/5G) for a device.
Inputs: device_id:str?


frontmatter:
Tool: check_network_status
Description: Check the mobile network status for a line or region.
Inputs: customer_id:str?, device_id:str?, line_id:str?, phone_number:str?


description: Check the SIM card status for a line.

frontmatter:
Tool: check_sim_status
Description: Check the SIM card status for a line.


frontmatter:
Tool: check_status_bar
Description: Check the device status bar (signal and connectivity indicators).
Inputs: customer_id:str?, device_id:str?, line_id:str?, phone_number:str?


frontmatter:
Tool: check_vpn_status
Description: Check whether a VPN is connected on the device.
Inputs: device_id:str?


frontmatter:
Tool: check_wifi_calling_status
Description: Check whether Wi-Fi calling is enabled on the device.
Inputs: device_id:str?


description: Enable international roaming on a line.

frontmatter:
Tool: enable_roaming
Description: Enable international roaming on a line.
Inputs: customer_id:str, line_id:str


description: Retrieve a customer's billing records.

limit

type: int

frontmatter:
Tool: get_bills_for_customer
Description: Retrieve a customer's billing records.
Inputs: customer_id:str, limit:int?
Outputs: results:list(str)


address

type: object

frontmatter:
Tool: get_customer_by_id
Description: Look up a customer account by their customer id.
Inputs: customer_id:str
Outputs: customer_id:str, full_name:str, date_of_birth:str, email:str, phone_number:str, address:object


frontmatter:
Tool: get_customer_by_phone
Description: Look up a customer account by their phone number.
Inputs: phone_number:str
Outputs: customer_id:str, full_name:str, date_of_birth:str, email:str, phone_number:str, address:object


frontmatter:
Tool: get_data_usage
Description: Retrieve the current data usage for a line.
Inputs: customer_id:str, line_id:str
Outputs: line_id:str, data_used_gb:str, data_limit_gb:str, data_refueling_gb:str, cycle_end_date:str


type: float

frontmatter:
Tool: get_details_by_id
Description: Retrieve the details of a line or entity by its id.
Inputs: id:str
Outputs: line_id:str, phone_number:str, status:str, plan_id:str, device_id:str, data_used_gb:float


description: Add a data top-up (refuel) to a line.

frontmatter:
Tool: refuel_data
Description: Add a data top-up (refuel) to a line.
Inputs: customer_id:str, gb_amount:int, line_id:str
Outputs: message:str, new_data_refueling_gb:str, charge:str


description: Resume a suspended line.

frontmatter:
Tool: resume_line
Description: Resume a suspended line.
Inputs: customer_id:str, line_id:str
Outputs: message:str, line:object


description: Run a network speed test for a line.

frontmatter:
Tool: run_speed_test
Description: Run a network speed test for a line.


frontmatter:
Tool: send_payment_request
Description: Send a payment request for a customer's outstanding bill.
Inputs: bill_id:str, customer_id:str