ConversationalAIEntity Class
Definition
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.
The entity associated with this intent.
public class ConversationalAIEntity : System.ClientModel.Primitives.IJsonModel<Azure.AI.Language.Conversations.Models.ConversationalAIEntity>, System.ClientModel.Primitives.IPersistableModel<Azure.AI.Language.Conversations.Models.ConversationalAIEntity>type ConversationalAIEntity = class
interface IJsonModel<ConversationalAIEntity>
interface IPersistableModel<ConversationalAIEntity>Public Class ConversationalAIEntity
Implements IJsonModel(Of ConversationalAIEntity), IPersistableModel(Of ConversationalAIEntity)- Inheritance
-
ConversationalAIEntity
- Implements
Properties
| ConfidenceScore |
The confidence score of the entity detection (0.0 to 1.0). |
| ConversationItemId |
The ID of the conversation item where the entity appears. |
| ConversationItemIndex |
The index of the conversation item where the entity appears. |
| ExtraInformation |
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. |
| Length |
The length of the detected entity text. |
| Name |
The entity name or category. |
| Offset |
The starting index of the entity in the query. |
| Resolutions |
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. |
| Text |
The detected text of the entity. |
Methods
| JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions) |
Explicit Interface Implementations
| IJsonModel<ConversationalAIEntity>.Create(Utf8JsonReader, ModelReaderWriterOptions) |
Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model. |
| IJsonModel<ConversationalAIEntity>.Write(Utf8JsonWriter, ModelReaderWriterOptions) |
Writes the model to the provided Utf8JsonWriter. |
| IPersistableModel<ConversationalAIEntity>.Create(BinaryData, ModelReaderWriterOptions) |
Converts the provided BinaryData into a model. |
| IPersistableModel<ConversationalAIEntity>.GetFormatFromOptions(ModelReaderWriterOptions) |
Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service. |
| IPersistableModel<ConversationalAIEntity>.Write(ModelReaderWriterOptions) |
Writes the model into a BinaryData. |
