ConversationAuthoringClient.GetTrainedModel Method

Definition

Namespace:

Azure.AI.Language.Conversations.Authoring

Assembly:

Azure.AI.Language.Conversations.dll

Package:

Azure.AI.Language.Conversations v1.1.0

Source:

ConversationAuthoringClient.cs

[Protocol Method] Gets the details of a trained model.

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

public virtual Azure.Response GetTrainedModel (string projectName, string trainedModelLabel, Azure.RequestContext context = default);

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

Public Overridable Function GetTrainedModel (projectName As String, trainedModelLabel As String, Optional context As RequestContext = Nothing) As Response

Parameters

projectName

String

The name of the project to use.

trainedModelLabel

String

The trained model label.

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

projectName or trainedModelLabel is null.

ArgumentException

projectName or trainedModelLabel 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 GetTrainedModel with required parameters and parse the result.

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

Response response = client.GetTrainedModel("<projectName>", "<trainedModelLabel>");

JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement;
Console.WriteLine(result.GetProperty("label").ToString());
Console.WriteLine(result.GetProperty("modelId").ToString());
Console.WriteLine(result.GetProperty("lastTrainedDateTime").ToString());
Console.WriteLine(result.GetProperty("lastTrainingDurationInSeconds").ToString());
Console.WriteLine(result.GetProperty("modelExpirationDate").ToString());
Console.WriteLine(result.GetProperty("modelTrainingConfigVersion").ToString());
Console.WriteLine(result.GetProperty("hasSnapshot").ToString());

Remarks

Additional information can be found in the service REST API documentation: https://learn.microsoft.com/rest/api/language/2023-04-01/conversational-analysis-authoring/get-trained-model