knowmax-quest-types/dist/types/IMetadataValueSuggestion.d.ts

Contains type definitions for communicating with Knowmax Quest.

/** Single result from /api/metadatavalue/suggest endpoint. */
export interface IMetadataValueSuggestion {
    /** Identification of metadata when requesting suggestions. Usually in format familylabel.label */
    metadataDefinition: string;
    /** Origin of suggestion. */
    origin: 'Collection' | 'Document' | 'Regular' | 'Octa';
    /** Suggested values for metadata. */
    values: IMetadataValueSuggestionItem[];
}
export interface IMetadataValueSuggestionItem {
    /** Actual value. */
    value: string;
    /** Value with marking of query. */
    highlightedValue: string;
    /** Optional domain value label of selected value in Knowmax Octa. */
    octaDomainValueLabel?: string;
}
//# sourceMappingURL=IMetadataValueSuggestion.d.ts.map