DocumentIntelligenceAdministrationClient.DeleteModel Method

Definition

Namespace:

Azure.AI.DocumentIntelligence

Assembly:

Azure.AI.DocumentIntelligence.dll

Package:

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

Source:

DocumentIntelligenceAdministrationClient.cs

[Protocol Method] Deletes document model.

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

public virtual Azure.Response DeleteModel (string modelId, Azure.RequestContext context = default);

abstract member DeleteModel : string * Azure.RequestContext -> Azure.Response
override this.DeleteModel : string * Azure.RequestContext -> Azure.Response

Public Overridable Function DeleteModel (modelId As String, Optional context As RequestContext = Nothing) As 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

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 DeleteModel.

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

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

Console.WriteLine(response.Status);

This sample shows how to call DeleteModel 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 = client.DeleteModel("<modelId>");

Console.WriteLine(response.Status);