NamedEntityWithMetadata Class

  • Reference

Definition

Namespace:
Azure.AI.Language.Text
Assembly:
Azure.AI.Language.Text.dll
Package:
Azure.AI.Language.Text v1.0.0-beta.1

Entity object with tags and metadata.

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

Properties

Category

Entity type.
ConfidenceScore

Confidence score between 0 and 1 of the extracted entity.
Length

Length for the entity text. Use of different 'stringIndexType' values can affect the length returned.
Metadata

The entity metadata object. Please note BaseMetadata 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 AgeMetadata, AreaMetadata, CurrencyMetadata, DateMetadata, DateTimeMetadata, InformationMetadata, LengthMetadata, NumberMetadata, NumericRangeMetadata, OrdinalMetadata, SpeedMetadata, TemperatureMetadata, TemporalSetMetadata, TemporalSpanMetadata, TimeMetadata, VolumeMetadata and WeightMetadata.
Offset

Start position for the entity text. Use of different 'stringIndexType' values can affect the offset returned.
Subcategory

(Optional) Entity sub type.
Tags

List of entity tags. Tags are to express some similarities/affinity between entities.
Text

Entity text as appears in the request.
Type

An entity type is the lowest (or finest) granularity at which the entity has been detected. The type maps to the specific metadata attributes associated with the entity detected.

Explicit Interface Implementations

IJsonModel<NamedEntityWithMetadata>.Create(Utf8JsonReader, ModelReaderWriterOptions)

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

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

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

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

Writes the model into a BinaryData.

Applies to