Anleitung: Erste Schritte mit der Gemini API


In diesem Tutorial wird gezeigt, wie Sie mit dem Google AI Dart SDK auf die Gemini API für Ihre Dart- oder Flutter-Anwendung zugreifen. Sie können dieses SDK verwenden, wenn Sie nicht direkt mit REST APIs für den Zugriff auf Gemini-Modelle in Ihrer App arbeiten möchten.

In dieser Anleitung erfahren Sie, wie Sie Folgendes tun:

Darüber hinaus enthält diese Anleitung Abschnitte zu erweiterten Anwendungsfällen (z. B. Einbettungen und Zähltokens) sowie Optionen zur Steuerung der Inhaltsgenerierung.

Voraussetzungen

In dieser Anleitung wird davon ausgegangen, dass Sie mit der Erstellung von Anwendungen mit Dart vertraut sind.

Damit Sie diese Anleitung abschließen können, muss Ihre Entwicklungsumgebung die folgenden Anforderungen erfüllen:

  • Dart 3.2.0+

Projekt einrichten

Bevor Sie die Gemini API aufrufen, müssen Sie Ihr Projekt einrichten. Dazu gehört das Einrichten des API-Schlüssels, das Hinzufügen des SDK zu den Pub-Abhängigkeiten und das Initialisieren des Modells.

API-Schlüssel einrichten

Zur Verwendung der Gemini API benötigen Sie einen API-Schlüssel. Falls noch nicht geschehen, erstellen Sie einen Schlüssel in Google AI Studio.

API-Schlüssel anfordern

API-Schlüssel sichern

Bewahren Sie Ihren API-Schlüssel sicher auf. Es wird dringend empfohlen, den API-Schlüssel nicht direkt in den Code einzufügen oder Dateien, die den Schlüssel enthalten, in Versionsverwaltungssystemen zu prüfen. Stattdessen sollten Sie einen geheimen Speicher für Ihren API-Schlüssel verwenden.

Bei allen Snippets in dieser Anleitung wird davon ausgegangen, dass Sie auf Ihren API-Schlüssel als Prozessumgebungsvariable zugreifen. Wenn Sie eine Flutter-Anwendung entwickeln, können Sie String.fromEnvironment verwenden und --dart-define=API_KEY=$API_KEY an flutter build oder flutter run übergeben, um mit dem API-Schlüssel zu kompilieren, da sich die Prozessumgebung bei der Ausführung der Anwendung unterscheidet.

SDK-Paket installieren

Wenn Sie die Gemini API in Ihrer eigenen Anwendung verwenden möchten, müssen Sie das google_generative_ai-Paket an Ihre Dart- oder Flutter-App add.

Dart 

dart pub add google_generative_ai

Flutter 

flutter pub add google_generative_ai

Generatives Modell initialisieren

Bevor Sie API-Aufrufe ausführen können, müssen Sie das generative Modell importieren und initialisieren.

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);
  }

  // The Gemini 1.5 models are versatile and work with most use cases
  final model = GenerativeModel(model: 'gemini-1.5-flash', apiKey: apiKey);
}

Beachten Sie beim Angeben eines Modells Folgendes:

  • Verwenden Sie ein Modell, das für Ihren Anwendungsfall spezifisch ist (z. B. gemini-1.5-flash für eine multimodale Eingabe). In diesem Leitfaden wird in den Anleitungen für jede Implementierung das empfohlene Modell für jeden Anwendungsfall aufgeführt.

Gängige Anwendungsfälle implementieren

Nachdem Ihr Projekt nun eingerichtet ist, können Sie ausprobieren, wie Sie mit der Gemini API verschiedene Anwendungsfälle implementieren:

Im Abschnitt zu erweiterten Anwendungsfällen finden Sie Informationen zur Gemini API und zu Einbettungen.

Text aus reiner Texteingabe generieren

Wenn der Prompt nur Text enthält, verwenden Sie ein Gemini 1.5-Modell oder das Gemini 1.0 Pro-Modell mit generateContent, um die Textausgabe zu generieren:

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);
  }
  // The Gemini 1.5 models are versatile and work with both text-only and multimodal prompts
  final model = GenerativeModel(model: 'gemini-1.5-flash', apiKey: apiKey);
  final content = [Content.text('Write a story about a magic backpack.')];
  final response = await model.generateContent(content);
  print(response.text);
}

Text aus Text- und Bildeingabe generieren (multimodal)

Gemini bietet verschiedene Modelle, die multimodale Eingaben verarbeiten können (Gemini 1.5-Modelle), sodass Sie sowohl Text als auch Bilder eingeben können. Lies dir auch die Anforderungen an Bilder für Prompts durch.

Wenn die Prompt-Eingabe sowohl Text als auch Bilder enthält, verwenden Sie ein Gemini 1.5-Modell mit der Methode generateContent, um eine Textausgabe zu generieren:

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);
  }
  // The Gemini 1.5 models are versatile and work with both text-only and multimodal prompts
  final model = GenerativeModel(model: 'gemini-1.5-flash', 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);
}

Multi-Turn Conversations erstellen (Chat)

Mit Gemini kannst du Unterhaltungen im freien Format über mehrere Runden hinweg führen. Das SDK vereinfacht den Vorgang, da es den Status der Unterhaltung verwaltet. Im Gegensatz zu generateContent müssen Sie den Unterhaltungsverlauf also nicht selbst speichern.

Wenn Sie eine mehrsprachige Unterhaltung (z. B. Chat) erstellen möchten, verwenden Sie ein Gemini 1.5-Modell oder Gemini 1.0 Pro und initialisieren Sie den Chat, indem Sie startChat() aufrufen. Verwenden Sie dann sendMessage(), um eine neue Nutzernachricht zu senden. Dadurch werden auch die Nachricht und die Antwort an das Chatprotokoll angehängt.

Es gibt zwei mögliche Optionen für role, die dem Inhalt einer Unterhaltung zugeordnet sind:

  • user: Die Rolle, die die Aufforderungen bereitstellt. Dieser Wert ist der Standardwert für sendMessage-Aufrufe und die Funktion löst eine Ausnahme aus, wenn eine andere Rolle übergeben wird.

  • model: Die Rolle, die die Antworten bereitstellt. Diese Rolle kann beim Aufrufen von startChat() mit vorhandenem history verwendet werden.

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);
  }
  // The Gemini 1.5 models are versatile and work with multi-turn conversations (like chat)
  final model = GenerativeModel(
      model: 'gemini-1.5-flash',
      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);
}

Streaming für schnellere Interaktionen nutzen

Standardmäßig gibt das Modell nach Abschluss des gesamten Generierungsprozesses eine Antwort zurück. Sie können schnellere Interaktionen erzielen, wenn Sie nicht auf das gesamte Ergebnis warten, sondern stattdessen Streaming verwenden, um Teilergebnisse zu verarbeiten.

Das folgende Beispiel zeigt, wie Streaming mit der Methode generateContentStream implementiert wird, um Text über einen Text-und-Bild-Eingabe-Prompt zu generieren.

// ...

final response = model.generateContentStream([
  Content.multi([prompt, ...imageParts])
]);
await for (final chunk in response) {
  print(chunk.text);
}

// ...

Sie können einen ähnlichen Ansatz für reine Texteingabe und Chat-Anwendungsfälle verwenden.

// Use streaming with text-only input
final response = model.generateContentStream(content);

// Use streaming with multi-turn conversations (like chat)
final response = chat.sendMessageStream(content);

Erweiterte Anwendungsfälle implementieren

Die im vorherigen Abschnitt dieses Tutorials beschriebenen gängigen Anwendungsfälle helfen Ihnen, sich mit der Verwendung der Gemini API vertraut zu machen. In diesem Abschnitt werden einige Anwendungsfälle beschrieben, die möglicherweise als komplexer gelten.

Funktionsaufrufe

Funktionsaufrufe erleichtern es Ihnen, Ausgaben strukturierter Daten aus generativen Modellen zu erhalten. Sie können diese Ausgaben dann verwenden, um andere APIs aufzurufen und die relevanten Antwortdaten an das Modell zurückzugeben. Mit anderen Worten: Funktionsaufrufe helfen Ihnen, generative Modelle mit externen Systemen zu verbinden, damit die generierten Inhalte aktuelle und genaue Informationen enthalten. Weitere Informationen finden Sie in der Anleitung zu Funktionsaufrufen.

Einbettungen verwenden

Einbettung ist eine Technik, mit der Informationen als Liste von Gleitkommazahlen in einem Array dargestellt werden. Mit Gemini können Sie Text (Wörter, Sätze und Textblöcke) vektorisiert darstellen. So lassen sich Einbettungen leichter vergleichen und gegenüberstellen. Beispielsweise sollten zwei Texte, die ein ähnliches Thema oder eine ähnliche Stimmung haben, ähnliche Einbettungen haben, die sich durch mathematische Vergleichstechniken wie Kosinus-Ähnlichkeit erkennen lassen.

Verwenden Sie das Modell embedding-001 mit der Methode embedContent (oder der Methode batchEmbedContent), um Einbettungen zu generieren. Im folgenden Beispiel wird eine Einbettung für einen einzelnen String generiert:

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);

Anzahl der Tokens

Bei langen Prompts kann es hilfreich sein, Tokens zu zählen, bevor Inhalte an das Modell gesendet werden. Die folgenden Beispiele zeigen, wie countTokens() für verschiedene Anwendungsfälle verwendet wird:

// 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}');

Optionen zum Steuern der Inhaltserstellung

Sie können das Generieren von Inhalten steuern, indem Sie Modellparameter konfigurieren und Sicherheitseinstellungen verwenden.

Wenn Sie generationConfig oder safetySettings an eine Modellanfragemethode (z. B. generateContent) übergeben, wird das Konfigurationsobjekt mit dem in getGenerativeModel übergebenen Namen vollständig überschrieben.

Modellparameter konfigurieren

Jede Aufforderung, die Sie an das Modell senden, enthält Parameterwerte, die steuern, wie das Modell eine Antwort generiert. Das Modell kann für verschiedene Parameterwerte unterschiedliche Ergebnisse generieren. Weitere Informationen zu Modellparametern Die Konfiguration wird für die gesamte Lebensdauer der Modellinstanz beibehalten.

final generationConfig = GenerationConfig(
  stopSequences: ["red"],
  maxOutputTokens: 200,
  temperature: 0.9,
  topP: 0.1,
  topK: 16,
);
final model = GenerativeModel(
  // The Gemini 1.5 models are versatile and work with most use cases
  model: 'gemini-1.5-flash',
  apiKey: apiKey,
  generationConfig: generationConfig,
);

Sicherheitseinstellungen verwenden

Mit Sicherheitseinstellungen kannst du die Wahrscheinlichkeit anpassen, dass du Antworten erhältst, die als schädlich eingestuft werden können. Standardmäßig blockieren Sicherheitseinstellungen Inhalte mit mittlerer und/oder hoher Wahrscheinlichkeit, die als unsicher eingestuft werden, in allen Dimensionen. Weitere Informationen zu den Sicherheitseinstellungen

So legen Sie eine Sicherheitseinstellung fest:

final safetySettings = [
  SafetySetting(HarmCategory.harassment, HarmBlockThreshold.high)
];
final model = GenerativeModel(
  // The Gemini 1.5 models are versatile and work with most use cases
  model: 'gemini-1.5-flash',
  apiKey: apiKey,
  safetySettings: safetySettings,
);

Sie können auch mehrere Sicherheitseinstellungen festlegen:

final safetySettings = [
  SafetySetting(HarmCategory.harassment, HarmBlockThreshold.high),
  SafetySetting(HarmCategory.hateSpeech, HarmBlockThreshold.high),
];

Nächste Schritte

  • Beim Prompt-Design werden Aufforderungen erstellt, die die gewünschte Antwort aus Sprachmodellen auslösen. Gut strukturierte Eingabeaufforderungen sind wichtig, um genaue, hochwertige Antworten aus einem Sprachmodell zu gewährleisten. Best Practices für das Schreiben von Prompts

  • Gemini bietet verschiedene Modellvarianten für verschiedene Anwendungsfälle, z. B. Eingabetypen und -komplexität, Implementierungen für Chat- oder andere Sprachaufgaben für Chats und Größenbeschränkungen. Weitere Informationen zu den verfügbaren Gemini-Modellen