Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface Skill

Package version

Abstract base class for skills.

Hierarchy

  • Skill

Index

Properties

Optional context

context: undefined | 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.

Optional description

description: undefined | string

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.

Optional name

name: undefined | 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: "Skill"

Polymorphic Discriminator

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.

Generated using TypeDoc