ConversationEntity Class

  • Reference

Definition

Namespace:
Azure.AI.Language.Conversations.Models
Assembly:
Azure.AI.Language.Conversations.dll
Package:
Azure.AI.Language.Conversations v2.0.0-beta.1

The entity extraction result of a Conversation project.

public class ConversationEntity : System.ClientModel.Primitives.IJsonModel<Azure.AI.Language.Conversations.Models.ConversationEntity>, System.ClientModel.Primitives.IPersistableModel<Azure.AI.Language.Conversations.Models.ConversationEntity>
type ConversationEntity = class
    interface IJsonModel<ConversationEntity>
    interface IPersistableModel<ConversationEntity>
Public Class ConversationEntity
Implements IJsonModel(Of ConversationEntity), IPersistableModel(Of ConversationEntity)
Inheritance
Object
ConversationEntity
Implements
IJsonModel<ConversationEntity> IPersistableModel<ConversationEntity> IPersistableModel<T>

Properties

Category

The entity category.
Confidence

The entity confidence score.
ExtraInformation

The collection of entity extra information objects. 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 text.
Offset

The starting index of this entity in the query.
Resolutions

The collection of entity resolution objects. 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 predicted entity text.

Explicit Interface Implementations

IJsonModel<ConversationEntity>.Create(Utf8JsonReader, ModelReaderWriterOptions)

Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.
IJsonModel<ConversationEntity>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.
IPersistableModel<ConversationEntity>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.
IPersistableModel<ConversationEntity>.GetFormatFromOptions(ModelReaderWriterOptions)

Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.
IPersistableModel<ConversationEntity>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

Applies to