# Tổng quan

Tài liệu tham khảo này mô tả các phương thức web RESTful để tương tác với Tisane API bằng cách sử dụng giao tiếp chuẩn dựa trên HTTP và JSON.

Version: 4.8.0.0

## Servers

Đám mây công cộng của Tisane
```
https://api.tisane.ai
```

## Security

### Tisane-API-Key

Khóa đăng ký API (chính hoặc phụ) từ [Cổng thông tin dành cho nhà phát triển Tisane](https://dev.tisane.ai/profile)

Type: apiKey
In: header
Name: Ocp-Apim-Subscription-Key

## Download OpenAPI description

[Tổng quan](https://docs.tisane.ai/_bundle/@l10n/vi/apis/tisane-api-short.yaml)

## NLU / NLP Methods

Đây là những phương pháp thực sự thực hiện phân tích và chuyển đổi văn bản đầu vào.

### Phân tích văn bản

 - [POST /parse](https://docs.tisane.ai/vi/apis/tisane-api-short/nlu-nlp-methods/parse.md): Phương pháp này phân tích dữ liệu đầu vào và phát hiện nội dung có vấn đề, đoạn văn bản thể hiện cảm xúc, thực thể, chủ đề, cấu trúc cụm từ, các loại từ, từ dừng, v.v.

### Liệt kê tất cả các ngôn ngữ có sẵn

 - [GET /languages](https://docs.tisane.ai/vi/apis/tisane-api-short/nlu-nlp-methods/languages.md): Truy xuất danh sách các ngôn ngữ được hỗ trợ.

Phản hồi bao gồm các thuộc tính sau:
* id - ID ngôn ngữ.
* name - Tên bản ngữ.
* englishName - Tên tiếng Anh.
* nativeEncoding - Mã hóa ngôn ngữ.
* preferredFont - Phông chữ hiển thị được đề xuất.
* latin - Ngôn ngữ có sử dụng chữ Latin hay không.
* rightToLeft - Ngôn ngữ có sử dụng chữ viết từ phải sang trái không (ví dụ: tiếng Ả Rập, tiếng Do Thái, tiếng Ba Tư).

### Dọn dẹp văn bản

 - [POST /helper/extract_text](https://docs.tisane.ai/vi/apis/tisane-api-short/nlu-nlp-methods/extract_text.md): Một phương pháp dịch vụ để loại bỏ JavaScript, thẻ CSS, JSON và các đánh dấu khác, trả về văn bản đã giải mã thuần túy.
Nội dung yêu cầu bao gồm nội dung đánh dấu mà văn bản sẽ được trích xuất.

Lưu ý: Phương pháp này không xử lý nội dung nhị phân.

### So sánh thực thể được đặt tên

 - [POST /compare/entities](https://docs.tisane.ai/vi/apis/tisane-api-short/nlu-nlp-methods/compareentities.md): So sánh hai thực thể có tên ghép và xác định các điểm khác biệt.
Nội dung yêu cầu phải bao gồm:
* language1 (chuỗi) - Thẻ IETF cho ngôn ngữ của thực thể đầu tiên.
* entity1 (string) - Thực thể đầu tiên.
* language2 (string) - Thẻ IETF cho ngôn ngữ của thực thể thứ hai.
* entity2 (string) - Thực thể thứ hai.
* type (string) - Loại thực thể (_person_).

Xem thêm thông tin: Các thực thể được đặt tên trong Hướng dẫn phản hồi API Tisane
Phản hồi chứa:
* result (string) - Kết quả so sánh:
* no_single_entity - Một hoặc cả hai thực thể đều không hợp lệ.
* same - Các thực thể giống hệt nhau (thứ tự tên có thể khác nhau).
* different - Các thực thể khác nhau, chi tiết được nêu trong differences.
* differences (mảng chuỗi) - Liệt kê các điểm khác biệt được phát hiện:

  * given_name
  
  * surname
  
  * title (Ví dụ: Ông, Bà)
  
  * social_role (ví dụ: bằng cấp học thuật)
  
  * suffix
  
  * variation (ví dụ: sự khác biệt về chính tả hoặc phong cách)

### Sự tương đồng về mặt ngữ nghĩa

 - [POST /similarity](https://docs.tisane.ai/vi/apis/tisane-api-short/nlu-nlp-methods/similarity.md): Tính toán mức độ tương đồng về mặt ngữ nghĩa giữa hai đoạn văn bản, trong cùng một ngôn ngữ hoặc trong các ngôn ngữ khác nhau.

Nội dung yêu cầu phải chứa:
* content1 (chuỗi) - Đoạn văn bản đầu tiên.
* language1 (chuỗi) - Mã ngôn ngữ IETF cho content1.
* content2 (chuỗi) - Đoạn văn bản thứ hai cần so sánh.
* language2 (chuỗi) - Mã ngôn ngữ IETF cho content2.
* settings (đối tượng) - Các thiết lập bổ sung theo thông số kỹ thuật. Xem thêm thông tin: Hướng dẫn cấu hình và tùy chỉnh API Tisane.
Phản hồi là một số nằm trong khoảng từ 0 đến 1, biểu thị mức độ giống nhau của các đoạn văn bản đã gửi.

### Phát hiện ngôn ngữ

 - [POST /detectLanguage](https://docs.tisane.ai/vi/apis/tisane-api-short/nlu-nlp-methods/detectlanguage.md): Phát hiện các ngôn ngữ được sử dụng trong đoạn văn bản được cung cấp và trả về phân tích chi tiết theo độ lệch.

Nội dung yêu cầu phải bao gồm:
* content (chuỗi) - đoạn văn bản cần phân tích.
* languages (chuỗi, tùy chọn) - danh sách mã ngôn ngữ được phân cách bằng dấu gạch đứng để sử dụng làm dấu hiệu.
* delimiter (chuỗi, tùy chọn) - một biểu thức chính quy để phân đoạn đoạn văn bản; theo mặc định, đoạn văn bản không được phân đoạn.
Phản hồi là cấu trúc JSON chứa languages, cung cấp thông tin phân tích về mã ngôn ngữ.

### Dịch văn bản

 - [POST /transform](https://docs.tisane.ai/vi/apis/tisane-api-short/nlu-nlp-methods/transform.md): Phương pháp này dịch văn bản đầu vào.
Nội dung yêu cầu phải bao gồm các phần tử sau:
 from (chuỗi) - Thẻ IETF chuẩn cho ngôn ngữ nguồn. Sử dụng  hoặc một bộ mã ngôn ngữ được phân cách bằng dấu gạch đứng để gọi chức năng tự động phát hiện.
* to (chuỗi) - Thẻ IETF chuẩn cho ngôn ngữ đích. Nếu ngôn ngữ nguồn và ngôn ngữ đích giống nhau, sẽ áp dụng cách diễn đạt lại.
* content (chuỗi) - Nội dung văn bản cần dịch.
* settings (đối tượng) - Cài đặt bản dịch bổ sung.

Xem thêm thông tin: Hướng dẫn cấu hình và tùy chỉnh API Tisane
Phản hồi là văn bản đã được chuyển đổi.

## Language Model Direct Access

Các phương pháp để truy xuất và kiểm tra các mục nhập từ mô hình ngôn ngữ.

### Liệt kê các dạng biến cách

 - [GET /lm/inflections](https://docs.tisane.ai/vi/apis/tisane-api-short/language-model-direct-access/inflections.md): Truy xuất các dạng biến cách của một trị từ vựng cụ thể trong một họ ngôn ngữ nhất định.