Interface VocabularyService

The public interface of the vocabulary service.

Remarks

Use createVocabularyService to obtain an instance. The service is lazy: domains are loaded on demand via VocabularyService.loadDomain.

Example

const svc = createVocabularyService();
await svc.loadDomain('procurement');
const results = await svc.search('vendor', 'procurement');

interface VocabularyService {
    getFieldSelector(
        term: string,
        domain?: SAPDomain,
    ): Promise<UI5Selector | undefined>;
    getStats(): VocabularyServiceStats;
    getSuggestions(partial: string, maxResults?: number): Promise<string[]>;
    loadDomain(domain: SAPDomain): Promise<void>;
    search(
        query: string,
        domain?: SAPDomain,
    ): Promise<VocabularySearchResult[]>;
}

Index

Methods

getFieldSelector getStats getSuggestions loadDomain search

Methods

getFieldSelector

getFieldSelector(
term: string,
domain?: SAPDomain,
): Promise<UI5Selector | undefined>
Resolve a term to its UI5 selector when confidence is high enough.
Parameters
- term: string
  Term to resolve.
- Optionaldomain: SAPDomain
  Optional domain to restrict resolution to.
Returns Promise<UI5Selector | undefined>
UI5 selector or undefined.
Remarks
Returns undefined when:
- No match reaches the 0.85 threshold.
- Multiple matches score above 0.7 but below 0.85 (ambiguous).
Example
```
const selector = await svc.getFieldSelector('vendor', 'procurement');
```
- Defined in vocabulary/types.ts:189

getStats

getStats(): VocabularyServiceStats
Return current service statistics.

Returns VocabularyServiceStats
Snapshot of loaded domains, term counts, and cache performance.
Example
```
const stats = svc.getStats();
logger.info(stats.totalTerms);
```
- Defined in vocabulary/types.ts:229

getSuggestions

getSuggestions(partial: string, maxResults?: number): Promise<string[]>
Return term name suggestions for a partial query.
Parameters
- partial: string
  Beginning of a term name to complete.
- OptionalmaxResults: number
  Maximum number of suggestions to return (default 10).
Returns Promise<string[]>
Array of matching term names.
Example
```
const suggestions = await svc.getSuggestions('sup');
// ['supplier', 'supplierName', ...]
```
- Defined in vocabulary/types.ts:204

loadDomain

loadDomain(domain: SAPDomain): Promise<void>
Load a SAP domain into memory, enabling search within it.
Parameters
- domain: SAPDomain
  The SAP domain to load.
Returns Promise<void>
Example
```
await svc.loadDomain('finance');
```
- Defined in vocabulary/types.ts:216

search

search(query: string, domain?: SAPDomain): Promise<VocabularySearchResult[]>
Search vocabulary terms matching query.
Parameters
- query: string
  Natural-language search string.
- Optionaldomain: SAPDomain
  Optional domain to restrict search to.
Returns Promise<VocabularySearchResult[]>
Matched terms sorted by confidence descending.
Example
```
const results = await svc.search('supplier');
```
- Defined in vocabulary/types.ts:170