Share via

ConversationsModelFactory.ConversationalAIEntity Method

Definition

Namespace:
Azure.AI.Language.Conversations
Assembly:
Azure.AI.Language.Conversations.dll
Package:
Azure.AI.Language.Conversations v2.0.0-beta.5
Source:
ConversationsModelFactory.cs

Initializes a new instance of ConversationalAIEntity.

public static Azure.AI.Language.Conversations.Models.ConversationalAIEntity ConversationalAIEntity(string name = default, string text = default, float confidenceScore = 0, int offset = 0, int length = 0, string conversationItemId = default, int? conversationItemIndex = default, System.Collections.Generic.IEnumerable<Azure.AI.Language.Conversations.Models.ResolutionBase> resolutions = default, System.Collections.Generic.IEnumerable<Azure.AI.Language.Conversations.Models.ConversationEntityExtraInformation> extraInformation = default);
static member ConversationalAIEntity : string * string * single * int * int * string * Nullable<int> * seq<Azure.AI.Language.Conversations.Models.ResolutionBase> * seq<Azure.AI.Language.Conversations.Models.ConversationEntityExtraInformation> -> Azure.AI.Language.Conversations.Models.ConversationalAIEntity
Public Shared Function ConversationalAIEntity (Optional name As String = Nothing, Optional text As String = Nothing, Optional confidenceScore As Single = 0, Optional offset As Integer = 0, Optional length As Integer = 0, Optional conversationItemId As String = Nothing, Optional conversationItemIndex As Nullable(Of Integer) = Nothing, Optional resolutions As IEnumerable(Of ResolutionBase) = Nothing, Optional extraInformation As IEnumerable(Of ConversationEntityExtraInformation) = Nothing) As ConversationalAIEntity

Parameters

name
String

The entity name or category.

text
String

The detected text of the entity.

confidenceScore
Single

The confidence score of the entity detection (0.0 to 1.0).

offset
Int32

The starting index of the entity in the query.

length
Int32

The length of the detected entity text.

conversationItemId
String

The ID of the conversation item where the entity appears.

conversationItemIndex
Nullable<Int32>

The index of the conversation item where the entity appears.

resolutions
IEnumerable<ResolutionBase>

Entity resolution details, if available. Please note ResolutionBase is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include AgeResolution, AreaResolution, BooleanResolution, CurrencyResolution, DateTimeResolution, InformationResolution, LengthResolution, NumberResolution, NumericRangeResolution, OrdinalResolution, SpeedResolution, TemperatureResolution, TemporalSpanResolution, VolumeResolution and WeightResolution.

extraInformation
IEnumerable<ConversationEntityExtraInformation>

Additional entity metadata. Please note ConversationEntityExtraInformation is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include EntitySubtype, ListKey and RegexKey.

Returns

ConversationalAIEntity

A new ConversationalAIEntity instance for mocking.

Applies to