RaiTopics interface
Interface representing a RaiTopics.
Methods
| begin |
Deletes the specified custom topic associated with the Azure OpenAI account. |
| begin |
Deletes the specified custom topic associated with the Azure OpenAI account. |
| create |
Create the rai topic associated with the Azure OpenAI account. |
| get(string, string, string, Rai |
Gets the specified custom topic associated with the Azure OpenAI account. |
| list(string, string, Rai |
Gets the custom topics associated with the Azure OpenAI account. |
Method Details
beginDelete(string, string, string, RaiTopicsDeleteOptionalParams)
Deletes the specified custom topic associated with the Azure OpenAI account.
function beginDelete(resourceGroupName: string, accountName: string, raiTopicName: string, options?: RaiTopicsDeleteOptionalParams): Promise<SimplePollerLike<OperationState<RaiTopicsDeleteHeaders>, RaiTopicsDeleteHeaders>>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- accountName
-
string
The name of Cognitive Services account.
- raiTopicName
-
string
The name of the Rai Topic associated with the Cognitive Services Account
- options
- RaiTopicsDeleteOptionalParams
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<RaiTopicsDeleteHeaders>, RaiTopicsDeleteHeaders>>
beginDeleteAndWait(string, string, string, RaiTopicsDeleteOptionalParams)
Deletes the specified custom topic associated with the Azure OpenAI account.
function beginDeleteAndWait(resourceGroupName: string, accountName: string, raiTopicName: string, options?: RaiTopicsDeleteOptionalParams): Promise<RaiTopicsDeleteHeaders>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- accountName
-
string
The name of Cognitive Services account.
- raiTopicName
-
string
The name of the Rai Topic associated with the Cognitive Services Account
- options
- RaiTopicsDeleteOptionalParams
The options parameters.
Returns
Promise<RaiTopicsDeleteHeaders>
createOrUpdate(string, string, string, RaiTopic, RaiTopicsCreateOrUpdateOptionalParams)
Create the rai topic associated with the Azure OpenAI account.
function createOrUpdate(resourceGroupName: string, accountName: string, raiTopicName: string, raiTopic: RaiTopic, options?: RaiTopicsCreateOrUpdateOptionalParams): Promise<RaiTopic>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- accountName
-
string
The name of Cognitive Services account.
- raiTopicName
-
string
The name of the Rai Topic associated with the Cognitive Services Account
- raiTopic
- RaiTopic
Properties describing the rai topic.
The options parameters.
Returns
Promise<RaiTopic>
get(string, string, string, RaiTopicsGetOptionalParams)
Gets the specified custom topic associated with the Azure OpenAI account.
function get(resourceGroupName: string, accountName: string, raiTopicName: string, options?: RaiTopicsGetOptionalParams): Promise<RaiTopic>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- accountName
-
string
The name of Cognitive Services account.
- raiTopicName
-
string
The name of the Rai Topic associated with the Cognitive Services Account
- options
- RaiTopicsGetOptionalParams
The options parameters.
Returns
Promise<RaiTopic>
list(string, string, RaiTopicsListOptionalParams)
Gets the custom topics associated with the Azure OpenAI account.
function list(resourceGroupName: string, accountName: string, options?: RaiTopicsListOptionalParams): PagedAsyncIterableIterator<RaiTopic, RaiTopic[], PageSettings>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- accountName
-
string
The name of Cognitive Services account.
- options
- RaiTopicsListOptionalParams
The options parameters.