अपने ऐप्लिकेशन से Genkit फ़्लो को ट्रिगर करना

Cloud Functions for Firebase में एक onCallGenkit तरीका है. इसकी मदद से, Genkit ऐक्शन (एक फ़्लो) के साथ कॉल किया जा सकने वाला फ़ंक्शन बनाया जा सकता है. इन फ़ंक्शन को genkit/beta/client या Cloud Functions क्लाइंट SDK टूल की मदद से कॉल किया जा सकता है. ये SDK टूल, पुष्टि करने की जानकारी अपने-आप जोड़ देते हैं.

शुरू करने से पहले

  • आपको Genkit के फ़्लो के कॉन्सेप्ट के बारे में पता होना चाहिए. साथ ही, आपको यह भी पता होना चाहिए कि इन्हें कैसे लिखा जाता है. इस पेज पर दिए गए निर्देशों में यह माना गया है कि आपने पहले से ही कुछ ऐसे फ़्लो तय कर लिए हैं जिन्हें आपको डिप्लॉय करना है.
  • अगर आपने Cloud Functions for Firebase का इस्तेमाल पहले किया है, तो यह जानकारी आपके लिए मददगार हो सकती है. हालांकि, ऐसा करना ज़रूरी नहीं है.

Firebase प्रोजेक्ट सेट अप करना

  1. Firebase कंसोल का इस्तेमाल करके, नया Firebase प्रोजेक्ट बनाएं या कोई मौजूदा प्रोजेक्ट चुनें.

  2. प्रोजेक्ट को ब्लेज़ प्लान पर अपग्रेड करें. यह प्लान, Cloud Functions को प्रोडक्शन एनवायरमेंट में डिप्लॉय करने के लिए ज़रूरी है.

  3. Firebase CLI इंस्टॉल करें.

  4. Firebase CLI में लॉग इन करें:

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

  5. नई प्रोजेक्ट डायरेक्ट्री बनाएं:

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

  6. डायरेक्ट्री में Firebase प्रोजेक्ट शुरू करें:

    cd $PROJECT_ROOT
firebase init functions

इस पेज के बाकी हिस्से में यह माना गया है कि आपने JavaScript में अपने फ़ंक्शन लिखने का विकल्प चुना है.

फ़्लो को onCallGenkit में रैप करें

Cloud Functions के साथ Firebase प्रोजेक्ट सेट अप करने के बाद, प्रोजेक्ट की functions डायरेक्ट्री में फ़्लो की परिभाषाएं कॉपी की जा सकती हैं या लिखी जा सकती हैं. यहां इस बारे में बताने के लिए, उदाहरण के तौर पर एक फ़्लो दिया गया है:

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

इस तरह के फ़्लो को डिप्लॉय करने के लिए, इसे onCallGenkit के साथ रैप करें. यह firebase-functions/https में उपलब्ध है. इस हेल्पर तरीके में, कॉल की जा सकने वाली फ़ंक्शन की सभी सुविधाएं मौजूद हैं. साथ ही, यह स्ट्रीमिंग और JSON, दोनों तरह के जवाबों के साथ अपने-आप काम करता है.

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

डिप्लॉय किए गए फ़्लो के लिए, एपीआई क्रेडेंशियल उपलब्ध कराना

डिप्लॉय होने के बाद, आपके फ़्लो को उन सभी रिमोट सेवाओं के साथ पुष्टि करने का तरीका चाहिए जिन पर वे निर्भर करते हैं. ज़्यादातर फ़्लो के लिए, कम से कम उस मॉडल एपीआई सेवा को ऐक्सेस करने के लिए क्रेडेंशियल की ज़रूरत होती है जिसका वे इस्तेमाल करते हैं.

इस उदाहरण के लिए, मॉडल उपलब्ध कराने वाली कंपनी के हिसाब से इनमें से कोई एक तरीका अपनाएं:

Gemini (Google का एआई)

  1. पक्का करें कि Google के एआई की सुविधा आपके देश/इलाके में उपलब्ध हो.

  2. Google AI Studio का इस्तेमाल करके, Gemini API के लिए एपीआई पासकोड जनरेट करें.

  3. Cloud Secret Manager में अपना एपीआई पासकोड सेव करें:

    firebase functions:secrets:set GOOGLE_GENAI_API_KEY

    यह चरण इसलिए ज़रूरी है, ताकि आपकी एपीआई कुंजी गलती से लीक न हो. इससे, मीटर के हिसाब से शुल्क लेने वाली सेवा को ऐक्सेस किया जा सकता है.

    सीक्रेट मैनेज करने के बारे में ज़्यादा जानने के लिए, संवेदनशील कॉन्फ़िगरेशन की जानकारी सेव करना और उसे ऐक्सेस करना लेख पढ़ें.

  4. src/index.js में बदलाव करें और मौजूदा इंपोर्ट के बाद यह जोड़ें:

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

    इसके बाद, कॉल किए जा सकने वाले फ़ंक्शन की परिभाषा में यह एलान करें कि फ़ंक्शन को इस सीक्रेट वैल्यू को ऐक्सेस करने की ज़रूरत है:

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

अब इस फ़ंक्शन को डिप्लॉय करने पर, आपकी एपीआई कुंजी Cloud Secret Manager में सेव हो जाएगी. साथ ही, यह Cloud Functions एनवायरमेंट में उपलब्ध होगी.

Gemini (Vertex AI)

  1. Cloud Console में, अपने Firebase प्रोजेक्ट के लिए Vertex AI API चालू करें.

  2. IAM पेज पर, पक्का करें कि डिफ़ॉल्ट कंप्यूट सेवा खाते को Vertex AI उपयोगकर्ता की भूमिका दी गई हो.

इस ट्यूटोरियल के लिए, आपको सिर्फ़ मॉडल उपलब्ध कराने वाली कंपनी के लिए सीक्रेट सेट अप करना होगा. हालांकि, आम तौर पर आपको अपने फ़्लो में इस्तेमाल की जाने वाली हर सेवा के लिए ऐसा ही करना होगा.

(ज़रूरी नहीं) App Check लागू करना

Firebase App Check, नेटिव अटेस्टेशन का इस्तेमाल करता है. इससे यह पुष्टि की जाती है कि आपके एपीआई को सिर्फ़ आपका ऐप्लिकेशन कॉल कर रहा है. onCallGenkit 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);

सीओआरएस (क्रॉस-ऑरिजिन रिसॉर्स शेयरिंग) कॉन्फ़िगर करना

cors विकल्प का इस्तेमाल करके, यह कंट्रोल करें कि कौनसे ऑरिजिन आपके फ़ंक्शन को ऐक्सेस कर सकते हैं.

डिफ़ॉल्ट रूप से, कॉल किए जा सकने वाले फ़ंक्शन के लिए सीओआरएस कॉन्फ़िगर किया जाता है, ताकि सभी ऑरिजिन से अनुरोध किए जा सकें. अगर आपको कुछ क्रॉस-ऑरिजिन अनुरोधों को अनुमति देनी है, लेकिन सभी को नहीं, तो उन खास डोमेन या रेगुलर एक्सप्रेशन की सूची पास करें जिन्हें अनुमति दी जानी चाहिए. उदाहरण के लिए:

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

पूरा उदाहरण

ऊपर बताए गए सभी बदलाव करने के बाद, आपका डिप्लॉय किया जा सकने वाला फ़्लो, यहां दिए गए उदाहरण की तरह दिखेगा:

const {onCallGenkit} = require("firebase-functions/v2/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

Firebase में फ़्लो डिप्लॉय करना

onCallGenkit का इस्तेमाल करके फ़्लो तय करने के बाद, उन्हें उसी तरह से डिप्लॉय किया जा सकता है जिस तरह से अन्य फ़ंक्शन डिप्लॉय किए जाते हैं:

cd $PROJECT_ROOT
firebase deploy --only functions