เรียกใช้เวิร์กโฟลว์ Genkit จากแอป

Cloud Functions for Firebase มีเมธอด onCallGenkit ที่ช่วยให้คุณ สร้างฟังก์ชันที่เรียกใช้ได้ด้วยการดำเนินการ Genkit (โฟลว์) เรียกใช้ฟังก์ชันเหล่านี้ได้ด้วย genkit/beta/client หรือ Cloud Functions Client SDK ซึ่งจะเพิ่มข้อมูลการให้สิทธิ์โดยอัตโนมัติ

ก่อนเริ่มต้น

• คุณควรคุ้นเคยกับแนวคิดของ Genkit ในเรื่องโฟลว์ และวิธีเขียนโฟลว์ วิธีการในหน้านี้ถือว่าคุณได้กำหนดโฟลว์บางอย่างที่ต้องการ นำไปใช้แล้ว
• หากคุณเคยใช้ Cloud Functions for Firebase มาก่อน ก็จะช่วยให้เข้าใจได้ง่ายขึ้น แต่ไม่จำเป็นต้องมีประสบการณ์ดังกล่าว

ตั้งค่าโปรเจ็กต์ Firebase

1. สร้างโปรเจ็กต์ Firebase ใหม่โดยใช้คอนโซล Firebase หรือเลือกโปรเจ็กต์ที่มีอยู่

2. อัปเกรดโปรเจ็กต์เป็นแพ็กเกจ Blaze ซึ่งจำเป็นสำหรับการติดตั้งใช้งานเวอร์ชันที่ใช้งานจริงของ 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

หลังจากตั้งค่าโปรเจ็กต์ Firebase ด้วย Cloud Functions แล้ว คุณจะคัดลอกหรือเขียนคำจำกัดความโฟลว์ในไดเรกทอรี 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/https");

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

ทำให้โฟลว์ที่ใช้งานอยู่เข้าถึงข้อมูลเข้าสู่ระบบ API ได้

เมื่อติดตั้งใช้งานแล้ว โฟลว์ของคุณจะต้องมีวิธีตรวจสอบสิทธิ์กับบริการระยะไกลใดๆ ที่โฟลว์ใช้ โดยส่วนใหญ่แล้ว ขั้นต่ำที่สุดคือโฟลว์ต้องมีข้อมูลเข้าสู่ระบบเพื่อเข้าถึงบริการ API ของโมเดลที่ใช้

สำหรับตัวอย่างนี้ ให้ทำอย่างใดอย่างหนึ่งต่อไปนี้ ขึ้นอยู่กับผู้ให้บริการโมเดลที่คุณเลือก

ความลับเดียวที่คุณต้องตั้งค่าสำหรับบทแนะนำนี้คือความลับสำหรับผู้ให้บริการโมเดล แต่โดยทั่วไปแล้ว คุณต้องทำสิ่งที่คล้ายกันสำหรับแต่ละบริการที่โฟลว์ใช้

(ไม่บังคับ) เพิ่มการบังคับใช้ App Check

Firebase App Check ใช้การรับรองเนทีฟเพื่อยืนยันว่าแอปพลิเคชันของคุณเท่านั้นที่เรียก API 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 (กลไกการแชร์ทรัพยากรข้ามโดเมน)

ใช้ตัวเลือก cors เพื่อควบคุมว่าต้นทางใดบ้างที่เข้าถึงฟังก์ชันได้

โดยค่าเริ่มต้น ฟังก์ชันที่เรียกใช้ได้จะมี CORS ที่กำหนดค่าไว้เพื่ออนุญาตคำขอจากต้นทางทั้งหมด หากต้องการอนุญาตคำขอข้ามต้นทางบางรายการ แต่ไม่อนุญาตทั้งหมด ให้ส่งรายการ โดเมนที่เฉพาะเจาะจงหรือนิพจน์ทั่วไปที่ควรได้รับอนุญาต เช่น

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

ตัวอย่างที่สมบูรณ์

หลังจากทำการเปลี่ยนแปลงทั้งหมดตามที่อธิบายไว้ข้างต้นแล้ว โฟลว์ที่พร้อมใช้งานจะมีลักษณะคล้ายกับตัวอย่างต่อไปนี้

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

ทําให้โฟลว์ใช้งานได้กับ Firebase

หลังจากกำหนดโฟลว์โดยใช้ onCallGenkit แล้ว คุณจะนําไปใช้งานได้เช่นเดียวกับ การนําฟังก์ชันอื่นๆ ไปใช้งาน

cd $PROJECT_ROOT
firebase deploy --only functions