ConversationAuthoringClient.GetSupportedPrebuiltEntitiesAsync Method

Reference

Definition

Namespace:: Azure.AI.Language.Conversations.Authoring

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

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

Source:: ConversationAuthoringClient.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] Lists the supported prebuilt entities that can be used while creating composed entities.

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

public virtual Azure.AsyncPageable<BinaryData> GetSupportedPrebuiltEntitiesAsync (string language = default, bool? multilingual = default, Azure.RequestContext context = default);

abstract member GetSupportedPrebuiltEntitiesAsync : string * Nullable<bool> * Azure.RequestContext -> Azure.AsyncPageable<BinaryData>
override this.GetSupportedPrebuiltEntitiesAsync : string * Nullable<bool> * Azure.RequestContext -> Azure.AsyncPageable<BinaryData>

Public Overridable Function GetSupportedPrebuiltEntitiesAsync (Optional language As String = Nothing, Optional multilingual As Nullable(Of Boolean) = Nothing, Optional context As RequestContext = Nothing) As AsyncPageable(Of BinaryData)

Parameters

language: String

The language to get supported prebuilt entities for. Required if multilingual is false. This is BCP-47 representation of a language. For example, use "en" for English, "en-gb" for English (UK), "es" for Spanish etc.

multilingual: Nullable<Boolean>

Whether to get the support prebuilt entities for multilingual or monolingual projects. If true, the language parameter is ignored.

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 GetSupportedPrebuiltEntitiesAsync and parse the result.

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

await foreach (var item in client.GetSupportedPrebuiltEntitiesAsync())
{
    JsonElement result = JsonDocument.Parse(item.ToStream()).RootElement;
    Console.WriteLine(result.GetProperty("category").ToString());
    Console.WriteLine(result.GetProperty("description").ToString());
    Console.WriteLine(result.GetProperty("examples").ToString());
}

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

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

await foreach (var item in client.GetSupportedPrebuiltEntitiesAsync("<language>", true))
{
    JsonElement result = JsonDocument.Parse(item.ToStream()).RootElement;
    Console.WriteLine(result.GetProperty("category").ToString());
    Console.WriteLine(result.GetProperty("description").ToString());
    Console.WriteLine(result.GetProperty("examples").ToString());
}

Remarks

Additional information can be found in the service REST API documentation: https://video2.skills-academy.com/rest/api/language/2023-04-01/conversational-analysis-authoring/get-supported-prebuilt-entities

Applies to

Share via