Package version:

Interface EntityRecognitionSkillV3

Using the Text Analytics API, extracts entities of different types from text.

interface EntityRecognitionSkillV3 {
    categories?: string[];
    context?: string;
    defaultLanguageCode?: string;
    description?: string;
    inputs: InputFieldMappingEntry[];
    minimumPrecision?: number;
    modelVersion?: string;
    name?: string;
    odatatype: "#Microsoft.Skills.Text.V3.EntityRecognitionSkill";
    outputs: OutputFieldMappingEntry[];
}

Hierarchy (view full)

Properties

categories? context? defaultLanguageCode? description? inputs minimumPrecision? modelVersion? name? odatatype outputs

Properties

Optionalcategories

categories?: string[]

A list of entity categories that should be extracted.

Optionalcontext

context?: string

Represents the level at which operations take place, such as the document root or document content (for example, /document or /document/content). The default is /document.

OptionaldefaultLanguageCode

defaultLanguageCode?: string

A value indicating which language code to use. Default is en.

Optionaldescription

description?: string

The description of the skill which describes the inputs, outputs, and usage of the skill.

inputs

inputs: InputFieldMappingEntry[]

Inputs of the skills could be a column in the source data set, or the output of an upstream skill.

OptionalminimumPrecision

minimumPrecision?: number

A value between 0 and 1 that be used to only include entities whose confidence score is greater than the value specified. If not set (default), or if explicitly set to null, all entities will be included.

OptionalmodelVersion

modelVersion?: string

The version of the model to use when calling the Text Analytics API. It will default to the latest available when not specified. We recommend you do not specify this value unless absolutely necessary.

Optionalname

name?: string

The name of the skill which uniquely identifies it within the skillset. A skill with no name defined will be given a default name of its 1-based index in the skills array, prefixed with the character '#'.

odatatype

odatatype

Polymorphic discriminator, which specifies the different types this object can be

outputs

outputs: OutputFieldMappingEntry[]

The output of a skill is either a field in a search index, or a value that can be consumed as an input by another skill.

Settings

Member Visibility