Xuất bản API

Tổng quan

Mẫu này bao gồm tính năng xuất bản API. Mặc dù giao diện chat có thể thuận tiện cho việc xác thực ban đầu, việc triển khai thực tế phụ thuộc vào trường hợp sử dụng cụ thể và trải nghiệm người dùng (UX) mong muốn cho người dùng cuối. Trong một số tình huống, giao diện chat có thể là lựa chọn ưu tiên, trong khi ở những trường hợp khác, API độc lập có thể phù hợp hơn. Sau khi xác thực ban đầu, mẫu này cung cấp khả năng xuất bản các bot tùy chỉnh theo nhu cầu của dự án. Bằng cách nhập các cài đặt cho hạn ngạch, giới hạn tốc độ, nguồn gốc, v.v., một điểm cuối có thể được xuất bản cùng với khóa API, mang lại sự linh hoạt cho các tùy chọn tích hợp đa dạng.

Bảo mật

Việc chỉ sử dụng API key không được khuyến nghị như đã mô tả trong: AWS API Gateway Developer Guide. Do đó, mẫu này triển khai hạn chế địa chỉ IP đơn giản thông qua AWS WAF. Quy tắc WAF được áp dụng chung cho toàn bộ ứng dụng do cân nhắc về chi phí, với giả định rằng các nguồn mà bạn muốn hạn chế có khả năng giống nhau trên tất cả các API đã phát hành. Vui lòng tuân thủ chính sách bảo mật của tổ chức bạn để triển khai thực tế. Đồng thời tham khảo phần Architecture.

Cách xuất bản API bot tùy chỉnh

Điều kiện tiên quyết

Vì lý do quản trị, chỉ một số người dùng giới hạn mới có thể xuất bản bot. Trước khi xuất bản, người dùng phải là thành viên của nhóm có tên PublishAllowed, có thể được thiết lập thông qua bảng điều khiển quản lý > Amazon Cognito User pools hoặc aws cli. Lưu ý rằng id của user pool có thể được tham chiếu bằng cách truy cập CloudFormation > BedrockChatStack > Outputs > AuthUserPoolIdxxxx.

Cài đặt Xuất bản API

Sau khi đăng nhập với tư cách người dùng PublishedAllowed và tạo một bot, chọn API PublishSettings. Lưu ý rằng chỉ bot được chia sẻ mới có thể được xuất bản.

Trên màn hình tiếp theo, chúng ta có thể cấu hình một số tham số liên quan đến điều tiết. Để biết chi tiết, vui lòng xem thêm: Throttle API requests for better throughput.

Sau khi triển khai, màn hình sau sẽ xuất hiện, nơi bạn có thể lấy url endpoint và khóa api. Chúng ta cũng có thể thêm và xóa các khóa api.

Kiến trúc

API được xuất bản theo sơ đồ sau:

WAF được sử dụng để giới hạn địa chỉ IP. Địa chỉ có thể được cấu hình bằng cách thiết lập các tham số publishedApiAllowedIpV4AddressRanges và publishedApiAllowedIpV6AddressRanges trong cdk.json.

Khi người dùng nhấp vào xuất bản bot, AWS CodeBuild sẽ khởi chạy tác vụ triển khai CDK để cung cấp stack API (Xem thêm: Định nghĩa CDK) bao gồm API Gateway, Lambda và SQS. SQS được sử dụng để tách riêng yêu cầu người dùng và thao tác LLM vì việc tạo đầu ra có thể vượt quá 30 giây, là giới hạn của hạn ngạch API Gateway. Để lấy đầu ra, cần truy cập API một cách bất đồng bộ. Để biết thêm chi tiết, xem Đặc tả API.

Máy khách cần thiết lập x-api-key trong header của request.

Đặc tả API

Xem tại đây.