Phát triển với API

ChatX cung cấp một API "Backend-as-a-Service", mang lại nhiều lợi ích đến các nhà phát triển ứng dụng AI. Phương pháp này cho phép các nhà phát triển truy cập vào các khả năng mạnh mẽ của các mô hình ngôn ngữ lớn (LLMs) trực tiếp trong các ứng dụng frontend mà không cần phải đối mặt với sự phức tạp của kiến trúc backend và quy trình triển khai.

Các lợi ích của việc sử dụng API ChatX:

• Cho phép ứng dụng frontend truy cập an toàn vào các khả năng của LLM mà không cần phát triển backend.

• Thiết kế ứng dụng một cách trực quan với cập nhật thời gian thực trên tất cả các client.

• API gốc của LLM được bao gồm một cách rõ ràng và rành mạch.

• Dễ dàng chuyển đổi giữa các nhà cung cấp LLM và quản lý tập trung các khóa API.

• Vận hành các ứng dụng một cách trực quan, bao gồm phân tích log, chú thích và quan sát hoạt động của người dùng.

• Liên tục cung cấp nhiều công cụ, plugin và kiến thức hơn.

Cách sử dụng:

Chọn một ứng dụng và tìm API Access trong điều hướng bên trái của phần Ứng dụng. Trên trang này, bạn có thể xem tài liệu API được cung cấp bởi ChatX và quản lý thông tin xác thực để truy cập vào API.

Tài liệu API

Bạn có thể tạo nhiều thông tin xác thực truy cập cho một ứng dụng để cung cấp cho các người dùng hoặc nhà phát triển khác nhau. Điều này có nghĩa là người dùng API có thể sử dụng các khả năng AI do nhà phát triển ứng dụng cung cấp, nhưng các thiết lập Prompt, kiến thức và công cụ cơ bản được đóng gói.

Trong các phương pháp tốt nhất, các khóa API nên được gọi thông qua backend, thay vì được hiển thị trực tiếp dưới dạng văn bản thô trong mã frontend hoặc các yêu cầu. Điều này giúp ngăn chặn ứng dụng của bạn bị lạm dụng hoặc tấn công.

Ví dụ, nếu bạn là một nhà phát triển trong một công ty tư vấn, bạn có thể cung cấp các khả năng AI dựa trên cơ sở dữ liệu riêng của công ty cho người dùng hoặc nhà phát triển cuối mà không cần phải tiết lộ dữ liệu và thiết kế logic AI của mình. Điều này đảm bảo một dịch vụ cung cấp an toàn và bền vững đáp ứng các mục tiêu kinh doanh.

Ứng dụng máy tạo văn bản:

Các ứng dụng này được sử dụng để tạo ra văn bản chất lượng cao, như bài viết, tóm tắt, bản dịch, vv., bằng cách gọi API completion-messages và gửi đầu vào của người dùng để nhận kết quả văn bản được tạo ra. Các tham số mô hình và mẫu prompt được sử dụng để tạo văn bản phụ thuộc vào cài đặt của nhà phát triển trong trang ChatX Prompt Arrangement.

Bạn có thể tìm thấy tài liệu API và các yêu cầu mẫu cho ứng dụng này trong Ứng dụng -> Truy cập API.

Ví dụ, đây là một cuộc gọi mẫu cho API tạo văn bản:

cURL

curl --location --request POST 'https://api.dify.ai/v1/completion-messages' \
--header 'Authorization: Bearer ENTER-YOUR-SECRET-KEY' \
--header 'Content-Type: application/json' \
--data-raw '{
    "inputs": {},
    "response_mode": "streaming",
    "user": "abc-123"
}'

Python

import requests
import json

url = "https://api.dify.ai/v1/completion-messages"

headers = {
    'Authorization': 'Bearer ENTER-YOUR-SECRET-KEY',
    'Content-Type': 'application/json',
}

data = {
    "inputs": {"text": 'Hello, how are you?'},
    "response_mode": "streaming",
    "user": "abc-123"
}

response = requests.post(url, headers=headers, data=json.dumps(data))

print(response.text)

Ứng dụng trò chuyện:

Phù hợp cho hầu hết các kịch bản, các ứng dụng trò chuyện tham gia vào cuộc trò chuyện liên tục với người dùng theo định dạng câu hỏi và trả lời. Để bắt đầu một cuộc trò chuyện, gọi API chat-messages và duy trì phiên bằng cách liên tục truyền vào conversation_id đã trả về.

Bạn có thể tìm thấy tài liệu API và các yêu cầu mẫu cho ứng dụng này trong Ứng dụng -> Truy cập API.

Ví dụ, đây là một cuộc gọi mẫu cho API trò chuyện:

cURL

curl --location --request POST 'https://api.dify.ai/v1/chat-messages' \
--header 'Authorization: Bearer ENTER-YOUR-SECRET-KEY' \
--header 'Content-Type: application/json' \
--data-raw '{
    "inputs": {},
    "query": "eh",
    "response_mode": "streaming",
    "conversation_id": "1c7e55fb-1ba2-4e10-81b5-30addcea2276"
    "user": "abc-123"
}'

Python

import requests
import json

url = 'https://api.dify.ai/v1/chat-messages'
headers = {
    'Authorization': 'Bearer ENTER-YOUR-SECRET-KEY',
    'Content-Type': 'application/json',
}
data = {
    "inputs": {},
    "query": "eh",
    "response_mode": "streaming",
    "conversation_id": "1c7e55fb-1ba2-4e10-81b5-30addcea2276",
    "user": "abc-123"
}

response = requests.post(url, headers=headers, data=json.dumps(data))

print(response.json())