RaiPolicyArgs

data class RaiPolicyArgs(val accountName: Output<String>? = null, val properties: Output<RaiPolicyPropertiesArgs>? = null, val raiPolicyName: Output<String>? = null, val resourceGroupName: Output<String>? = null, val tags: Output<Map<String, String>>? = null) : ConvertibleToJava<RaiPolicyArgs>

Cognitive Services RaiPolicy. Uses Azure REST API version 2024-10-01. In version 2.x of the Azure Native provider, it used API version 2023-10-01-preview. Other available API versions: 2023-10-01-preview, 2024-04-01-preview, 2024-06-01-preview, 2025-04-01-preview. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native cognitiveservices [ApiVersion]. See the ../../../version-guide/#accessing-any-api-version-via-local-packages for details.

Example Usage

PutRaiPolicy

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;
return await Deployment.RunAsync(() =>
{
var raiPolicy = new AzureNative.CognitiveServices.RaiPolicy("raiPolicy", new()
{
AccountName = "accountName",
Properties = new AzureNative.CognitiveServices.Inputs.RaiPolicyPropertiesArgs
{
BasePolicyName = "Microsoft.Default",
ContentFilters = new[]
{
new AzureNative.CognitiveServices.Inputs.RaiPolicyContentFilterArgs
{
Blocking = false,
Enabled = false,
Name = "Hate",
SeverityThreshold = AzureNative.CognitiveServices.ContentLevel.High,
Source = AzureNative.CognitiveServices.RaiPolicyContentSource.Prompt,
},
new AzureNative.CognitiveServices.Inputs.RaiPolicyContentFilterArgs
{
Blocking = true,
Enabled = true,
Name = "Hate",
SeverityThreshold = AzureNative.CognitiveServices.ContentLevel.Medium,
Source = AzureNative.CognitiveServices.RaiPolicyContentSource.Completion,
},
new AzureNative.CognitiveServices.Inputs.RaiPolicyContentFilterArgs
{
Blocking = true,
Enabled = true,
Name = "Sexual",
SeverityThreshold = AzureNative.CognitiveServices.ContentLevel.High,
Source = AzureNative.CognitiveServices.RaiPolicyContentSource.Prompt,
},
new AzureNative.CognitiveServices.Inputs.RaiPolicyContentFilterArgs
{
Blocking = true,
Enabled = true,
Name = "Sexual",
SeverityThreshold = AzureNative.CognitiveServices.ContentLevel.Medium,
Source = AzureNative.CognitiveServices.RaiPolicyContentSource.Completion,
},
new AzureNative.CognitiveServices.Inputs.RaiPolicyContentFilterArgs
{
Blocking = true,
Enabled = true,
Name = "Selfharm",
SeverityThreshold = AzureNative.CognitiveServices.ContentLevel.High,
Source = AzureNative.CognitiveServices.RaiPolicyContentSource.Prompt,
},
new AzureNative.CognitiveServices.Inputs.RaiPolicyContentFilterArgs
{
Blocking = true,
Enabled = true,
Name = "Selfharm",
SeverityThreshold = AzureNative.CognitiveServices.ContentLevel.Medium,
Source = AzureNative.CognitiveServices.RaiPolicyContentSource.Completion,
},
new AzureNative.CognitiveServices.Inputs.RaiPolicyContentFilterArgs
{
Blocking = true,
Enabled = true,
Name = "Violence",
SeverityThreshold = AzureNative.CognitiveServices.ContentLevel.Medium,
Source = AzureNative.CognitiveServices.RaiPolicyContentSource.Prompt,
},
new AzureNative.CognitiveServices.Inputs.RaiPolicyContentFilterArgs
{
Blocking = true,
Enabled = true,
Name = "Violence",
SeverityThreshold = AzureNative.CognitiveServices.ContentLevel.Medium,
Source = AzureNative.CognitiveServices.RaiPolicyContentSource.Completion,
},
new AzureNative.CognitiveServices.Inputs.RaiPolicyContentFilterArgs
{
Blocking = true,
Enabled = true,
Name = "Jailbreak",
Source = AzureNative.CognitiveServices.RaiPolicyContentSource.Prompt,
},
new AzureNative.CognitiveServices.Inputs.RaiPolicyContentFilterArgs
{
Blocking = true,
Enabled = true,
Name = "Protected Material Text",
Source = AzureNative.CognitiveServices.RaiPolicyContentSource.Completion,
},
new AzureNative.CognitiveServices.Inputs.RaiPolicyContentFilterArgs
{
Blocking = true,
Enabled = true,
Name = "Protected Material Code",
Source = AzureNative.CognitiveServices.RaiPolicyContentSource.Completion,
},
new AzureNative.CognitiveServices.Inputs.RaiPolicyContentFilterArgs
{
Blocking = true,
Enabled = true,
Name = "Profanity",
Source = AzureNative.CognitiveServices.RaiPolicyContentSource.Prompt,
},
},
Mode = AzureNative.CognitiveServices.RaiPolicyMode.Asynchronous_filter,
},
RaiPolicyName = "raiPolicyName",
ResourceGroupName = "resourceGroupName",
});
});
package main
import (
cognitiveservices "github.com/pulumi/pulumi-azure-native-sdk/cognitiveservices/v3"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := cognitiveservices.NewRaiPolicy(ctx, "raiPolicy", &cognitiveservices.RaiPolicyArgs{
AccountName: pulumi.String("accountName"),
Properties: &cognitiveservices.RaiPolicyPropertiesArgs{
BasePolicyName: pulumi.String("Microsoft.Default"),
ContentFilters: cognitiveservices.RaiPolicyContentFilterArray{
&cognitiveservices.RaiPolicyContentFilterArgs{
Blocking: pulumi.Bool(false),
Enabled: pulumi.Bool(false),
Name: pulumi.String("Hate"),
SeverityThreshold: pulumi.String(cognitiveservices.ContentLevelHigh),
Source: pulumi.String(cognitiveservices.RaiPolicyContentSourcePrompt),
},
&cognitiveservices.RaiPolicyContentFilterArgs{
Blocking: pulumi.Bool(true),
Enabled: pulumi.Bool(true),
Name: pulumi.String("Hate"),
SeverityThreshold: pulumi.String(cognitiveservices.ContentLevelMedium),
Source: pulumi.String(cognitiveservices.RaiPolicyContentSourceCompletion),
},
&cognitiveservices.RaiPolicyContentFilterArgs{
Blocking: pulumi.Bool(true),
Enabled: pulumi.Bool(true),
Name: pulumi.String("Sexual"),
SeverityThreshold: pulumi.String(cognitiveservices.ContentLevelHigh),
Source: pulumi.String(cognitiveservices.RaiPolicyContentSourcePrompt),
},
&cognitiveservices.RaiPolicyContentFilterArgs{
Blocking: pulumi.Bool(true),
Enabled: pulumi.Bool(true),
Name: pulumi.String("Sexual"),
SeverityThreshold: pulumi.String(cognitiveservices.ContentLevelMedium),
Source: pulumi.String(cognitiveservices.RaiPolicyContentSourceCompletion),
},
&cognitiveservices.RaiPolicyContentFilterArgs{
Blocking: pulumi.Bool(true),
Enabled: pulumi.Bool(true),
Name: pulumi.String("Selfharm"),
SeverityThreshold: pulumi.String(cognitiveservices.ContentLevelHigh),
Source: pulumi.String(cognitiveservices.RaiPolicyContentSourcePrompt),
},
&cognitiveservices.RaiPolicyContentFilterArgs{
Blocking: pulumi.Bool(true),
Enabled: pulumi.Bool(true),
Name: pulumi.String("Selfharm"),
SeverityThreshold: pulumi.String(cognitiveservices.ContentLevelMedium),
Source: pulumi.String(cognitiveservices.RaiPolicyContentSourceCompletion),
},
&cognitiveservices.RaiPolicyContentFilterArgs{
Blocking: pulumi.Bool(true),
Enabled: pulumi.Bool(true),
Name: pulumi.String("Violence"),
SeverityThreshold: pulumi.String(cognitiveservices.ContentLevelMedium),
Source: pulumi.String(cognitiveservices.RaiPolicyContentSourcePrompt),
},
&cognitiveservices.RaiPolicyContentFilterArgs{
Blocking: pulumi.Bool(true),
Enabled: pulumi.Bool(true),
Name: pulumi.String("Violence"),
SeverityThreshold: pulumi.String(cognitiveservices.ContentLevelMedium),
Source: pulumi.String(cognitiveservices.RaiPolicyContentSourceCompletion),
},
&cognitiveservices.RaiPolicyContentFilterArgs{
Blocking: pulumi.Bool(true),
Enabled: pulumi.Bool(true),
Name: pulumi.String("Jailbreak"),
Source: pulumi.String(cognitiveservices.RaiPolicyContentSourcePrompt),
},
&cognitiveservices.RaiPolicyContentFilterArgs{
Blocking: pulumi.Bool(true),
Enabled: pulumi.Bool(true),
Name: pulumi.String("Protected Material Text"),
Source: pulumi.String(cognitiveservices.RaiPolicyContentSourceCompletion),
},
&cognitiveservices.RaiPolicyContentFilterArgs{
Blocking: pulumi.Bool(true),
Enabled: pulumi.Bool(true),
Name: pulumi.String("Protected Material Code"),
Source: pulumi.String(cognitiveservices.RaiPolicyContentSourceCompletion),
},
&cognitiveservices.RaiPolicyContentFilterArgs{
Blocking: pulumi.Bool(true),
Enabled: pulumi.Bool(true),
Name: pulumi.String("Profanity"),
Source: pulumi.String(cognitiveservices.RaiPolicyContentSourcePrompt),
},
},
Mode: pulumi.String(cognitiveservices.RaiPolicyMode_Asynchronous_filter),
},
RaiPolicyName: pulumi.String("raiPolicyName"),
ResourceGroupName: pulumi.String("resourceGroupName"),
})
if err != nil {
return err
}
return nil
})
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.cognitiveservices.RaiPolicy;
import com.pulumi.azurenative.cognitiveservices.RaiPolicyArgs;
import com.pulumi.azurenative.cognitiveservices.inputs.RaiPolicyPropertiesArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var raiPolicy = new RaiPolicy("raiPolicy", RaiPolicyArgs.builder()
.accountName("accountName")
.properties(RaiPolicyPropertiesArgs.builder()
.basePolicyName("Microsoft.Default")
.contentFilters(
RaiPolicyContentFilterArgs.builder()
.blocking(false)
.enabled(false)
.name("Hate")
.severityThreshold("High")
.source("Prompt")
.build(),
RaiPolicyContentFilterArgs.builder()
.blocking(true)
.enabled(true)
.name("Hate")
.severityThreshold("Medium")
.source("Completion")
.build(),
RaiPolicyContentFilterArgs.builder()
.blocking(true)
.enabled(true)
.name("Sexual")
.severityThreshold("High")
.source("Prompt")
.build(),
RaiPolicyContentFilterArgs.builder()
.blocking(true)
.enabled(true)
.name("Sexual")
.severityThreshold("Medium")
.source("Completion")
.build(),
RaiPolicyContentFilterArgs.builder()
.blocking(true)
.enabled(true)
.name("Selfharm")
.severityThreshold("High")
.source("Prompt")
.build(),
RaiPolicyContentFilterArgs.builder()
.blocking(true)
.enabled(true)
.name("Selfharm")
.severityThreshold("Medium")
.source("Completion")
.build(),
RaiPolicyContentFilterArgs.builder()
.blocking(true)
.enabled(true)
.name("Violence")
.severityThreshold("Medium")
.source("Prompt")
.build(),
RaiPolicyContentFilterArgs.builder()
.blocking(true)
.enabled(true)
.name("Violence")
.severityThreshold("Medium")
.source("Completion")
.build(),
RaiPolicyContentFilterArgs.builder()
.blocking(true)
.enabled(true)
.name("Jailbreak")
.source("Prompt")
.build(),
RaiPolicyContentFilterArgs.builder()
.blocking(true)
.enabled(true)
.name("Protected Material Text")
.source("Completion")
.build(),
RaiPolicyContentFilterArgs.builder()
.blocking(true)
.enabled(true)
.name("Protected Material Code")
.source("Completion")
.build(),
RaiPolicyContentFilterArgs.builder()
.blocking(true)
.enabled(true)
.name("Profanity")
.source("Prompt")
.build())
.mode("Asynchronous_filter")
.build())
.raiPolicyName("raiPolicyName")
.resourceGroupName("resourceGroupName")
.build());
}
}

Import

An existing resource can be imported using its type token, name, and identifier, e.g.

$ pulumi import azure-native:cognitiveservices:RaiPolicy raiPolicyName /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/raiPolicies/{raiPolicyName}

Constructors

Link copied to clipboard
constructor(accountName: Output<String>? = null, properties: Output<RaiPolicyPropertiesArgs>? = null, raiPolicyName: Output<String>? = null, resourceGroupName: Output<String>? = null, tags: Output<Map<String, String>>? = null)

Properties

Link copied to clipboard
val accountName: Output<String>? = null

The name of Cognitive Services account.

Link copied to clipboard
val properties: Output<RaiPolicyPropertiesArgs>? = null

Properties of Cognitive Services RaiPolicy.

Link copied to clipboard
val raiPolicyName: Output<String>? = null

The name of the RaiPolicy associated with the Cognitive Services Account

Link copied to clipboard
val resourceGroupName: Output<String>? = null

The name of the resource group. The name is case insensitive.

Link copied to clipboard
val tags: Output<Map<String, String>>? = null

Resource tags.

Functions

Link copied to clipboard
open override fun toJava(): RaiPolicyArgs