Skip to main content
Version: 1.x

Interface: VocabularySearchResult

Defined in: src/vocabulary/types.ts:113

A single search result returned by VocabularyService.search.

Example​

const result: VocabularySearchResult = {
  term: 'supplier',
  synonyms: ['vendor', 'vendorId'],
  confidence: 0.95,
  domain: 'procurement',
  sapField: 'LIFNR',
  selector: { controlType: 'sap.m.Input' },
};

Properties​

confidence​

readonly confidence: number

Defined in: src/vocabulary/types.ts:119

Confidence score from 0.0 (no match) to 1.0 (exact match).

domain​

readonly domain: SAPDomain

Defined in: src/vocabulary/types.ts:121

The SAP domain in which the match was found.

sapField?​

readonly optional sapField: string

Defined in: src/vocabulary/types.ts:123

SAP ABAP field name if available.

selector?​

readonly optional selector: UI5Selector

Defined in: src/vocabulary/types.ts:125

UI5 selector for the matched term if available.

synonyms​

readonly synonyms: string[]

Defined in: src/vocabulary/types.ts:117

Synonyms of the matched term.

term​

readonly term: string

Defined in: src/vocabulary/types.ts:115

The matched canonical term name.