API Keys
Tạo, giới hạn phạm vi và quản lý khóa cho API.
Một khóa API xác thực các yêu cầu gửi tới Open API của Reverie. Khóa nằm ở Cài đặt → Thêm → API Keys, cũng chính là nơi ô Open API trong Labs dẫn tới. Tài khoản nào cũng tạo được — không đòi hỏi hạng nào và không giới hạn bạn giữ bao nhiêu khóa.
Tạo một khóa
Nhấn Tạo API Key mới
Khi trang còn trống, nút ghi là Tạo API Key đầu tiên của bạn.
Đặt tên cho nó
Tên là bắt buộc, từ 1 đến 100 ký tự. Đó là cách khóa được gắn nhãn trong danh sách và trong thống kê sử dụng — "Loa phòng khách", "staging worker".
Chọn toàn cục hay một nhân vật cụ thể
Chọn nhân vật là lựa chọn giữa Toàn cục (Tất cả nhân vật) và Nhân vật cụ thể, chứ không phải một phần thêm vào cho vui. Nhân vật cụ thể ấy sẽ trở thành nhân vật được ghim vào khóa.
Nếu muốn, đặt loại thiết bị và hạn dùng
Loại thiết bị là chữ tự do (speaker, phone, iot). Hết hạn cần cả ngày và giờ; đúng khoảnh khắc đó khóa tự ngừng hoạt động.
Khóa hiện ra ngay, dạng rk_ theo sau là 64 ký tự thập lục phân.
Khóa luôn xem lại được
Bí mật này không phải loại chỉ hiện một lần. Thẻ của mỗi khóa luôn có Hiện khóa API, Ẩn khóa API và Sao chép khóa API, bất cứ lúc nào, chừng nào khóa còn tồn tại.
Vì bí mật đầy đủ vẫn đọc được từ phần cài đặt của bạn, hãy coi quyền vào tài khoản là quyền vào khóa. Giữ khóa trên máy chủ hoặc trong một trình quản lý bí mật, đừng bao giờ để nó trong hệ quản lý mã nguồn hay trong mã chạy ở trình duyệt.
Khóa toàn cục và khóa đã ghim
| Toàn cục (Tất cả nhân vật) | Nhân vật cụ thể | |
|---|---|---|
GET /models trả về | Các nhân vật gần đây của bạn | Các kịch bản của nhân vật ấy, hoặc chính nhân vật nếu nó không có kịch bản nào |
Bỏ trống model | Rơi về cuộc trò chuyện gần nhất của bạn | Dùng nhân vật đã ghim |
| ID kịch bản ngắn | Không bao giờ tra ra | Tra ra trong phạm vi nhân vật đã ghim |
Tắt, xóa, thay khóa
| Hành động | Tác dụng | Hoàn tác được |
|---|---|---|
| Công tắc Hoạt động | Khi tắt, mọi yêu cầu dùng khóa đó đều bị từ chối | Có |
| Xóa | Khóa bị hủy và các ứng dụng đang dùng nó mất quyền truy cập | Không |
Không có thao tác thu hồi riêng — tắt và xóa là hai lựa chọn duy nhất.
Xóa một khóa là không thể hoàn tác, và nó mang theo cả phần ghi công của khóa ấy: lưu lượng cũ chuyển vào nhóm Khóa đã xóa trong thống kê sử dụng, nơi bạn không còn phân biệt được tích hợp nào đã tiêu những gì. Nếu có thể còn cần lịch sử, hãy tắt khóa trước đã.
Muốn thay khóa, hãy tạo khóa thay thế, triển khai nó, rồi mới tắt hoặc xóa khóa cũ. Không có việc thay tự động và cũng không có thời gian ân hạn sau khi hết hạn — khóa quá hạn bị từ chối với api_key_expired ngay ở yêu cầu kế tiếp.
Phạm vi
Khóa mang theo phạm vi, và hộp thoại tạo khóa không phơi chúng ra. Khóa bạn tạo trong Cài đặt gọi được các endpoint trò chuyện, và chỉ những cái đó.
Endpoint nhập nhân vật cần một phạm vi khác, và cách duy nhất để có một khóa như vậy là mở Labs → Kỹ năng Nhập Nhân vật, nó sẽ tạo cho bạn một khóa tên Reverie Character Importer (Skill). Gọi trình nhập bằng một khóa thường từ phần cài đặt sẽ nhận về 403. Nhập nhân vật →
Thống kê sử dụng
Bảng Thống kê sử dụng trên cùng trang đó báo Yêu cầu, Token, Tín dụng và Khóa đang hoạt động, gom theo ngày UTC, kèm phần chia nhỏ theo từng khóa dưới mục Sử dụng theo khóa. Lọc theo một khóa hoặc Tất cả khóa, trong khoảng từ 7 đến 90 ngày — mặc định là 30. Chỉ những cuộc trò chuyện tạo qua API mới được tính.
Bảng này là nơi duy nhất có mức chi theo từng khóa. Lịch sử tín dụng của bạn ghi mỗi tin nhắn tốn bao nhiêu, nhưng không ghi giao dịch đó do khóa nào thực hiện, nên hãy dùng thống kê ở đây để so sánh các tích hợp.
Tạo yêu cầu
Tạo yêu cầu mở một bộ sinh mã: chọn một trong các khóa đang hoạt động, chọn một nhân vật hoặc kịch bản từ danh sách mà khóa đó nhìn thấy, gõ một tin nhắn, chọn có truyền theo luồng không và temperature bao nhiêu, rồi sao chép cURL, TypeScript hay Python chạy được ngay.
Khóa chỉ được dùng trong trình duyệt của bạn để nạp danh sách nhân vật. Đoạn mã sinh ra đọc REVERIE_API_KEY từ môi trường chứ không nhúng bí mật vào trong.
Giới hạn
| Giới hạn | Giá trị |
|---|---|
| Số khóa mỗi tài khoản | Không giới hạn |
| Giới hạn tần suất theo khóa | Không có |
| Trần số yêu cầu đồng thời theo khóa | Không có |
| Thứ thật sự ràng buộc mức dùng | Số dư tín dụng của bạn, cùng cửa sổ mô hình miễn phí |
Liên quan
- Open API — endpoint, hình dạng yêu cầu và lỗi
- Nhập nhân vật — khóa dành cho trình nhập dùng để làm gì
- Reverie Labs — ô Open API và ô nhập nhân vật
- Bảo mật — phần còn lại trong thiết lập truy cập của tài khoản bạn