다음을 통해 공유

Text Operations - Analyze Text

  • 참조
서비스:
Azure AI Services
API 버전:
2024-09-01

텍스트 분석
잠재적으로 유해한 텍스트 콘텐츠를 분석하기 위한 동기 API입니다. 현재 증오, 셀프 하름, 성적 및 폭력의 네 가지 범주를 지원합니다.

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

URI 매개 변수

Name In(다음 안에) 필수 형식 Description
endpoint
 path True

string

지원되는 Cognitive Services 엔드포인트(프로토콜 및 호스트 이름, 예: https://.cognitiveservices.azure.com).
api-version
 query True

string

이 작업에 사용할 API 버전입니다.

요청 본문

Name 필수 형식 Description
text True

string

분석할 텍스트입니다. 한 요청의 텍스트에서 최대 10k 유니코드 문자(유니코드 코드 포인트)를 지원합니다.
blocklistNames

string[]

차단 목록의 이름입니다.
categories

TextCategory[]

범주가 분석됩니다. 할당되지 않은 경우 범주에 대한 기본 분석 결과 집합이 반환됩니다.
haltOnBlocklistHit

boolean

true로 설정하면 차단 목록이 적중되는 경우 유해한 콘텐츠에 대한 추가 분석이 수행되지 않습니다. false로 설정하면 차단 목록에 적중되었는지 여부에 관계없이 유해한 콘텐츠의 모든 분석이 수행됩니다.
outputType

AnalyzeTextOutputType

이는 텍스트 분석 출력의 형식을 나타냅니다. 값이 할당되지 않은 경우 기본값은 "FourSeverityLevels"입니다.

응답

Name 형식 Description
200 OK

AnalyzeTextResult

요청이 성공했습니다.
Other Status Codes

Azure.Core.Foundations.ErrorResponse

예기치 않은 오류 응답입니다.

헤더

x-ms-error-code: string

보안

Ocp-Apim-Subscription-Key

형식: apiKey
In(다음 안에): header

OAuth2Auth

형식: oauth2
Flow: application
토큰 URL: https://login.microsoftonline.com/common/oauth2/v2.0/token

범위

Name Description
https://cognitiveservices.azure.com/.default

예제

Analyze Text

샘플 요청

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

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

샘플 응답

상태 코드:
200 
{
  "blocklistsMatch": [],
  "categoriesAnalysis": [
    {
      "category": "Hate",
      "severity": 0
    },
    {
      "category": "SelfHarm",
      "severity": 0
    },
    {
      "category": "Sexual",
      "severity": 0
    },
    {
      "category": "Violence",
      "severity": 0
    }
  ]
}

정의

Name Description
AnalyzeTextOptions

텍스트 분석 요청입니다.
AnalyzeTextOutputType

이는 텍스트 분석 출력의 형식을 나타냅니다. 값이 할당되지 않은 경우 기본값은 "FourSeverityLevels"입니다.
AnalyzeTextResult

텍스트 분석 응답입니다.
Azure.Core.Foundations.Error

오류 개체입니다.
Azure.Core.Foundations.ErrorResponse

오류 세부 정보가 포함된 응답입니다.
Azure.Core.Foundations.InnerError

오류에 대한 보다 구체적인 정보를 포함하는 개체입니다. Microsoft One API 지침에 따라 https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
TextBlocklistMatch

차단 목록 일치의 결과입니다.
TextCategoriesAnalysis

텍스트 분석 결과입니다.
TextCategory

텍스트 콘텐츠 분석에서 지원되는 피해 범주입니다.

AnalyzeTextOptions

텍스트 분석 요청입니다.

Name 형식 Default value Description
blocklistNames

string[]

차단 목록의 이름입니다.
categories

TextCategory[]

범주가 분석됩니다. 할당되지 않은 경우 범주에 대한 기본 분석 결과 집합이 반환됩니다.
haltOnBlocklistHit

boolean

true로 설정하면 차단 목록이 적중되는 경우 유해한 콘텐츠에 대한 추가 분석이 수행되지 않습니다. false로 설정하면 차단 목록에 적중되었는지 여부에 관계없이 유해한 콘텐츠의 모든 분석이 수행됩니다.
outputType

AnalyzeTextOutputType

FourSeverityLevels

이는 텍스트 분석 출력의 형식을 나타냅니다. 값이 할당되지 않은 경우 기본값은 "FourSeverityLevels"입니다.
text

string

분석할 텍스트입니다. 한 요청의 텍스트에서 최대 10k 유니코드 문자(유니코드 코드 포인트)를 지원합니다.

AnalyzeTextOutputType

이는 텍스트 분석 출력의 형식을 나타냅니다. 값이 할당되지 않은 경우 기본값은 "FourSeverityLevels"입니다.

Name 형식 Description
EightSeverityLevels

string

8개 수준의 출력 심각도 값은 0,1,2,3,4,5,6,7일 수 있습니다.
FourSeverityLevels

string

4개 수준의 출력 심각도 값은 0,2,4,6일 수 있습니다.

AnalyzeTextResult

텍스트 분석 응답입니다.

Name 형식 Description
blocklistsMatch

TextBlocklistMatch[]

차단 목록 일치 세부 정보입니다.
categoriesAnalysis

TextCategoriesAnalysis[]

범주에 대한 분석 결과입니다.

Azure.Core.Foundations.Error

오류 개체입니다.

Name 형식 Description
code

string

서버에서 정의한 오류 코드 집합 중 하나입니다.
details

Azure.Core.Foundations.Error[]

이 보고된 오류로 이어진 특정 오류에 대한 세부 정보 배열입니다.
innererror

Azure.Core.Foundations.InnerError

오류에 대한 현재 개체보다 더 구체적인 정보를 포함하는 개체입니다.
message

string

사람이 읽을 수 있는 오류 표현입니다.
target

string

오류의 대상입니다.

Azure.Core.Foundations.ErrorResponse

오류 세부 정보가 포함된 응답입니다.

Name 형식 Description
error

Azure.Core.Foundations.Error

오류 개체입니다.

Azure.Core.Foundations.InnerError

오류에 대한 보다 구체적인 정보를 포함하는 개체입니다. Microsoft One API 지침에 따라 https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Name 형식 Description
code

string

서버에서 정의한 오류 코드 집합 중 하나입니다.
innererror

Azure.Core.Foundations.InnerError

내부 오류입니다.

TextBlocklistMatch

차단 목록 일치의 결과입니다.

Name 형식 Description
blocklistItemId

string

일치하는 항목의 ID입니다.
blocklistItemText

string

일치하는 항목의 콘텐츠입니다.
blocklistName

string

일치하는 차단 목록의 이름입니다.

TextCategoriesAnalysis

텍스트 분석 결과입니다.

Name 형식 Description
category

TextCategory

텍스트 분석 범주입니다.
severity

integer

입력 콘텐츠의 심각도에 따라 값이 증가합니다. 이 필드의 값은 요청에 지정된 출력 형식에 따라 결정됩니다. 출력 형식은 'FourSeverityLevels' 또는 'EightSeverity Levels'일 수 있으며 출력 값은 0, 2, 4, 6 또는 0, 1, 2, 3, 4, 5, 6 또는 7일 수 있습니다.

TextCategory

텍스트 콘텐츠 분석에서 지원되는 피해 범주입니다.

Name 형식 Description
Hate

string

텍스트의 피해 범주 - 증오.
SelfHarm

string

Text - SelfHarm의 피해 범주입니다.
Sexual

string

텍스트에 대한 피해 범주 - 성적.
Violence

string

텍스트의 피해 범주 - 폭력.