De API ondersteunt workflows voor het beheren van collecties en documenten, het verwerken van content en het toepassen van AI-mogelijkheden zoals het beantwoorden van vragen, samenvatting, zoekopdracht en gestructureerde extractie.Gebruik deze pagina om te begrijpen hoe die onderdelen samenwerken, en gebruik vervolgens de API-referentie voor implementatiedetails op eindpunt-Niveau.
Zorg ervoor dat je het volgende hebt:
Als je nog geen API-toegang hebt geconfigureerd, raadpleeg dan Stel Knowledge Base-API-toegang in.
Een typische Knowledge Base-API-workflow volgt deze volgorde:
Authenticeren → Collectie → Document → Index → Inferentie → Reactie
Een collectie definieert het kennisdomein waarmee je applicatie werkt.Wanneer je een collectie maakt, bevat de reactie de unieke namespace die je gebruikt in volgende bewerkingen.
Bijvoorbeeld:
{
"namespace": "<collection-namespace>",
"name": "example-collection"
}
Behoud de collectie-namespace voor document- en inferentieverzoeken.
Documenten worden geüpload naar collecties en krijgen unieke documentidentificatoren toegewezen.
Een upload-reactie identificeert het document zodat je applicatie de verwerking kan bijhouden en ernaar kan verwijzen in latere verzoeken.
{
"document_id": "<document-id>",
"document_name": "example.pdf"
}
Het uploaden van een document en het indexeren ervan zijn afzonderlijke fasen.
Uploaden draagt het bestand over naar Knowledge Base.Indexering extraheert de content en verwerkt die content voor gebruik door AI-bewerkingen.
Je applicatie moet bevestigen dat de verwerking is voltooid voordat inferentieverzoeken worden ingediend tegen het document.
Inferentiebewerkingen passen Knowledge Base-AI-mogelijkheden toe op verwerkte content.
Beschikbare bewerkingen omvatten:
Gebruik de API-referentie om het eindpunt en het aanvraagschema te bepalen voor de bewerking die je wilt uitvoeren.
Inference-reacties geven het gegenereerde resultaat terug en kunnen ondersteunende attributie-informatie bevatten.
Afhankelijk van de bewerking kunnen attributiegegevens de broncontent, pagina en coördinaten identificeren die zijn gekoppeld aan het resultaat.Jouw applicatie bepaalt hoe die informatie aan de gebruiker wordt gepresenteerd.
De eenvoudigste applicatieworkflow is een verzameling maken, een document toevoegen, wachten tot de verwerking is voltooid en vervolgens een inference-bewerking uitvoeren.
Maak de verzameling die de brondocumenten voor jouw applicatie zal bevatten.
Bewaar de namespace die in de reactie wordt geretourneerd:
collection_namespace = <returned-namespace>
Je gebruikt deze waarde bij het toevoegen van documenten en het uitvoeren van bewerkingen op de verzameling.
Upload een document naar de verzameling en bewaar het geretourneerde document-ID:
document_id = <returned-document-id>
Het document-ID identificeert het geüploade document onafhankelijk van de bestandsnaam.
Start de vereiste indexeringsbewerking en controleer vervolgens de documentstatus totdat de verwerking is voltooid.
Ga er niet van uit dat een geslaagde upload betekent dat het document gereed is voor AI-bewerkingen.
Een typische applicatieflow is:
Document uploaden
↓
Indexering starten
↓
Verwerkingsstatus controleren
↓
Voltooid
Als verwerken mislukt, los dan het documentverwerkingsprobleem op voordat je een inference-verzoek indient.
Nadat de verwerking is voltooid, verstuur je de verzamelingsnaamruimte, document-ID en eventuele bewerkingsspecifieke invoer die vereist is voor het eindpunt.
Een vraag-beantwoordverzoek levert bijvoorbeeld conceptueel:
Collectie: <collection-namespace>
Document: <document-id>
Vraag: Wat zijn de belangrijkste bevindingen?
Gebruik de API-referentie voor het daadwerkelijke aanvraagschema.
Gebruik het geretourneerde antwoord of geëxtraheerde gegevens in je applicatie.
Als de reactie attributie-informatie bevat, kun je deze gebruiken om gegenereerde informatie te verbinden met de ondersteunende documentinhoud.
De levenscyclus van documenten beïnvloedt wanneer je applicatie geüploade content kan gebruiken.
| Fase | Wat gebeurt er | Applicatieactie |
|---|---|---|
| Uploaden | Het bestand wordt toegevoegd aan Knowledge Base en krijgt een document-ID. | Bewaar de document-ID. |
| Indexeren | Inhoud wordt geëxtraheerd en verwerkt voor AI-gebruik. | Documentstatus monitoren. |
| Voltooien | De verwerkte inhoud is beschikbaar voor inferentie. | AI-verzoeken versturen. |
| Mislukt | Verwerking is niet succesvol voltooid. | Los de fout op voordat je verdergaat. |
Dit onderscheid is vooral belangrijk voor geautomatiseerde workflows. Een applicatie moet de verwerkingsstatus controleren in plaats van direct een inferentieverzoek te versturen na het uploaden.
Kies een bewerking op basis van wat je applicatie moet doen met de broninhoud.
Gebruik Q&A om natuurlijke taalvragen te stellen over collectie- of documentinhoud.
De API biedt zowel streaming als non-streaming Q&A.
Streaming Q&A retourneert de reactie stapsgewijs terwijl deze wordt gegenereerd. Gebruik dit wanneer je interface gegenereerd content geleidelijk moet weergeven.
Streaming Q&A ondersteunt ook het regelen of Aangepaste instructies worden toegepast op het verzoek. Je kunt ook regelen of redenering wordt gegenereerd voor een streaming Q&A-reactie.
Non-streaming Q&A wacht tot het genereren is voltooid en retourneert de voltooide reactie. Gebruik dit wanneer je applicatie geen gedeeltelijke uitvoer hoeft weer te geven.
Gebruik samenvatting om een beknopte weergave van documentcontent te genereren.
De API-referentie definieert de huidige verzoekeisen en ondersteunde invoer.
Gebruik context search om content op te halen die relevant is voor de opgegeven zoektekst.
Dit kan applicaties helpen relevant bronmateriaal te identificeren zonder een gespreksreactie te genereren.
Gebruik extractie wanneer je applicatie gestructureerde waarden van documentcontent nodig heeft.
Een extractiedefinitie kan informatie identificeren zoals:
Eigenschapsnaam: contract_value
Type: integer
Beschrijving: Overeenkomst contractwaarde
Opdracht: Haal de grootste overeenkomstwaarde in dollars.
Het geretourneerde resultaat kan de geëxtraheerde waarde, betrouwbaarheidsinformatie en bronattributie bevatten.
De API biedt verschillende manieren om te bepalen welke content deelneemt aan een verzoek.
Gebruik verzamelings- en documentidentificatoren om de primaire content te definiëren die beschikbaar is voor een operatie.
Tags zijn gekoppeld aan documenten in plaats van verzamelingen.
Document tags zijn alleen beschikbaar via de Knowledge Base API en worden niet weergegeven in de standaard gebruikersinterface.
Je kunt tags gebruiken met ondersteunde operaties om de documenten te filteren die worden overwogen voor een verzoek. Een applicatie kan bijvoorbeeld een groep documenten labelen als financiële documenten en een vraag beperken tot documenten die dat label dragen.
Bijlagen zijn gescheiden van collectiedocumenten.
Door een bijlage aan een gesprek toe te voegen, wordt dat bestand niet aan de collectie toegevoegd.De bijlage kan nog steeds context bieden aan een gegenereerde reactie, samen met verzamelingscontent en chatgeschiedenis.
Gebruik bijlageeindpunten wanneer je applicatie tijdelijke of gespreksspecifieke content nodig heeft zonder deze permanent aan een collectie toe te voegen.
Inferentieresponses kunnen attributie-informatie bevatten die gegenereerde output verbindt met ondersteunende broncontent.
Attributiegegevens kunnen informatie bevatten zoals:
De API verstrekt deze informatie als gegevens.Je applicatie is verantwoordelijk voor hoe je die presenteert.
Een applicatie kan bijvoorbeeld geretourneerde coördinaten gebruiken om een bronmarkering-ervaring te bouwen die de locatie identificeert die een gegenereerd antwoord ondersteunt.
API-bewerkingen gebruiken de machtigingen die beschikbaar zijn voor de geverifieerde identiteit.
Een verzoek kan mislukken als de geauthenticeerde identiteit geen toegang heeft tot de collectie, het document of de bewerking die wordt aangevraagd.
Bij het oplossen van problemen:
De X-Request-ID identificeert het verzoek in Knowledge Base-services en kan Support helpen bij het onderzoeken van een mislukt verzoek.
Gebruik de Python Demo wanneer je werkende voorbeelden wilt die deze concepten in een applicatie demonstreren.
Aan de slag met de Knowledge Base Python Demo
Gebruik de API-referentie wanneer je klaar bent om een specifieke bewerking te implementeren.
