Back to Firebase Js Sdk

LiveServerContent interface

docs-devsite/ai.liveservercontent.md

12.12.14.0 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 %}

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

An incremental content update from the model.

<b>Signature:</b>

typescript
export interface LiveServerContent 

Properties

PropertyTypeDescription
inputTranscriptionTranscription<b><i>(Public Preview)</i></b> Transcription of the audio that was input to the model.
interruptedboolean<b><i>(Public Preview)</i></b> Indicates whether the model was interrupted by the client. An interruption occurs when the client sends a message before the model finishes it's turn. This is <code>undefined</code> if the model was not interrupted.
modelTurnContent<b><i>(Public Preview)</i></b> The content that the model has generated as part of the current conversation with the user.
outputTranscriptionTranscription<b><i>(Public Preview)</i></b> Transcription of the audio output from the model.
turnCompleteboolean<b><i>(Public Preview)</i></b> Indicates whether the turn is complete. This is <code>undefined</code> if the turn is not complete.
type'serverContent'<b><i>(Public Preview)</i></b>

LiveServerContent.inputTranscription

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.

Transcription of the audio that was input to the model.

<b>Signature:</b>

typescript
inputTranscription?: Transcription;

LiveServerContent.interrupted

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.

Indicates whether the model was interrupted by the client. An interruption occurs when the client sends a message before the model finishes it's turn. This is undefined if the model was not interrupted.

<b>Signature:</b>

typescript
interrupted?: boolean;

LiveServerContent.modelTurn

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.

The content that the model has generated as part of the current conversation with the user.

<b>Signature:</b>

typescript
modelTurn?: Content;

LiveServerContent.outputTranscription

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.

Transcription of the audio output from the model.

<b>Signature:</b>

typescript
outputTranscription?: Transcription;

LiveServerContent.turnComplete

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.

Indicates whether the turn is complete. This is undefined if the turn is not complete.

<b>Signature:</b>

typescript
turnComplete?: boolean;

LiveServerContent.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: 'serverContent';