LiveServerToolCallCancellation interface
Stay organized with collections
Save and categorize content based on your preferences.
This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
Notification to cancel a previous function call triggered by LiveServerToolCall.
Signature:
export interface LiveServerToolCallCancellation
Properties
| Property |
Type |
Description |
| functionIds |
string[] |
(Public Preview) IDs of function calls that were cancelled. These refer to the id property of a FunctionCall. |
| type |
'toolCallCancellation' |
(Public Preview) |
This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
IDs of function calls that were cancelled. These refer to the id property of a FunctionCall.
Signature:
functionIds: string[];
This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
Signature:
type: 'toolCallCancellation';
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-08-28 UTC.
[null,null,["Last updated 2025-08-28 UTC."],[],[],null,["\u003e This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.\n\nNotification to cancel a previous function call triggered by [LiveServerToolCall](./ai.liveservertoolcall.md#liveservertoolcall_interface).\n\n**Signature:** \n\n export interface LiveServerToolCallCancellation \n\nProperties\n\n| Property | Type | Description |\n|-------------------------------------------------------------------------------------------------|------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| [functionIds](./ai.liveservertoolcallcancellation.md#liveservertoolcallcancellationfunctionids) | string\\[\\] | ***(Public Preview)*** IDs of function calls that were cancelled. These refer to the `id` property of a [FunctionCall](./ai.functioncall.md#functioncall_interface). |\n| [type](./ai.liveservertoolcallcancellation.md#liveservertoolcallcancellationtype) | 'toolCallCancellation' | ***(Public Preview)*** |\n\nLiveServerToolCallCancellation.functionIds This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.\n\nIDs of function calls that were cancelled. These refer to the `id` property of a [FunctionCall](./ai.functioncall.md#functioncall_interface).\n\n**Signature:** \n\n functionIds: string[];\n\nLiveServerToolCallCancellation.type This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.\n\n**Signature:** \n\n type: 'toolCallCancellation';"]]
