text_blocklist_items

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

Overview

Name	text_blocklist_items
Type	Resource
Id	azure.ai_content_safety.text_blocklist_items

Fields

The following fields are returned by SELECT queries:

get_text_blocklist_item

Name	Datatype	Description
blocklistItemId	string	The service will generate a BlocklistItemId, which will be a UUID. Required.
description	string	BlocklistItem description.
text	string	BlocklistItem content. Required.

list_text_blocklist_items

Name	Datatype	Description
blocklistItemId	string	The service will generate a BlocklistItemId, which will be a UUID. Required.
description	string	BlocklistItem description.
text	string	BlocklistItem content. Required.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_text_blocklist_item	select	blocklist_name, blocklist_item_id, endpoint		Get BlocklistItem By blocklistName And blocklistItemId. Get blocklistItem by blocklistName and blocklistItemId from a text blocklist.
list_text_blocklist_items	select	blocklist_name, endpoint	top, skip, maxpagesize	Get All BlocklistItems By blocklistName. Get all blocklistItems in a text blocklist.

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
blocklist_item_id	string	The service will generate a BlocklistItemId, which will be a UUID. Required.
blocklist_name	string	Text blocklist name. Required.
endpoint	string	The service endpoint host (no scheme), e.g. myaccount.table.cosmos.azure.com:443 - value of the client endpoint parameter. (default: )
maxpagesize	integer
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

get_text_blocklist_item

Get BlocklistItem By blocklistName And blocklistItemId. Get blocklistItem by blocklistName and blocklistItemId from a text blocklist.

SELECT
blocklistItemId,
description,
text
FROM azure.ai_content_safety.text_blocklist_items
WHERE blocklist_name = '{{ blocklist_name }}' -- required
AND blocklist_item_id = '{{ blocklist_item_id }}' -- required
AND endpoint = '{{ endpoint }}' -- required
;

list_text_blocklist_items

Get All BlocklistItems By blocklistName. Get all blocklistItems in a text blocklist.

SELECT
blocklistItemId,
description,
text
FROM azure.ai_content_safety.text_blocklist_items
WHERE blocklist_name = '{{ blocklist_name }}' -- required
AND endpoint = '{{ endpoint }}' -- required
AND top = '{{ top }}'
AND skip = '{{ skip }}'
AND maxpagesize = '{{ maxpagesize }}'
;