Tutorial: inizia a utilizzare l'API Gemini


Questo tutorial mostra come accedere all'API Gemini per la tua applicazione Node.js utilizzando l'SDK JavaScript di Google AI.

In questo tutorial imparerai a:

Inoltre, questo tutorial contiene sezioni sui casi d'uso avanzati (come incorporamenti e conteggio dei token), nonché sulle opzioni per controllare la generazione di contenuti.

Prerequisiti

Questo tutorial presuppone che tu abbia familiarità con la creazione di applicazioni con Node.js.

Per completare questo tutorial, assicurati che il tuo ambiente di sviluppo soddisfi i seguenti requisiti:

  • Node.js v18 e versioni successive
  • npm

Configura il progetto

Prima di chiamare l'API Gemini, devi configurare il progetto, inclusa la configurazione della chiave API, l'installazione del pacchetto SDK e l'inizializzazione del modello.

Configura la chiave API

Per utilizzare l'API Gemini, hai bisogno di una chiave API. Se non ne hai già una, crea una chiave in Google AI Studio.

Ottenere una chiave API

Proteggi la chiave API

Ti consigliamo vivamente di non controllare una chiave API nel tuo sistema di controllo della versione. Devi invece utilizzare un archivio di secret per la tua chiave API.

Tutti gli snippet in questo tutorial presuppongono che tu stia accedendo alla chiave API come variabile di ambiente.

Installa il pacchetto SDK

Per utilizzare l'API Gemini nella tua applicazione, devi installare il pacchetto GoogleGenerativeAI per Node.js:

npm install @google/generative-ai

Inizializzare il modello generativo

Prima di poter effettuare chiamate API, devi importare e inizializzare il modello generativo.

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

// ...

// The Gemini 1.5 models are versatile and work with most use cases
const model = genAI.getGenerativeModel({ model: "gemini-1.5-flash"});

// ...

Quando specifichi un modello, tieni presente quanto segue:

  • Utilizza un modello specifico per il tuo caso d'uso (ad esempio, gemini-1.5-flash è per l'input multimodale). All'interno di questa guida, le istruzioni per ogni implementazione elencano il modello consigliato per ogni caso d'uso.

Implementare casi d'uso comuni

Ora che il progetto è configurato, puoi esplorare l'utilizzo dell'API Gemini per implementare diversi casi d'uso:

Nella sezione dei casi d'uso avanzati, puoi trovare informazioni sull'API Gemini e sugli incorporamenti.

Genera testo da input di solo testo

Quando l'input del prompt include solo testo, utilizza un modello Gemini 1.5 con generateContent per generare un output di testo:

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() {
  // The Gemini 1.5 models are versatile and work with both text-only and multimodal prompts
  const model = genAI.getGenerativeModel({ model: "gemini-1.5-flash"});

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

Genera testo da input di testo e immagine (multimodale)

Gemini 1.5 Flash e 1.5 Pro sono in grado di gestire l'input multimodale in modo da poter inserire sia testo che immagini. Assicurati di rivedere i requisiti relativi alle immagini per i prompt.

Quando l'input del prompt include sia testo che immagini, utilizza un modello Gemini 1.5 con il metodo generateContent per generare un output di testo:

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() {
  // The Gemini 1.5 models are versatile and work with both text-only and multimodal prompts
  const model = genAI.getGenerativeModel({ model: "gemini-1.5-flash" });

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

Creare conversazioni in più passaggi (chat)

Con Gemini, puoi creare conversazioni in formato libero in più turni. L'SDK semplifica il processo gestendo lo stato della conversazione, quindi, a differenza di generateContent, non devi archiviare manualmente la cronologia delle conversazioni.

Per creare una conversazione in più passaggi (come la chat), utilizza un modello Gemini 1.5 o Gemini 1.0 Pro e inizializza la chat chiamando startChat(). Utilizza quindi sendMessage() per inviare un nuovo messaggio utente, che aggiungerà anche il messaggio e la risposta alla cronologia chat.

Esistono due possibili opzioni per role associate ai contenuti in una conversazione:

  • user: il ruolo che fornisce i prompt. Questo valore è il valore predefinito per le chiamate sendMessage.

  • model: il ruolo che fornisce le risposte. Questo ruolo può essere utilizzato durante la chiamata a startChat() con history esistente.

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() {
  // The Gemini 1.5 models are versatile and work with multi-turn conversations (like chat)
  const model = genAI.getGenerativeModel({ model: "gemini-1.5-flash"});

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

Usa la modalità flusso per interazioni più rapide

Per impostazione predefinita, il modello restituisce una risposta dopo aver completato l'intero processo di generazione. Puoi ottenere interazioni più rapide non attendere l'intero risultato e utilizzare invece la modalità flusso per gestire i risultati parziali.

L'esempio seguente mostra come implementare il flusso di dati con il metodo generateContentStream per generare testo da una richiesta di input di testo e immagine.

//...

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

//...

Puoi utilizzare un approccio simile per casi d'uso di input di solo testo e chat.

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

Per informazioni su come creare un'istanza di chat, vedi l'esempio di chat riportato sopra.

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

Implementare casi d'uso avanzati

I casi d'uso comuni descritti nella sezione precedente di questo tutorial ti aiutano ad acquisire dimestichezza con l'utilizzo dell'API Gemini. Questa sezione descrive alcuni casi d'uso che possono essere considerati più avanzati.

Utilizza gli incorporamenti

L'incorporamento è una tecnica utilizzata per rappresentare le informazioni come un elenco di numeri in virgola mobile in un array. Con Gemini, puoi rappresentare il testo (parole, frasi e blocchi di testo) in forma vettoriale, semplificando il confronto e la contrapposizione degli incorporamenti. Ad esempio, due testi che condividono un argomento o un sentiment simile dovrebbero avere incorporamenti simili, che possono essere identificati tramite tecniche di confronto matematiche come la somiglianza coseno.

Utilizza il modello embedding-001 con il metodo embedContent (o il metodo batchEmbedContent) per generare incorporamenti. L'esempio seguente genera un incorporamento per una singola stringa:

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

Chiamate di funzione

La chiamata di funzione semplifica l'ottenimento di output di dati strutturati da modelli generativi. Puoi quindi utilizzare questi output per chiamare altre API e restituire i dati di risposta pertinenti al modello. In altre parole, le chiamate di funzione consentono di collegare modelli generativi a sistemi esterni, in modo che i contenuti generati includano le informazioni più aggiornate e accurate. Scopri di più nel tutorial sulle chiamate di funzione.

Conta token

Quando utilizzi prompt lunghi, può essere utile contare i token prima di inviare contenuti al modello. I seguenti esempi mostrano come utilizzare countTokens() per vari casi d'uso:

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

Opzioni per controllare la generazione di contenuti

Puoi controllare la generazione di contenuti configurando i parametri del modello e utilizzando le impostazioni di sicurezza.

Tieni presente che il passaggio di generationConfig o safetySettings a un metodo di richiesta di modello (come generateContent) sostituirà completamente l'oggetto di configurazione con lo stesso nome passato in getGenerativeModel.

Configura i parametri del modello

Ogni prompt inviato al modello include valori parametro che controllano il modo in cui il modello genera una risposta. Il modello può generare risultati diversi per valori parametro diversi. Scopri di più sui parametri del modello.

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

// The Gemini 1.5 models are versatile and work with most use cases
const model = genAI.getGenerativeModel({ model: "gemini-1.5-flash",  generationConfig });

Utilizzare le impostazioni di sicurezza

Puoi utilizzare le impostazioni di sicurezza per modificare la probabilità di ricevere risposte che potrebbero essere considerate dannose. Per impostazione predefinita, le impostazioni di sicurezza bloccano i contenuti con probabilità media e/o alta di non essere sicuri in tutte le dimensioni. Scopri di più sulle impostazioni di sicurezza.

Per configurare un'impostazione di sicurezza:

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

// ...

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

// The Gemini 1.5 models are versatile and work with most use cases
const model = genAI.getGenerativeModel({ model: "gemini-1.5-flash", safetySettings });

Puoi anche configurare più di un'impostazione di sicurezza:

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

Passaggi successivi

  • La progettazione dei prompt è il processo di creazione di prompt che suscitano la risposta desiderata dai modelli linguistici. Scrivere prompt ben strutturati è essenziale per garantire risposte accurate e di alta qualità da un modello linguistico. Scopri le best practice per la scrittura di prompt.

  • Gemini offre diverse varianti del modello per soddisfare le esigenze di diversi casi d'uso, come tipi di input e complessità, implementazioni di chat o altre attività basate su dialoghi di dialoghi e limiti di dimensioni. Scopri di più sui modelli Gemini disponibili.