rai_content_filters

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

Overview

Name	rai_content_filters
Type	Resource
Id	azure.cognitive_services.rai_content_filters

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
isMultiLevelFilter	boolean	If the Content Filter has multi severity levels(Low, Medium, or High).
source	string	Content source to apply the Content Filters. Known values are: "Prompt", "Completion", "PreToolCall", "PostToolCall", "PreRun", and "PostRun". (Prompt, Completion, PreToolCall, PostToolCall, PreRun, PostRun)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
isMultiLevelFilter	boolean	If the Content Filter has multi severity levels(Low, Medium, or High).
source	string	Content source to apply the Content Filters. Known values are: "Prompt", "Completion", "PreToolCall", "PostToolCall", "PreRun", and "PostRun". (Prompt, Completion, PreToolCall, PostToolCall, PreRun, PostRun)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	location, filter_name, subscription_id		Get Content Filters by Name.
list	select	location, subscription_id		List Content Filters types.

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
filter_name	string	The name of the RAI Content Filter. Required.
location	string	The name of the Azure region. Required.
subscription_id	string

SELECT examples

get

Get Content Filters by Name.

SELECT
id,
name,
isMultiLevelFilter,
source,
systemData,
type
FROM azure.cognitive_services.rai_content_filters
WHERE location = '{{ location }}' -- required
AND filter_name = '{{ filter_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

List Content Filters types.

SELECT
id,
name,
isMultiLevelFilter,
source,
systemData,
type
FROM azure.cognitive_services.rai_content_filters
WHERE location = '{{ location }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;