Đặc tả API
Tài liệu tham khảo để tích hợp các quy trình làm việc về văn bản, tác nhân, nội dung đa phương tiện và truy xuất thông tin.
https://cicora.ai/api/v1https://cicora.ai/apiTài liệu tham khảo tích hợp: chọn tham số và năng lực khả dụng từ cài đặt API tài khoản và danh mục mô hình cho môi trường của bạn.
Gửi yêu cầu đầu tiênBắt đầu
Gửi yêu cầu đầu tiên, chọn mô hình từ danh mục và giữ mã định danh yêu cầu để chẩn đoán.
Xác thựcGửi khóa API trong tiêu đề Bearer và tách thông tin xác thực sản xuất khỏi thông tin xác thực phát triển.
SDK và ứng dụng khách HTTPDùng URL cơ sở khác nhau cho ứng dụng khách kiểu OpenAI và Messages: chúng nhắm đến một đặc tả nhưng ghép đường dẫn khác nhau.
CLI và tích hợpCấu hình ứng dụng khách bằng khóa, mô hình và URL cơ sở khớp với giao thức; giữ bí mật trong môi trường.
Câu hỏi thường gặp cho nhà phát triểnCâu trả lời thực tế, ngắn gọn về khóa, URL cơ sở, mô hình, chi phí và chẩn đoán tích hợp.
Tài khoản và danh mục
Xây dựng phần lựa chọn mô hình từ dữ liệu danh mục thay vì danh sách viết cứng trong mã ứng dụng của bạn.
Nhóm và khóa APITách khóa, chủ sở hữu, ngân sách và dấu vết sử dụng giữa các ứng dụng và không gian làm việc.
Giới hạnXem các giới hạn theo khóa, tổ chức, mô hình và định tuyến là một phần của quy trình người dùng.
Mức sử dụng và chi phíLiên kết siêu dữ liệu phản hồi và nhật ký yêu cầu của bạn với hành động thực tế của người dùng.
Dữ liệu và quyền riêng tưGiảm thiểu dữ liệu truyền đi, tách mã định danh người dùng cuối khỏi nội dung và kiểm soát việc lưu giữ trong sản phẩm.
Văn bản và tác nhân
Tạo hội thoại nhiều lượt theo định dạng messages quen thuộc và chọn mô hình cho từng yêu cầu.
Messages APIDùng định dạng Messages cho hội thoại có hướng dẫn hệ thống ở cấp cao nhất và giới hạn đầu ra rõ ràng.
Responses APIDùng một đối tượng đầu vào khi ứng dụng của bạn hưởng lợi từ việc xử lý mục đầu ra và hành động trong một mô hình dữ liệu duy nhất.
Phát trực tiếpNhận token và các phần thay đổi có cấu trúc qua SSE mà không phải chờ phản hồi hoàn chỉnh.
Công cụ và gọi hàmMô tả hàm bằng JSON Schema, thực thi lệnh gọi trong ứng dụng và trả kết quả về cuộc hội thoại.
Đầu ra có cấu trúcYêu cầu đối tượng JSON hoặc JSON Schema khi phần mềm, thay vì con người, sẽ sử dụng phản hồi.
Suy luậnChỉ đặt mức nỗ lực suy luận cho từng yêu cầu đối với mô hình có khai báo năng lực này.
Định tuyếnThể hiện yêu cầu thực thi trong tùy chọn nhà cung cấp và lưu kết quả thực tế để quan sát.
Lưu bộ nhớ đệm ngữ cảnhTách ngữ cảnh lặp lại để ứng dụng khách có thể dùng bộ nhớ đệm tương thích khi mô hình đã chọn hỗ trợ.
Tìm kiếm webTruy xuất nguồn mới bằng hàm `web_search` do ứng dụng khách thực thi và lưu liên kết riêng với văn bản được tạo.
Nội dung đa phương tiện và truy xuất
Tải tệp lên qua thao tác riêng, lưu ID của tệp và truyền tham chiếu trong yêu cầu tương thích sau đó.
Hình ảnhTạo hình ảnh qua một tuyến và chọn tham số từ năng lực của mô hình đã chọn.
VideoBắt đầu tạo video dưới dạng tác vụ bất đồng bộ, lưu ID tác vụ và tách việc tạo khỏi việc đọc kết quả.
Âm thanhDùng các thao tác riêng cho tổng hợp giọng nói, phiên âm và đầu vào âm thanh vào mô hình.
Nhúng vectorChuyển văn bản hoặc đầu vào được hỗ trợ thành vector để tìm kiếm, phân cụm và đề xuất.
Xếp hạng lạiSắp xếp lại một tập ứng viên nhỏ theo truy vấn để cải thiện độ chính xác của kết quả truy xuất cuối.
Thực thi hàng loạtXử lý các thao tác độc lập theo nhóm được kiểm soát khi quy trình cho phép phân phối bất đồng bộ.