supported_prebuilt_entities

Creates, updates, deletes, gets or lists a supported_prebuilt_entities resource.

Overview

Name	supported_prebuilt_entities
Type	Resource
Id	azure.ai_language.supported_prebuilt_entities

Fields

The following fields are returned by SELECT queries:

list_supported_prebuilt_entities

Name	Datatype	Description
category	string	The prebuilt entity category. Required.
description	string	The description. Required.
examples	string	English examples for the entity. Required.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_supported_prebuilt_entities	select	endpoint	top, skip, maxpagesize, language, multilingual	Lists the supported prebuilt entities that can be used while creating composed entities.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
endpoint	string	The service endpoint host (no scheme), e.g. myaccount.table.cosmos.azure.com:443 - value of the client Endpoint parameter. (default: )
language	string	The language to get supported prebuilt entities for. Required if multilingual is false. This is BCP-47 representation of a language. For example, use "en" for English, "en-gb" for English (UK), "es" for Spanish etc. Default value is None.
maxpagesize	integer
multilingual	string	Whether to get the support prebuilt entities for multilingual or monolingual projects. If true, the language parameter is ignored. Default value is None.
skip	integer	The number of result items to skip. Default value is None.
top	integer	The number of result items to return. Default value is None.

SELECT examples

list_supported_prebuilt_entities

Lists the supported prebuilt entities that can be used while creating composed entities.

SELECT
category,
description,
examples
FROM azure.ai_language.supported_prebuilt_entities
WHERE endpoint = '{{ endpoint }}' -- required
AND top = '{{ top }}'
AND skip = '{{ skip }}'
AND maxpagesize = '{{ maxpagesize }}'
AND language = '{{ language }}'
AND multilingual = '{{ multilingual }}'
;