این صفحه قابلیتهای Live API را هنگام استفاده از آن ازطریق Firebase AI Logic شرح میدهد، ازجمله:
روشهای ورودی پشتیبانیشده، ازجمله:
توجه داشته باشید که Live API از ورودی تصویر + صدا نیز پشتیبانی میکند.
فهرستهای ویژگیهایی که هنوز پشتیبانی نمیشوند، که بسیاری از آنها بهزودی ارائه میشوند!
برای آشنایی با نحوه سفارشیسازی پیادهسازی بااستفاده از گزینههای پیکربندی مختلف، مثل افزودن ترانویسی، تنظیم صدای پاسخ، یا پیکربندی تشخیص فعالیت گفتاری (VAD) (برای مثال، برای مدیریت وقفهها)، از صفحههای دیگر بازدید کنید. همچنین میتوانید با نحوه مدیریت جلسهها آشنا شوید.
روشهای ورودی
این بخش نحوه ارسال انواع مختلف ورودی به مدل Live API را شرح میدهد. مدلهای صوتی بومی همیشه به ورودی صوتی نیاز دارند (همراه با ورودیهای اختیاری اضافی از نوع نوشتار یا ویدیو)، و همیشه با خروجی صوتی پاسخ میدهند.
توجه داشته باشید که Live API از ورودی تصویر + صدا نیز پشتیبانی میکند.
جاریسازی ورودی صدا
|
روی ارائهدهنده Gemini API کلیک کنید تا محتوا و کد مختص ارائهدهنده را در این صفحه ببینید. |
رایجترین قابلیت Live API، جاریسازی صوتی دوطرفه است، یعنی جاریسازی همزمان ورودی و خروجی صوتی.
Live API از قالبهای صوتی زیر پشتیبانی میکند:
- قالب صوتی ورودی: صدای PCM ۱۶ بیتی خام با فرکانس ۱۶ کیلوهرتز و ترتیب بایتهای کمارزشتر
قالب صوتی خروجی: صدای PCM خام ۱۶ بیتی با فرکانس ۲۴ کیلوهرتز و ترتیب بایتهای کمارزش
انواع MIME پشتیبانیشده:
audio/x-aac،audio/flac،audio/mp3،audio/m4a،audio/mpeg،audio/mpga،audio/mp4،audio/ogg،audio/pcm،audio/wav،audio/webm
برای انتقال بسامد نمونه صدای ورودی، نوع MIME هر Blob حاوی صدا را روی مقداری مثل audio/pcm;rate=16000 تنظیم کنید.
Swift
برای استفاده از Live API، یک نمونه
LiveModel
ایجاد کنید و
حالت پاسخ
را روی audio تنظیم کنید.
import FirebaseAILogic
// Initialize the Gemini Developer API backend service.
// Create a `liveModel` instance with a model that supports the Live API.
let liveModel = FirebaseAI.firebaseAI(backend: .googleAI()).liveModel(
modelName: "GEMINI_LIVE_API_MODEL_NAME",
// Configure the model to respond with audio.
generationConfig: LiveGenerationConfig(
responseModalities: [.audio]
)
)
do {
let session = try await liveModel.connect()
// Load the audio file, or tap a microphone.
guard let audioFile = NSDataAsset(name: "audio.pcm") else {
fatalError("Failed to load audio file")
}
// Provide the audio data.
await session.sendAudioRealtime(audioFile.data)
var outputText = ""
for try await message in session.responses {
if case let .content(content) = message.payload {
content.modelTurn?.parts.forEach { part in
if let part = part as? InlineDataPart, part.mimeType.starts(with: "audio/pcm") {
// Handle 16bit pcm audio data at 24khz
playAudio(part.data)
}
}
// Optional: if you don't need to send more requests.
if content.isTurnComplete {
await session.close()
}
}
}
} catch {
fatalError(error.localizedDescription)
}
Kotlin
برای استفاده از Live API، یک نمونه
LiveModel
ایجاد کنید و
حالت پاسخ
را روی AUDIO تنظیم کنید.
// Initialize the Gemini Developer API backend service.
// Create a `liveModel` instance with a model that supports the Live API.
val liveModel = Firebase.ai(backend = GenerativeBackend.googleAI()).liveModel(
modelName = "GEMINI_LIVE_API_MODEL_NAME",
// Configure the model to respond with audio.
generationConfig = liveGenerationConfig {
responseModality = ResponseModality.AUDIO
}
)
val session = liveModel.connect()
// This is the recommended approach.
// However, you can create your own recorder and handle the stream.
session.startAudioConversation()
Java
برای استفاده از Live API، یک نمونه
LiveModel
ایجاد کنید و
حالت پاسخ
را روی AUDIO تنظیم کنید.
ExecutorService executor = Executors.newFixedThreadPool(1);
// Initialize the Gemini Developer API backend service.
// Create a `liveModel` instance with a model that supports the Live API.
LiveGenerativeModel lm = FirebaseAI.getInstance(GenerativeBackend.googleAI()).liveModel(
"GEMINI_LIVE_API_MODEL_NAME",
// Configure the model to respond with audio.
new LiveGenerationConfig.Builder()
.setResponseModality(ResponseModality.AUDIO)
.build()
);
LiveModelFutures liveModel = LiveModelFutures.from(lm);
ListenableFuture<LiveSession> sessionFuture = liveModel.connect();
Futures.addCallback(sessionFuture, new FutureCallback<LiveSession>() {
@Override
public void onSuccess(LiveSession ses) {
LiveSessionFutures session = LiveSessionFutures.from(ses);
session.startAudioConversation();
}
@Override
public void onFailure(Throwable t) {
// Handle exceptions
}
}, executor);
Web
برای استفاده از Live API، یک نمونه
LiveGenerativeModel
ایجاد کنید و
حالت پاسخ
را روی AUDIO تنظیم کنید.
import { initializeApp } from "firebase/app";
import { getAI, getLiveGenerativeModel, GoogleAIBackend, ResponseModality } from "firebase/ai";
// TODO(developer): Replace the following with your app's Firebase configuration
// See: https://firebase.google.com/docs/web/learn-more#config-object
const firebaseConfig = {
// ...
};
// Initialize FirebaseApp
const firebaseApp = initializeApp(firebaseConfig);
// Initialize the Gemini Developer API backend service.
const ai = getAI(firebaseApp, { backend: new GoogleAIBackend() });
// Create a `LiveGenerativeModel` instance with a model that supports the Live API.
const liveModel = getLiveGenerativeModel(ai, {
model: "GEMINI_LIVE_API_MODEL_NAME",
// Configure the model to respond with audio.
generationConfig: {
responseModalities: [ResponseModality.AUDIO],
},
});
const session = await liveModel.connect();
// Start the audio conversation.
const audioConversationController = await startAudioConversation(session);
// ... Later, to stop the audio conversation
// await audioConversationController.stop()
Dart
برای استفاده از Live API، یک نمونه
LiveGenerativeModel
ایجاد کنید و
حالت پاسخ
را روی audio تنظیم کنید.
import 'package:firebase_ai/firebase_ai.dart';
import 'package:firebase_core/firebase_core.dart';
import 'firebase_options.dart';
import 'package:your_audio_recorder_package/your_audio_recorder_package.dart';
late LiveSession _session;
final _audioRecorder = YourAudioRecorder();
await Firebase.initializeApp(
options: DefaultFirebaseOptions.currentPlatform,
);
// Initialize the Gemini Developer API backend service.
// Create a `liveGenerativeModel` instance with a model that supports the Live API.
final liveModel = FirebaseAI.googleAI().liveGenerativeModel(
model: 'GEMINI_LIVE_API_MODEL_NAME',
// Configure the model to respond with audio.
liveGenerationConfig: LiveGenerationConfig(
responseModalities: [ResponseModalities.audio],
),
);
_session = await liveModel.connect();
final audioRecordStream = _audioRecorder.startRecordingStream();
// Map the Uint8List stream to InlineDataPart stream.
final mediaChunkStream = audioRecordStream.map((data) {
return InlineDataPart('audio/pcm', data);
});
await for (final chunk in mediaChunkStream) {
await _session.sendAudioRealtime(chunk);
}
// In a separate thread, receive the audio response from the model.
await for (final message in _session.receive()) {
// Process the received message.
}
Unity
برای استفاده از Live API، یک نمونه
LiveModel
ایجاد کنید و
حالت پاسخ
را روی Audio تنظیم کنید.
using Firebase;
using Firebase.AI;
async Task SendTextReceiveAudio() {
// Initialize the Gemini Developer API backend service.
// Create a `LiveModel` instance with a model that supports the Live API.
var liveModel = FirebaseAI.GetInstance(FirebaseAI.Backend.GoogleAI()).GetLiveModel(
modelName: "GEMINI_LIVE_API_MODEL_NAME",
// Configure the model to respond with audio.
liveGenerationConfig: new LiveGenerationConfig(
responseModalities: new[] { ResponseModality.Audio })
);
LiveSession session = await liveModel.ConnectAsync();
// Start a coroutine to send audio from the Microphone.
var recordingCoroutine = StartCoroutine(SendAudio(session));
// Start receiving the response.
await ReceiveAudio(session);
}
IEnumerator SendAudio(LiveSession liveSession) {
string microphoneDeviceName = null;
int recordingFrequency = 16000;
int recordingBufferSeconds = 2;
var recordingClip = Microphone.Start(microphoneDeviceName, true,
recordingBufferSeconds, recordingFrequency);
int lastSamplePosition = 0;
while (true) {
if (!Microphone.IsRecording(microphoneDeviceName)) {
yield break;
}
int currentSamplePosition = Microphone.GetPosition(microphoneDeviceName);
if (currentSamplePosition != lastSamplePosition) {
// The Microphone uses a circular buffer, so we need to check if the
// current position wrapped around to the beginning, and handle it accordingly.
int sampleCount;
if (currentSamplePosition > lastSamplePosition) {
sampleCount = currentSamplePosition - lastSamplePosition;
} else {
sampleCount = recordingClip.samples - lastSamplePosition + currentSamplePosition;
}
if (sampleCount > 0) {
// Get the audio chunk.
float[] samples = new float[sampleCount];
recordingClip.GetData(samples, lastSamplePosition);
// Send the data, discarding the resulting Task to avoid the warning.
_ = liveSession.SendAudioAsync(samples);
lastSamplePosition = currentSamplePosition;
}
}
// Wait for a short delay before reading the next sample from the Microphone.
const float MicrophoneReadDelay = 0.5f;
yield return new WaitForSeconds(MicrophoneReadDelay);
}
}
Queue<float> audioBuffer = new();
async Task ReceiveAudio(LiveSession liveSession) {
int sampleRate = 24000;
int channelCount = 1;
// Create a looping AudioClip to fill with the received audio data.
int bufferSamples = (int)(sampleRate * channelCount);
AudioClip clip = AudioClip.Create("StreamingPCM", bufferSamples, channelCount,
sampleRate, true, OnAudioRead);
// Attach the clip to an AudioSource and start playing it.
AudioSource audioSource = GetComponent<AudioSource>();
audioSource.clip = clip;
audioSource.loop = true;
audioSource.Play();
// Start receiving the response.
await foreach (var message in liveSession.ReceiveAsync()) {
// Process the received message
foreach (float[] pcmData in message.AudioAsFloat) {
lock (audioBuffer) {
foreach (float sample in pcmData) {
audioBuffer.Enqueue(sample);
}
}
}
}
}
// This method is called by the AudioClip to load audio data.
private void OnAudioRead(float[] data) {
int samplesToProvide = data.Length;
int samplesProvided = 0;
lock(audioBuffer) {
while (samplesProvided < samplesToProvide && audioBuffer.Count > 0) {
data[samplesProvided] = audioBuffer.Dequeue();
samplesProvided++;
}
}
while (samplesProvided < samplesToProvide) {
data[samplesProvided] = 0.0f;
samplesProvided++;
}
}
جاریسازی ورودی نوشتاری + صوتی
|
روی ارائهدهنده Gemini API کلیک کنید تا محتوا و کد مختص ارائهدهنده را در این صفحه ببینید. |
درصورت نیاز، میتوانید ورودی نوشتاری را همراه با ورودی صوتی ارسال کنید و خروجی صوتی جاریشده دریافت کنید.
Swift
برای استفاده از Live API، یک نمونه
LiveModel
ایجاد کنید و
حالت پاسخ
را روی audio تنظیم کنید.
import FirebaseAILogic
// Initialize the Gemini Developer API backend service.
// Create a `liveModel` instance with a model that supports the Live API.
let liveModel = FirebaseAI.firebaseAI(backend: .googleAI()).liveModel(
modelName: "GEMINI_LIVE_API_MODEL_NAME",
// Configure the model to respond with audio.
generationConfig: LiveGenerationConfig(
responseModalities: [.audio]
)
)
do {
let session = try await liveModel.connect()
// Provide a text prompt.
let text = "tell a short story"
await session.sendTextRealtime(text)
var outputText = ""
for try await message in session.responses {
if case let .content(content) = message.payload {
content.modelTurn?.parts.forEach { part in
if let part = part as? InlineDataPart, part.mimeType.starts(with: "audio/pcm") {
// Handle 16-bit PCM audio data at 24 kHz.
playAudio(part.data)
}
}
// Optional: if you don't need to send more requests.
if content.isTurnComplete {
await session.close()
}
}
}
} catch {
fatalError(error.localizedDescription)
}
Kotlin
برای استفاده از Live API، یک نمونه
LiveModel
ایجاد کنید و
حالت پاسخ
را روی AUDIO تنظیم کنید.
// Initialize the Gemini Developer API backend service.
// Create a `liveModel` instance with a model that supports the Live API.
val liveModel = Firebase.ai(backend = GenerativeBackend.googleAI()).liveModel(
modelName = "GEMINI_LIVE_API_MODEL_NAME",
// Configure the model to respond with audio.
generationConfig = liveGenerationConfig {
responseModality = ResponseModality.AUDIO
}
)
val session = liveModel.connect()
// Provide a text prompt.
val text = "tell a short story"
session.send(text)
session.receive().collect {
if(it.turnComplete) {
// Optional: if you don't need to send more requests.
session.stopReceiving();
}
// Handle 16bit pcm audio data at 24khz.
playAudio(it.data)
}
Java
برای استفاده از Live API، یک نمونه
LiveModel
ایجاد کنید و
حالت پاسخ
را روی AUDIO تنظیم کنید.
ExecutorService executor = Executors.newFixedThreadPool(1);
// Initialize the Gemini Developer API backend service.
// Create a `liveModel` instance with a model that supports the Live API.
LiveGenerativeModel lm = FirebaseAI.getInstance(GenerativeBackend.googleAI()).liveModel(
"GEMINI_LIVE_API_MODEL_NAME",
// Configure the model to respond with audio.
new LiveGenerationConfig.Builder()
.setResponseModality(ResponseModality.AUDIO)
.build()
);
LiveModelFutures model = LiveModelFutures.from(lm);
ListenableFuture<LiveSession> sessionFuture = model.connect();
class LiveContentResponseSubscriber implements Subscriber<LiveContentResponse> {
@Override
public void onSubscribe(Subscription s) {
s.request(Long.MAX_VALUE); // Request an unlimited number of items
}
@Override
public void onNext(LiveContentResponse liveContentResponse) {
// Handle 16bit pcm audio data at 24khz.
liveContentResponse.getData();
}
@Override
public void onError(Throwable t) {
System.err.println("Error: " + t.getMessage());
}
@Override
public void onComplete() {
System.out.println("Done receiving messages!");
}
}
Futures.addCallback(sessionFuture, new FutureCallback<LiveSession>() {
@Override
public void onSuccess(LiveSession ses) {
LiveSessionFutures session = LiveSessionFutures.from(ses);
// Provide a text prompt.
String text = "tell me a short story?";
session.send(text);
Publisher<LiveContentResponse> publisher = session.receive();
publisher.subscribe(new LiveContentResponseSubscriber());
}
@Override
public void onFailure(Throwable t) {
// Handle exceptions
}
}, executor);
Web
برای استفاده از Live API، یک نمونه
LiveGenerativeModel
ایجاد کنید و
حالت پاسخ
را روی AUDIO تنظیم کنید.
import { initializeApp } from "firebase/app";
import { getAI, getLiveGenerativeModel, GoogleAIBackend, ResponseModality } from "firebase/ai";
// TODO(developer): Replace the following with your app's Firebase configuration
// See: https://firebase.google.com/docs/web/learn-more#config-object
const firebaseConfig = {
// ...
};
// Initialize FirebaseApp
const firebaseApp = initializeApp(firebaseConfig);
// Initialize the Gemini Developer API backend service.
const ai = getAI(firebaseApp, { backend: new GoogleAIBackend() });
// Create a `LiveGenerativeModel` instance with a model that supports the Live API.
const liveModel = getLiveGenerativeModel(ai, {
model: "GEMINI_LIVE_API_MODEL_NAME",
// Configure the model to respond with audio
generationConfig: {
responseModalities: [ResponseModality.AUDIO],
},
});
const session = await liveModel.connect();
// Provide a text prompt.
const prompt = "tell a short story";
session.send(prompt);
// Handle the model's audio output.
const messages = session.receive();
for await (const message of messages) {
switch (message.type) {
case "serverContent":
if (message.turnComplete) {
// TODO(developer): Handle turn completion
} else if (message.interrupted) {
// TODO(developer): Handle the interruption
break;
} else if (message.modelTurn) {
const parts = message.modelTurn?.parts;
parts?.forEach((part) => {
if (part.type === "inlineData") {
// TODO(developer): Play the audio chunk
}
});
}
break;
case "toolCall":
// Ignore
case "toolCallCancellation":
// Ignore
}
}
Dart
برای استفاده از Live API، یک نمونه
LiveGenerativeModel
ایجاد کنید و
حالت پاسخ
را روی audio تنظیم کنید.
import 'package:firebase_ai/firebase_ai.dart';
import 'package:firebase_core/firebase_core.dart';
import 'firebase_options.dart';
import 'dart:async';
import 'dart:typed_data';
late LiveSession _session;
Future<Stream<Uint8List>> textToAudio(String textPrompt) async {
WidgetsFlutterBinding.ensureInitialized();
await Firebase.initializeApp(
options: DefaultFirebaseOptions.currentPlatform,
);
// Initialize the Gemini Developer API backend service.
// Create a `liveGenerativeModel` instance with a model that supports the Live API.
final liveModel = FirebaseAI.googleAI().liveGenerativeModel(
model: 'GEMINI_LIVE_API_MODEL_NAME',
// Configure the model to respond with audio.
liveGenerationConfig: LiveGenerationConfig(
responseModalities: [ResponseModalities.audio],
),
);
_session = await liveModel.connect();
final prompt = Content.text(textPrompt);
await _session.send(input: prompt);
return _session.receive().asyncMap((response) async {
final message = response.message;
if (message is LiveServerContent && message.modelTurn?.parts != null) {
for (final part in message.modelTurn!.parts) {
if (part is InlineDataPart) {
return part.bytes;
}
}
}
throw Exception('Audio data not found');
});
}
Future<void> main() async {
try {
final audioStream = await textToAudio('Convert this text to audio.');
await for (final audioData in audioStream) {
// Process the audio data (e.g., play it using an audio player package).
print('Received audio data: ${audioData.length} bytes');
// Example using flutter_sound (replace with your chosen package):
// await _flutterSoundPlayer.startPlayer(fromDataBuffer: audioData);
}
} catch (e) {
print('Error: $e');
}
}
Unity
برای استفاده از Live API، یک نمونه
LiveModel
ایجاد کنید و
حالت پاسخ
را روی Audio تنظیم کنید.
using Firebase;
using Firebase.AI;
async Task SendTextReceiveAudio() {
// Initialize the Gemini Developer API backend service.
// Create a `LiveModel` instance with a model that supports the Live API.
var liveModel = FirebaseAI.GetInstance(FirebaseAI.Backend.GoogleAI()).GetLiveModel(
modelName: "GEMINI_LIVE_API_MODEL_NAME",
// Configure the model to respond with audio.
liveGenerationConfig: new LiveGenerationConfig(
responseModalities: new[] { ResponseModality.Audio })
);
LiveSession session = await liveModel.ConnectAsync();
// Provide a text prompt.
var prompt = ModelContent.Text("Convert this text to audio.");
await session.SendAsync(content: prompt, turnComplete: true);
// Start receiving the response.
await ReceiveAudio(session);
}
Queue<float> audioBuffer = new();
async Task ReceiveAudio(LiveSession session) {
int sampleRate = 24000;
int channelCount = 1;
// Create a looping AudioClip to fill with the received audio data.
int bufferSamples = (int)(sampleRate * channelCount);
AudioClip clip = AudioClip.Create("StreamingPCM", bufferSamples, channelCount,
sampleRate, true, OnAudioRead);
// Attach the clip to an AudioSource and start playing it.
AudioSource audioSource = GetComponent<AudioSource>();
audioSource.clip = clip;
audioSource.loop = true;
audioSource.Play();
// Start receiving the response.
await foreach (var message in session.ReceiveAsync()) {
// Process the received message.
foreach (float[] pcmData in message.AudioAsFloat) {
lock (audioBuffer) {
foreach (float sample in pcmData) {
audioBuffer.Enqueue(sample);
}
}
}
}
}
// This method is called by the AudioClip to load audio data.
private void OnAudioRead(float[] data) {
int samplesToProvide = data.Length;
int samplesProvided = 0;
lock(audioBuffer) {
while (samplesProvided < samplesToProvide && audioBuffer.Count > 0) {
data[samplesProvided] = audioBuffer.Dequeue();
samplesProvided++;
}
}
while (samplesProvided < samplesToProvide) {
data[samplesProvided] = 0.0f;
samplesProvided++;
}
}
توجه داشته باشید که میتوانید نوشتار را بهصورت بهروزرسانیهای افزایشی محتوا درطول جلسه فعال نیز ارسال کنید.
جاریسازی ورودی ویدیو + صدا
ارائه محتوای ویدیویی ورودی، بافتار دیداری برای صدای ورودی فراهم میکند.
Live API انتظار دنبالهای از فریمهای تصویر گسسته را دارد و از ورودی فریمهای ویدیو با سرعت ۱ فریم در ثانیه (FPS) پشتیبانی میکند.
ورودی توصیهشده: وضوح اصلی ۷۶۸×۷۶۸ با ۱ فریم در ثانیه.
انواع MIME پشتیبانیشده:
video/x-flv،video/quicktime،video/mpeg،video/mpegs،video/mpg،video/mp4،video/webm،video/wmv،video/3gpp
جاریسازی ورودی ویدیو + صدا پیادهسازی پیشرفتهتری است، بنابراین برای آشنایی با نحوه پیادهسازی این قابلیت، برنامه نمونه را بررسی کنید: Swift - بهزودی! | Android - برنامه نمونه | وب - بهزودی! | Flutter - برنامه نمونه | Unity - بهزودی!
ویژگیهایی که هنوز پشتیبانی نمیشوند
ویژگیهایی که هنوز توسط Firebase AI Logic هنگام استفاده از Live API پشتیبانی نمیشوند، اما بهزودی اضافه خواهند شد!
پیکربندی اندیشیدن (پیشفرض برای مدل Gemini Live 3.x،
minimalاست)تنظیم وضوح رسانه ورودی
درحال افزودن پیکربندی تفکر
فعال کردن مکالمه عاطفی یا پاسخدهی پیشکنشی (فقط برای مدلهای Gemini Live 2.x قابلاجرا است)
دریافت
UsageMetadataدر پاسخ
ویژگیهایی که هنگام استفاده از Live API، توسط Firebase AI Logic پشتیبانی نمیشوند و درحالحاضر برنامهای برای آنها وجود ندارد.
الگوهای پیامواره سرور
استنتاج ترکیبی یا دروندستگاهی
پایش هوش مصنوعی در کنسول Firebase
چه کارهای دیگری میتوانید انجام دهید؟
بااستفاده از گزینههای پیکربندی مختلف، پیادهسازیتان را سفارشیسازی کنید، مثلاً با افزودن ترانویسی، تنظیم صدای پاسخ، یا پیکربندی تشخیص فعالیت گفتاری (VAD) (برای مثال، برای مدیریت وقفهها).
با مدیریت جلسهها، ازجمله بهروزرسانی محتوا در اواسط جلسه، علامتدهی دستی فعالیت کاربر، فشردهسازی پنجره زمینه، تشخیص زمان پایان جلسه، و ازسرگیری جلسه آشنا شوید.
با دادن دسترسی به ابزارهایی مثل فراخوانی تابع و «پایهسازی» با
Google Search به مدل، پیادهسازیتان را تقویت کنید. مستندات رسمی برای استفاده از ابزارها با Live API بهزودی ارائه میشود!با حدود و مشخصات استفاده از Live API، مثل طول جلسه، حدود نرخ، زبانهای پشتیبانیشده، و غیره آشنا شوید.