Text Operations - Detect Text Protected Material

Layanan:

Azure AI Services

Versi API:

2024-09-01

Mendeteksi Bahan yang Dilindungi untuk Teks
API sinkron untuk mendeteksi materi yang dilindungi dalam teks tertentu.

POST {endpoint}/contentsafety/text:detectProtectedMaterial?api-version=2024-09-01

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
endpoint	path	True	string	Titik akhir Cognitive Services yang didukung (protokol dan nama host, misalnya: https://.cognitiveservices.azure.com).
api-version	query	True	string	Versi API yang akan digunakan untuk operasi ini.

Isi Permintaan

Nama	Diperlukan	Jenis	Deskripsi
text	True	string	Teks yang akan dianalisis, yang mungkin berisi bahan yang dilindungi. Karakter akan dihitung dalam poin kode Unicode.

Respons

Nama	Jenis	Deskripsi
200 OK	DetectTextProtectedMaterialResult	Permintaan telah berhasil.
Other Status Codes	Azure.Core.Foundations.ErrorResponse	Respons kesalahan tak terduga. Header x-ms-error-code: string

Keamanan

Ocp-Apim-Subscription-Key

Jenis: apiKey
Dalam: header

OAuth2Auth

Jenis: oauth2
Alur: application
URL token: https://login.microsoftonline.com/common/oauth2/v2.0/token

Cakupan

Nama	Deskripsi
https://cognitiveservices.azure.com/.default

Contoh

Detect Protected Material for Text

Permintaan sampel

HTTP

POST {endpoint}/contentsafety/text:detectProtectedMaterial?api-version=2024-09-01

{
  "text": "to everyone, the best things in life are free. the stars belong to everyone, they gleam there for you and me. the flowers in spring, the robins that sing, the sunbeams that shine"
}

Respon sampel

Kode status:

200

{
  "protectedMaterialAnalysis": {
    "detected": true
  }
}

Definisi

Nama	Deskripsi
Azure.Core.Foundations.Error	Objek kesalahan.
Azure.Core.Foundations.ErrorResponse	Respons yang berisi detail kesalahan.
Azure.Core.Foundations.InnerError	Objek yang berisi informasi yang lebih spesifik tentang kesalahan. Sesuai panduan Microsoft One API - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
DetectTextProtectedMaterialOptions	Permintaan mendeteksi potensi bahan yang dilindungi yang ada dalam teks yang diberikan.
DetectTextProtectedMaterialResult	Hasil deteksi gabungan dari potensi bahan yang dilindungi.
TextProtectedMaterialAnalysisResult	Hasil deteksi individu dari potensi bahan yang dilindungi.

Azure.Core.Foundations.Error

Objek kesalahan.

Nama	Jenis	Deskripsi
code	string	Salah satu sekumpulan kode kesalahan yang ditentukan server.
details	Azure.Core.Foundations.Error[]	Array detail tentang kesalahan tertentu yang menyebabkan kesalahan yang dilaporkan ini.
innererror	Azure.Core.Foundations.InnerError	Objek yang berisi informasi yang lebih spesifik daripada objek saat ini tentang kesalahan.
message	string	Representasi kesalahan yang dapat dibaca manusia.
target	string	Target kesalahan.

Azure.Core.Foundations.ErrorResponse

Respons yang berisi detail kesalahan.

Nama	Jenis	Deskripsi
error	Azure.Core.Foundations.Error	Objek kesalahan.

Azure.Core.Foundations.InnerError

Objek yang berisi informasi yang lebih spesifik tentang kesalahan. Sesuai panduan Microsoft One API - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Nama	Jenis	Deskripsi
code	string	Salah satu sekumpulan kode kesalahan yang ditentukan server.
innererror	Azure.Core.Foundations.InnerError	Kesalahan dalam.

DetectTextProtectedMaterialOptions

Permintaan mendeteksi potensi bahan yang dilindungi yang ada dalam teks yang diberikan.

Nama	Jenis	Deskripsi
text	string	Teks yang akan dianalisis, yang mungkin berisi bahan yang dilindungi. Karakter akan dihitung dalam poin kode Unicode.

DetectTextProtectedMaterialResult

Hasil deteksi gabungan dari potensi bahan yang dilindungi.

Nama	Jenis	Deskripsi
protectedMaterialAnalysis	TextProtectedMaterialAnalysisResult	Hasil analisis untuk teks yang diberikan.

TextProtectedMaterialAnalysisResult

Hasil deteksi individu dari potensi bahan yang dilindungi.

Nama	Jenis	Deskripsi
detected	boolean	Apakah potensi bahan yang dilindungi terdeteksi atau tidak.