Interface: VocabularyService

Defined in: domain/contracts.ts:568

Lookup of SKOS concept schemes and concepts.

Methods

getMaterializedIndex()

getMaterializedIndex(): Promise<MaterializedVocabularyIndex>;

Defined in: domain/contracts.ts:614

Returns the materialized index backing this service.

Returns

Promise<MaterializedVocabularyIndex>

---

listConcepts()

listConcepts(input): Promise<VocabularyListResult<VocabularyConceptSummary>>;

Defined in: domain/contracts.ts:577

Lists concepts in one scheme.

Parameters

Parameter	Type
input	{ includeDescendants?: boolean; locale?: string; page?: number; pageSize?: number; parentUri?: string; schemeUri: string; }
input.includeDescendants?	boolean
input.locale?	string
input.page?	number
input.pageSize?	number
input.parentUri?	string
input.schemeUri	string

Returns

Promise<VocabularyListResult<VocabularyConceptSummary>>

---

listSchemes()

listSchemes(input?): Promise<VocabularyListResult<VocabularySchemeSummary>>;

Defined in: domain/contracts.ts:570

Lists concept schemes, optionally filtered by query.

Parameters

Parameter	Type
input?	{ page?: number; pageSize?: number; query?: string; }
input.page?	number
input.pageSize?	number
input.query?	string

Returns

Promise<VocabularyListResult<VocabularySchemeSummary>>

---

resolveFieldVocabulary()

resolveFieldVocabulary(input): Promise<FieldVocabularyBinding | null>;

Defined in: domain/contracts.ts:617

Returns the vocabulary binding for a field in a profile, or null if the field has none.

Parameters

Parameter	Type
input	{ fieldPath: string; profile: DocumentProfile; }
input.fieldPath	string
input.profile	DocumentProfile

Returns

Promise<FieldVocabularyBinding | null>

---

resolveTerm()

resolveTerm(input): Promise<VocabularyConceptSummary | null>;

Defined in: domain/contracts.ts:608

Looks up a concept by URI. Resolves to null if it is not known.

Parameters

Parameter	Type
input	{ locale?: string; term: string; }
input.locale?	string
input.term	string

Returns

Promise<VocabularyConceptSummary | null>

---

searchConcepts()

searchConcepts(input): Promise<VocabularyListResult<VocabularyConceptSummary>>;

Defined in: domain/contracts.ts:587

Searches concepts by label across one or more schemes.

Parameters

Parameter	Type
input	{ includeDescendants?: boolean; locale?: string; page?: number; pageSize?: number; parentUri?: string; query: string; schemeUris?: string[]; }
input.includeDescendants?	boolean
input.locale?	string
input.page?	number
input.pageSize?	number
input.parentUri?	string
input.query	string
input.schemeUris?	string[]

Returns

Promise<VocabularyListResult<VocabularyConceptSummary>>

---

suggestConcepts()

suggestConcepts(input): Promise<VocabularyConceptSummary[]>;

Defined in: domain/contracts.ts:598

Returns up to limit concepts that match query, for autocomplete.

Parameters

Parameter	Type
input	{ includeDescendants?: boolean; limit?: number; locale?: string; parentUri?: string; query: string; schemeUris?: string[]; }
input.includeDescendants?	boolean
input.limit?	number
input.locale?	string
input.parentUri?	string
input.query	string
input.schemeUris?	string[]

Returns

Promise<VocabularyConceptSummary[]>