Compartilhar via


TextAnalysisModelFactory.NamedEntityWithMetadata Method

Definition

Initializes a new instance of NamedEntityWithMetadata.

public static Azure.AI.Language.Text.NamedEntityWithMetadata NamedEntityWithMetadata (string text = default, string category = default, string subcategory = default, int offset = 0, int length = 0, double confidenceScore = 0, string type = default, System.Collections.Generic.IEnumerable<Azure.AI.Language.Text.EntityTag> tags = default, Azure.AI.Language.Text.BaseMetadata metadata = default);
static member NamedEntityWithMetadata : string * string * string * int * int * double * string * seq<Azure.AI.Language.Text.EntityTag> * Azure.AI.Language.Text.BaseMetadata -> Azure.AI.Language.Text.NamedEntityWithMetadata
Public Shared Function NamedEntityWithMetadata (Optional text As String = Nothing, Optional category As String = Nothing, Optional subcategory As String = Nothing, Optional offset As Integer = 0, Optional length As Integer = 0, Optional confidenceScore As Double = 0, Optional type As String = Nothing, Optional tags As IEnumerable(Of EntityTag) = Nothing, Optional metadata As BaseMetadata = Nothing) As NamedEntityWithMetadata

Parameters

text
String

Entity text as appears in the request.

category
String

Entity type.

subcategory
String

(Optional) Entity sub type.

offset
Int32

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

length
Int32

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

confidenceScore
Double

Confidence score between 0 and 1 of the extracted entity.

type
String

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.

tags
IEnumerable<EntityTag>

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

metadata
BaseMetadata

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.

Returns

A new NamedEntityWithMetadata instance for mocking.

Applies to