DocumentIntelligenceAdministrationClient.GetModelsAsync Method

Definition

Namespace:

Azure.AI.DocumentIntelligence

Assembly:

Azure.AI.DocumentIntelligence.dll

Package:

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

Overloads

GetModelsAsync(RequestContext)	[Protocol Method] List all document models This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. Please try the simpler GetModelsAsync(CancellationToken) convenience overload with strongly typed models first.
GetModelsAsync(CancellationToken)	List all document models.

GetModelsAsync(RequestContext)

Source:

DocumentIntelligenceAdministrationClient.cs

[Protocol Method] List all document models

• This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
• Please try the simpler GetModelsAsync(CancellationToken) convenience overload with strongly typed models first.

public virtual Azure.AsyncPageable<BinaryData> GetModelsAsync (Azure.RequestContext context);

abstract member GetModelsAsync : Azure.RequestContext -> Azure.AsyncPageable<BinaryData>
override this.GetModelsAsync : Azure.RequestContext -> Azure.AsyncPageable<BinaryData>

Public Overridable Function GetModelsAsync (context As RequestContext) As AsyncPageable(Of BinaryData)

Parameters

context

RequestContext

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

Returns

AsyncPageable<BinaryData>

The AsyncPageable<T> from the service containing a list of BinaryData objects. Details of the body schema for each item in the collection are in the Remarks section below.

Exceptions

RequestFailedException

Service returned a non-success status code.

Examples

This sample shows how to call GetModelsAsync and parse the result.

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

await foreach (BinaryData item in client.GetModelsAsync(null))
{
    JsonElement result = JsonDocument.Parse(item.ToStream()).RootElement;
    Console.WriteLine(result.GetProperty("modelId").ToString());
    Console.WriteLine(result.GetProperty("createdDateTime").ToString());
}

This sample shows how to call GetModelsAsync with all parameters and parse the result.

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

await foreach (BinaryData item in client.GetModelsAsync(null))
{
    JsonElement result = JsonDocument.Parse(item.ToStream()).RootElement;
    Console.WriteLine(result.GetProperty("modelId").ToString());
    Console.WriteLine(result.GetProperty("description").ToString());
    Console.WriteLine(result.GetProperty("createdDateTime").ToString());
    Console.WriteLine(result.GetProperty("expirationDateTime").ToString());
    Console.WriteLine(result.GetProperty("apiVersion").ToString());
    Console.WriteLine(result.GetProperty("tags").GetProperty("<key>").ToString());
    Console.WriteLine(result.GetProperty("buildMode").ToString());
    Console.WriteLine(result.GetProperty("azureBlobSource").GetProperty("containerUrl").ToString());
    Console.WriteLine(result.GetProperty("azureBlobSource").GetProperty("prefix").ToString());
    Console.WriteLine(result.GetProperty("azureBlobFileListSource").GetProperty("containerUrl").ToString());
    Console.WriteLine(result.GetProperty("azureBlobFileListSource").GetProperty("fileList").ToString());
    Console.WriteLine(result.GetProperty("classifierId").ToString());
    Console.WriteLine(result.GetProperty("split").ToString());
    Console.WriteLine(result.GetProperty("docTypes").GetProperty("<key>").GetProperty("description").ToString());
    Console.WriteLine(result.GetProperty("docTypes").GetProperty("<key>").GetProperty("buildMode").ToString());
    Console.WriteLine(result.GetProperty("docTypes").GetProperty("<key>").GetProperty("fieldSchema").GetProperty("<key>").GetProperty("type").ToString());
    Console.WriteLine(result.GetProperty("docTypes").GetProperty("<key>").GetProperty("fieldSchema").GetProperty("<key>").GetProperty("description").ToString());
    Console.WriteLine(result.GetProperty("docTypes").GetProperty("<key>").GetProperty("fieldSchema").GetProperty("<key>").GetProperty("example").ToString());
    Console.WriteLine(result.GetProperty("docTypes").GetProperty("<key>").GetProperty("fieldSchema").GetProperty("<key>").GetProperty("items").GetProperty("type").ToString());
    Console.WriteLine(result.GetProperty("docTypes").GetProperty("<key>").GetProperty("fieldSchema").GetProperty("<key>").GetProperty("items").GetProperty("description").ToString());
    Console.WriteLine(result.GetProperty("docTypes").GetProperty("<key>").GetProperty("fieldSchema").GetProperty("<key>").GetProperty("items").GetProperty("example").ToString());
    Console.WriteLine(result.GetProperty("docTypes").GetProperty("<key>").GetProperty("fieldSchema").GetProperty("<key>").GetProperty("properties").GetProperty("<key>").GetProperty("type").ToString());
    Console.WriteLine(result.GetProperty("docTypes").GetProperty("<key>").GetProperty("fieldSchema").GetProperty("<key>").GetProperty("properties").GetProperty("<key>").GetProperty("description").ToString());
    Console.WriteLine(result.GetProperty("docTypes").GetProperty("<key>").GetProperty("fieldSchema").GetProperty("<key>").GetProperty("properties").GetProperty("<key>").GetProperty("example").ToString());
    Console.WriteLine(result.GetProperty("docTypes").GetProperty("<key>").GetProperty("fieldSchema").GetProperty("<key>").GetProperty("properties").GetProperty("<key>").GetProperty("items").GetProperty("type").ToString());
    Console.WriteLine(result.GetProperty("docTypes").GetProperty("<key>").GetProperty("fieldSchema").GetProperty("<key>").GetProperty("properties").GetProperty("<key>").GetProperty("items").GetProperty("description").ToString());
    Console.WriteLine(result.GetProperty("docTypes").GetProperty("<key>").GetProperty("fieldSchema").GetProperty("<key>").GetProperty("properties").GetProperty("<key>").GetProperty("items").GetProperty("example").ToString());
    Console.WriteLine(result.GetProperty("docTypes").GetProperty("<key>").GetProperty("fieldConfidence").GetProperty("<key>").ToString());
    Console.WriteLine(result.GetProperty("docTypes").GetProperty("<key>").GetProperty("modelId").ToString());
    Console.WriteLine(result.GetProperty("docTypes").GetProperty("<key>").GetProperty("confidenceThreshold").ToString());
    Console.WriteLine(result.GetProperty("docTypes").GetProperty("<key>").GetProperty("features")[0].ToString());
    Console.WriteLine(result.GetProperty("docTypes").GetProperty("<key>").GetProperty("queryFields")[0].ToString());
    Console.WriteLine(result.GetProperty("docTypes").GetProperty("<key>").GetProperty("maxDocumentsToAnalyze").ToString());
    Console.WriteLine(result.GetProperty("warnings")[0].GetProperty("code").ToString());
    Console.WriteLine(result.GetProperty("warnings")[0].GetProperty("message").ToString());
    Console.WriteLine(result.GetProperty("warnings")[0].GetProperty("target").ToString());
    Console.WriteLine(result.GetProperty("trainingHours").ToString());
}

GetModelsAsync(CancellationToken)

Source:

DocumentIntelligenceAdministrationClient.cs

List all document models.

public virtual Azure.AsyncPageable<Azure.AI.DocumentIntelligence.DocumentModelDetails> GetModelsAsync (System.Threading.CancellationToken cancellationToken = default);

abstract member GetModelsAsync : System.Threading.CancellationToken -> Azure.AsyncPageable<Azure.AI.DocumentIntelligence.DocumentModelDetails>
override this.GetModelsAsync : System.Threading.CancellationToken -> Azure.AsyncPageable<Azure.AI.DocumentIntelligence.DocumentModelDetails>

Public Overridable Function GetModelsAsync (Optional cancellationToken As CancellationToken = Nothing) As AsyncPageable(Of DocumentModelDetails)

Parameters

cancellationToken

CancellationToken

The cancellation token to use.

Returns

AsyncPageable<DocumentModelDetails>

Examples

This sample shows how to call GetModelsAsync.

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

await foreach (DocumentModelDetails item in client.GetModelsAsync())
{
}

This sample shows how to call GetModelsAsync with all parameters.

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

await foreach (DocumentModelDetails item in client.GetModelsAsync())
{
}