Miloslav Hub Public API
Veřejné API
Veřejné read-only API poskytuje strojově čitelný přístup k publikovanému obsahu webu Miloslav Hub.
API je určeno pro vývojáře, výzkumné nástroje, externí aplikace a systémy umělé inteligence. Neobsahuje neveřejná data ani interní rozhraní WordPressu a jeho pluginů.
Základní informace
- Verze API
- v1
- Základní URL
-
https://miloslavhub.cz/wp-json/mh/v1/ - Formát
- JSON
- Přístup
- Veřejný, pouze pro čtení
- OpenAPI
- 3.1
OpenAPI specifikace
Aktuální strojově čitelná dokumentace API je dostupná ve formátu OpenAPI 3.1.
Specifikace se generuje dynamicky podle aktuální veřejné struktury webu.
Endpointy
Informace o webu
GET /site
Vrací základní informace o webu a veřejném API.
Typy obsahu
GET /content-types
Vrací aktuální veřejné typy obsahu a jejich taxonomie.
Obsah
GET /content
Vrací publikovaný obsah vybraného veřejného typu.
Příklad:
GET /content?type=prednaskaVyhledávání
GET /search
Prohledává veřejné stránky, příspěvky, přednášky a další veřejné typy obsahu.
Příklad:
GET /search?q=bezpečnostTaxonomie
GET /taxonomies
Vrací katalog veřejných taxonomií nebo termíny konkrétní taxonomie.
Příklad:
GET /taxonomies?taxonomy=tema_prednaskyVeřejná znalostní báze
GET /knowledge-base
Vrací metadata aktuální verze Miloslav Hub Public Knowledge Base, včetně verze datasetu, licence, kontrolního součtu, počtu dokumentů a chunků a odkazů ke stažení.
OpenAPI
GET /openapi
Vrací dynamicky generovanou OpenAPI 3.1 specifikaci veřejného API.
Kanonická adresa:
https://miloslavhub.cz/openapi.jsonVeřejná znalostní báze
Miloslav Hub Public Knowledge Base je samostatně verzovaný dataset určený pro RAG, výzkumné nástroje a další strojové zpracování. Obsahuje pouze položky schválené pro veřejný export.
Aktuální metadata jsou dostupná prostřednictvím endpointu /knowledge-base. Samotný dataset je distribuován jako ZIP
a neobsahuje embeddingy, soukromou znalostní bázi, logy ani autentizační údaje.
Dataset Miloslav Hub Public Knowledge Base je publikován pod licencí Creative Commons Attribution 4.0 International (CC BY 4.0).
Veřejný obsah
API automaticky rozpoznává veřejné typy obsahu dostupné prostřednictvím REST API WordPressu.
Aktuální seznam je možné získat z endpointu /content-types.
U doplňkových polí je použit bezpečnostní whitelist. Nové interní nebo soukromé ACF pole se proto automaticky nezveřejní.
Použití API
Veřejná část API nevyžaduje autentizaci a umožňuje pouze čtení publikovaného obsahu.
Například:
GET https://miloslavhub.cz/wp-json/mh/v1/search?q=AInebo:
GET https://miloslavhub.cz/wp-json/mh/v1/content?type=prednaskaVerzování a kompatibilita
Aktuální veřejná verze API je v1.
Rozšíření, která nenarušují existující rozhraní, mohou být do verze v1 přidávána průběžně.
Změny, které by nebyly zpětně kompatibilní, budou publikovány v nové verzi API.
Podmínky použití
Licence a použití
Licenční podmínky se liší podle toho, zda jde o software, technickou dokumentaci nebo obsah zpřístupněný prostřednictvím API.
GNU Affero General Public License
AGPL-3.0-or-later
Zdrojový kód veřejného API je určen k distribuci pod licencí GNU Affero General Public License, verze 3 nebo novější.
Podmínky GNU AGPL v3Creative Commons Attribution
CC BY 4.0
Dokumentaci veřejného API a jeho OpenAPI specifikaci lze používat podle podmínek licence Creative Commons Attribution 4.0 International.
Podmínky CC BY 4.0Autorská práva k poskytovanému obsahu
Texty, publikace, dokumenty, obrázky, prezentace a další obsah zpřístupněný prostřednictvím API zůstávají pod původními autorskými a licenčními podmínkami jednotlivých zdrojů, není-li u konkrétní položky výslovně uvedeno jinak.
Technické zpřístupnění obsahu prostřednictvím API samo o sobě nepředstavuje udělení licence k jeho dalšímu publikování, rozmnožování nebo šíření.
Další rozvoj
Veřejné API bude postupně rozšiřováno o další datové zdroje a bezpečně zpřístupněné služby Miloslav Hub.
Nové služby budou do dokumentace a OpenAPI specifikace zařazeny až po jejich uvedení do veřejného provozu a po ověření přístupových a bezpečnostních pravidel.
Veřejná znalostní báze je již součástí API prostřednictvím
endpointu /knowledge-base. Generativní RAG služby
zatím veřejně zpřístupněny nejsou.
