ContentSafetyClient.CreateOrUpdateTextBlocklistAsync Method

Reference

Definition

Namespace:: Azure.AI.ContentSafety

Assembly:: Azure.AI.ContentSafety.dll

Package:: Azure.AI.ContentSafety v1.0.0-beta.1

Source:: ContentSafetyClient.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

[Protocol Method] Create Or Update Text Blocklist

This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.

public virtual System.Threading.Tasks.Task<Azure.Response> CreateOrUpdateTextBlocklistAsync (string blocklistName, Azure.Core.RequestContent content, Azure.RequestContext context = default);

abstract member CreateOrUpdateTextBlocklistAsync : string * Azure.Core.RequestContent * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>
override this.CreateOrUpdateTextBlocklistAsync : string * Azure.Core.RequestContent * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>

Public Overridable Function CreateOrUpdateTextBlocklistAsync (blocklistName As String, content As RequestContent, Optional context As RequestContext = Nothing) As Task(Of Response)

Parameters

blocklistName: String

Text blocklist name.

content: RequestContent

The content to send as the body of the request.

context: RequestContext

The request context, which can override default behaviors of the client pipeline on a per-call basis.

Returns

Task<Response>

The response returned from the service.

Exceptions

ArgumentNullException

blocklistName or content is null.

ArgumentException

blocklistName is an empty string, and was expected to be non-empty.

RequestFailedException

Service returned a non-success status code.

Examples

This sample shows how to call CreateOrUpdateTextBlocklistAsync with required parameters and request content, and how to parse the result.

var credential = new AzureKeyCredential("<key>");
var endpoint = new Uri("<https://my-service.azure.com>");
var client = new ContentSafetyClient(endpoint, credential);

var data = new {
    blocklistName = "<blocklistName>",
};

Response response = await client.CreateOrUpdateTextBlocklistAsync("<blocklistName>", RequestContent.Create(data));

JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement;
Console.WriteLine(result.GetProperty("blocklistName").ToString());

This sample shows how to call CreateOrUpdateTextBlocklistAsync with all parameters and request content, and how to parse the result.

var credential = new AzureKeyCredential("<key>");
var endpoint = new Uri("<https://my-service.azure.com>");
var client = new ContentSafetyClient(endpoint, credential);

var data = new {
    blocklistName = "<blocklistName>",
    description = "<description>",
};

Response response = await client.CreateOrUpdateTextBlocklistAsync("<blocklistName>", RequestContent.Create(data), new RequestContext());

JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement;
Console.WriteLine(result.GetProperty("blocklistName").ToString());
Console.WriteLine(result.GetProperty("description").ToString());

Applies to

Share via