Cách SDK GitHub Copilot hỗ trợ các ứng dụng phân loại sự cố bằng AI như IssueCrush

Trang chủ » Python » Cách SDK GitHub Copilot hỗ trợ các ứng dụng phân loại sự cố bằng AI như IssueCrush

Đối với nhiều người quản lý dự án, việc mở một kho lưu trữ bận rộn trên GitHub đồng nghĩa với việc phải đối mặt với một danh sách dài các vấn đề chưa được giải quyết, tưởng chừng như vô tận. Báo cáo lỗi, yêu cầu tính năng, câu hỏi thực sự nên được thảo luận, và các vấn đề trùng lặp từ nhiều năm trước đều cạnh tranh nhau để thu hút sự chú ý và tạo ra rất nhiều rắc rối. gánh nặng tinh thần trong quá trình phân loại vấn đề.

Bộ SDK Copilot của GitHub cung cấp một cách để giảm bớt một phần gánh nặng nhận thức bằng cách cho phép bạn nhúng cùng một trí tuệ nhân tạo (AI) hỗ trợ Copilot Chat vào các công cụ của riêng bạn. Một ví dụ cụ thể là ứng dụng IssueCrush, sử dụng SDK để tạo ra... Tóm tắt các vấn đề trên GitHub bằng AI Nhờ đó, người bảo trì có thể nhanh chóng quyết định phải làm gì với từng yêu cầu.

Từ hộp thư đến hệ thống phân loại tự động hỗ trợ bởi AI

IssueCrush được xây dựng dựa trên một ý tưởng đơn giản: trình bày các vấn đề dưới dạng các thẻ có thể vuốt và để trí tuệ nhân tạo (AI) đảm nhiệm phần lớn việc xử lý ngữ cảnh. Trong ứng dụng, Mỗi vấn đề trên GitHub được hiển thị dưới dạng một thẻ. Bạn có thể vuốt sang trái để bỏ qua hoặc vuốt sang phải để giữ lại. Thao tác “Nhận tóm tắt AI” sẽ gửi chi tiết sự cố đến máy chủ phụ trợ được hỗ trợ bởi GitHub Copilot SDK, máy chủ này sẽ trả về một bản giải thích ngắn gọn, dễ thực hiện về sự cố đó là gì và cách giải quyết nó.

Thay vì phải đọc qua những mô tả dài dòng và các chuỗi bình luận, người bảo trì có thể xem lướt qua các bản tóm tắt này để quyết định xem vấn đề có cần điều tra thêm, đã sẵn sàng để triển khai, cần được phân công lại hay có thể đóng lại. Quy trình này biến quá trình phân loại tẻ nhạt kiểu hộp thư đến thành một quy trình làm việc nhanh hơn và tập trung hơn. Trí tuệ nhân tạo (AI) cung cấp bước xử lý đầu tiên. và con người vẫn là người đưa ra quyết định cuối cùng.

Điểm mấu chốt là tất cả những điều này được xây dựng dựa trên SDK của Copilot chứ không phải cơ sở hạ tầng AI tùy chỉnh. SDK đó cung cấp... môi trường chạy tác nhân đã được kiểm thử trong môi trường sản xuất Trước đây, tính năng này đã được sử dụng cho các trải nghiệm Copilot ngay trong GitHub, vì vậy các nhà phát triển không cần phải tự tạo lại logic lập kế hoạch hoặc điều phối chỉ để triển khai tính năng phân loại sự cố được hỗ trợ bởi AI.

Ngoài ứng dụng cụ thể này, mô hình tương tự có thể được tái sử dụng cho bất kỳ quy trình làm việc nào khác. đồ thị ngữ cảnh và thông tin có cấu trúc Cần tóm tắt nhanh chóng, cho dù đó là công cụ theo dõi sự cố nội bộ, báo cáo sự cố hay hàng đợi xem xét mã.

Vì sao SDK của Copilot phải được lưu trữ trên máy chủ?

Mặc dù IssueCrush là một ứng dụng React Native, nhưng SDK Copilot không thể chạy trực tiếp trên điện thoại. SDK này phụ thuộc vào một hệ thống khác. Môi trường chạy Node.js cộng với tệp nhị phân CLI Copilot.Nó quản lý việc này ngầm thông qua JSON-RPC. Môi trường di động không cung cấp kiểu thiết lập tương thích với Node.js như vậy, vì vậy việc tích hợp phải được thực hiện trên máy chủ phụ trợ.

Trên thực tế, điều này dẫn đến một mô hình phía máy chủ đơn giản: phần phụ trợ khởi tạo một máy khách Copilot SDK duy nhất, máy khách này giao tiếp nội bộ với Copilot CLI, và tất cả các máy khách di động gửi yêu cầu của chúng đến dịch vụ này. Thiết kế này mang lại một số lợi thế quan trọng vượt xa việc chỉ đáp ứng các yêu cầu thời gian chạy.

• A Một phiên bản SDK duy nhất được chia sẻ giữa các máy khách. Phương pháp này tránh việc tạo kết nối mới cho mỗi điện thoại hoặc mỗi yêu cầu, giúp giảm chi phí vận hành và giữ cho quá trình xác thực được tập trung hóa.
• Bí mật vẫn nằm trên máy chủ.Các mã thông báo liên quan đến Copilot hoặc thông tin xác thực BYOK (mang theo khóa riêng của bạn) không bao giờ xuất hiện trong gói React Native, nếu không sẽ có thể bị phân tích ngược.
• Ứng dụng có thể Giảm hiệu suất một cách nhẹ nhàng khi AI không khả dụngNếu dịch vụ Copilot hết thời gian chờ hoặc trả về lỗi, máy chủ phụ trợ vẫn có thể phản hồi bằng một bản tóm tắt cơ bản, chỉ bao gồm siêu dữ liệu, thay vì báo lỗi hoàn toàn.
• Vì mọi yêu cầu đều đi qua một nơi duy nhất, máy chủ có thể thực hiện... ghi nhật ký và giám sát tập trung về các lời nhắc, phản hồi và độ trễ.

Để thiết lập điều này, cần đáp ứng một vài điều kiện tiên quyết trên máy chủ: CLI Copilot phải được cài đặt và có thể truy cập được trong PATH, môi trường cần có đăng ký Copilot hợp lệ trên GitHub hoặc thiết lập BYOK, và quá trình xác thực phải được hoàn tất thông qua quy trình đăng nhập dòng lệnh hoặc thông qua biến môi trường như... COPILOT_GITHUB_TOKEN.

Cách thức tích hợp SDK GitHub Copilot hoạt động

Về mặt kỹ thuật, Copilot SDK tuân theo một quy trình rõ ràng, vòng đời dựa trên phiên để vận hành LLMMột quy trình điển hình bao gồm việc khởi tạo một máy khách, tạo một phiên với một mô hình cụ thể, gửi một lời nhắc và chờ câu trả lời, sau đó dọn dẹp cả phiên và máy khách một cách rõ ràng.

Mô hình được khuyến nghị là xử lý vòng đời này một cách rất nghiêm ngặt: gọi start() trước, sau đó createSession().Và chỉ sau khi hoàn tất tất cả các tương tác, hãy gọi hàm disconnect() trên phiên và sau đó gọi hàm stop() trên máy khách. Việc gói các bước này trong các khối try/finally không chỉ mang tính thẩm mỹ mà còn ngăn ngừa rò rỉ bộ nhớ và tiến trình, những lỗi có thể khó chẩn đoán.

Trong phần phụ trợ của IssueCrush, ứng dụng khách Copilot được khởi chạy, một phiên được tạo với một mô hình như gpt-4.1, và dữ liệu sự cố được chuyển đổi thành một lời nhắc. Phản hồi được truy xuất bằng một phương thức chờ cho đến khi mô hình hoàn tất trước khi trả về. Chỉ sau khi tóm tắt được trích xuất, máy chủ mới chạy logic dọn dẹp của nó, đảm bảo rằng mọi phiên đang mở đều được ngắt kết nối một cách rõ ràng và ứng dụng khách được dừng lại.

Sự tích hợp này cũng cho thấy cách xử lý an toàn. nhập khẩu động của SDKViệc sử dụng import bất đồng bộ thay vì require ở cấp cao nhất cho phép máy chủ khởi động ngay cả khi có sự cố tạm thời khi tải SDK hoặc truy cập CLI, điều này có thể đơn giản hóa việc triển khai và gỡ lỗi trong một số môi trường.

Thiết kế gợi ý cho các bản tóm tắt vấn đề có thể hành động được.

Việc chỉ đơn thuần đưa một lượng lớn văn bản vấn đề vào hệ thống quản lý ngôn ngữ pháp lý (LLM) thường cho ra kết quả không mấy khả quan. Ví dụ về SDK Copilot trong IssueCrush chứng minh điều đó. các lời nhắc có cấu trúc được xây dựng từ siêu dữ liệu thường dẫn đến những bản tóm tắt hữu ích hơn.

Thay vì chỉ đơn thuần nối nội dung vấn đề lại với nhau, hệ thống phụ trợ sẽ xây dựng một lời nhắc bao gồm các trường như tiêu đề, số thứ tự, tên kho lưu trữ, trạng thái hiện tại, nhãn, ngày tạo và tác giả. Điều này cung cấp cho mô hình đủ ngữ cảnh để điều chỉnh đề xuất của nó — ví dụ, nó có thể xử lý báo cáo từ người đóng góp lần đầu khác với báo cáo được gửi bởi người bảo trì lâu năm.

Lời nhắc cũng chỉ rõ định dạng đầu ra cần có: một bản tóm tắt ngắn gọn từ hai đến ba câu giải thích vấn đề, chỉ ra vấn đề hoặc yêu cầu chính và đề xuất bước tiếp theo như “cần điều tra”, “sẵn sàng thực hiện” hoặc “đóng lại vì trùng lặp”. Nó thậm chí còn hướng dẫn mô hình không sử dụng định dạng Markdown, đảm bảo rằng Tóm tắt có thể được hiển thị trực tiếp. trong giao diện người dùng di động mà không cần xử lý hậu kỳ thêm.

Về phía phản hồi, máy chủ gọi phương thức của SDK để gửi lời nhắc và chờ phản hồi, truyền vào một giá trị thời gian chờ (ví dụ: 30 giây). Thời gian chờ này ngăn người dùng chờ đợi vô thời hạn đối với các phản hồi chậm. Trước khi đọc bất kỳ thuộc tính nào từ kết quả, mã sẽ duyệt qua chuỗi phản hồi một cách thận trọng, kiểm tra xem các đối tượng có tồn tại hay không để tránh bị lỗi kiểu "undefined is not an object" khi có điều gì đó không mong muốn xảy ra.

Khi mọi thứ diễn ra suôn sẻ, máy chủ sẽ trích xuất bản tóm tắt văn bản và trả về cho ứng dụng. Nếu phản hồi trống hoặc bị lỗi định dạng, máy chủ có thể báo lỗi và kích hoạt logic dự phòng thay vì trả về dữ liệu không thể sử dụng được cho máy khách.

Lớp dịch vụ phía máy khách trong React Native

Về phía thiết bị di động, quá trình tích hợp được thiết kế tối giản một cách có chủ ý. Một lớp dịch vụ chuyên dụng bao bọc tất cả các lệnh gọi đến máy chủ phụ trợ, xử lý các tác vụ như kiểm tra trạng thái, lấy mã thông báo, yêu cầu mạng và xử lý lỗi để giao diện người dùng có thể duy trì sự đơn giản tương đối.

Dịch vụ này cung cấp một phương thức để gửi tín hiệu ping tới... Điểm cuối /health trên máy chủNếu máy chủ báo cáo rằng tính năng hỗ trợ Copilot đang hoạt động, ứng dụng có thể hiển thị nút “Tóm tắt AI” một cách an toàn. Nếu không, nút đó có thể được ẩn hoàn toàn để người dùng không chạm vào tính năng bị lỗi.

Để tóm tắt, máy khách đọc mã thông báo GitHub của người dùng từ bộ nhớ an toàn và gửi cả mã thông báo lẫn dữ liệu sự cố đến điểm cuối tóm tắt AI của máy chủ phụ trợ. Phản hồi có thể chứa bản tóm tắt do Copilot tạo ra thông thường, bản tóm tắt dự phòng hoặc lỗi với cờ “requiresCopilot” khi người dùng không có đăng ký phù hợp.

Dịch vụ này chuyển đổi các phản hồi đó thành một đối tượng kết quả nhất quán bao gồm văn bản tóm tắt cùng với các cờ mô tả xem kết quả đó đến từ AI hay từ một đường dẫn dự phòng. Từ góc nhìn của giao diện người dùng, nó chỉ cần biết Văn bản nào sẽ được hiển thị và liệu có hiển thị bất kỳ thông báo đặc biệt nào không. Về các yêu cầu đăng ký.

Luồng giao diện người dùng và bộ nhớ đệm trong React Native

Trong giao diện React Native, logic chủ yếu là quản lý trạng thái tiêu chuẩn. Khi người dùng nhấn vào nút để lấy bản tóm tắt AI, thành phần sẽ kiểm tra xem vấn đề hiện tại đã có bản tóm tắt được tạo ra hay chưa; nếu có, sẽ không có yêu cầu mạng nào được thực hiện. Nếu không, ứng dụng sẽ đặt cờ tải, gọi phương thức dịch vụ và cập nhật vấn đề trong danh sách cục bộ sau khi nhận được bản tóm tắt.

Sau khi tóm tắt được lưu trữ trên đối tượng sự cố, thành phần thẻ sẽ thay thế nút bằng chính văn bản tóm tắt đó. Nếu người dùng vuốt đi và sau đó quay lại cùng một thẻ, ứng dụng sẽ hiển thị ngay lập tức nội dung đã được lưu trong bộ nhớ cache thay vì gọi lại máy chủ. Phương pháp này giảm thiểu việc sử dụng API, tránh độ trễ không cần thiết.và giúp giao diện người dùng phản hồi nhanh hơn khi xem lại nhiều lần.

Cờ tải cho phép thành phần hiển thị biểu tượng chờ hoặc trạng thái bị vô hiệu hóa trong khi yêu cầu phía máy chủ đang chạy. Mọi lỗi từ dịch vụ đều được ghi lại và có thể được hiển thị thông qua thông báo ngắn, biểu ngữ hoặc các mẫu giao diện người dùng khác tùy thuộc vào thiết kế của ứng dụng.

Giảm hiệu năng một cách mượt mà khi AI ngừng hoạt động.

Không có dịch vụ AI nào hoạt động 100% thời gian, và giới hạn tốc độ hoặc sự cố mạng là điều không thể tránh khỏi. Ví dụ về IssueCrush đã cố tình tích hợp chiến lược dự phòng để việc phân loại sự cố không bị gián đoạn nếu Copilot không khả dụng.

Ở phía máy chủ, lỗi được phân loại thành hai nhóm chính. Nếu thông báo cho thấy vấn đề về xác thực hoặc đăng ký, máy chủ sẽ trả về mã trạng thái 403 cùng với lời giải thích rõ ràng rằng... Cần phải có đăng ký Copilot. Đối với các bản tóm tắt do AI tạo ra, khách hàng sau đó có thể hiển thị thông báo phù hợp với tình huống đó.

Tất cả các lỗi khác đều kích hoạt cơ chế dự phòng dựa trên siêu dữ liệu. Máy chủ sẽ xây dựng bản tóm tắt từ thông tin mà nó đã có – thường là tiêu đề sự cố, danh sách nhãn và có thể là câu đầu tiên của nội dung nếu nó đủ ngắn. Một ghi chú cuối cùng khuyến khích người bảo trì xem lại chi tiết đầy đủ của sự cố để biết các bước tiếp theo.

Vì phương án dự phòng này được tạo ra hoàn toàn từ dữ liệu sự cố hiện có, nên nó vẫn hoạt động ngay cả khi dịch vụ Copilot hoặc kết nối mạng bị lỗi. Ứng dụng không tự nhận là thông minh như một mô hình AI trong chế độ này, nhưng nó vẫn cung cấp thông tin hữu ích hơn là chỉ hiển thị trạng thái lỗi trống rỗng.

Kết hợp với điểm cuối kiểm tra sức khỏe và khả năng ẩn hoặc hiển thị nút tóm tắt AI của người dùng, điều này có nghĩa là trải nghiệm tổng thể vẫn được duy trì. Có chức năng và dự đoán được ngay cả trong điều kiện lỗi..

Tóm tắt theo yêu cầu và nhận thức về chi phí

Một khía cạnh đáng chú ý khác của thiết kế là các bản tóm tắt chỉ được tạo ra khi người dùng yêu cầu. Hệ thống phụ trợ không tính toán trước các bản tóm tắt AI cho mọi vấn đề trong kho lưu trữ; thay vào đó, nó chờ cho đến khi người quản lý nhấn vào nút cho một thẻ cụ thể.

Mô hình xử lý theo yêu cầu này giúp giảm thiểu việc sử dụng tài nguyên tính toán và kiểm soát chi phí API, vì nhiều vấn đề có thể được bỏ qua hoặc nhanh chóng được giải quyết mà không cần đến sự hỗ trợ của AI. Sau khi bản tóm tắt được tạo cho một vấn đề, nó sẽ được lưu vào bộ nhớ đệm trong bản ghi của vấn đề đó trong ứng dụng, đảm bảo rằng việc xem lại nhiều lần không phát sinh thêm yêu cầu.

Sự cân bằng giữa tính tiện lợi và việc sử dụng tài nguyên này đặc biệt quan trọng đối với các nhóm hoạt động ở quy mô lớn, nơi mà hàng chục nghìn vấn đề và người dùng có thể phát sinh. một lượng lớn các yêu cầu AI không cần thiết.

Yêu cầu, các yếu tố phụ thuộc và nền tảng được hỗ trợ

Về mặt công cụ, phần backend sử dụng... @github/copilot-sdk Gói SDK được tích hợp cùng với một khung máy chủ HTTP tiêu chuẩn như Express. SDK giao tiếp với Copilot CLI thông qua JSON-RPC, vì vậy việc cài đặt và cấu hình đúng CLI là điều bắt buộc.

Ví dụ hiện tại nhắm đến môi trường Node.js, nhưng bản thân SDK Copilot được thiết kế để hoạt động trên nhiều ngôn ngữ. Nó hỗ trợ Node.js/TypeScript, Python, Go và .NET, với việc tích cực phát triển thêm các nền tảng khác. Bất kể ngôn ngữ nào, khái niệm cốt lõi vẫn giống nhau: SDK cung cấp một môi trường chạy tác nhân có thể được kết nối với các công cụ tùy chỉnh mà không yêu cầu các nhà phát triển phải tự tạo ra lớp điều phối riêng.

Việc xác thực được thực hiện thông qua cơ chế đăng nhập của giao diện dòng lệnh (CLI) hoặc thông qua các biến môi trường chứa mã thông báo. Trong môi trường sản xuất, thông tin đăng nhập này được lưu trữ trên máy chủ và không bao giờ được tiết lộ cho máy khách, tuân theo các thực tiễn bảo mật tiêu chuẩn. Khóa API và mã thông báo truy cập.

Những bài học thực tiễn từ việc xây dựng dự án với Copilot SDK

Có một số điểm đáng lưu ý từ kiểu tích hợp này. Thứ nhất, việc giữ SDK của Copilot hoàn toàn trên máy chủ không chỉ là một yêu cầu kỹ thuật mà còn đơn giản hóa bảo mật và triển khai bằng cách tập trung hóa cấu hình và thông tin xác thực.

Thứ hai, chất lượng đầu ra của AI Hiệu quả của việc này phụ thuộc nhiều hơn vào cách bạn cấu trúc câu hỏi hơn là lượng văn bản thô bạn đưa vào mô hình. Việc bao gồm siêu dữ liệu mục tiêu như nhãn, tác giả và dấu thời gian có thể cải thiện đáng kể tính hữu ích của các đề xuất phân loại do AI tạo ra.

Thứ ba, quản lý vòng đời mạnh mẽ là rất quan trọng. Việc ngắt kết nối các phiên và dừng máy khách một cách rõ ràng rất dễ bị bỏ qua trong các thử nghiệm ban đầu, nhưng bỏ qua các bước này có thể dẫn đến rò rỉ bộ nhớ và các tiến trình còn tồn đọng trong các dịch vụ chạy dài.

Cuối cùng, bộ nhớ đệm và cơ chế dự phòng là những mô hình thiết yếu. Khi đã có bản tóm tắt tốt, việc lưu trữ nó trên đối tượng sự cố sẽ giúp tránh làm việc trùng lặp và tiết kiệm chi phí không cần thiết. Và việc có bản tóm tắt dự phòng không phải do AI tạo ra đảm bảo rằng người bảo trì vẫn có thể tiếp tục công việc ngay cả khi các dịch vụ bên ngoài gặp sự cố.

Nhìn chung, những mô hình này cho thấy cách SDK GitHub Copilot có thể hỗ trợ các công cụ thực tiễn như IssueCrush, giúp các nhóm làm việc hiệu quả hơn. Các phương pháp nhanh hơn, bền vững hơn để quản lý khối lượng lớn vấn đề mà không biến việc phân loại bệnh nhân thành một công việc quá sức.