Back to Firebase Js Sdk

LiveServerToolCallCancellation interface

docs-devsite/ai.liveservertoolcallcancellation.md

12.12.11.9 KB
Original Source

Project: /docs/reference/js/_project.yaml Book: /docs/reference/_book.yaml page_type: reference

{% comment %} DO NOT EDIT THIS FILE! This is generated by the JS SDK team, and any local changes will be overwritten. Changes should be made in the source code at https://github.com/firebase/firebase-js-sdk {% endcomment %}

LiveServerToolCallCancellation interface

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<!-- -->.

<b>Signature:</b>

typescript
export interface LiveServerToolCallCancellation 

Properties

PropertyTypeDescription
functionIdsstring[]<b><i>(Public Preview)</i></b> IDs of function calls that were cancelled. These refer to the <code>id</code> property of a FunctionCall<!-- -->.
type'toolCallCancellation'<b><i>(Public Preview)</i></b>

LiveServerToolCallCancellation.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.

IDs of function calls that were cancelled. These refer to the id property of a FunctionCall<!-- -->.

<b>Signature:</b>

typescript
functionIds: string[];

LiveServerToolCallCancellation.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.

<b>Signature:</b>

typescript
type: 'toolCallCancellation';