Uygulamanızdan Genkit akışlarını çağırma

Cloud Functions for Firebase, Genkit işlemi (akış) içeren çağrılabilir bir işlev oluşturmanıza olanak tanıyan bir onCallGenkit yöntemine sahiptir. Bu işlevler, genkit/beta/client veya kimlik doğrulama bilgilerini otomatik olarak ekleyen bir Cloud Functions for Firebase Client SDK ile çağrılabilir.

Başlamadan önce

• Genkit akışları kavramını ve bunları nasıl yazacağınızı bilmeniz gerekir. Bu sayfadaki talimatlar, dağıtmak istediğiniz bazı akışları tanımladığınızı varsayar.
• Daha önce Cloud Functions for Firebase kullanmış olmanız faydalı olacaktır ancak zorunlu değildir.

Firebase projesi oluşturma

1. Firebase konsolunu kullanarak yeni bir Firebase projesi oluşturun veya mevcut bir projeyi seçin.

2. Projeyi, Cloud Functions üretim dağıtımı için gerekli olan kullandıkça öde Blaze fiyatlandırma planına yükseltin.

3. Firebase CLI'yı yükleyin.

4. Firebase CLI'da oturum açın:

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

5. Yeni bir proje dizini oluşturun:

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

6. Dizinde bir Firebase projesi başlatın:

   cd $PROJECT_ROOT
   firebase init functions

Bu sayfanın geri kalanında, işlevlerinizi JavaScript'te yazmayı seçtiğiniz varsayılır.

Akışı onCallGenkit ile sarmalama

Bir Firebase projesi oluşturup bu projede Cloud Functions'i başlattıktan sonra projenin functions dizininde akış tanımlarını kopyalayabilir veya yazabilirsiniz. Bunu göstermek için örnek bir akış aşağıda verilmiştir:

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

Bunun gibi bir akışı dağıtmak için firebase-functions/https paketinde bulunan onCallGenkit ile sarmalayın. Bu yardımcı yöntem, çağrılabilir işlevlerin tüm özelliklerine sahiptir ve hem akış hem de JSON yanıtlarını otomatik olarak destekler.

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 kimlik bilgilerini dağıtılan akışlarda kullanılabilir hale getirme

Dağıtıldıktan sonra akışlarınızın, kullandıkları tüm uzak hizmetlerle kimlik doğrulaması yapması gerekir. Çoğu akışın, kullandığı model API hizmetine erişmek için en azından kimlik bilgilerine ihtiyacı vardır.

Bu örnekte, seçtiğiniz model sağlayıcıya bağlı olarak aşağıdakilerden birini yapın:

Bu eğitim için ayarlamanız gereken tek gizli anahtar, model sağlayıcıya ait olan anahtardır. Ancak genel olarak, akışınızın kullandığı her hizmet için benzer bir işlem yapmanız gerekir.

(İsteğe bağlı) Firebase App Check yaptırımı ekleyin

Firebase App Check, API'mizin yalnızca uygulamanız tarafından çağrıldığını doğrulamak için yerel onayı kullanır. onCallGenkit yöntemi, App Check yaptırımını bildirimli olarak destekler.

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'yi (merkezler arası kaynak paylaşımı) yapılandırma

İşlevinize hangi kaynakların erişebileceğini kontrol etmek için cors seçeneğini kullanın.

Varsayılan olarak, çağrılabilir işlevlerde CORS, tüm kaynaklardan gelen isteklere izin verecek şekilde yapılandırılır. Tüm çapraz kaynak isteklerine değil de yalnızca bazılarına izin vermek için izin verilmesi gereken belirli alan adlarının veya normal ifadelerin listesini iletin. Örneğin:

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

Eksiksiz örnek

Bu kılavuzda açıklanan tüm değişiklikleri yaptıktan sonra dağıtılabilir akışınız aşağıdaki örneğe benzer:

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

Akışları Firebase'e dağıtma

onCallGenkit kullanarak akışları tanımladıktan sonra, diğer işlevleri dağıttığınız gibi bunları da dağıtabilirsiniz:

cd $PROJECT_ROOT
firebase deploy --only functions