RaiBlocklists interface
Interface representing a RaiBlocklists.
Methods
| begin |
Deletes the specified custom blocklist associated with the Azure OpenAI account. |
| begin |
Deletes the specified custom blocklist associated with the Azure OpenAI account. |
| create |
Update the state of specified blocklist associated with the Azure OpenAI account. |
| get(string, string, string, Rai |
Gets the specified custom blocklist associated with the Azure OpenAI account. |
| list(string, string, Rai |
Gets the custom blocklists associated with the Azure OpenAI account. |
Method Details
beginDelete(string, string, string, RaiBlocklistsDeleteOptionalParams)
Deletes the specified custom blocklist associated with the Azure OpenAI account.
function beginDelete(resourceGroupName: string, accountName: string, raiBlocklistName: string, options?: RaiBlocklistsDeleteOptionalParams): Promise<SimplePollerLike<OperationState<RaiBlocklistsDeleteHeaders>, RaiBlocklistsDeleteHeaders>>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
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<RaiBlocklistsDeleteHeaders>, RaiBlocklistsDeleteHeaders>>
beginDeleteAndWait(string, string, string, RaiBlocklistsDeleteOptionalParams)
Deletes the specified custom blocklist associated with the Azure OpenAI account.
function beginDeleteAndWait(resourceGroupName: string, accountName: string, raiBlocklistName: string, options?: RaiBlocklistsDeleteOptionalParams): Promise<RaiBlocklistsDeleteHeaders>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
The options parameters.
Returns
Promise<RaiBlocklistsDeleteHeaders>
createOrUpdate(string, string, string, RaiBlocklist, RaiBlocklistsCreateOrUpdateOptionalParams)
Update the state of specified blocklist associated with the Azure OpenAI account.
function createOrUpdate(resourceGroupName: string, accountName: string, raiBlocklistName: string, raiBlocklist: RaiBlocklist, options?: RaiBlocklistsCreateOrUpdateOptionalParams): 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
- raiBlocklist
- RaiBlocklist
Properties describing the custom blocklist.
The options parameters.
Returns
Promise<RaiBlocklist>
get(string, string, string, RaiBlocklistsGetOptionalParams)
Gets the specified custom blocklist associated with the Azure OpenAI account.
function get(resourceGroupName: string, accountName: string, raiBlocklistName: string, options?: RaiBlocklistsGetOptionalParams): 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
- options
- RaiBlocklistsGetOptionalParams
The options parameters.
Returns
Promise<RaiBlocklist>
list(string, string, RaiBlocklistsListOptionalParams)
Gets the custom blocklists associated with the Azure OpenAI account.
function list(resourceGroupName: string, accountName: string, options?: RaiBlocklistsListOptionalParams): PagedAsyncIterableIterator<RaiBlocklist, RaiBlocklist[], PageSettings>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- accountName
-
string
The name of Cognitive Services account.
- options
- RaiBlocklistsListOptionalParams
The options parameters.