ContentSafetyClient.GetTextBlocklistItem Method

Definition

Namespace:

Azure.AI.ContentSafety

Assembly:

Azure.AI.ContentSafety.dll

Package:

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

Overloads

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

GetTextBlocklistItem(String, String, RequestContext)

Source:

ContentSafetyClient.cs

[Protocol Method] Get BlockItem By blocklistName And blockItemId

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

public virtual Azure.Response GetTextBlocklistItem (string blocklistName, string blockItemId, Azure.RequestContext context);

abstract member GetTextBlocklistItem : string * string * Azure.RequestContext -> Azure.Response
override this.GetTextBlocklistItem : string * string * Azure.RequestContext -> Azure.Response

Public Overridable Function GetTextBlocklistItem (blocklistName As String, blockItemId As String, context As RequestContext) As Response

Parameters

blocklistName

String

Text blocklist name.

blockItemId

String

Block Item Id. It will be uuid.

context

RequestContext

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

Returns

Response

The response returned from the service.

Exceptions

ArgumentNullException

blocklistName or blockItemId is null.

ArgumentException

blocklistName or blockItemId 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 GetTextBlocklistItem 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 = client.GetTextBlocklistItem("<blocklistName>", "<blockItemId>", new RequestContext());

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

GetTextBlocklistItem(String, String, CancellationToken)

Source:

ContentSafetyClient.cs

Get BlockItem By blocklistName And blockItemId.

public virtual Azure.Response<Azure.AI.ContentSafety.TextBlockItem> GetTextBlocklistItem (string blocklistName, string blockItemId, System.Threading.CancellationToken cancellationToken = default);

abstract member GetTextBlocklistItem : string * string * System.Threading.CancellationToken -> Azure.Response<Azure.AI.ContentSafety.TextBlockItem>
override this.GetTextBlocklistItem : string * string * System.Threading.CancellationToken -> Azure.Response<Azure.AI.ContentSafety.TextBlockItem>

Public Overridable Function GetTextBlocklistItem (blocklistName As String, blockItemId As String, Optional cancellationToken As CancellationToken = Nothing) As Response(Of TextBlockItem)

Parameters

blocklistName

String

Text blocklist name.

blockItemId

String

Block Item Id. It will be uuid.

cancellationToken

CancellationToken

The cancellation token to use.

Returns

Response<TextBlockItem>

Exceptions

ArgumentNullException

blocklistName or blockItemId is null.

ArgumentException

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

Examples

This sample shows how to call GetTextBlocklistItem 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 = client.GetTextBlocklistItem("<blocklistName>", "<blockItemId>");

Remarks

Get blockItem By blockItemId from a text blocklist.