Wywoływanie procesów Genkit z aplikacji

Cloud Functions for Firebase ma metodę onCallGenkit, która umożliwia utworzenie funkcji wywoływanej z działaniem Genkit (przepływem). Te funkcje można wywoływać za pomocą genkit/beta/client lub a Cloud Functions for Firebase Client SDK, co automatycznie dodaje informacje o autoryzacji.

Zanim zaczniesz

• Musisz znać koncepcję Genkitścieżek i wiedzieć, jak je tworzyć. Instrukcje na tej stronie zakładają, że masz już zdefiniowane przepływy, które chcesz wdrożyć.
• Jeśli wcześniej korzystałeś(-aś) z Cloud Functions for Firebase, będzie to pomocne, ale nie jest wymagane.

Konfigurowanie projektu w Firebase

1. Utwórz nowy projekt w Firebase w Firebasekonsoli lub wybierz istniejący.

2. Przejdź na abonament Blaze z płatnością według wykorzystania, który jest wymagany w przypadkuCloud Functions wdrożenia produkcyjnego.

3. Zainstaluj interfejs wiersza poleceń Firebase.

4. Zaloguj się w interfejsie wiersza poleceń Firebase:

   firebase login
   firebase login --reauth # alternative, if necessary
   firebase login --no-localhost # if running in a remote shell

5. Utwórz nowy katalog projektu:

   export PROJECT_ROOT=~/tmp/genkit-firebase-project1
   mkdir -p $PROJECT_ROOT

6. Zainicjuj projekt w Firebase w katalogu:

   cd $PROJECT_ROOT
   firebase init functions

W dalszej części tej strony zakładamy, że funkcje zostały napisane w JavaScript.

Umieść proces w onCallGenkit

Po skonfigurowaniu projektu w Firebase i zainicjowaniu w nim Cloud Functions możesz skopiować lub napisać definicje funkcji typu flow w katalogu functions projektu. Oto przykładowy proces, który to ilustruje:

const ai = genkit({
  plugins: [googleAI()],
  model: gemini15Flash,
});

const jokeTeller = ai.defineFlow({
  name: "jokeTeller",
  inputSchema: z.string().nullable(),
  outputSchema: z.string(),
  streamSchema: z.string(),
}, async (jokeType = "knock-knock", {sendChunk}) => {
  const prompt = `Tell me a ${jokeType} joke.`;

  // Call the `generateStream()` method to
  // receive the `stream` async iterable.
  const {stream, response: aiResponse} = ai.generateStream(prompt);

  // Send new words of the generative AI response
  // to the client as they are generated.
  for await (const chunk of stream) {
    sendChunk(chunk.text);
  }

  // Return the full generative AI response
  // to clients that may not support streaming.
  return (await aiResponse).text;
},
);
index.js

Aby wdrożyć taki przepływ, umieść go w funkcji onCallGenkit, która jest dostępna w firebase-functions/https. Ta metoda pomocnicza ma wszystkie funkcje funkcji wywoływanych i automatycznie obsługuje zarówno przesyłanie strumieniowe, jak i odpowiedzi w formacie JSON.

const {onCallGenkit} = require("firebase-functions/https");

exports.tellJoke = onCallGenkit({
  // Bind the Gemini API key secret parameter to the function.
  secrets: [apiKey],
},
// Pass in the genkit flow.
jokeTeller,
);
index.js

Udostępnianie danych logowania interfejsu API w przypadku wdrożonych automatyzacji

Po wdrożeniu przepływy muszą mieć możliwość uwierzytelniania w usługach zdalnych, z których korzystają. Większość procesów wymaga co najmniej danych logowania do usługi interfejsu API modelu, z której korzystają.

W tym przykładzie wykonaj jedną z tych czynności w zależności od wybranego dostawcy modelu:

W tym samouczku musisz skonfigurować tylko klucz tajny dostawcy modelu, ale ogólnie musisz zrobić coś podobnego w przypadku każdej usługi używanej przez Twój przepływ.

(Opcjonalnie) Dodaj Firebase App Check egzekwowanie

Firebase App Check używa atestu natywnego, aby sprawdzić, czy nasz interfejs API jest wywoływany tylko przez Twoją aplikację. Metoda onCallGenkit obsługuje deklaratywne egzekwowanie App Check.

export const generatePoem = onCallGenkit({
  enforceAppCheck: true,
  // Optional. Makes App Check tokens only usable once. This adds extra security
  // at the expense of slowing down your app to generate a token for every API
  // call
  consumeAppCheckToken: true,
}, generatePoemFlow);

Konfigurowanie CORS (współdzielenia zasobów pomiędzy serwerami z różnych domen)

Użyj opcji cors, aby określić, które źródła mogą uzyskiwać dostęp do Twojej funkcji.

Domyślnie funkcje wywoływalne mają skonfigurowane CORS, aby zezwalać na żądania ze wszystkich źródeł. Aby zezwolić na niektóre żądania współdzielenia, ale nie na wszystkie, przekaż listę konkretnych domen lub wyrażeń regularnych, które powinny być dozwolone. Przykład:

export const tellJoke = onCallGenkit({
  cors: 'mydomain.com',
}, jokeTeller);

Kompletny przykład

Po wprowadzeniu wszystkich zmian opisanych w tym przewodniku wdrożony przepływ będzie wyglądać mniej więcej tak:

const {onCallGenkit} = require("firebase-functions/https");
const {defineSecret} = require("firebase-functions/params");

// Dependencies for Genkit.
const {gemini15Flash, googleAI} = require("@genkit-ai/googleai");
const {genkit, z} = require("genkit");

// Store the Gemini API key in Cloud Secret Manager.
const apiKey = defineSecret("GOOGLE_GENAI_API_KEY");

const ai = genkit({
  plugins: [googleAI()],
  model: gemini15Flash,
});

const jokeTeller = ai.defineFlow({
  name: "jokeTeller",
  inputSchema: z.string().nullable(),
  outputSchema: z.string(),
  streamSchema: z.string(),
}, async (jokeType = "knock-knock", {sendChunk}) => {
  const prompt = `Tell me a ${jokeType} joke.`;

  // Call the `generateStream()` method to
  // receive the `stream` async iterable.
  const {stream, response: aiResponse} = ai.generateStream(prompt);

  // Send new words of the generative AI response
  // to the client as they are generated.
  for await (const chunk of stream) {
    sendChunk(chunk.text);
  }

  // Return the full generative AI response
  // to clients that may not support streaming.
  return (await aiResponse).text;
},
);

exports.tellJoke = onCallGenkit({
  // Bind the Gemini API key secret parameter to the function.
  secrets: [apiKey],
},
// Pass in the genkit flow.
jokeTeller,
);
index.js

Wdrażanie przepływów w Firebase

Po zdefiniowaniu przepływów za pomocą onCallGenkit możesz je wdrożyć tak samo jak inne funkcje:

cd $PROJECT_ROOT
firebase deploy --only functions