Ten samouczek pokazuje, jak uzyskać dostęp do interfejsu Gemini API na potrzeby aplikacji Dart lub Flutter za pomocą pakietu SDK Google AI Dart SDK. Tego pakietu SDK możesz używać, jeśli nie chcesz pracować bezpośrednio z interfejsami API REST w celu uzyskiwania dostępu do modeli Gemini w aplikacji.
Z tego samouczka dowiesz się, jak:
- Konfigurowanie projektu, w tym klucza interfejsu API
- Generowanie tekstu tylko na podstawie tekstu
- Generowanie tekstu na podstawie danych wejściowych typu tekst i obraz (multimodalne)
- Tworzenie rozmów wieloetapowych (czat)
- Korzystanie ze strumieniowania danych w celu szybszej interakcji
Ten samouczek zawiera też sekcje dotyczące zaawansowanych przypadków użycia (takich jak umieszczanie na stronie i tokeny zliczania) oraz opcje kontrolowania generowania treści.
Wymagania wstępne
W tym samouczku zakładamy, że umiesz tworzyć aplikacje za pomocą Dart.
Aby ukończyć ten samouczek, sprawdź, czy Twoje środowisko programistyczne spełnia te wymagania:
- Dart 3.2.0 lub nowszy
Konfigurowanie projektu
Zanim wywołasz interfejs Gemini API, musisz skonfigurować projekt, który obejmuje skonfigurowanie klucza interfejsu API, dodanie pakietu SDK do zależności wydawcy i zainicjowanie modelu.
Konfigurowanie klucza interfejsu API
Aby korzystać z interfejsu Gemini API, potrzebujesz klucza interfejsu API. Jeśli nie masz jeszcze klucza, utwórz go w Google AI Studio.
Uzyskiwanie klucza interfejsu API
Zabezpieczanie klucza interfejsu API
Dbaj o bezpieczeństwo klucza interfejsu API. Zdecydowanie zalecamy, aby nie umieszczać klucza interfejsu API bezpośrednio w kodzie ani sprawdzać plików, które go zawierają, w systemach kontroli wersji. Zamiast tego używaj magazynu obiektów tajnych klucza interfejsu API.
Wszystkie fragmenty kodu w tym samouczku zakładają, że uzyskujesz dostęp do klucza interfejsu API jako zmiennej środowiskowej procesu. Jeśli tworzysz aplikację Flutter, możesz użyć String.fromEnvironment i przekazać kod --dart-define=API_KEY=$API_KEY do flutter build lub flutter run do skompilowania za pomocą klucza interfejsu API, ponieważ środowisko procesu będzie inne podczas uruchamiania aplikacji.
Zainstaluj pakiet SDK
Aby użyć interfejsu Gemini API we własnej aplikacji, musisz add
pakiet google_generative_ai dla aplikacji Dart lub Flutter:
Dart
dart pub add google_generative_ai
Flutter
flutter pub add google_generative_ai
Inicjowanie modelu generatywnego
Zanim zaczniesz wywoływać interfejs API, musisz zaimportować i zainicjować model generatywny.
import 'package:google_generative_ai/google_generative_ai.dart';
// Access your API key as an environment variable (see "Set up your API key" above)
final apiKey = Platform.environment['API_KEY'];
if (apiKey == null) {
print('No \$API_KEY environment variable');
exit(1);
}
final model = GenerativeModel(model: 'MODEL_NAME', apiKey: apiKey);
Określając model, pamiętaj o tych kwestiach:
Użyj modelu, który odpowiada Twojemu przypadkowi użycia (np.
gemini-pro-visionjest używany w przypadku multimodalnych danych wejściowych). W tym przewodniku w instrukcjach dotyczących poszczególnych implementacji wymieniono model zalecany dla każdego przypadku użycia.
Wdrażanie typowych przypadków użycia
Po skonfigurowaniu projektu możesz zacząć korzystać z interfejsu Gemini API, aby wdrażać różne przypadki użycia:
- Generowanie tekstu tylko na podstawie tekstu
- Generowanie tekstu na podstawie danych wejściowych typu tekst i obraz (multimodalne)
- Tworzenie rozmów wieloetapowych (czat)
- Korzystanie ze strumieniowania danych w celu szybszej interakcji
W sekcji zaawansowanych przypadków użycia znajdziesz informacje o interfejsie Gemini API i umieszczaniu.
Generuj tekst na podstawie samego tekstu
Jeśli dane wejściowe promptu zawierają tylko tekst, użyj modelu gemini-pro z metodą generateContent, aby wygenerować dane wyjściowe tekstowe:
import 'dart:io';
import 'package:google_generative_ai/google_generative_ai.dart';
void main() async {
// Access your API key as an environment variable (see "Set up your API key" above)
final apiKey = Platform.environment['API_KEY'];
if (apiKey == null) {
print('No \$API_KEY environment variable');
exit(1);
}
// For text-only input, use the gemini-pro model
final model = GenerativeModel(model: 'gemini-pro', apiKey: apiKey);
final content = [Content.text('Write a story about a magic backpack.')];
final response = await model.generateContent(content);
print(response.text);
}
Generuj tekst na podstawie danych wejściowych typu tekst i obraz (multimodalne)
Gemini udostępnia model multimodalny (gemini-pro-vision), który umożliwia wpisywanie zarówno tekstu, jak i obrazów. Zapoznaj się z wymaganiami dotyczącymi obrazów w przypadku danych wejściowych.
Jeśli dane wejściowe promptu zawierają zarówno tekst, jak i obrazy, do wygenerowania danych wyjściowych tekstowych użyj modelu gemini-pro-vision z metodą generateContent:
import 'dart:io';
import 'package:google_generative_ai/google_generative_ai.dart';
void main() async {
// Access your API key as an environment variable (see "Set up your API key" above)
final apiKey = Platform.environment['API_KEY'];
if (apiKey == null) {
print('No \$API_KEY environment variable');
exit(1);
}
// For text-and-image input (multimodal), use the gemini-pro-vision model
final model = GenerativeModel(model: 'gemini-pro-vision', apiKey: apiKey);
final (firstImage, secondImage) = await (
File('image0.jpg').readAsBytes(),
File('image1.jpg').readAsBytes()
).wait;
final prompt = TextPart("What's different between these pictures?");
final imageParts = [
DataPart('image/jpeg', firstImage),
DataPart('image/jpeg', secondImage),
];
final response = await model.generateContent([
Content.multi([prompt, ...imageParts])
]);
print(response.text);
}
Tworzenie rozmów wieloetapowych (czat)
Dzięki Gemini możesz swobodnie prowadzić rozmowy w wielu etapach. Pakiet SDK upraszcza ten proces, zarządzając stanem rozmowy, więc w przeciwieństwie do pakietu generateContent nie musisz samodzielnie przechowywać historii rozmowy.
Aby utworzyć rozmowę wieloetapową (taką jak czat), użyj modelu gemini-pro i zainicjuj czat, wywołując metodę startChat(). Następnie za pomocą polecenia sendMessage() możesz wysłać nową wiadomość do użytkownika, która również dołączy tę wiadomość i odpowiedź do historii czatu.
Atrybut role może być powiązany z treścią rozmowy na 2 sposoby:
user: rola, która udostępnia prompty. Jest to wartość domyślna w wywołaniach funkcjisendMessage, a w przypadku przekazania innej roli funkcja zgłosi wyjątek.model: rola, która udziela odpowiedzi. Tej roli można używać przy wywoływaniu funkcjistartChat()za pomocą istniejącej funkcjihistory.
import 'dart:io';
import 'package:google_generative_ai/google_generative_ai.dart';
Future<void> main() async {
// Access your API key as an environment variable (see "Set up your API key" above)
final apiKey = Platform.environment['API_KEY'];
if (apiKey == null) {
print('No \$API_KEY environment variable');
exit(1);
}
// For text-only input, use the gemini-pro model
final model = GenerativeModel(
model: 'gemini-pro',
apiKey: apiKey,
generationConfig: GenerationConfig(maxOutputTokens: 100));
// Initialize the chat
final chat = model.startChat(history: [
Content.text('Hello, I have 2 dogs in my house.'),
Content.model([TextPart('Great to meet you. What would you like to know?')])
]);
var content = Content.text('How many paws are in my house?');
var response = await chat.sendMessage(content);
print(response.text);
}
Strumieniowanie zapewnia szybsze interakcje
Domyślnie model zwraca odpowiedź po zakończeniu całego procesu generowania. Możesz przyspieszyć interakcje, nie czekając na cały wynik. Zamiast tego możesz używać strumieniowania do obsługi częściowych wyników.
Z przykładu poniżej dowiesz się, jak wdrożyć strumieniowanie za pomocą metody generateContentStream, aby generować tekst na podstawie promptu z tekstem i obrazem.
// ...
final response = model.generateContentStream([
Content.multi([prompt, ...imageParts])
]);
await for (final chunk in response) {
print(chunk.text);
}
// ...
Podobne podejście możesz zastosować w przypadkach użycia związanych tylko z tekstem i na czacie.
// Use streaming with text-only input
final response = model.generateContentStream(content);
// Use streaming with multi-turn conversations (like chat)
final response = chat.sendMessageStream(content);
Wdrażanie zaawansowanych przypadków użycia
Typowe przypadki użycia opisane w poprzedniej części tego samouczka pomogą Ci zapoznać się z interfejsem Gemini API. W tej sekcji opisujemy kilka przypadków użycia, które mogą być bardziej zaawansowane.
Wywoływanie funkcji
Wywoływanie funkcji ułatwia uzyskiwanie uporządkowanych danych wyjściowych z modeli generatywnych. Następnie możesz użyć tych danych wyjściowych, aby wywoływać inne interfejsy API i zwracać odpowiednie dane odpowiedzi do modelu. Inaczej mówiąc, wywołania funkcji pomagają połączyć modele generatywne z systemami zewnętrznymi, aby generowane treści zawierały aktualne i dokładne informacje. Więcej informacji znajdziesz w samouczku wywoływania funkcji.
Użyj wektorów dystrybucyjnych
Umieszczanie to technika używana do przedstawiania informacji w postaci listy liczb zmiennoprzecinkowych w tablicy. Gemini możesz reprezentować tekst (słowa, zdania i bloki tekstu) w formie wektorowej, co ułatwia porównywanie i różnicowanie reprezentacji właściwościowych. Na przykład 2 teksty o podobnej tematyce lub uczuciach powinny mieć podobne osadzenia, co można zidentyfikować za pomocą matematycznych technik porównywania, takich jak podobieństwo cosinusowe.
Do generowania wektorów dystrybucyjnych użyj modelu embedding-001 z metodą embedContent (lub metody batchEmbedContent). Ten przykład generuje umieszczenie pojedynczego ciągu znaków:
final model = GenerativeModel(model: 'embedding-001', apiKey: apiKey);
final content = Content.text('The quick brown fox jumps over the lazy dog.');
final result = await model.embedContent(content);
print(result.embedding.values);
Policz tokeny
W przypadku używania długich promptów warto zliczać tokeny przed wysłaniem jakiejkolwiek treści do modelu. Poniższe przykłady pokazują, jak używać właściwości countTokens() w różnych przypadkach użycia:
// For text-only input
final tokenCount = await model.countTokens(Content.text(prompt));
print('Token count: ${tokenCount.totalTokens}');
// For text-and-image input (multimodal)
final tokenCount = await model.countTokens([
Content.multi([prompt, ...imageParts])
]);
print('Token count: ${tokenCount.totalTokens}');
// For multi-turn conversations (like chat)
final prompt = Content.text(message);
final allContent = [...chat.history, prompt];
final tokenCount = await model.countTokens(allContent);
print('Token count: ${tokenCount.totalTokens}');
Opcje sterowania generowaniem treści
Możesz kontrolować generowanie treści, konfigurując parametry modelu i używając ustawień bezpieczeństwa.
Pamiętaj, że przekazanie metody generationConfig lub safetySettings do metody żądania modelu (takiej jak generateContent) spowoduje pełne zastąpienie obiektu konfiguracji tą samą nazwą, która jest przekazywana w getGenerativeModel.
Skonfiguruj parametry modelu
Każdy prompt, który wysyłasz do modelu, zawiera wartości parametrów, które kontrolują sposób generowania odpowiedzi przez model. Model może generować różne wyniki dla różnych wartości parametrów. Dowiedz się więcej o parametrach modelu. Konfiguracja jest zachowywana przez cały okres istnienia instancji modelu.
final generationConfig = GenerationConfig(
stopSequences: ["red"],
maxOutputTokens: 200,
temperature: 0.9,
topP: 0.1,
topK: 16,
);
final model = GenerativeModel(
model: 'MODEL_NAME',
apiKey: apiKey,
generationConfig: generationConfig,
);
Korzystanie z ustawień bezpieczeństwa
Za pomocą ustawień bezpieczeństwa możesz dostosować prawdopodobieństwo otrzymania odpowiedzi, które mogą zostać uznane za szkodliwe. Ustawienia bezpieczeństwa domyślnie blokują treści o średnim lub wysokim prawdopodobieństwie, że mogą być niebezpieczne we wszystkich wymiarach. Dowiedz się więcej o ustawieniach bezpieczeństwa.
Aby skonfigurować jedno ustawienie bezpieczeństwa:
final safetySettings = [
SafetySetting(HarmCategory.harassment, HarmBlockThreshold.high)
];
final model = GenerativeModel(
model: 'MODEL_NAME',
apiKey: apiKey,
safetySettings: safetySettings,
);
Możesz też skonfigurować więcej niż jedno ustawienie bezpieczeństwa:
final safetySettings = [
SafetySetting(HarmCategory.harassment, HarmBlockThreshold.high),
SafetySetting(HarmCategory.hateSpeech, HarmBlockThreshold.high),
];
Co dalej
Projektowanie promptów to proces tworzenia promptów, które wywołują pożądaną odpowiedź od modeli językowych. Tworzenie dobrze uporządkowanych promptów to klucz do zapewnienia dokładnych i wysokiej jakości odpowiedzi z modelu językowego. Poznaj sprawdzone metody pisania promptów.
Gemini oferuje kilka wersji modelu, które spełniają różne potrzeby dotyczące na przykład typów danych wejściowych i złożoności, implementacji czatu lub innych zadań związanych z językiem okna czy ograniczeń rozmiaru. Dowiedz się więcej o dostępnych modelach Gemini.
Gemini udostępnia opcje, dzięki którym możesz poprosić o zwiększenie limitu częstotliwości. Dla modeli Gemini Pro limit szybkości wynosi 60 żądań na minutę (RPM).