Erste Schritte mit der Gemini API in Node.js-Anwendungen

In dieser Anleitung wird gezeigt, wie Sie mit dem Google AI JavaScript SDK auf die Gemini API für Ihre Node.js-Anwendung zugreifen.

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ählmethoden) sowie Optionen zur Steuerung der Inhaltsgenerierung.

Voraussetzungen

In dieser Anleitung wird davon ausgegangen, dass Sie mit dem Erstellen von Anwendungen mit Node.js vertraut sind.

Achten Sie beim Durcharbeiten dieser Anleitung darauf, dass Ihre Entwicklungsumgebung die folgenden Anforderungen erfüllt:

  • Node.js v18 und höher
  • npm

Projekt einrichten

Bevor Sie die Gemini API aufrufen, müssen Sie Ihr Projekt einrichten. Dazu müssen Sie Ihren API-Schlüssel einrichten, das SDK-Paket installieren und das Modell initialisieren.

API-Schlüssel einrichten

Sie benötigen einen API-Schlüssel, um die Gemini API zu verwenden. Erstellen Sie einen Schlüssel in Google AI Studio, falls noch nicht geschehen.

API-Schlüssel anfordern

API-Schlüssel sichern

Wir empfehlen dringend, einen API-Schlüssel nicht in Ihr Versionsverwaltungssystem einzuchecken. Verwenden Sie stattdessen einen Secrets-Speicher für Ihren API-Schlüssel.

Bei allen Snippets in dieser Anleitung wird davon ausgegangen, dass Sie auf Ihren API-Schlüssel als Umgebungsvariable zugreifen.

SDK-Paket installieren

Wenn Sie die Gemini API in Ihrer eigenen Anwendung verwenden möchten, müssen Sie das Paket GoogleGenerativeAI für Node.js installieren:

npm install @google/generative-ai

Generatives Modell initialisieren

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

const { GoogleGenerativeAI } = require("@google/generative-ai");

// Access your API key as an environment variable (see "Set up your API key" above)
const genAI = new GoogleGenerativeAI(process.env.API_KEY);

// ...

const model = genAI.getGenerativeModel({ model: "MODEL_NAME"});

// ...

Beachten Sie bei der Angabe eines Modells Folgendes:

  • Verwenden Sie ein Modell, das für Ihren Anwendungsfall spezifisch ist (z. B. gemini-pro-vision ist für die multimodale Eingabe vorgesehen). In diesem Leitfaden ist in den Anleitungen für jede Implementierung das empfohlene Modell für den jeweiligen Anwendungsfall aufgeführt.

Gängige Anwendungsfälle implementieren

Nachdem Ihr Projekt nun eingerichtet ist, können Sie die Verwendung der Gemini API zum Implementieren verschiedener Anwendungsfälle kennenlernen:

Im Abschnitt „Erweiterte Anwendungsfälle“ finden Sie Informationen zur Gemini API und zu Einbettungen.

Text aus reiner Texteingabe generieren

Wenn die Eingabe nur Text enthält, verwenden Sie das Modell gemini-pro mit der Methode generateContent, um eine Textausgabe zu generieren:

const { GoogleGenerativeAI } = require("@google/generative-ai");

// Access your API key as an environment variable (see "Set up your API key" above)
const genAI = new GoogleGenerativeAI(process.env.API_KEY);

async function run() {
  // For text-only input, use the gemini-pro model
  const model = genAI.getGenerativeModel({ model: "gemini-pro"});

  const prompt = "Write a story about a magic backpack."

  const result = await model.generateContent(prompt);
  const response = await result.response;
  const text = response.text();
  console.log(text);
}

run();

Text aus Text- und Bildeingabe generieren (multimodal)

Gemini bietet ein multimodales Modell (gemini-pro-vision), sodass Sie sowohl Text als auch Bilder eingeben können. Sieh dir die Anforderungen an Bilder für Prompts an.

Wenn die Eingabe der Aufforderung sowohl Text als auch Bilder enthält, verwenden Sie das Modell gemini-pro-vision mit der Methode generateContent, um die Textausgabe zu generieren:

const { GoogleGenerativeAI } = require("@google/generative-ai");
const fs = require("fs");

// Access your API key as an environment variable (see "Set up your API key" above)
const genAI = new GoogleGenerativeAI(process.env.API_KEY);

// Converts local file information to a GoogleGenerativeAI.Part object.
function fileToGenerativePart(path, mimeType) {
  return {
    inlineData: {
      data: Buffer.from(fs.readFileSync(path)).toString("base64"),
      mimeType
    },
  };
}

async function run() {
  // For text-and-image input (multimodal), use the gemini-pro-vision model
  const model = genAI.getGenerativeModel({ model: "gemini-pro-vision" });

  const prompt = "What's different between these pictures?";

  const imageParts = [
    fileToGenerativePart("image1.png", "image/png"),
    fileToGenerativePart("image2.jpeg", "image/jpeg"),
  ];

  const result = await model.generateContent([prompt, ...imageParts]);
  const response = await result.response;
  const text = response.text();
  console.log(text);
}

run();

Multi-Turn Conversations (Chat)

Mit Gemini können Sie frei formulierte Unterhaltungen über mehrere Runden hinweg erstellen. Das SDK vereinfacht den Prozess, indem es den Status der Unterhaltung verwaltet. Im Gegensatz zu generateContent müssen Sie den Unterhaltungsverlauf also nicht selbst speichern.

Verwenden Sie das Modell gemini-pro und initialisieren Sie den Chat, indem Sie startChat() aufrufen, um eine Unterhaltung mit mehreren Themen (z. B. Chat) zu erstellen. 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 mit dem Inhalt einer Unterhaltung verknüpft sind:

  • user: die Rolle, die die Prompts bereitstellt. Dieser Wert ist der Standardwert für sendMessage-Aufrufe.

  • model: die Rolle, die die Antworten bereitstellt. Diese Rolle kann verwendet werden, wenn startChat() mit vorhandenem history aufgerufen wird.

const { GoogleGenerativeAI } = require("@google/generative-ai");

// Access your API key as an environment variable (see "Set up your API key" above)
const genAI = new GoogleGenerativeAI(process.env.API_KEY);

async function run() {
  // For text-only input, use the gemini-pro model
  const model = genAI.getGenerativeModel({ model: "gemini-pro"});

  const chat = model.startChat({
    history: [
      {
        role: "user",
        parts: [{ text: "Hello, I have 2 dogs in my house." }],
      },
      {
        role: "model",
        parts: [{ text: "Great to meet you. What would you like to know?" }],
      },
    ],
    generationConfig: {
      maxOutputTokens: 100,
    },
  });

  const msg = "How many paws are in my house?";

  const result = await chat.sendMessage(msg);
  const response = await result.response;
  const text = response.text();
  console.log(text);
}

run();

Streaming für schnellere Interaktionen

Standardmäßig gibt das Modell eine Antwort zurück, nachdem der gesamte Generierungsprozess abgeschlossen ist. Sie können Interaktionen beschleunigen, indem Sie nicht auf das gesamte Ergebnis warten und stattdessen Streaming verwenden, um Teilergebnisse zu verarbeiten.

Das folgende Beispiel zeigt, wie Sie Streaming mit der Methode generateContentStream implementieren, um Text aus einer Eingabeaufforderung für Text und Bilder zu generieren.

//...

const result = await model.generateContentStream([prompt, ...imageParts]);

let text = '';
for await (const chunk of result.stream) {
  const chunkText = chunk.text();
  console.log(chunkText);
  text += chunkText;
}

//...

Ein ähnlicher Ansatz kann für reine Texteingaben und Chats verwendet werden.

// Use streaming with text-only input
const result = await model.generateContentStream(prompt);

Informationen zum Instanziieren einer chat finden Sie im Chatbeispiel oben.

// Use streaming with multi-turn conversations (like chat)
const result = await chat.sendMessageStream(msg);

Erweiterte Anwendungsfälle implementieren

Die im vorherigen Abschnitt dieser Anleitung beschriebenen häufigen Anwendungsfälle helfen Ihnen, sich mit der Verwendung der Gemini API vertraut zu machen. In diesem Abschnitt werden einige Anwendungsfälle beschrieben, die als komplexer gelten.

Einbettungen verwenden

Das Einbetten ist eine Methode, um Informationen als Liste von Gleitkommazahlen in einem Array darzustellen. Mit Gemini können Sie Text (Wörter, Sätze und Textblöcke) in einer vektorisierten Form darstellen, was das Vergleichen und Gegenüberstellen von Einbettungen erleichtert. Zum Beispiel sollten zwei Texte, die ein ähnliches Thema oder eine ähnliche Stimmung haben, ähnliche Einbettungen haben, die durch mathematische Vergleichstechniken wie Kosinus-Ähnlichkeit identifiziert werden können.

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:

const { GoogleGenerativeAI } = require("@google/generative-ai");

// Access your API key as an environment variable (see "Set up your API key" above)
const genAI = new GoogleGenerativeAI(process.env.API_KEY);

async function run() {
  // For embeddings, use the embedding-001 model
  const model = genAI.getGenerativeModel({ model: "embedding-001"});

  const text = "The quick brown fox jumps over the lazy dog."

  const result = await model.embedContent(text);
  const embedding = result.embedding;
  console.log(embedding.values);
}

run();

Anzahl der Tokens

Bei der Verwendung langer Aufforderungen 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
const { totalTokens } = await model.countTokens(prompt);

// For text-and-image input (multimodal)
const { totalTokens } = await model.countTokens([prompt, ...imageParts]);

// For multi-turn conversations (like chat)
const history = await chat.getHistory();
const msgContent = { role: "user", parts: [{ text: msg }] };
const contents = [...history, msgContent];
const { totalTokens } = await model.countTokens({ contents });

Optionen zum Steuern der Inhaltsgenerierung

Sie können die Inhaltsgenerierung steuern, indem Sie Modellparameter konfigurieren und Sicherheitseinstellungen verwenden.

Wenn Sie generationConfig oder safetySettings an eine Modellanfragemethode wie generateContent übergeben, wird das Konfigurationsobjekt mit demselben Namen, der in getGenerativeModel übergeben wurde, 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

const generationConfig = {
  stopSequences: ["red"],
  maxOutputTokens: 200,
  temperature: 0.9,
  topP: 0.1,
  topK: 16,
};

const model = genAI.getGenerativeModel({ model: "MODEL_NAME",  generationConfig });

Sicherheitseinstellungen verwenden

In den Sicherheitseinstellungen kannst du die Wahrscheinlichkeit anpassen, dass du Antworten erhältst, die als schädlich eingestuft werden könnten. Inhalte mit mittlerer und/oder hoher Wahrscheinlichkeit werden standardmäßig durch Sicherheitseinstellungen in allen Dimensionen blockiert. Weitere Informationen zu Sicherheitseinstellungen

So legen Sie eine Sicherheitseinstellung fest:

import { HarmBlockThreshold, HarmCategory } from "@google/generative-ai";

// ...

const safetySettings = [
  {
    category: HarmCategory.HARM_CATEGORY_HARASSMENT,
    threshold: HarmBlockThreshold.BLOCK_ONLY_HIGH,
  },
];

const model = genAI.getGenerativeModel({ model: "MODEL_NAME", safetySettings });

Sie können auch mehrere Sicherheitseinstellungen festlegen:

const safetySettings = [
  {
    category: HarmCategory.HARM_CATEGORY_HARASSMENT,
    threshold: HarmBlockThreshold.BLOCK_ONLY_HIGH,
  },
  {
    category: HarmCategory.HARM_CATEGORY_HATE_SPEECH,
    threshold: HarmBlockThreshold.BLOCK_MEDIUM_AND_ABOVE,
  },
];

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 Modellvariationen, um den Anforderungen verschiedener Anwendungsfälle gerecht zu werden, z. B. Eingabetypen und -komplexität, Implementierungen für Chat- oder andere Dialogsprachaufgaben sowie Größenbeschränkungen. Weitere Informationen zu den verfügbaren Gemini-Modellen

  • Gemini bietet Optionen zum Anfordern von Erhöhungen der Ratenbegrenzung. Das Ratenlimit für Gemini Pro-Modelle beträgt 60 Anfragen pro Minute (RPM).