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 Cloud Functions for Firebase Client SDK, co automatycznie dodaje informacje o autoryzacji.

Zanim zaczniesz

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

Konfigurowanie projektu Firebase

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

  2. Przenieś projekt na abonament Blaze z płatnością według wykorzystania, który jest wymagany w przypadku Cloud Functionswdroż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 Firebase w katalogu:

    cd $PROJECT_ROOT
firebase init functions

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

Owiń proces w onCallGenkit

Po skonfigurowaniu projektu Firebase i zainicjowaniu w nim Cloud Functions możesz skopiować lub napisać definicje przepływów w katalogu functions projektu. Oto przykładowy przepływ, 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;
},
);

Aby wdrożyć taki przepływ, umieść go w funkcji onCallGenkit dostępnej 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,
);

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:

Gemini (AI od Google)

  1. Wygeneruj klucz interfejsu API dla Gemini Developer API za pomocą Google AI Studio.

  2. Zapisz klucz interfejsu API w Google Cloud Secret Manager:

    firebase functions:secrets:set GOOGLE_GENAI_API_KEY

    Ten krok jest ważny, aby zapobiec przypadkowemu ujawnieniu klucza interfejsu API, który zapewnia dostęp do usługi, za którą możesz płacić.

    Więcej informacji o zarządzaniu obiektami tajnymi znajdziesz w artykule Przechowywanie poufnych informacji o konfiguracji i uzyskiwanie do nich dostępu.

  3. Edytuj plik src/index.js i po istniejących instrukcjach importu dodaj te instrukcje:

    const {defineSecret} = require("firebase-functions/params");
     
    // Store the Gemini API key in Cloud Secret Manager.
const apiKey = defineSecret("GOOGLE_GENAI_API_KEY");

    Następnie w definicji funkcji wywoływanej zadeklaruj, że funkcja potrzebuje dostępu do tej wartości tajnej:

    // Bind the Gemini API key secret parameter to the function.
secrets: [apiKey],

Teraz, gdy wdrożysz tę funkcję, klucz interfejsu API będzie przechowywany w usłudze Google Cloud Secret Manager i dostępny w środowisku Cloud Functions.

Gemini (Vertex AI)

  1. W konsoli Google Cloud włącz interfejs Vertex AI API w projekcie Firebase.

  2. Na stronie Uprawnienia sprawdź, czy domyślne konto usługi Compute ma przypisaną rolę użytkownika Vertex AI.

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 w przepływie.

(Opcjonalnie) Dodaj Firebase App Check wymuszanie

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

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 tak, aby zezwalać na żądania ze wszystkich źródeł. Aby zezwolić na niektóre żądania z innych domen, 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);

Pełny 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,
);

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