Xây dựng trợ lý mã AI bằng Tác nhân mã Pipet

Việc viết mã có thể vừa mang lại hiệu quả vừa khiến bạn hài lòng, nhưng việc lấy mã từ công việc để trình bày cho đồng nghiệp thường là một công việc vất vả. Nhân tạo các mô hình AI tạo sinh có thể giúp bạn thêm nhận xét trong mã, tìm sai lầm trước khi nhân viên đánh giá mắc sai lầm, cũng như thực hiện nhiều thao tác khác để giúp quy trình lập trình của bạn dễ dàng hơn.

Hướng dẫn này chỉ cho bạn cách mở rộng Nhân viên hỗ trợ mã PIN một công cụ hỗ trợ lập trình dựa trên AI do nhóm Quan hệ nhà phát triển AI của Google. Dự án nguồn mở này là một tiện ích cho Microsoft Visual Studio Mã (VS Code) giúp bạn tận dụng quan tâm đến một số nhiệm vụ lập trình quan trọng nhưng kém thú vị hơn, chẳng hạn như nhận xét mã của bạn, tìm lỗi và đề xuất cải thiện. Tiện ích sẽ gửi các yêu cầu hỗ trợ lập trình lên Gemini API và kết hợp các câu trả lời vào cửa sổ chỉnh sửa mã của bạn.

Bạn có thể sửa đổi Pipet để làm cho các hàm hiện có này hoạt động tốt hơn cho bạn hoặc tạo các lệnh mới để hỗ trợ tốt hơn cho quy trình phát triển của bạn.

Để xem video tổng quan về dự án và cách mở rộng dự án, bao gồm cả thông tin chi tiết từ những người tạo ra nó, hãy xem Trợ lý mã AI – Xây dựng bằng AI của Google. Nếu không, bạn có thể bắt đầu mở rộng dự án theo hướng dẫn bên dưới.

Thiết lập dự án

Các hướng dẫn sau sẽ hướng dẫn bạn cách thiết lập dự án Pipet Code Agent để phát triển và thử nghiệm. Các bước chung là cài đặt một số điều kiện tiên quyết phần mềm, thiết lập một vài biến môi trường, sao chép dự án từ đoạn mã kho lưu trữ và chạy cài đặt cấu hình.

Cài đặt điều kiện tiên quyết

Dự án Pipet Code Agent chạy dưới dạng một phần mở rộng của Microsoft Visual Studio Mã và cách sử dụng Node.js và công cụ npm để quản lý các gói và chạy ứng dụng. Các hướng dẫn cài đặt sau đây dành cho máy chủ Linux.

Cách cài đặt phần mềm cần thiết:

  1. Cài đặt Visual Studio Code cho nền tảng của bạn.
  2. Cài đặt node và npm bằng cách làm theo hướng dẫn cài đặt hướng dẫn cho nền tảng của bạn.

Sao chép và định cấu hình dự án

Tải mã dự án xuống rồi dùng lệnh cài đặt npm để tải xuống các phần phụ thuộc bắt buộc và định cấu hình dự án. Bạn cần git phần mềm kiểm soát nguồn để truy xuất mã nguồn dự án.

Cách tải xuống và định cấu hình mã dự án:

  1. Sao chép kho lưu trữ git bằng lệnh sau.
    git clone https://github.com/google/generative-ai-docs
  2. Bạn có thể định cấu hình kho lưu trữ git cục bộ để sử dụng quy trình thanh toán thưa thớt, nên bạn chỉ có các tệp cho dự án Docs Agent. 
    cd generative-ai-docs/
git sparse-checkout init --cone
git sparse-checkout set examples/gemini/node/pipet-code-agent/
  3. Chuyển đến thư mục gốc của dự án Pipet Code Agent. 
    cd generative-ai-docs/examples/gemini/node/pipet-code-agent/
  4. Chạy lệnh cài đặt để tải các phần phụ thuộc xuống và định cấu hình dự án: 
    npm install

Định cấu hình và kiểm thử tiện ích

Bây giờ, bạn có thể kiểm tra việc cài đặt của mình bằng cách chạy Pipet Code Agent dưới dạng một tiện ích phát triển trong VS Code trên thiết bị của bạn. Thử nghiệm mở ra một VS riêng biệt Cửa sổ Máy chủ phát triển tiện ích mã khi có tiện ích mới. Trong cửa sổ mới này, bạn định cấu hình Khoá API mà tiện ích sử dụng để truy cập vào API Google Gemini.

Tác nhân mã Pipet chạy trong cửa sổ Máy chủ phát triển tiện ích Hình 1. Cửa sổ Máy chủ phát triển tiện ích mã so với cùng với Pipet các lệnh của tiện ích.

Cách định cấu hình và kiểm tra chế độ thiết lập:

  1. Khởi động ứng dụng VS Code.
  2. Trong VS Code, hãy tạo một cửa sổ mới bằng cách chọn File > (Tệp >) Cửa sổ mới.
  3. Mở dự án Pipet Code Agent bằng cách chọn File > Mở thư mục, rồi chọn thư mục pipet-code-agent/.
  4. Mở tệp pipet-code-agent/package.json.
  5. Chạy tiện ích ở chế độ gỡ lỗi bằng cách chọn Run > (Chạy >) Bắt đầu gỡ lỗi. Bước này sẽ mở ra một cửa sổ Máy chủ phát triển tiện ích riêng biệt VS Code.
  6. Mở phần cài đặt Mã VS bằng cách chọn Mã > Cài đặt > Cài đặt.
  7. Lấy Khoá API Gemini của Google trên Trang web dành cho nhà phát triển AI tạo sinh rồi sao chép chuỗi khoá.
  8. Đặt khoá API làm chế độ cài đặt cấu hình. Trong phần Cài đặt Tìm kiếm hãy nhập pipet, chọn tab Người dùng và trong Google > Gemini: Cài đặt Khóa API, nhấp vào liên kết Chỉnh sửa trong settings.json rồi thêm Khoá Gemini API: 
    "google.gemini.apiKey": "your-api-key-here"
  9. Lưu các thay đổi đối với tệp settings.json rồi đóng các thẻ cài đặt.

Cách kiểm tra các lệnh của tiện ích:

  1. Trong cửa sổ Máy chủ phát triển tiện ích mã VS, chọn mã bất kỳ trong cửa sổ trình chỉnh sửa.
  2. Mở bảng lệnh bằng cách chọn View > (Xem >) Bảng điều khiển lệnh.
  3. Trong bảng Command Palette, nhập Pipet và chọn một trong các lệnh có tiền tố đó.

Sửa đổi lệnh hiện có

Sửa đổi các lệnh được cung cấp trong Pipet Code Agent là cách đơn giản nhất để thay đổi hành vi và khả năng của tiện ích. Cả nhận xét và Hãy dùng các lệnh xem lại một vài cảnh nhắc nhở bằng các ví dụ về mã và chú thích cho mã đó, cũng như một số hướng dẫn chung về mô hình tạo sinh AI. Ngữ cảnh của lời nhắc này sẽ giúp mô hình tạo sinh Gemini hình thành câu trả lời. Theo thay đổi hướng dẫn câu lệnh, ví dụ hoặc cả hai trong nhận xét hoặc xem lại, bạn có thể thay đổi cách hoạt động của từng lệnh hiện tại.

Tập hợp hướng dẫn này giải thích cách sửa đổi lệnh review.ts bằng cách thay đổi văn bản lời nhắc của lệnh.

Cách chuẩn bị chỉnh sửa lệnh review.ts:

  1. Khởi động ứng dụng VS Code.
  2. Trong VS Code, hãy tạo một cửa sổ mới bằng cách chọn File > (Tệp >) Cửa sổ mới.
  3. Mở dự án Pipet Code Agent bằng cách chọn File > Mở thư mục, rồi chọn thư mục pipet-code-agent/.
  4. Mở tệp pipet-code-agent/src/review.ts.

Cách sửa đổi hành vi của lệnh review.ts:

  1. Trong tệp review.ts, hãy thay đổi phần đầu của PROMPT không đổi theo các hướng dẫn khác nhau. 
    const PROMPT = '
Write review comments for following code, identifying bugs and ways to improve code quality. Examples of bugs are syntax errors or typos, out of memory errors, and boundary value errors. Examples of improving code quality are reducing complexity of code, eliminating duplicate code, and ensuring other developers
are able to understand the code.
${CODE_LABEL}
...
  2. (Không bắt buộc) Thêm một ví dụ khác vào tệp review.ts danh sách các ví dụ về việc xem xét mã. 
    ...
${REVIEW_LABEL}
There are duplicate lines of code in this control structure.
${CODE_LABEL}
const fixed_value = 128;
${REVIEW_LABEL}
Make sure constant names are in all capitals (FIXED_VALUE) for clarity.
';
  3. Lưu các thay đổi đối với tệp review.ts.

Cách kiểm tra lệnh đã sửa đổi:

  1. Trong cửa sổ dự án tiện ích Pipet mã VS, hãy khởi động lại trình gỡ lỗi bằng chọn Run > (Chạy >) Khởi động lại gỡ lỗi.
  2. Trong cửa sổ Máy chủ phát triển tiện ích mã VS, chọn mã bất kỳ trong cửa sổ trình chỉnh sửa.
  3. Mở bảng lệnh bằng cách chọn View > (Xem >) Bảng điều khiển lệnh.
  4. Trong Bảng điều khiển lệnh, nhập Pipet và chọn Pipet: Xem lại đã chọn.

Tạo lệnh mới

Bạn có thể mở rộng Pipet bằng cách tạo các lệnh mới thực hiện các thao tác hoàn toàn mới với API Gemini. Mỗi tệp lệnh (comment.ts và review.ts) chủ yếu độc lập và bao gồm mã để thu thập văn bản từ trình chỉnh sửa đang hoạt động, soạn một câu lệnh, kết nối với Gemini API, gửi câu lệnh và xử lý nội dung phản hồi.

Tác nhân mã Pipet có chức năng Đặt tên cho hàm lựa chọn xuất hiện Hình 2. Lệnh đề xuất tên hàm mới trong Tiện ích mã VS Cửa sổ Development Host.

Tập hợp các hướng dẫn này giải thích cách xây dựng một lệnh mới bằng mã một lệnh hiện có comment.ts làm mẫu.

Cách tạo một lệnh đề xuất tên cho các hàm:

  1. Tạo bản sao của tệp pipet-code-agent/src/comment.ts có tên là name.ts trong thư mục src/.
  2. Trong mã VS, hãy mở tệp src/name.ts.
  3. Thay đổi hướng dẫn câu lệnh trong tệp name.ts bằng cách chỉnh sửa giá trị PROMPT. 
    // Provide instructions for the AI generative model
const PROMPT = `Recommend a name for this function. Explain your
reasoning in 3 sentences or less:`;
  4. Thay đổi tên của hàm lệnh và thông báo thông tin của hàm đó. 
    export async function generateName() {
  vscode.window.showInformationMessage('Generating function name...');
  5. Cập nhật mã tập hợp lời nhắc để chỉ bao gồm PROMPT và văn bản đã chọn trong trình chỉnh sửa. 
      // Build the full prompt using the template.
  const fullPrompt = `${PROMPT}
"
${selectedCode}
"
`;
  6. Hãy thay đổi kết quả phản hồi để mô tả nội dung mà phản hồi đó đang tạo. 
        // update prefix to describe output
    let commentIntro = padding + commentPrefix + "Recommended name: (generated)\n";
    editBuilder.insert(selection.start, commentIntro);
    editBuilder.insert(selection.start, pyComment);
  7. Lưu các thay đổi đối với tệp review.ts.

Tích hợp lệnh mới

Sau khi hoàn tất mã cho lệnh mới, bạn cần tích hợp lệnh đó với phần còn lại của tiện ích. Cập nhật các tệp extension.ts và package.json thành tạo phần lệnh mới của tiện ích và cho phép Mã VS gọi lệnh mới.

Cách tích hợp lệnh name với mã tiện ích:

  1. Trong mã VS, hãy mở tệp pipet-code-agent/src/extension.ts.
  2. Thêm tệp mã mới vào tiện ích bằng cách thêm lệnh nhập mới tuyên bố. 
    import { generateName } from './name';
  3. Đăng ký lệnh mới bằng cách thêm mã sau vào Hàm activate(). 
    export function activate(context: vscode.ExtensionContext) {
    ...
    vscode.commands.registerCommand('pipet-code-agent.nameFunction', generateName);
}
  4. Lưu các thay đổi đối với tệp extension.ts.

Cách tích hợp lệnh name với gói tiện ích:

  1. Trong mã VS, hãy mở tệp pipet-code-agent/package.json.
  2. Thêm lệnh mới vào phần commands của gói . 
      "contributes": {
    "commands": [
      ...
      {
        "command": "pipet-code-agent.nameFunction",
        "title": "Pipet: Name the selected function."
      }
    ],
  3. Lưu các thay đổi đối với tệp package.json.

Kiểm thử lệnh mới

Sau khi bạn hoàn tất việc lập trình lệnh và tích hợp lệnh đó với tiện ích, bạn có thể kiểm tra nó. Lệnh mới của bạn chỉ có trong Mã VS cửa sổ Extension Development Host (Máy chủ phát triển tiện ích), không phải trong cửa sổ VS Code mà bạn chỉnh sửa mã cho tiện ích.

Cách kiểm tra lệnh đã sửa đổi:

  1. Trong cửa sổ dự án tiện ích Pipet mã VS, hãy khởi động lại trình gỡ lỗi bằng chọn Run > (Chạy >) Khởi động lại gỡ lỗi, thao tác này sẽ khởi động lại một Cửa sổ Extension Development Host (Máy chủ phát triển tiện ích).
  2. Trong cửa sổ Máy chủ phát triển tiện ích mã VS, chọn một số mã trong cửa sổ trình chỉnh sửa.
  3. Mở bảng lệnh bằng cách chọn View > (Xem >) Bảng điều khiển lệnh.
  4. Trong bảng Command Palette, nhập Pipet và chọn Pipet: Đặt tên cho đã chọn.

Tài nguyên khác

Để biết thêm thông tin về dự án Pipet Code Agent, hãy xem kho lưu trữ mã. Nếu bạn cần trợ giúp về việc xây dựng ứng dụng hoặc đang tìm kiếm nhà phát triển cộng tác viên, hãy xem Cộng đồng nhà phát triển của Google trên Discord máy chủ.

Ứng dụng phát hành công khai

Nếu bạn dự định triển khai Tác nhân Google Tài liệu cho nhiều người dùng, xin lưu ý rằng việc sử dụng thì Google Gemini API có thể bị giới hạn số lượng yêu cầu và hạn chế sử dụng. Nếu bạn đang cân nhắc xây dựng một ứng dụng phát hành công khai bằng Gemini API, chẳng hạn như Tác nhân Tài liệu, thanh toán Vertex AI của Google Cloud các dịch vụ khác để tăng khả năng có thể mở rộng và độ tin cậy cho ứng dụng của bạn.