Text Moderation - Screen Text

Odwołanie

Usługa:: Azure AI Services

Wersja interfejsu API:: 1.0

Wykrywanie wulgaryzmów i dopasowywanie do niestandardowych i udostępnionych list blokowych
Wykrywa wulgaryzmy w ponad 100 językach i pasuje do niestandardowych i udostępnionych list zablokowanych.

POST {Endpoint}/contentmoderator/moderate/v1.0/ProcessText/Screen/

Z parametrami opcjonalnymi:

POST {Endpoint}/contentmoderator/moderate/v1.0/ProcessText/Screen/?language={language}&autocorrect={autocorrect}&PII={PII}&listId={listId}&classify={classify}

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
Endpoint	path	True	string	Obsługiwane punkty końcowe usług Azure Cognitive Services (nazwa protokołu i hosta, takie jak https://westus.api.cognitive.microsoft.com).
autocorrect	query		boolean	Tekst autokorekty.
classify	query		boolean	Klasyfikowanie danych wejściowych.
language	query		string	Język tekstu.
listId	query		string	Identyfikator listy.
PII	query		boolean	Wykrywanie danych osobowych.

Nagłówek żądania

Media Types: "text/plain", "text/html", "text/xml", "text/markdown"

Nazwa	Wymagane	Typ	Opis
Ocp-Apim-Subscription-Key	True	string
Content-Type	True	string	Typ zawartości.

Treść żądania

Media Types: "text/plain", "text/html", "text/xml", "text/markdown"

Nazwa	Typ	Opis
Text Content	object (file)	Zawartość do ekranu.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	Screen	Stan 200.
Other Status Codes	APIError	Odpowiedź na błąd.

Zabezpieczenia

Ocp-Apim-Subscription-Key

Typ: apiKey
W: header

Przykłady

Detect Language request

Przykładowe żądanie

HTTP

POST {Endpoint}/contentmoderator/moderate/v1.0/ProcessText/Screen/?language=eng&autocorrect=False&PII=False&listId=&classify=False



"Is this a crap email abcdef@abcd.com, phone: 6657789887, IP: 255.255.255.255, 1 Microsoft Way, Redmond, WA 98052"

Przykładowa odpowiedź

Kod stanu:: 200

{
  "OriginalText": "Is this a crap email abcdef@abcd.com, phone: 6657789887, IP: 255.255.255.255, 1 Microsoft Way, Redmond, WA 98052",
  "NormalizedText": "Is this a crap email abcdef@ abcd. com, phone: 6657789887, IP: 255. 255. 255. 255, 1 Microsoft Way, Redmond, WA 98052",
  "Misrepresentation": [],
  "Language": "eng",
  "PII": {
    "Email": [
      {
        "Detected": "abcdef@abcd.com",
        "SubType": "Regular",
        "Text": "abcdef@abcd.com",
        "Index": 21
      }
    ],
    "IPA": [
      {
        "SubType": "IPV4",
        "Text": "255.255.255.255",
        "Index": 61
      }
    ],
    "Phone": [
      {
        "CountryCode": "US",
        "Text": "6657789887",
        "Index": 45
      }
    ],
    "Address": [
      {
        "Text": "1 Microsoft Way, Redmond, WA 98052",
        "Index": 78
      }
    ],
    "SSN": [
      {
        "Text": "665778988",
        "Index": 45
      }
    ]
  },
  "Classification": {
    "ReviewRecommended": true,
    "Category1": {
      "Score": 0.00040505084325559437
    },
    "Category2": {
      "Score": 0.2234508991241455
    },
    "Category3": {
      "Score": 0.9879999756813049
    }
  },
  "Terms": [
    {
      "Index": 10,
      "OriginalIndex": 10,
      "ListId": 0,
      "Term": "crap"
    }
  ],
  "Status": {
    "Code": 3000,
    "Description": "OK",
    "Exception": ""
  },
  "TrackingId": "9fdfef70-6ed8-4a88-99a0-5b6d0b8d7108"
}

Definicje

Nazwa	Opis
Address	Szczegóły adresu.
APIError	Informacje o błędzie zwracane przez interfejs API.
Category1	Szczegóły wyniku kategorii1 tekstu. Aby uzyskać więcej informacji na temat klasyfikacji kategorii, zobacz tym artykule.
Category2	Szczegóły wyniku kategorii2 tekstu. Aby uzyskać więcej informacji na temat klasyfikacji kategorii, zobacz tym artykule.
Category3	Szczegóły wyniku kategorii 3 tekstu. Aby uzyskać więcej informacji na temat klasyfikacji kategorii, zobacz tym artykule.
Classification	Szczegóły klasyfikacji tekstu.
DetectedTerms	Wykryto szczegóły terminu.
Email	Szczegóły adresu e-mail.
Error	Treść błędu.
IPA	Szczegóły adresu IP.
Phone	Szczegóły właściwości telefonu.
PII	Szczegółowe informacje o danych osobowych.
Screen	Odpowiedź na żądanie tekstowe ekranu.
SSN	Szczegółowe informacje o wykrytym numerze ubezpieczenia społecznego.
Status	Właściwości stanu.

Address

Objekt

Szczegóły adresu.

Nazwa	Typ	Opis
Index	integer	Indeks (lokalizacja) adresu w zawartości tekstu wejściowego.
Text	string	Wykryty adres.

APIError

Objekt

Informacje o błędzie zwracane przez interfejs API.

Nazwa	Typ	Opis
Error	Error	Treść błędu.

Category1

Objekt

Szczegóły wyniku kategorii1 tekstu. Aby uzyskać więcej informacji na temat klasyfikacji kategorii, zobacz tym artykule.

Nazwa	Typ	Opis
Score	number	Wynik kategorii1.

Category2

Objekt

Szczegóły wyniku kategorii2 tekstu. Aby uzyskać więcej informacji na temat klasyfikacji kategorii, zobacz tym artykule.

Nazwa	Typ	Opis
Score	number	Wynik kategorii2.

Category3

Objekt

Szczegóły wyniku kategorii 3 tekstu. Aby uzyskać więcej informacji na temat klasyfikacji kategorii, zobacz tym artykule.

Nazwa	Typ	Opis
Score	number	Wynik kategorii3.

Classification

Objekt

Szczegóły klasyfikacji tekstu.

Nazwa	Typ	Opis
Category1	Category1	Szczegóły wyniku kategorii1 tekstu. Aby uzyskać więcej informacji na temat klasyfikacji kategorii, zobacz tym artykule.
Category2	Category2	Szczegóły wyniku kategorii2 tekstu. Aby uzyskać więcej informacji na temat klasyfikacji kategorii, zobacz tym artykule.
Category3	Category3	Szczegóły wyniku kategorii 3 tekstu. Aby uzyskać więcej informacji na temat klasyfikacji kategorii, zobacz tym artykule.
ReviewRecommended	boolean	Flaga zalecana do przeglądu.

DetectedTerms

Objekt

Wykryto szczegóły terminu.

Nazwa	Typ	Opis
Index	integer	Indeks (lokalizacja) wykrytego terminu wulgaryzmów w zawartości tekstu wejściowego.
ListId	integer	Dopasowany identyfikator na liście terminów.
OriginalIndex	integer	Oryginalny indeks (lokalizacja) wykrytego terminu wulgaryzmów w zawartości tekstu wejściowego.
Term	string	Wykryto termin wulgaryzmów.

Email

Objekt

Szczegóły adresu e-mail.

Nazwa	Typ	Opis
Detected	string	Wykryto adres e-mail z zawartości tekstu wejściowego.
Index	integer	Indeks (lokalizacja) adresu e-mail w wejściowej zawartości tekstowej.
SubType	string	Podtyp wykrytego adresu e-mail.
Text	string	Adres e-mail w wejściowej zawartości tekstowej.

Error

Objekt

Treść błędu.

Nazwa	Typ	Opis
Code	string
Message	string

IPA

Objekt

Szczegóły adresu IP.

Nazwa	Typ	Opis
Index	integer	Indeks (lokalizacja) adresu IP w zawartości tekstu wejściowego.
SubType	string	Podtyp wykrytego adresu IP.
Text	string	Wykryty adres IP.

Phone

Objekt

Szczegóły właściwości telefonu.

Nazwa	Typ	Opis
CountryCode	string	Kod kraju/regionu wykrytego numeru telefonu.
Index	integer	Indeks (lokalizacja) numeru telefonu w wejściowej zawartości tekstowej.
Text	string	Wykryty numer telefonu.

PII

Objekt

Szczegółowe informacje o danych osobowych.

Nazwa	Typ	Opis
Address	Address[]	Szczegóły adresu.
Email	Email[]	Szczegóły adresu e-mail.
IPA	IPA[]	Szczegóły adresu IP.
Phone	Phone[]	Szczegóły właściwości telefonu.
SSN	SSN[]	Szczegółowe informacje o wykrytym numerze ubezpieczenia społecznego.

Screen

Objekt

Odpowiedź na żądanie tekstowe ekranu.

Nazwa	Typ	Opis
AutoCorrectedText	string	Tekst autokorekty.
Classification	Classification	Szczegóły klasyfikacji tekstu.
Language	string	Język zawartości tekstu wejściowego.
Misrepresentation	string[]	Tekst wprowadzenia w błąd.
NormalizedText	string	Znormalizowany tekst.
OriginalText	string	Oryginalny tekst.
PII	PII	Szczegółowe informacje o danych osobowych.
Status	Status	Stan oceny.
Terms	DetectedTerms[]	Wykryto szczegóły terminu.
TrackingId	string	Unikatowy identyfikator transakcji usługi Content Moderator.

SSN

Objekt

Szczegółowe informacje o wykrytym numerze ubezpieczenia społecznego.

Nazwa	Typ	Opis
Index	integer	Indeks (lokalizacja) numeru ubezpieczenia społecznego w zawartości tekstowej wejściowej.
Text	string	Wykryto numer ubezpieczenia społecznego w zawartości tekstu wejściowego.

Status

Objekt

Właściwości stanu.

Nazwa	Typ	Opis
Code	integer	Kod stanu.
Description	string	Opis stanu.
Exception	string	Stan wyjątku.

Udostępnij za pośrednictwem

Text Moderation - Screen Text

Parametry identyfikatora URI

Nagłówek żądania

Treść żądania

Odpowiedzi

Zabezpieczenia

Ocp-Apim-Subscription-Key

Przykłady

Detect Language request

Przykładowe żądanie

Przykładowa odpowiedź

Definicje

Address

APIError

Category1

Category2

Category3

Classification

DetectedTerms

Email

Error

IPA

Phone

PII

Screen

SSN

Status