ConversationAnalysisClient.CancelAnalyzeConversations Method

Definition

Namespace:

Azure.AI.Language.Conversations

Assembly:

Azure.AI.Language.Conversations.dll

Package:

Azure.AI.Language.Conversations v1.1.0

Source:

ConversationAnalysisClient.cs

[Protocol Method] Cancel a long-running Text Analysis conversations job.

• This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.

public virtual Azure.Operation CancelAnalyzeConversations (Azure.WaitUntil waitUntil, Guid jobId, Azure.RequestContext context = default);

abstract member CancelAnalyzeConversations : Azure.WaitUntil * Guid * Azure.RequestContext -> Azure.Operation
override this.CancelAnalyzeConversations : Azure.WaitUntil * Guid * Azure.RequestContext -> Azure.Operation

Public Overridable Function CancelAnalyzeConversations (waitUntil As WaitUntil, jobId As Guid, Optional context As RequestContext = Nothing) As Operation

Parameters

waitUntil

WaitUntil

Completed if the method should wait to return until the long-running operation has completed on the service; Started if it should return after starting the operation. For more information on long-running operations, please see Azure.Core Long-Running Operation samples.

jobId

Guid

The job ID to cancel.

context

RequestContext

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

Returns

Operation

The Operation representing an asynchronous operation on the service.

Exceptions

RequestFailedException

Service returned a non-success status code.

Examples

This sample shows how to call CancelAnalyzeConversations.

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

Operation operation = client.CancelAnalyzeConversations(WaitUntil.Completed, Guid.Parse("73f411fe-4f43-4b4b-9cbd-6828d8f4cf9a"));

This sample shows how to call CancelAnalyzeConversations with all parameters.

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

Operation operation = client.CancelAnalyzeConversations(WaitUntil.Completed, Guid.Parse("73f411fe-4f43-4b4b-9cbd-6828d8f4cf9a"));

Remarks

Additional information can be found in the service REST API documentation: https://learn.microsoft.com/rest/api/language/2023-04-01/analyze-conversation/cancel-job