API:et stöder arbetsflöden för att hantera samlingar och dokument, bearbeta innehåll och tillämpa AI-funktioner som frågor och svar, sammanfattning, sökning och strukturerad extrahering.Använd den här sidan för att förstå hur dessa delar fungerar tillsammans och använd sedan API-referensen för implementeringsdetaljer på slutpunktsnivå.
Se till att du har:
Om du inte har konfigurerat API-åtkomst, se Konfigurera Knowledge Base API-åtkomst.
Ett typiskt arbetsflöde för API:et Knowledge Base följer denna sekvens:
Autentisering → Samling → Dokument → Index → Inferens → Svar
En samling definierar kunskapsdomänen som din applikation arbetar med.När du skapar en samling innehåller svaret dess unika namnrymd, som du använder i efterföljande operationer.
Till exempel:
{
"namespace": "<collection-namespace>",
"name": "example-collection"
}
Behåll samlingens namnrymd för dokument- och slutledningsförfrågningar.
Dokument laddas upp till samlingar och får unika dokumentidentifierare.
Ett uppladdningssvar identifierar dokumentet så att din applikation kan spåra bearbetningen och referera till det i senare förfrågningar.
{
"document_id": "<document-id>",
"document_name": "example.pdf"
}
Att ladda upp ett dokument och indexera det är separata stadier.
Uppladdning överför filen till Knowledge Base.Indexering extraherar dess innehåll och bearbetar detta innehåll för användning av AI-operationer.
Din applikation bör bekräfta att bearbetningen har slutförts innan slutledningsförfrågningar skickas mot dokumentet.
Slutledningsoperationer tillämpar AI-funktioner från Knowledge Base på bearbetat innehåll.
Tillgängliga åtgärder inkluderar:
Använd API-referensen för att fastställa slutpunkten och begäranschemat för den åtgärd du vill utföra.
Inferenssvar returnerar det genererade resultatet och kan inkludera stödjande attributionsinformation.
Beroende på åtgärden kan attributionsdata identifiera källinnehållet, sidan och koordinaterna som är associerade med resultatet.Din applikation bestämmer hur den informationen presenteras för användaren.
Det enklaste applikationsarbetsflödet är att skapa en samling, lägga till ett dokument, vänta på bearbetning och sedan köra en inferensåtgärd.
Skapa samlingen som kommer att innehålla källdokumenten för ditt program.
Behåll namnområdet som returneras i svaret:
collection_namespace = <returned-namespace>
Du använder detta värde när du lägger till dokument och anropar åtgärder mot samlingen.
Ladda upp ett dokument till samlingen och behåll det returnerade dokument-ID:t:
document_id = <returned-document-id>
Dokument-ID:t identifierar det uppladdade dokumentet oberoende av dess filnamn.
Starta den nödvändiga indexeringsåtgärden och kontrollera sedan dokumentets status tills bearbetningen är klar.
Anta inte att en lyckad uppladdning betyder att dokumentet är redo för AI-åtgärder.
Ett typiskt applikationsflöde är:
Ladda upp dokument
↓
Starta indexering
↓
Kontrollera bearbetningsstatus
↓
Klart
Om bearbetningen misslyckas, lös problemet med dokumentbearbetningen innan du skickar en inferensbegäran.
När bearbetningen är klar skickar du samlingsnamnområdet, dokument-ID:t och eventuell operationsspecifik indata som krävs av slutpunkten.
Till exempel tillhandahåller en fråga-svar-förfrågan konceptuellt:
Samling: <collection-namespace>
Dokument: <document-id>
Fråga: Vilka är huvudresultaten?
Använd API-referensen för det faktiska begärансchemat.
Använd det returnerade svaret eller extraherade data i din applikation.
Om svaret inkluderar tillskrivningsinformation kan du använda den för att koppla genererad information tillbaka till dess stödjande dokumentinnehåll.
Dokumentets livscykel påverkar när din applikation kan använda uppladdat innehåll.
| Steg | Vad händer | Applikationsåtgärd |
|---|---|---|
| Ladda upp | Filen läggs till i Kunskapsbas och får ett dokument-ID. | Behåll dokument-ID:t. |
| Indexering | Innehåll extraheras och bearbetas för AI-användning. | Övervaka dokumentstatus. |
| Fullständig | Det bearbetade innehållet är tillgängligt för inferens. | Skicka AI-förfrågningar. |
| Misslyckades | Bearbetningen slutfördes inte framgångsrikt. | Lös felet innan du fortsätter. |
Denna skillnad är särskilt viktig för automatiserade arbetsflöden. En applikation bör kontrollera bearbetningsstatus snarare än att omedelbart skicka en inference-begäran efter uppladdning.
Välj en operation baserat på vad din applikation behöver göra med källinnehållet.
Använd frågor och svar för att skicka frågor på naturligt språk om samlings- eller dokumentinnehåll.
API:et tillhandahåller både streaming och icke-streaming Q&A.
Streaming Q&A returnerar svaret stegvis när det genereras. Använd det när ditt gränssnitt ska visa genererat innehåll progressivt.
Streaming Q&A stöder också kontroll av om anpassade instruktioner tillämpas på begäran. Du kan också kontrollera om resonemang genereras för ett strömnings-Q&A-svar.
Icke-streaming Q&A väntar på att genereringen ska slutföras och returnerar det färdiga svaret. Använd det när din applikation inte behöver visa partiell utdata.
Använd sammanfattning för att generera en komprimerad representation av dokumentinnehåll.
API-referensen definierar aktuella krav på begäranden och vilka indata som stöds.
Använd kontextsökning för att hämta innehåll som är relevant för den angivna söktexten.
Detta kan hjälpa applikationer att identifiera relevant källmaterial utan att generera ett konversationssvar.
Använd extrahering när ditt program behöver strukturerade värden från dokumentinnehåll.
En extraheringsdefinition kan identifiera information som:
Egenskapsnamn: contract_value
Typ: heltal
Beskrivning: Avtalsvärde
Prompt: Extrahera det största avtalsvärdet i dollar.
Det returnerade resultatet kan inkludera det extraherade värdet, konfidenssinformation och källattribuering.
API:et erbjuder flera sätt att bestämma vilket Innehåll som deltar i en begäran.
Använd samlings- och dokumentidentifierare för att definiera det primära innehåll som är tillgängligt för en operation.
Taggar associeras med dokument snarare än samlingar.
Dokumenttaggar är endast tillgängliga genom Knowledge Base-API:et och exponeras inte i standardanvändargränssnittet.
Du kan använda taggar med stödda operationer för att filtrera de dokument som beaktas för en begäran. Till exempel kan en applikation tagga en grupp dokument som ekonomiska dokument och begränsa en fråga till dokument som har den taggen.
Bilagor är separata från samlingsdokument.
Att lägga till en bilaga till en konversation lägger inte till den filen till samlingen. Bilagan kan fortfarande bidra med sammanhang till ett genererat svar, tillsammans med samlingsinnehåll och chatthistorik.
Använd bilagesluttpunkter när din applikation behöver tillfälligt eller konversationsspecifikt innehåll utan att permanent lägga till det till en samling.
Slutledningssvar kan inkludera attribueringsinformation som kopplar genererad utdata till stödjande källinnehåll.
Attribueringsdata kan inkludera information som:
API:t tillhandahåller denna information som data. Din applikation ansvarar för att bestämma hur den ska presenteras.
Till exempel kan en applikation använda returnerade koordinater för att bygga en källmarkeringsupplevelse som identifierar platsen som stöder ett genererat svar.
API-operationer använder behörigheterna som är tillgängliga för den autentiserade identiteten.
En begäran kan misslyckas om den autentiserade identiteten saknar åtkomst till samlingen, dokumentet eller åtgärden som begärs.
Vid felsökning:
X-Request-ID identifierar begäran över Knowledge Base-tjänster och kan hjälpa supporten att undersöka en misslyckad begäran.
Använd Python-demon när du vill ha fungerande exempel som demonstrerar dessa koncept i en applikation.
Kom igång med Knowledge Base Python-demon
Använd API-referensen när du är redo att implementera en specifik åtgärd.
