synonyms

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

Overview

Name	synonyms
Type	Resource
Id	azure.ai_language.synonyms

Fields

The following fields are returned by SELECT queries:

list_synonyms

Name	Datatype	Description
alterations	array	Collection of word alterations. Required.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_synonyms	select	project_name, endpoint	top, skip, maxpagesize	Gets all the synonyms of a project.
update_synonyms	update	project_name, endpoint, value		Updates all the synonyms of a project.

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: )
project_name	string	The name of the project to use. Required.
maxpagesize	integer
skip	integer	An offset into the collection of the first resource to be returned. Default value is None.
top	integer	The maximum number of resources to return from the collection. Default value is None.

SELECT examples

list_synonyms

Gets all the synonyms of a project.

SELECT
alterations
FROM azure.ai_language.synonyms
WHERE project_name = '{{ project_name }}' -- required
AND endpoint = '{{ endpoint }}' -- required
AND top = '{{ top }}'
AND skip = '{{ skip }}'
AND maxpagesize = '{{ maxpagesize }}'
;

UPDATE examples

update_synonyms

Updates all the synonyms of a project.

UPDATE azure.ai_language.synonyms
SET 
value = '{{ value }}',
nextLink = '{{ nextLink }}'
WHERE 
project_name = '{{ project_name }}' --required
AND endpoint = '{{ endpoint }}' --required
AND value = '{{ value }}' --required;