ConversationAnalysisClient.CancelAnalyzeConversations Method

Reference

Definition

Namespace:: Azure.AI.Language.Conversations

Assembly:: Azure.AI.Language.Conversations.dll

Package:: Azure.AI.Language.Conversations v1.1.0

Source:: ConversationAnalysisClient.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

[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

Job ID.

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 with required parameters.

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

var operation = client.CancelAnalyzeConversations(WaitUntil.Completed, Guid.NewGuid());

Console.WriteLine(operation.GetRawResponse().Status);

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

Applies to

Aracılığıyla paylaş