ContentSafetyClient.GetTextBlocklistAsync Method

Definition

Namespace:

Azure.AI.ContentSafety

Assembly:

Azure.AI.ContentSafety.dll

Package:

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

Overloads

GetTextBlocklistAsync(String, RequestContext)	[Protocol Method] Get Text Blocklist By blocklistName This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. Please try the simpler GetTextBlocklistAsync(String, CancellationToken) convenience overload with strongly typed models first.
GetTextBlocklistAsync(String, CancellationToken)	Get Text Blocklist By blocklistName.

GetTextBlocklistAsync(String, RequestContext)

Source:

ContentSafetyClient.cs

[Protocol Method] Get Text Blocklist By blocklistName

• This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
• Please try the simpler GetTextBlocklistAsync(String, CancellationToken) convenience overload with strongly typed models first.

public virtual System.Threading.Tasks.Task<Azure.Response> GetTextBlocklistAsync (string blocklistName, Azure.RequestContext context);

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

Public Overridable Function GetTextBlocklistAsync (blocklistName As String, context As RequestContext) As Task(Of Response)

Parameters

blocklistName

String

Text blocklist name.

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 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 GetTextBlocklistAsync with required parameters and parse the result.

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

Response response = await client.GetTextBlocklistAsync("<blocklistName>", new RequestContext());

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

GetTextBlocklistAsync(String, CancellationToken)

Source:

ContentSafetyClient.cs

Get Text Blocklist By blocklistName.

public virtual System.Threading.Tasks.Task<Azure.Response<Azure.AI.ContentSafety.TextBlocklist>> GetTextBlocklistAsync (string blocklistName, System.Threading.CancellationToken cancellationToken = default);

abstract member GetTextBlocklistAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.AI.ContentSafety.TextBlocklist>>
override this.GetTextBlocklistAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.AI.ContentSafety.TextBlocklist>>

Public Overridable Function GetTextBlocklistAsync (blocklistName As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of TextBlocklist))

Parameters

blocklistName

String

Text blocklist name.

cancellationToken

CancellationToken

The cancellation token to use.

Returns

Task<Response<TextBlocklist>>

Exceptions

ArgumentNullException

blocklistName is null.

ArgumentException

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

Examples

This sample shows how to call GetTextBlocklistAsync with required parameters.

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

var result = await client.GetTextBlocklistAsync("<blocklistName>");

Remarks

Returns text blocklist details.