EntityRecognitionSkill interface

Package:

@azure/search-documents

Warning

This API is now deprecated.

This skill has been deprecated.

Text analytics entity recognition.

Extends

BaseSearchIndexerSkill

Properties

categories	A list of entity categories that should be extracted.
defaultLanguageCode	A value indicating which language code to use. Default is en.
includeTypelessEntities	Determines whether or not to include entities which are well known but don't conform to a pre-defined type. If this configuration is not set (default), set to null or set to false, entities which don't conform to one of the pre-defined types will not be surfaced.
minimumPrecision	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.
odatatype	Polymorphic discriminator, which specifies the different types this object can be

Inherited Properties

context	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.
description	The description of the skill which describes the inputs, outputs, and usage of the skill.
inputs	Inputs of the skills could be a column in the source data set, or the output of an upstream skill.
name	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 '#'.
outputs	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.

Property Details

categories

A list of entity categories that should be extracted.

categories?: ("location" | "organization" | "person" | "quantity" | "datetime" | "url" | "email")[]

Property Value

("location" | "organization" | "person" | "quantity" | "datetime" | "url" | "email")[]

defaultLanguageCode

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

defaultLanguageCode?: "da" | "de" | "en" | "es" | "fi" | "fr" | "it" | "ko" | "ar" | "cs" | "zh-Hans" | "zh-Hant" | "nl" | "el" | "hu" | "ja" | "no" | "pl" | "pt-PT" | "pt-BR" | "ru" | "sv" | "tr"

Property Value

"da" | "de" | "en" | "es" | "fi" | "fr" | "it" | "ko" | "ar" | "cs" | "zh-Hans" | "zh-Hant" | "nl" | "el" | "hu" | "ja" | "no" | "pl" | "pt-PT" | "pt-BR" | "ru" | "sv" | "tr"

includeTypelessEntities

Determines whether or not to include entities which are well known but don't conform to a pre-defined type. If this configuration is not set (default), set to null or set to false, entities which don't conform to one of the pre-defined types will not be surfaced.

includeTypelessEntities?: boolean

Property Value

boolean

minimumPrecision

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.

minimumPrecision?: number

Property Value

number

odatatype

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

odatatype: "#Microsoft.Skills.Text.EntityRecognitionSkill"

Property Value

"#Microsoft.Skills.Text.EntityRecognitionSkill"

Inherited Property Details

context

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.

context?: string

Property Value

string

Inherited From BaseSearchIndexerSkill.context

description

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

description?: string

Property Value

string

Inherited From BaseSearchIndexerSkill.description

inputs

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

inputs: InputFieldMappingEntry[]

Property Value

InputFieldMappingEntry[]

Inherited From BaseSearchIndexerSkill.inputs

name

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 '#'.

name?: string

Property Value

string

Inherited From BaseSearchIndexerSkill.name

outputs

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.

outputs: OutputFieldMappingEntry[]

Property Value

OutputFieldMappingEntry[]

Inherited From BaseSearchIndexerSkill.outputs