Поделиться через


Conversational Analysis Authoring - Get Supported Prebuilt Entities

Списки поддерживаемые предварительно созданные сущности, которые можно использовать при создании составных сущностей.

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

Параметры URI

Имя В Обязательно Тип Описание
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, параметр language игнорируется.

skip
query

integer

int32

Смещение в коллекции первого возвращаемого ресурса.

top
query

integer

int32

Максимальное количество ресурсов, возвращаемых из коллекции.

Ответы

Имя Тип Описание
200 OK

ConversationalAnalysisAuthoringPrebuiltEntities

Список поддерживаемых предварительно созданных сущностей.

Other Status Codes

ErrorResponse

Ответ об ошибке.

Безопасность

AADToken

Это потоки OAuth2 Azure Active Directory . При связывании с управлением доступом на основе ролей Azure его можно использовать для управления доступом к Azure Maps REST API. Элементы управления доступом на основе ролей Azure используются для назначения доступа к одной или нескольким учетным записям Azure Maps ресурсов или вложенным ресурсам. Любому пользователю, группе или субъекту-службе можно предоставить доступ через встроенную роль или пользовательскую роль, состоящую из одного или нескольких разрешений на Azure Maps REST API.

Для реализации сценариев рекомендуется ознакомиться с основными понятиями проверки подлинности. Таким образом, это определение безопасности предоставляет решение для моделирования приложений с помощью объектов, способных управлять доступом к определенным API и областям.

Примечания

  • Это определение безопасности требует использования заголовкаx-ms-client-id, чтобы указать, к какому Azure Maps ресурсу приложение запрашивает доступ. Его можно получить из API управления Картами.

Объект Authorization URL предназначен для экземпляра общедоступного облака Azure. Национальные облака имеют уникальные URL-адреса авторизации и конфигурации Azure Active Directory. * Управление доступом на основе ролей Azure настраивается из плоскости управления Azure с помощью портал Azure, PowerShell, CLI, пакетов SDK для Azure или REST API. * Использование веб-пакета SDK для Azure Maps позволяет настраивать приложение на основе конфигурации для нескольких вариантов использования.

  • В настоящее время Azure Active Directory версии 1.0 или 2.0 поддерживает рабочие, учебные заведения и гостей, но не поддерживает личные учетные записи.

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

Имя Описание
https://cognitiveservices.azure.com/.default https://cognitiveservices.azure.com/.default

Ocp-Apim-Subscription-Key

Ключ подписки для ресурса языковой службы.

Тип: apiKey
В: header

Примеры

Successful Get Supported Prebuilt Entities

Образец запроса

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

Пример ответа

{
  "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
}

Определения

Имя Описание
ConversationalAnalysisAuthoringPrebuiltEntities

Представляет список полученных поддерживаемых предварительно созданных сущностей.

ConversationalAnalysisAuthoringPrebuiltEntity

Представляет поддерживаемую предварительно созданную сущность.

Error

Объект ошибки.

ErrorCode

Код ошибки, доступный для чтения человеком.

ErrorResponse

Ответ об ошибке.

InnerErrorCode

Код ошибки, доступный для чтения человеком.

InnerErrorModel

Объект , содержащий более конкретные сведения об ошибке. В соответствии с рекомендациями по API Microsoft One — https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

ConversationalAnalysisAuthoringPrebuiltEntities

Представляет список полученных поддерживаемых предварительно созданных сущностей.

Имя Тип Описание
nextLink

string

Ссылка на следующую страницу.

value

ConversationalAnalysisAuthoringPrebuiltEntity[]

Поддерживаемые предварительно созданные сущности.

ConversationalAnalysisAuthoringPrebuiltEntity

Представляет поддерживаемую предварительно созданную сущность.

Имя Тип Описание
category

string

Категория предварительно созданных сущностей.

description

string

Описание.

examples

string

Примеры сущности на английском языке.

Error

Объект ошибки.

Имя Тип Описание
code

ErrorCode

Один из серверных наборов кодов ошибок.

details

Error[]

Массив сведений о конкретных ошибках, которые привели к этой сообщаемой ошибке.

innererror

InnerErrorModel

Объект , содержащий более конкретные сведения об ошибке, чем текущий объект.

message

string

Понятное представление ошибки.

target

string

Целевой объект ошибки.

ErrorCode

Код ошибки, доступный для чтения человеком.

Имя Тип Описание
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

Ответ об ошибке.

Имя Тип Описание
error

Error

Объект ошибки.

InnerErrorCode

Код ошибки, доступный для чтения человеком.

Имя Тип Описание
AzureCognitiveSearchNotFound

string

AzureCognitiveSearchThrottling

string

EmptyRequest

string

ExtractionFailure

string

InvalidCountryHint

string

InvalidDocument

string

InvalidDocumentBatch

string

InvalidParameterValue

string

InvalidRequest

string

InvalidRequestBodyFormat

string

KnowledgeBaseNotFound

string

MissingInputDocuments

string

ModelVersionIncorrect

string

UnsupportedLanguageCode

string

InnerErrorModel

Объект , содержащий более конкретные сведения об ошибке. В соответствии с рекомендациями по API Microsoft One — https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Имя Тип Описание
code

InnerErrorCode

Один из серверных наборов кодов ошибок.

details

object

Сведения об ошибке.

innererror

InnerErrorModel

Объект , содержащий более конкретные сведения об ошибке, чем текущий объект.

message

string

Сообщение об ошибке.

target

string

Целевой объект ошибки.