API podporuje pracovní postupy pro správu kolekcí a dokumentů, zpracování obsahu a využití schopností AI, jako jsou zodpovídání otázek, shrnutí, vyhledávání a strukturovaná extrakce.Tuto stránku použijte k pochopení, jak tyto části spolupracují, poté použijte API referenci pro implementační detaily na úrovni koncových bodů.
Ujistěte se, že máte:
Pokud jste nenakonfigurovali přístup k API, přečtěte si část Nastavení přístupu k API Knowledge Base.
Typický pracovní postup rozhraní API Knowledge Base probíhá v tomto pořadí:
Autentizace → Kolekce → Dokument → Index → Inference → Odpověď
Kolekce definuje znalostní doménu, se kterou vaše aplikace pracuje.Když vytvoříte kolekci, odpověď obsahuje její jedinečný namespace, který použijete v následujících operacích.
Například:
{
"namespace": "<collection-namespace>",
"name": "example-collection"
}
Zachovejte namespace kolekce pro požadavky na dokumenty a inference.
Dokumenty jsou nahrány do kolekcí a přiřazeny jedinečné identifikátory dokumentů.
Odpověď nahrání identifikuje dokument, aby vaše aplikace mohla sledovat zpracování a odkazovat na něj v pozdějších požadavcích.
{
"document_id": "<document-id>",
"document_name": "example.pdf"
}
Nahrání dokumentu a jeho indexování jsou oddělené fáze.
Nahrání přenáší soubor do Knowledge Base.Indexování extrahuje jeho obsah a zpracovává tento obsah pro použití AI operacemi.
Vaše aplikace by měla potvrdit, že zpracování bylo dokončeno před odesláním inferenčních požadavků pro daný dokument.
Inference operace aplikují AI schopnosti Knowledge Base na zpracovaný obsah.
K dispozici jsou tyto operace:
Pomocí referenční dokumentace API určete koncový bod a schéma požadavku pro operaci, kterou chcete provést.
Odpovědi inference vrátí generovaný výsledek a mohou zahrnovat podpůrné informace o atribuci.
V závislosti na operaci mohou data atribuce identifikovat zdrojový obsah, stránku a souřadnice spojené s výsledkem.Vaše aplikace určuje, jak jsou tyto informace prezentovány uživateli.
Nejjednodušší pracovní postup aplikace je vytvoření kolekce, přidání dokumentu, čekání na zpracování a následné spuštění operace inference.
Vytvořte kolekci, která bude obsahovat zdrojové dokumenty pro vaši aplikaci.
Pamatujte si namespace vrácený v odpovědi:
collection_namespace = <returned-namespace>
Tuto hodnotu použijete při přidávání dokumentů a vyvolávání operací nad kolekcí.
Nahrajte dokument do kolekce a uchovejte si vrácené ID dokumentu:
document_id = <vrácené-id-dokumentu>
ID dokumentu identifikuje nahraný dokument nezávisle na jeho názvu souboru.
Spusťte požadovanou operaci indexování a poté kontrolujte stav dokumentu, dokud se zpracování nedokončí.
Nepředpokládejte, že úspěšné nahrání znamená, že dokument je připraven pro AI operace.
Typický průběh aplikace je:
Nahrání dokumentu
↓
Spuštění indexování
↓
Kontrola stavu zpracování
↓
Dokončení
Pokud zpracování selže, vyřešte problém zpracování dokumentu před odesláním požadavku na odvozování.
Po dokončení zpracování odešlete jmenný prostor kolekce, ID dokumentu a jakýkoli vstup specifický pro danou operaci, který vyžaduje koncový bod.
Například požadavek na zodpovězení otázky koncepčně poskytuje:
Kolekce: <collection-namespace>
Dokument: <document-id>
Otázka: Jaká jsou klíčová zjištění?
Pro skutečné schéma požadavku použijte referenci API.
Použijte vrácenou odpověď nebo extrahovaná data ve své aplikaci.
Pokud odpověď obsahuje informace o atribuci, můžete je použít k propojení generovaných informací zpět k jejich podpůrnému obsahu dokumentu.
Životní cyklus dokumentu ovlivňuje, kdy může vaše aplikace použít nahraný obsah.
| Fáze | Co se stane | Akce aplikace |
|---|---|---|
| Nahrát | Soubor je přidán do Knowledge Base a obdrží ID dokumentu. | Ponechte si ID dokumentu. |
| Vytváření indexu | Obsah je extrahován a zpracován pro použití AI. | Sledovat stav dokumentu. |
| Dokončit | Zpracovaný obsah je k dispozici pro odvozování. | Odeslat požadavky AI. |
| Neúspěch | Zpracování nebylo úspěšně dokončeno. | Vyřešte selhání před pokračováním. |
Toto rozlišení je obzvláště důležité pro automatizované pracovní postupy. Aplikace by měla zkontrolovat stav zpracování namísto okamžitého odeslání požadavku na odvozování po nahrání.
Vyberte operaci na základě toho, co vaše aplikace potřebuje dělat se zdrojovým obsahem.
Pomocí Q&A můžete pokládat přírodní otázky o obsahu kolekce nebo dokumentu.
API poskytuje streamované i nestreamované Q&A.
Streamované Q&A vrací odpověď postupně během generování. Použijte je, když by vaše rozhraní mělo zobrazovat generovaný obsah postupně.
Streamované Q&A také podporuje řízení toho, zda se na požadavek aplikují vlastní pokyny. Můžete také řídit, zda se pro streamovanou Q&A odpověď generuje odůvodnění.
Nestreamované Q&A čeká na dokončení generování a vrací hotovou odpověď. Použijte je, když aplikace nepotřebuje zobrazovat částečný výstup.
Použijte sumarizaci pro generování kondenzovaného zobrazení obsahu dokumentu.
Referenční dokumentace API definuje aktuální požadavky na žádosti a podporované vstupy.
Použijte kontextové vyhledávání pro načtení obsahu relevantního k zadanému vyhledávacímu textu.
To může pomoci aplikacím identifikovat relevantní zdrojový materiál bez generování konverzační odpovědi.
Použijte extrakci, když aplikace potřebuje strukturované hodnoty z obsahu dokumentu.
Definice extrakce může identifikovat informace jako:
Název vlastnosti: contract_value
Typ: integer
Popis: Hodnota smlouvy o dohodě
Pokyn: Extrahujte nejvyšší hodnotu dohody v dolarech.
Vrácený výsledek může obsahovat extrahovanou hodnotu, informace o míře jistoty a přiřazení zdroje.
API poskytuje několik způsobů, jak určit, který obsah se účastní požadavku.
Použijte identifikátory kolekce a dokumentu pro definování primárního obsahu dostupného pro operaci.
Značky jsou spojené s dokumenty spíše než s kolekcemi.
Značky dokumentů jsou dostupné pouze prostřednictvím API Knowledge Base a nejsou vystavené ve standardním uživatelském rozhraní.
Pomocí značek s podporovanými operacemi můžete filtrovat dokumenty, které se mají zohlednit v požadavku.Například aplikace může označit skupinu dokumentů jako finanční dokumenty a omezit otázku na dokumenty obsahující danou značku.
Přílohy jsou oddělené od dokumentů kolekce.
Přidání přílohy do konverzace nepřidá daný soubor do kolekce. Příloha může i nadále přispívat kontextem k vygenerované odpovědi spolu s obsahem kolekce a historií chatu.
Použijte koncové body příloh, když vaše aplikace potřebuje dočasný nebo specifický obsah pro konverzaci bez trvalého přidání do kolekce.
Inferenční odpovědi mohou obsahovat informace o atribuci, které propojují vygenerovaný výstup s podpůrným zdrojovým obsahem.
Data atribuce mohou zahrnovat informace jako:
API poskytuje tyto informace jako data. Vaše aplikace je zodpovědná za rozhodnutí, jak je prezentovat.
Například aplikace může použít vrácené souřadnice k vytvoření funkce zvýrazňování zdroje, která identifikuje umístění podporující vygenerovanou odpověď.
Operace API používají oprávnění dostupná pro ověřenou identitu.
Požadavek může selhat, pokud ověřená identita nemá přístup ke kolekci, dokumentu nebo operaci, která je požadována.
Při odstraňování potíží:
X-Request-ID identifikuje požadavek napříč službami Knowledge Base a může pomoci podpoře při vyšetřování neúspěšného požadavku.
Použijte Python Demo, když chcete funkční příklady, které demonstrují tyto koncepty v aplikaci.
Začínáme s Knowledge Base Python Demo
Použijte API referenci, když jste připraveni implementovat konkrétní operaci.
