Conversational Analysis Authoring - Get Supported Prebuilt Entities

참조

서비스:: Cognitive Services - Language

API 버전:: 2022-05-01

구성된 엔터티를 만드는 동안 사용할 수 있는 지원되는 미리 빌드된 엔터티를 Lists.

GET {Endpoint}/language/authoring/analyze-conversations/projects/global/prebuilt-entities?api-version=2022-05-01

선택적 매개 변수:

GET {Endpoint}/language/authoring/analyze-conversations/projects/global/prebuilt-entities?language={language}&multilingual={multilingual}&top={top}&skip={skip}&maxpagesize={maxpagesize}&api-version=2022-05-01

URI 매개 변수

Name	In(다음 안에)	필수	형식	Description
Endpoint	path	True	string	지원되는 Cognitive Services 엔드포인트(예: https://.api.cognitiveservices.azure.com).
api-version	query	True	string	클라이언트 API 버전입니다.
language	query		string	지원되는 미리 빌드된 엔터티를 가져올 언어입니다. 다국어 가 false이면 필수입니다. 이는 언어의 BCP-47 표현입니다. 예를 들어 영어의 경우 "en", 영어(영국)의 경우 "en-gb", 스페인어의 경우 "es"를 사용합니다.
maxpagesize	query		integer int32	단일 응답에 포함할 최대 리소스 수입니다.
multilingual	query		string	다국어 또는 단일 언어 프로젝트에 대한 지원 미리 빌드된 엔터티를 가져올지 여부입니다. true이면 언어 매개 변수가 무시됩니다.
skip	query		integer int32	반환할 첫 번째 리소스의 컬렉션에 대한 오프셋입니다.
top	query		integer int32	컬렉션에서 반환할 최대 리소스 수입니다.

요청 헤더

Name	필수	형식	Description
Ocp-Apim-Subscription-Key	True	string	언어 서비스 리소스에 대한 구독 키입니다.

응답

Name	형식	Description
200 OK	ConversationalAnalysisAuthoringPrebuiltEntities	지원되는 미리 빌드된 엔터티 목록입니다.
Other Status Codes	ErrorResponse	오류 응답입니다.

보안

Ocp-Apim-Subscription-Key

언어 서비스 리소스에 대한 구독 키입니다.

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

예제

Successful Get Supported Prebuilt Entities

샘플 요청

HTTP

GET {Endpoint}/language/authoring/analyze-conversations/projects/global/prebuilt-entities?language=en&api-version=2022-05-01

샘플 응답

상태 코드:: 200

{
  "value": [
    {
      "category": "Person.Name",
      "description": "Name of an individual",
      "examples": "john, Sam, Lisa"
    },
    {
      "category": "General.Event",
      "description": "Important events",
      "examples": "World War two, Covid 19"
    },
    {
      "category": "General.Organization",
      "description": "Companies and corporations",
      "examples": "Microsoft, Amazon"
    },
    {
      "category": "Choice.Boolean",
      "description": "boolean choice",
      "examples": "yes, no, agreed"
    },
    {
      "category": "Quantity.Age",
      "description": "Age of a person or thing",
      "examples": "10-month-old, 19 years old, 58 year-old"
    },
    {
      "category": "Quantity.NumberRange",
      "description": "a numeric interval",
      "examples": "between 25 and 35, 25-35"
    },
    {
      "category": "Quantity.Number",
      "description": "A cardinal number in numeric or text form",
      "examples": "ten, forty two, 3.141, 10K"
    },
    {
      "category": "Quantity.Percentage",
      "description": "A percentage, using the symbol % or the word \"percent\"",
      "examples": "10%, 5.6 percent"
    },
    {
      "category": "Quantity.Ordinal",
      "description": "An ordinal number in numeric or text form",
      "examples": "first, second, tenth, 1st, 2nd, 10th"
    },
    {
      "category": "Quantity.Dimension",
      "description": "Spacial dimensions, including length, distance, area, and volume",
      "examples": "2 miles, 650 square kilometres, 9,350 feet"
    },
    {
      "category": "Quantity.Temperature",
      "description": "A temperature in celsius or fahrenheit",
      "examples": "32F, 34 degrees celsius, 2 deg C"
    },
    {
      "category": "Quantity.Currency",
      "description": "Monetary amounts, including currency",
      "examples": "1000.00 US dollars, £20.00, $ 67.5 B"
    },
    {
      "category": "DateTime",
      "description": "exact date values",
      "examples": "May 11th"
    },
    {
      "category": "Email",
      "description": "Email addresses",
      "examples": "user@example.net, user_name@example.com, user.Name12@example.net"
    },
    {
      "category": "Phone Number",
      "description": "US phone numbers",
      "examples": "123-456-7890, +1 123 456 789, (123)456-789"
    },
    {
      "category": "URL",
      "description": "Websites URLs and links",
      "examples": "www.example.com, http://example.net?name=my_name&age=10"
    }
  ],
  "nextLink": null
}

정의

Name	Description
ConversationalAnalysisAuthoringPrebuiltEntities	검색된 지원되는 미리 빌드된 엔터티의 목록을 나타냅니다.
ConversationalAnalysisAuthoringPrebuiltEntity	지원되는 미리 빌드된 엔터티를 나타냅니다.
Error	Error 개체.
ErrorCode	사람이 읽을 수 있는 오류 코드입니다.
ErrorResponse	오류 응답입니다.
InnerErrorCode	사람이 읽을 수 있는 오류 코드입니다.
InnerErrorModel	오류에 대한 보다 구체적인 정보를 포함하는 개체입니다. Microsoft One API 지침에 따라 - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

ConversationalAnalysisAuthoringPrebuiltEntities

검색된 지원되는 미리 빌드된 엔터티의 목록을 나타냅니다.

Name	형식	Description
nextLink	string	다음 페이지 링크입니다.
value	ConversationalAnalysisAuthoringPrebuiltEntity[]	지원되는 미리 빌드된 엔터티입니다.

ConversationalAnalysisAuthoringPrebuiltEntity

지원되는 미리 빌드된 엔터티를 나타냅니다.

Name	형식	Description
category	string	미리 빌드된 엔터티 범주입니다.
description	string	설명입니다.
examples	string	엔터티에 대한 영어 예제입니다.

Error

Error 개체.

Name	형식	Description
code	ErrorCode	서버 정의 오류 코드 집합 중 하나입니다.
details	Error[]	이 보고된 오류로 이어진 특정 오류에 대한 세부 정보 배열입니다.
innererror	InnerErrorModel	오류에 대한 현재 개체보다 더 구체적인 정보를 포함하는 개체입니다.
message	string	사람이 읽을 수 있는 오류 표현입니다.
target	string	오류의 대상입니다.

ErrorCode

사람이 읽을 수 있는 오류 코드입니다.

Name	형식	Description
AzureCognitiveSearchIndexLimitReached	string
AzureCognitiveSearchIndexNotFound	string
AzureCognitiveSearchNotFound	string
AzureCognitiveSearchThrottling	string
Conflict	string
Forbidden	string
InternalServerError	string
InvalidArgument	string
InvalidRequest	string
NotFound	string
OperationNotFound	string
ProjectNotFound	string
QuotaExceeded	string
ServiceUnavailable	string
Timeout	string
TooManyRequests	string
Unauthorized	string
Warning	string

ErrorResponse

오류 응답입니다.

Name	형식	Description
error	Error	Error 개체.

InnerErrorCode