RaiBlocklistItems interface

Package:

@azure/arm-cognitiveservices

Interface representing a RaiBlocklistItems.

Methods

batchAdd(string, string, string, RaiBlocklistItemBulkRequest[], RaiBlocklistItemsBatchAddOptionalParams)	Batch operation to add blocklist items.
batchDelete(string, string, string, string[], RaiBlocklistItemsBatchDeleteOptionalParams)	Batch operation to delete blocklist items.
beginDelete(string, string, string, string, RaiBlocklistItemsDeleteOptionalParams)	Deletes the specified blocklist Item associated with the custom blocklist.
beginDeleteAndWait(string, string, string, string, RaiBlocklistItemsDeleteOptionalParams)	Deletes the specified blocklist Item associated with the custom blocklist.
createOrUpdate(string, string, string, string, RaiBlocklistItem, RaiBlocklistItemsCreateOrUpdateOptionalParams)	Update the state of specified blocklist item associated with the Azure OpenAI account.
get(string, string, string, string, RaiBlocklistItemsGetOptionalParams)	Gets the specified custom blocklist Item associated with the custom blocklist.
list(string, string, string, RaiBlocklistItemsListOptionalParams)	Gets the blocklist items associated with the custom blocklist.

Method Details

batchAdd(string, string, string, RaiBlocklistItemBulkRequest[], RaiBlocklistItemsBatchAddOptionalParams)

Batch operation to add blocklist items.

function batchAdd(resourceGroupName: string, accountName: string, raiBlocklistName: string, raiBlocklistItems: RaiBlocklistItemBulkRequest[], options?: RaiBlocklistItemsBatchAddOptionalParams): Promise<RaiBlocklist>

Parameters

resourceGroupName

string

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

accountName

string

The name of Cognitive Services account.

raiBlocklistName

string

The name of the RaiBlocklist associated with the Cognitive Services Account

raiBlocklistItems

RaiBlocklistItemBulkRequest[]

Properties describing the custom blocklist items.

options

RaiBlocklistItemsBatchAddOptionalParams

The options parameters.

Returns

Promise<RaiBlocklist>

batchDelete(string, string, string, string[], RaiBlocklistItemsBatchDeleteOptionalParams)

Batch operation to delete blocklist items.

function batchDelete(resourceGroupName: string, accountName: string, raiBlocklistName: string, raiBlocklistItemsNames: string[], options?: RaiBlocklistItemsBatchDeleteOptionalParams): Promise<void>

Parameters

resourceGroupName

string

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

accountName

string

The name of Cognitive Services account.

raiBlocklistName

string

The name of the RaiBlocklist associated with the Cognitive Services Account

raiBlocklistItemsNames

string[]

List of RAI Blocklist Items Names.

options

RaiBlocklistItemsBatchDeleteOptionalParams

The options parameters.

Returns

Promise<void>

beginDelete(string, string, string, string, RaiBlocklistItemsDeleteOptionalParams)

Deletes the specified blocklist Item associated with the custom blocklist.

function beginDelete(resourceGroupName: string, accountName: string, raiBlocklistName: string, raiBlocklistItemName: string, options?: RaiBlocklistItemsDeleteOptionalParams): Promise<SimplePollerLike<OperationState<RaiBlocklistItemsDeleteHeaders>, RaiBlocklistItemsDeleteHeaders>>

Parameters

resourceGroupName

string

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

accountName

string

The name of Cognitive Services account.

raiBlocklistName

string

The name of the RaiBlocklist associated with the Cognitive Services Account

raiBlocklistItemName

string

The name of the RaiBlocklist Item associated with the custom blocklist

options

RaiBlocklistItemsDeleteOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<RaiBlocklistItemsDeleteHeaders>, RaiBlocklistItemsDeleteHeaders>>

beginDeleteAndWait(string, string, string, string, RaiBlocklistItemsDeleteOptionalParams)

Deletes the specified blocklist Item associated with the custom blocklist.

function beginDeleteAndWait(resourceGroupName: string, accountName: string, raiBlocklistName: string, raiBlocklistItemName: string, options?: RaiBlocklistItemsDeleteOptionalParams): Promise<RaiBlocklistItemsDeleteHeaders>

Parameters

resourceGroupName

string

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

accountName

string

The name of Cognitive Services account.

raiBlocklistName

string

The name of the RaiBlocklist associated with the Cognitive Services Account

raiBlocklistItemName

string

The name of the RaiBlocklist Item associated with the custom blocklist

options

RaiBlocklistItemsDeleteOptionalParams

The options parameters.

Returns

Promise<RaiBlocklistItemsDeleteHeaders>

createOrUpdate(string, string, string, string, RaiBlocklistItem, RaiBlocklistItemsCreateOrUpdateOptionalParams)

Update the state of specified blocklist item associated with the Azure OpenAI account.

function createOrUpdate(resourceGroupName: string, accountName: string, raiBlocklistName: string, raiBlocklistItemName: string, raiBlocklistItem: RaiBlocklistItem, options?: RaiBlocklistItemsCreateOrUpdateOptionalParams): Promise<RaiBlocklistItem>

Parameters

resourceGroupName

string

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

accountName

string

The name of Cognitive Services account.

raiBlocklistName

string

The name of the RaiBlocklist associated with the Cognitive Services Account

raiBlocklistItemName

string

The name of the RaiBlocklist Item associated with the custom blocklist

raiBlocklistItem

RaiBlocklistItem

Properties describing the custom blocklist.

options

RaiBlocklistItemsCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<RaiBlocklistItem>

get(string, string, string, string, RaiBlocklistItemsGetOptionalParams)

Gets the specified custom blocklist Item associated with the custom blocklist.

function get(resourceGroupName: string, accountName: string, raiBlocklistName: string, raiBlocklistItemName: string, options?: RaiBlocklistItemsGetOptionalParams): Promise<RaiBlocklistItem>

Parameters

resourceGroupName

string

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

accountName

string

The name of Cognitive Services account.

raiBlocklistName

string

The name of the RaiBlocklist associated with the Cognitive Services Account

raiBlocklistItemName

string

The name of the RaiBlocklist Item associated with the custom blocklist

options

RaiBlocklistItemsGetOptionalParams

The options parameters.

Returns

Promise<RaiBlocklistItem>

list(string, string, string, RaiBlocklistItemsListOptionalParams)

Gets the blocklist items associated with the custom blocklist.

function list(resourceGroupName: string, accountName: string, raiBlocklistName: string, options?: RaiBlocklistItemsListOptionalParams): PagedAsyncIterableIterator<RaiBlocklistItem, RaiBlocklistItem[], PageSettings>

Parameters

resourceGroupName

string

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

accountName

string

The name of Cognitive Services account.

raiBlocklistName

string

The name of the RaiBlocklist associated with the Cognitive Services Account

options

RaiBlocklistItemsListOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<RaiBlocklistItem, RaiBlocklistItem[], PageSettings>