Source code for iamsystem.keywords.api

""" Declare Keyword Interface;"""
from typing import Collection

from typing_extensions import Protocol
from typing_extensions import runtime_checkable


[docs]@runtime_checkable class IKeyword(Protocol): """A string to search in a document (ex: "heart failure").""" label: str
[docs] def get_kb_id(self): """Get the knowledge base id of this keyword.""" raise NotImplementedError
@runtime_checkable class IStoreKeywords(Protocol): @property def keywords(self) -> Collection[IKeyword]: """Get the keywords.""" raise NotImplementedError def add_keyword(self, keyword: IKeyword) -> None: """Add keywords to the store.""" raise NotImplementedError