API'en understøtter arbejdsforløb til administration af samlinger og dokumenter, behandling af indhold og anvendelse af AI-funktioner som spørgsmål og svar, opsummering, søgning og struktureret udtræk.Brug denne side til at forstå, hvordan disse dele fungerer sammen, og brug derefter API-referencen til implementeringsdetaljer på slutpunktsniveau.
Sørg for, at du har:
Hvis du ikke har konfigureret API-adgang, skal du se Opsæt Knowledge Base API-adgang.
Et typisk Knowledge Base API-arbejdsforløb følger denne rækkefølge:
Godkend → Samling → Dokument → Indeks → Inferens → Svar
En samling definerer det vidensdomæne, din app arbejder med. Når du opretter en samling, inkluderer svaret dens unikke navneområde, som du bruger i efterfølgende operationer.
For eksempel:
{
"namespace": "<collection-namespace>",
"name": "example-collection"
}
Behold samlingsnavneområdet til dokument- og inferensanmodninger.
Dokumenter uploades til samlinger og tildeles unikke dokumentidentifikatorer.
Et uploadsvar identificerer dokumentet, så din app kan spore behandlingen og referere til det i senere anmodninger.
{
"document_id": "<document-id>",
"document_name": "example.pdf"
}
Upload af et dokument og indeksering af det er separate stadier.
Upload overfører filen til Knowledge Base. Indeksering udtrækker indholdet og behandler dette indhold til brug af AI-operationer.
Din app skal bekræfte, at behandlingen er afsluttet, før der sendes inferensanmodninger mod dokumentet.
Inferensoperationer anvender Knowledge Base AI-funktioner på behandlet indhold.
Tilgængelige handlinger omfatter:
Brug API-referencen til at bestemme endepunktet og anmodningsskemaet for den handling, du vil udføre.
Inferenssvar returnerer det genererede resultat og kan inkludere understøttende attribueringsoplysninger.
Afhængigt af handlingen kan attribueringsdata identificere kildeindholdet, siden og koordinaterne, der er knyttet til resultatet. Din app bestemmer, hvordan disse oplysninger præsenteres for brugeren.
Det simpleste apparbejdsforløb er at oprette en samling, tilføje et dokument, vente på behandling og derefter køre en inferenshandling.
Opret den samling, der skal indeholde kildedokumenterne til din app.
Gem navnerummet, der returneres i svaret:
collection_namespace = <returned-namespace>
Du bruger denne værdi, når du tilføjer dokumenter og kører handlinger på samlingen.
Upload et dokument til samlingen og behold det returnerede dokument-ID:
document_id = <returned-document-id>
Dokument-ID'et identificerer det uploadede dokument uafhængigt af dets filnavn.
Start den påkrævede indekshandling, og kontrollér derefter dokumentstatus, indtil behandlingen er fuldført.
Antag ikke, at et vellykket upload betyder, at dokumentet er klar til AI-handlinger.
Et typisk appforløb er:
Upload dokument
↓
Start indeksering
↓
Kontrollér behandlingsstatus
↓
Fuldført
Hvis behandlingen mislykkes, skal du løse dokumentbehandlingsproblemet, før du sender en inferensanmodning.
Når behandling er fuldført, indsend samlingens navneområde, dokument-id og eventuelle handlingsspecifikke input, der kræves af endpunktet.
For eksempel leverer en spørgsmål-svar-anmodning begrebsmæssigt:
Samling: <collection-namespace>
Dokument: <document-id>
Spørgsmål: Hvad er de væsentligste resultater?
Brug API-referencen til det faktiske anmodningsskema.
Brug det returnerede svar eller udtrukne data i din app.
Hvis svaret inkluderer attributoplysninger, kan du bruge det til at forbinde genereret information tilbage til dets understøttende dokumentindhold.
Dokumentets livscyklus påvirker, hvornår din app kan bruge uploadet indhold.
| Stadie | Hvad sker der | App-handling |
|---|---|---|
| Upload | Filen tilføjes til Knowledge Base og får et dokument-id. | Bevar dokument-id'et. |
| Indeksering | Indhold udtrækkes og behandler til AI-brug. | Overvåg dokumentstatus. |
| Fuldfør | Det behandlede Indhold er tilgængeligt til inferens. | Indsend AI-anmodninger. |
| Mislykkedes | Behandling blev ikke fuldført succesfuldt. | Løs fejlen før du fortsætter. |
Denne forskel er særligt vigtig for automatiserede arbejdsforløb. En app bør kontrollere behandlingsstatus i stedet for straks at sende en inferensanmodning efter upload.
Vælg en handling baseret på, hvad din app skal gøre med kildeindholdet.
Brug Q&A til at indsende spørgsmål i naturligt sprog om samlings- eller dokumentindhold.
API'en leverer både streaming og ikke-streaming spørgsmål og svar.
Streaming Q&A returnerer svaret trinvist, efterhånden som det genereres.Brug det, når din brugerflade skal vise genereret indhold progressivt.
Streaming Q&A understøtter også kontrol af, om brugerdefinerede instruktioner anvendes på anmodningen.Du kan også kontrollere, om der generéres begrundelse for et streaming spørgsmål og svar-svar.
Ikke-streaming spørgsmål og svar venter på, at genereringen fuldendes, og returnerer det færdige svar. Brug det, når din app ikke behøver at vise delvist output.
Brug sammenfatning til at generere en komprimeret repræsentation af dokumentets indhold.
API-referencen definerer de aktuelle anmodningskrav og understøttede input.
Brug kontekstsøgning til at hente indhold, der er relevant for den angivne søgetekst.
Dette kan hjælpe applikationer med at identificere relevant kildemateriale uden at generere et samtalesvar.
Brug udtræk, når din app har brug for strukturerede værdier fra dokumentets indhold.
En udtræksdefinition kan identificere oplysninger som:
Egenskabsnavn: contract_value
Type: heltal
Beskrivelse: Aftalens kontraktværdi
Prompt: Udtræk den største aftaleværdi i dollars.
Det returnerede resultat kan omfatte den udtrukne Værdi, tillidsoplysninger og kildehenvisning.
API'en giver flere måder at bestemme, hvilket Indhold der deltager i en anmodning.
Brug samlings- og dokumentidentifikatorer til at definere det primære indhold, der er tilgængeligt for en funktion.
Mærkater er knyttet til dokumenter snarere end samlinger.
Dokumentmærkater er kun tilgængelige gennem Knowledge Base API'en og vises ikke i standardbrugergrænsefladen.
Du kan bruge mærkater med understøttede funktioner til at filtrere de dokumenter, der overvejes til en anmodning. For eksempel kan en applikation tagge en gruppe dokumenter som finansielle dokumenter og begrænse et spørgsmål til dokumenter med det pågældende tag.
Vedhæftede filer er separate fra samlingsdokumenter.
Tilføjelse af en vedhæftet fil til en samtale tilføjer ikke den fil til samlingen. Den vedhæftede fil kan stadig bidrage med kontekst til et genereret svar sammen med samlingsindhold og chathistorik.
Brug endepunkter for vedhæftede filer, når din app har brug for midlertidigt eller samtalespecifikt indhold uden permanent at tilføje det til en samling.
Inferenssvar kan indeholde attribueringsoplysninger, der forbinder genereret output til understøttende kildeindhold.
Attribueringsdata kan indeholde oplysninger som:
API'en leverer disse oplysninger som data. Din app er ansvarlig for at beslutte, hvordan de skal præsenteres.
For eksempel kan en app bruge returnerede koordinater til at bygge en oplevelse med kildemarkering, der identificerer placeringen, som understøtter et genereret svar.
API-operationer bruger de tilladelser, der er tilgængelige for den godkendte identitet.
En anmodning kan mislykkes, hvis den godkendte identitet mangler adgang til samlingen, dokumentet eller den anmodede operation.
Ved fejlfinding:
X-Request-ID identificerer anmodningen på tværs af Knowledge Base-tjenester og kan hjælpe support med at undersøge en mislykket anmodning.
Brug Python-demoen, når du vil have fungerende eksempler, der demonstrerer disse koncepter i en app.
Kom godt i gang med Knowledge Base Python-demoen
Brug API-referencen, når du er klar til at implementere en specifik handling.
