Sử dụng Cấu hình từ xa trong môi trường máy chủ

Cấu hình từ xa Firebase hiện hỗ trợ cấu hình phía máy chủ bằng cách sử dụng SDK Node.js dành cho quản trị viên Firebase phiên bản 12.1.0 trở lên. Tính năng mới này cho phép bạn linh hoạt quản lý hành vi và cấu hình của các ứng dụng phía máy chủ bằng cách sử dụng Cấu hình từ xa. Điều này bao gồm các phương thức triển khai không máy chủ như Cloud Functions.

Không giống như SDK ứng dụng Firebase (tìm nạp cấu hình dành riêng cho ứng dụng khách được lấy từ mẫu Cấu hình từ xa, SDK Cấu hình từ xa phía máy chủ sẽ tải xuống một mẫu Cấu hình từ xa hoàn chỉnh từ Firebase). Sau đó, máy chủ của bạn có thể đánh giá mẫu theo từng yêu cầu đến, đồng thời sử dụng logic riêng để phân phát phản hồi tuỳ chỉnh với độ trễ rất thấp.

Với Cấu hình từ xa phía máy chủ, bạn có thể:

  • Xác định tham số cấu hình cho các ứng dụng chạy trên hoặc truy cập qua máy chủ của bạn, cho phép sử dụng trong những trường hợp như định cấu hình từ xa các tham số và lời nhắc của mô hình AI cũng như các công cụ tích hợp khác, để đảm bảo các khoá API luôn an toàn.
  • Linh động điều chỉnh các tham số để phản hồi các thay đổi trong môi trường hoặc các thay đổi khác của ứng dụng, chẳng hạn như cập nhật các tham số LLM và điểm cuối của mô hình.
  • Kiểm soát chi phí bằng cách cập nhật từ xa các API mà máy chủ của bạn gọi.
  • Tạo cấu hình tuỳ chỉnh một cách nhanh chóng cho các ứng dụng truy cập vào máy chủ của bạn.
  • Ghi lại những ứng dụng khách đã nhận được giá trị thông số và sử dụng giá trị này trong Cloud Functions như một phần của hệ thống xác minh quyền.

Bạn có thể triển khai Cấu hình từ xa phía máy chủ trên Cloud Run, Cloud Functions hoặc môi trường máy chủ tự lưu trữ.

Trước khi bắt đầu

Làm theo hướng dẫn trong bài viết Thêm SDK quản trị Firebase vào máy chủ để tạo dự án Firebase, thiết lập tài khoản dịch vụ và thêm SDK Node.js dành cho quản trị viên của Firebase vào máy chủ.

Bước 1: Khởi chạy SDK Node.js dành cho quản trị viên của Firebase và uỷ quyền cho các yêu cầu API

Khi bạn khởi chạy SDK dành cho quản trị viên mà không có tham số, SDK sẽ sử dụng Thông tin xác thực mặc định của ứng dụng Google và đọc các tuỳ chọn từ biến môi trường GOOGLE_APPLICATION_CREDENTIALS. Ví dụ: để khởi chạy SDK và thêm Cấu hình từ xa, hãy làm như sau:

import { initializeApp } from "firebase-admin/app";
import { getRemoteConfig } from "firebase-admin/remote-config";

// Initialize Firebase
const firebaseApp = initializeApp();

Bước 2: Xác định các giá trị tham số mặc định cho ứng dụng máy chủ của bạn

Xác định các biến trong ứng dụng mà bạn muốn cập nhật động bằng Cấu hình từ xa. Sau đó, hãy xem xét những biến nào phải được đặt theo mặc định trong ứng dụng của bạn và giá trị mặc định của các biến đó. Điều này đảm bảo ứng dụng chạy thành công ngay cả khi kết nối của ứng dụng với máy chủ phụ trợ Cấu hình từ xa bị gián đoạn.

Ví dụ: nếu đang viết một ứng dụng máy chủ quản lý chức năng AI tạo sinh, thì bạn có thể đặt tên mô hình mặc định, lời mở đầu câu lệnh và cấu hình AI tạo sinh, chẳng hạn như sau:

Tên thông số Nội dung mô tả Loại Giá trị mặc định
model_name Tên API mô hình Chuỗi gemini-1.5-pro
preamble_prompt Lời nhắc thêm vào trước truy vấn của người dùng Chuỗi I'm a developer who wants to learn about Firebase and you are a helpful assistant who knows everything there is to know about Firebase!
generation_config Thông số cần gửi đến mô hình JSON {"stopSequences": ["I hope this helps"], "temperature": 0.7, "maxOutputTokens": 512, "topP": 0.1, "topK": 20}

Bước 3: Định cấu hình ứng dụng máy chủ

Sau khi xác định các thông số mà bạn muốn sử dụng với Cấu hình từ xa, hãy định cấu hình ứng dụng của bạn để đặt các giá trị mặc định, tìm nạp mẫu Cấu hình từ xa dành riêng cho máy chủ và sử dụng các giá trị của mẫu đó. Các bước sau đây mô tả cách định cấu hình ứng dụng Node.js.

  1. Truy cập và tải mẫu.

    // Initialize server-side Remote Config
    const rc = getRemoteConfig(firebaseApp);
    const template = rc.initServerTemplate();
    
    // Load Remote Config
    await template.load();
    

    Nếu đang sử dụng Node.js trong Cloud Functions, thì bạn có thể dùng getServerTemplate không đồng bộ để tìm nạp và tải mẫu chỉ trong một bước:

    // Initialize server-side Remote Config
    const rc = getRemoteConfig(firebaseApp);
    const template = await rc.getServerTemplate();
    
  2. Để đảm bảo ứng dụng chạy thành công ngay cả khi kết nối của ứng dụng với máy chủ phụ trợ Cấu hình từ xa bị gián đoạn, hãy thêm các giá trị mặc định cho mỗi tham số vào ứng dụng. Để thực hiện việc này, hãy thêm defaultConfig bên trong hàm mẫu initServerTemplate hoặc getServerTemplate:

    const template = rc.initServerTemplate({
      defaultConfig: {
        model_name: "gemini-pro",
        generation_config: '{"stopSequences": [], "temperature": 0.7, "maxOutputTokens": 512, "topP": 0.1, "topK": 20}',
        preamble_prompt: "I'm a developer who wants to learn about Firebase and you are a helpful assistant who knows everything there is to know about Firebase!"
      },
    });
    
    // Load Remote Config
    await template.load();
    
  3. Sau khi mẫu tải, hãy sử dụng template.evaluate() để nhập các thông số và giá trị từ mẫu:

    // Add template parameters to config
    const config = template.evaluate();
    
  4. Nếu đặt điều kiện phần trăm trong mẫu Cấu hình từ xa (không bắt buộc), hãy xác định và cung cấp randomizationId mà bạn muốn sử dụng để đánh giá (các) điều kiện trong hàm template.evaluate().

    Ví dụ: bạn có thể đặt một mã cài đặt Firebase thành randomizationId hoặc một mã nhận dạng người dùng để đảm bảo rằng mỗi người dùng liên hệ với máy chủ của bạn đều được thêm vào nhóm ngẫu nhiên thích hợp. Ví dụ sau đây là một ví dụ cơ bản, nhưng bạn có thể định cấu hình máy chủ để tạo randomizationIds riêng cho từng yêu cầu ứng dụng nhằm đảm bảo rằng người dùng được cung cấp các giá trị nhất quán từ Cấu hình từ xa dựa trên tư cách thành viên của họ theo nhóm điều kiện tỷ lệ phần trăm.

    Để biết thêm thông tin về các điều kiện tỷ lệ phần trăm, hãy xem bài viết Người dùng theo tỷ lệ phần trăm ngẫu nhiên.

    // Set the randomizationId
    const randomizationId = "2ac93c28-c459-4760-963d-a3974ec26c04"
    
    // Add template parameters to `config`. Evaluates the
    // template and returns the parameter value assigned to
    // the group assigned to the {randomizationId}.
    const config = template.evaluate({
      randomizationId
    });
    
  5. Tiếp theo, hãy trích xuất các giá trị thông số mà bạn cần từ hằng số config. Sử dụng getters để truyền các giá trị từ Cấu hình từ xa sang định dạng dự kiến. Các loại sau được hỗ trợ:

    • Boolean: getBoolean
    • Đồ vật: getValue
    • Số: getNumber
    • Chuỗi: getString

    Ví dụ: nếu đang triển khai Vertex AI trên máy chủ và muốn thay đổi mô hình cũng như tham số của mô hình, bạn nên định cấu hình các tham số cho model_namegenerationConfig. Dưới đây là ví dụ về cách bạn có thể truy cập vào các giá trị của Cấu hình từ xa:

    // Replace defaults with values from Remote Config.
    const generationConfig =
      JSON.parse(
        config.getString('generation_config'));
    
    const is_ai_enabled = config.getBool('is_ai_enabled');
    
    const model = config.getString('model_name');
    
    // Generates a prompt comprised of the Remote Config
    // parameter and prepends it to the user prompt
    const prompt = `${config.getString('preamble_prompt')} ${req.query.prompt}`;
    
  6. Nếu máy chủ của bạn hoạt động trong thời gian dài, trái ngược với môi trường không máy chủ, hãy sử dụng setInterval để tải lại mẫu theo định kỳ nhằm đảm bảo rằng bạn định kỳ tìm nạp mẫu mới nhất từ máy chủ Cấu hình từ xa.

Bước 4: Đặt giá trị thông số dành riêng cho máy chủ trong Cấu hình từ xa

Tiếp theo, hãy tạo mẫu Cấu hình từ xa của máy chủ rồi định cấu hình các tham số cũng như giá trị để dùng trong ứng dụng của bạn.

Cách tạo mẫu Cấu hình từ xa dành riêng cho máy chủ:

  1. Mở trang thông số Cấu hình từ xa trên bảng điều khiển của Firebase và trong bộ chọn Ứng dụng/Máy chủ, hãy chọn Máy chủ.
  2. Xác định các thông số Cấu hình từ xa có cùng tên và kiểu dữ liệu với thông số mà bạn đã xác định trong ứng dụng của mình và cung cấp giá trị. Các giá trị này sẽ ghi đè defaultConfig mà bạn đặt trong phần Định cấu hình ứng dụng máy chủ khi tìm nạp và đánh giá mẫu, đồng thời chỉ định các giá trị này cho các biến của bạn.
  3. Bạn có thể đặt điều kiện tỷ lệ phần trăm để áp dụng liên tục một giá trị cho một mẫu thực thể ngẫu nhiên. Để biết thêm thông tin về điều kiện tỷ lệ phần trăm, hãy xem bài viết Người dùng theo tỷ lệ phần trăm ngẫu nhiên.
  4. Khi bạn thêm xong thông số, hãy nhấp vào Xuất bản các thay đổi.
  5. Xem lại các thay đổi rồi nhấp lại vào Xuất bản các thay đổi.

Bước 5: Triển khai bằng Cloud Functions hoặc Cloud Run

Nếu ứng dụng máy chủ của bạn nhẹ và dựa trên sự kiện, bạn nên cân nhắc việc triển khai mã bằng Cloud Functions. Ví dụ: giả sử bạn có một ứng dụng có hộp thoại nhân vật dựa trên một API AI tạo sinh (ví dụ: Google AI hoặc Vertex AI). Trong trường hợp này, bạn có thể lưu trữ logic phân phát LLM (mô hình ngôn ngữ lớn) trong một hàm mà ứng dụng của bạn gọi theo yêu cầu.

Nếu muốn chạy ứng dụng trong thời gian dài (ví dụ: ứng dụng web có tài sản), bạn có thể cân nhắc sử dụng Cloud Run. Để triển khai ứng dụng máy chủ bằng Cloud Run, hãy làm theo hướng dẫn trong bài viết Quickstart: Triển khai dịch vụ Node.js cho Cloud Run.

Để biết thêm thông tin về các trường hợp sử dụng phù hợp nhất cho Cloud Run và Cloud Functions, hãy tham khảo bài viết Cloud Run so với Cloud Run: thời điểm sử dụng một trong các tính năng kia.