Text Operations - Analyze Text

Odwołanie

Usługa:: Azure AI Services

Wersja interfejsu API:: 2023-10-01

Analizowanie tekstu
Synchroniczny interfejs API do analizy potencjalnie szkodliwej zawartości tekstowej. Obecnie obsługuje cztery kategorie: Nienawiść, SelfHarm, Seks i Przemoc.

POST {endpoint}/contentsafety/text:analyze?api-version=2023-10-01

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
endpoint	path	True	string	Obsługiwane punkty końcowe usług Cognitive Services (protokół i nazwa hosta, na przykład: https://.cognitiveservices.azure.com).
api-version	query	True	string	Wersja interfejsu API do użycia dla tej operacji.

Treść żądania

Nazwa	Wymagane	Typ	Opis
text	True	string	Tekst do przeanalizowania. W tekście jednego żądania obsługujemy maksymalnie 10 000 znaków Unicode (punkty kodu Unicode).
blocklistNames		string[]	Nazwy list zablokowanych.
categories		TextCategory[]	Kategorie zostaną przeanalizowane. Jeśli nie zostaną przypisane, zostanie zwrócony domyślny zestaw wyników analizy dla kategorii.
haltOnBlocklistHit		boolean	W przypadku ustawienia wartości true dalsze analizy szkodliwej zawartości nie będą wykonywane w przypadkach trafienia listy zablokowanych. Po ustawieniu wartości false zostaną wykonane wszystkie analizy szkodliwej zawartości, niezależnie od tego, czy trafią listy zablokowanych.
outputType		AnalyzeTextOutputType	Odnosi się to do typu danych wyjściowych analizy tekstu. Jeśli żadna wartość nie zostanie przypisana, wartość domyślna będzie mieć wartość "FourSeverityLevels".

Odpowiedzi

Nazwa	Typ	Opis
200 OK	AnalyzeTextResult	Żądanie zakończyło się pomyślnie.
Other Status Codes	Azure.Core.Foundations.ErrorResponse	Nieoczekiwana odpowiedź na błąd. Nagłówki x-ms-error-code: string

Nazwa

Typ

Opis

200 OK

AnalyzeTextResult

Żądanie zakończyło się pomyślnie.

Other Status Codes

Azure.Core.Foundations.ErrorResponse

Nieoczekiwana odpowiedź na błąd.

Nagłówki

x-ms-error-code: string

Zabezpieczenia

Ocp-Apim-Subscription-Key

Typ: apiKey
W: header

OAuth2Auth

Typ: oauth2
Flow: application
Adres URL tokenu: https://login.microsoftonline.com/common/oauth2/v2.0/token

Zakresy

Nazwa	Opis
https://cognitiveservices.azure.com/.default

Przykłady

Analyze Text

Przykładowe żądanie

HTTP

POST {endpoint}/contentsafety/text:analyze?api-version=2023-10-01

{
  "text": "This is text example"
}

Przykładowa odpowiedź

Kod stanu:: 200

{
  "blocklistsMatch": [],
  "categoriesAnalysis": [
    {
      "category": "Hate",
      "severity": 0
    },
    {
      "category": "SelfHarm",
      "severity": 0
    },
    {
      "category": "Sexual",
      "severity": 0
    },
    {
      "category": "Violence",
      "severity": 0
    }
  ]
}

Definicje

Nazwa	Opis
AnalyzeTextOptions	Żądanie analizy tekstu.
AnalyzeTextOutputType	Odnosi się to do typu danych wyjściowych analizy tekstu. Jeśli żadna wartość nie zostanie przypisana, wartość domyślna będzie mieć wartość "FourSeverityLevels".
AnalyzeTextResult	Odpowiedź analizy tekstu.
Azure.Core.Foundations.Error	Obiekt błędu.
Azure.Core.Foundations.ErrorResponse	Odpowiedź zawierająca szczegóły błędu.
Azure.Core.Foundations.InnerError	Obiekt zawierający bardziej szczegółowe informacje o błędzie. Zgodnie z wytycznymi dotyczącymi interfejsu MICROSOFT One API — https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
TextBlocklistMatch	Wynik dopasowania listy zablokowanych.
TextCategoriesAnalysis	Wynik analizy tekstu.
TextCategory	Kategoria szkody obsługiwana w analizie zawartości tekstowej.

AnalyzeTextOptions

Żądanie analizy tekstu.

Nazwa	Typ	Domyślna wartość	Opis
blocklistNames	string[]		Nazwy list zablokowanych.
categories	TextCategory[]		Kategorie zostaną przeanalizowane. Jeśli nie zostaną przypisane, zostanie zwrócony domyślny zestaw wyników analizy dla kategorii.
haltOnBlocklistHit	boolean		W przypadku ustawienia wartości true dalsze analizy szkodliwej zawartości nie będą wykonywane w przypadkach trafienia listy zablokowanych. Po ustawieniu wartości false zostaną wykonane wszystkie analizy szkodliwej zawartości, niezależnie od tego, czy trafią listy zablokowanych.
outputType	AnalyzeTextOutputType	FourSeverityLevels	Odnosi się to do typu danych wyjściowych analizy tekstu. Jeśli żadna wartość nie zostanie przypisana, wartość domyślna będzie mieć wartość "FourSeverityLevels".
text	string		Tekst do przeanalizowania. W tekście jednego żądania obsługujemy maksymalnie 10 000 znaków Unicode (punkty kodu Unicode).

AnalyzeTextOutputType

Odnosi się to do typu danych wyjściowych analizy tekstu. Jeśli żadna wartość nie zostanie przypisana, wartość domyślna będzie mieć wartość "FourSeverityLevels".

Nazwa	Typ	Opis
EightSeverityLevels	string	Ważność danych wyjściowych na ośmiu poziomach, wartość może wynosić 0,1,2,3,4,5,6,7.
FourSeverityLevels	string	Ważność danych wyjściowych na czterech poziomach, wartość może wynosić 0,2,4,6.

AnalyzeTextResult

Odpowiedź analizy tekstu.

Nazwa	Typ	Opis
blocklistsMatch	TextBlocklistMatch[]	Szczegóły dopasowania listy zablokowanych.
categoriesAnalysis	TextCategoriesAnalysis[]	Wynik analizy dla kategorii.

Azure.Core.Foundations.Error

Obiekt błędu.

Nazwa	Typ	Opis
code	string	Jeden z zdefiniowanych przez serwer zestaw kodów błędów.
details	Azure.Core.Foundations.Error[]	Tablica szczegółów dotyczących określonych błędów, które doprowadziły do tego zgłoszonego błędu.
innererror	Azure.Core.Foundations.InnerError	Obiekt zawierający bardziej szczegółowe informacje niż bieżący obiekt o błędzie.
message	string	Czytelna dla człowieka reprezentacja błędu.
target	string	Element docelowy błędu.

Azure.Core.Foundations.ErrorResponse

Odpowiedź zawierająca szczegóły błędu.

Nazwa	Typ	Opis
error	Azure.Core.Foundations.Error	Obiekt błędu.

Azure.Core.Foundations.InnerError

Obiekt zawierający bardziej szczegółowe informacje o błędzie. Zgodnie z wytycznymi dotyczącymi interfejsu MICROSOFT One API — https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Nazwa	Typ	Opis
code	string	Jeden z zdefiniowanych przez serwer zestaw kodów błędów.
innererror	Azure.Core.Foundations.InnerError	Błąd wewnętrzny.

TextBlocklistMatch

Wynik dopasowania listy zablokowanych.

Nazwa	Typ	Opis
blocklistItemId	string	Identyfikator dopasowanego elementu.
blocklistItemText	string	Zawartość dopasowanego elementu.
blocklistName	string	Nazwa dopasowanej listy zablokowanych.

TextCategoriesAnalysis

Wynik analizy tekstu.

Nazwa	Typ	Opis
category	TextCategory	Kategoria analiza tekstu.
severity	integer	Wartość zwiększa się wraz z ważnością zawartości wejściowej. Wartość tego pola jest określana przez typ danych wyjściowych określony w żądaniu. Typ danych wyjściowych może mieć wartość "FourSeverityLevels" lub "EightSeverity Levels", a wartość wyjściowa może wynosić 0, 2, 4, 6 lub 0, 1, 2, 3, 4, 5, 6 lub 7.

TextCategory

Kategoria szkody obsługiwana w analizie zawartości tekstowej.

Nazwa	Typ	Opis
Hate	string	Kategoria szkody dla tekstu — nienawiść.
SelfHarm	string	Kategoria szkody dla tekstu — SelfHarm.
Sexual	string	Kategoria szkody dla tekstu - seksualnego.
Violence	string	Kategoria szkody dla Tekstu - Przemoc.

Udostępnij za pośrednictwem

Text Operations - Analyze Text

Parametry identyfikatora URI

Treść żądania

Odpowiedzi

Zabezpieczenia

Ocp-Apim-Subscription-Key

OAuth2Auth

Zakresy

Przykłady

Analyze Text

Przykładowe żądanie

Przykładowa odpowiedź

Definicje

AnalyzeTextOptions

AnalyzeTextOutputType

AnalyzeTextResult

Azure.Core.Foundations.Error

Azure.Core.Foundations.ErrorResponse

Azure.Core.Foundations.InnerError

TextBlocklistMatch

TextCategoriesAnalysis

TextCategory

Dodatkowe zasoby