DocumentIntelligenceAdministrationClient.DeleteModelAsync Method

Reference

Definition

Namespace:: Azure.AI.DocumentIntelligence

Assembly:: Azure.AI.DocumentIntelligence.dll

Package:: Azure.AI.DocumentIntelligence v1.0.0-beta.3

Source:: DocumentIntelligenceAdministrationClient.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] Deletes document model.

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

public virtual System.Threading.Tasks.Task<Azure.Response> DeleteModelAsync (string modelId, Azure.RequestContext context = default);

abstract member DeleteModelAsync : string * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>
override this.DeleteModelAsync : string * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>

Public Overridable Function DeleteModelAsync (modelId As String, Optional context As RequestContext = Nothing) As Task(Of Response)

Parameters

modelId: String

Unique document model name.

context: RequestContext

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

Returns

Task<Response>

The response returned from the service.

Exceptions

ArgumentNullException

modelId is null.

ArgumentException

modelId is an empty string, and was expected to be non-empty.

RequestFailedException

Service returned a non-success status code.

Examples

This sample shows how to call DeleteModelAsync.

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

Response response = await client.DeleteModelAsync("<modelId>");

Console.WriteLine(response.Status);

This sample shows how to call DeleteModelAsync with all parameters.

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

Response response = await client.DeleteModelAsync("<modelId>");

Console.WriteLine(response.Status);

Applies to

Share via