API-et støtter arbeidsflyter for å administrere samlinger og dokumenter, behandle innhold og anvende KI-funksjoner som spørsmål og svar, sammendrag, søk og strukturert uttrekk.Bruk denne siden til å forstå hvordan disse delene fungerer sammen, og bruk deretter API-referansen for implementeringsdetaljer på endepunktnivå.
Sørg for at du har:
Hvis du ikke har konfigurert API-tilgang, se Konfigurer Knowledge Base API-tilgang.
En typisk Knowledge Base API-arbeidsflyt følger denne sekvensen:
Autentisering → Samling → Dokument → Indeks → Inferens → Respons
En samling definerer kunnskapsdomenet applikasjonen din arbeider med.Når du oppretter en samling, inkluderer responsen det unike navneområdet, som du bruker i påfølgende operasjoner.
For eksempel:
{
"namespace": "<collection-namespace>",
"name": "example-collection"
}
Behold samlingens navneområde for dokument- og inferensforespørsler.
Dokumenter lastes opp til samlinger og tildeles unike dokumentidentifikatorer.
En opplastingsrespons identifiserer dokumentet slik at applikasjonen din kan spore behandlingen og referere til det i senere forespørsler.
{
"document_id": "<document-id>",
"document_name": "example.pdf"
}
Å laste opp et dokument og indeksere det er separate stadier.
Opplasting overfører filen til Knowledge Base.Indeksering trekker ut innholdet og behandler det innholdet for bruk av KI-operasjoner.
Applikasjonen din bør bekrefte at behandlingen er fullført før den sender inferensforespørsler mot dokumentet.
Inferensoperasjoner anvender Knowledge Base KI-funksjoner på behandlet innhold.
Tilgjengelige operasjoner inkluderer:
Bruk API-referansen til å bestemme endepunktet og forespørselsskjemaet for operasjonen du vil utføre.
Inferanseresponser returnerer det genererte resultatet og kan inkludere støttende attribusjonsinformasjon.
Avhengig av operasjonen kan attribusjonsdata identifisere kildeinnholdet, siden og koordinatene som er knyttet til resultatet.Applikasjonen din bestemmer hvordan denne informasjonen presenteres for brukeren.
Den enkleste applikasjonsarbeidsflyten er å opprette en samling, legge til et dokument, vente på behandling og deretter kjøre en inferensoperasjon.
Opprett samlingen som skal inneholde kildedokumentene for applikasjonen din.
Behold navneområdet som returneres i responsen:
collection_namespace = <returned-namespace>
Du bruker denne verdien når du legger til dokumenter og påkaller operasjoner mot samlingen.
Last opp et dokument til samlingen og behold den returnerte dokument-IDen:
document_id = <returnert-dokument-ID>
Dokument-IDen identifiserer det opplastede dokumentet uavhengig av filnavnet.
Start den nødvendige indekseringsoperasjonen, og kontroller deretter dokumentstatusen til behandlingen er fullført.
Ikke anta at en vellykket opplasting betyr at dokumentet er klart for KI-operasjoner.
En typisk applikasjonsflyt er:
Last opp dokument
↓
Start indeksering
↓
Sjekk behandlingsstatus
↓
Fullført
Hvis behandlingen mislykkes, løs problemet med dokumentbehandlingen før du sender inn en inferanseforespørsel.
Når behandlingen er ferdig, send inn samlingens navneområde, dokument-ID og eventuelle operasjonsspesifikke inndata som kreves av endepunktet.
For eksempel leverer en spørsmål-svar-forespørsel konseptuelt:
Samling: <collection-namespace>
Dokument: <document-id>
Spørsmål: Hva er hovedfunnene?
Bruk API-referansen for det faktiske forespørselsskjemaet.
Bruk det returnerte svaret eller ekstraherte dataene i appen din.
Hvis svaret inkluderer attribusjonsinformasjon, kan du bruke den til å koble generert informasjon tilbake til det støttende dokumentinnholdet.
Dokumentets livssyklus påvirker når appen din kan bruke opplastet innhold.
| Trinn | Hva som skjer | Applikasjonshandling |
|---|---|---|
| Last opp | Filen legges til i Knowledge Base og får en dokument-ID. | Behold dokument-ID-en. |
| Indeksering | Innhold ekstraheres og behandles for KI-bruk. | Overvåk dokumentstatus. |
| Fullfør | Det behandlede innholdet er tilgjengelig for inferens. | Send KI-forespørsler. |
| Mislykket | Behandlingen ble ikke fullført. | Løs feilen før du fortsetter. |
Dette skillet er spesielt viktig for automatiserte arbeidsflyter.En app bør sjekke behandlingsstatus i stedet for å sende en inferensforespørsel umiddelbart etter opplasting.
Velg en operasjon basert på hva appen din trenger å gjøre med kildeinnholdet.
Bruk spørsmål og svar til å sende naturlige spørsmål om samlings- eller dokumentinnhold.
API-et gir både strømming og ikke-strømming Q&A.
Strømmende Q&A returnerer svaret trinnvis når det genereres.Bruk det når grensesnittet ditt skal vise generert innhold gradvis.
Strømming Q&A støtter også kontroll av om tilpassede instruksjoner brukes på forespørselen. Du kan også kontrollere om resonnering genereres for et strømmende Q&A-svar.
Ikke-strømming Q&A venter til genereringen er fullført og returnerer det ferdige svaret. Bruk det når applikasjonen din ikke trenger å vise delvis utdata.
Bruk sammendrag for å generere en komprimert representasjon av dokumentinnhold.
API-referansen definerer gjeldende krav til forespørsler og støttede inndata.
Bruk kontekstsøk for å hente innhold som er relevant for den angitte søketeksten.
Dette kan hjelpe applikasjoner med å identifisere relevant kildemateriale uten å generere et samtalebasert svar.
Bruk uttrekk når applikasjonen din trenger strukturerte verdier fra dokumentinnhold.
En uttrekksdefinisjon kan identifisere informasjon som:
Egenskapsnavn: contract_value
Type: integer
Beskrivelse: Avtalekontrakt Verdi
Hjelpetekst: Trekk ut den største avtaleverdien i dollar.
Det returnerte resultatet kan inkludere den uttrukne verdien, tillitsinformasjon og kildeattribusjon.
API-et gir flere måter å bestemme hvilket innhold som deltar i en forespørsel.
Bruk samlings- og dokumentidentifikatorer for å definere det primære innholdet som er tilgjengelig for en operasjon.
Merker er tilknyttet dokumenter i stedet for samlinger.
Dokumentmerker er bare tilgjengelige gjennom Knowledge Base-API-et og er ikke synlige i standardbrukergrensesnittet.
Du kan bruke merker med støttede operasjoner for å filtrere dokumentene som vurderes for en forespørsel. For eksempel kan en applikasjon tagge en gruppe dokumenter som finansdokumenter og begrense et spørsmål til dokumenter som bærer den taggen.
Vedlegg er separate fra samlingsdokumenter.
Hvis du legger til et vedlegg i en samtale, blir ikke den filen lagt til i samlingen.Vedlegget kan fortsatt bidra med kontekst til et generert svar, sammen med samlingsinnhold og samtalehistorikk.
Bruk vedleggsendepunkter når programmet ditt trenger midlertidig eller samtalesspesifikt innhold uten å legge det til permanent i en samling.
Inferenssvar kan inkludere attribusjonsinformasjon som kobler generert output til støttende kildeinnhold.
Attribusjonsdata kan inkludere informasjon som:
APIet gir denne informasjonen som data.Programmet ditt er ansvarlig for å bestemme hvordan det skal presenteres.
For eksempel kan en applikasjon bruke returnerte koordinater til å bygge en kildeutheving-opplevelse som identifiserer lokasjonen som støtter et generert svar.
API-operasjoner bruker tillatelsene som er tilgjengelige for den autentiserte identiteten.
En forespørsel kan mislykkes hvis den autentiserte identiteten mangler tilgang til samlingen, dokumentet eller operasjonen som forespørres.
Ved feilsøking:
X-Request-ID identifiserer forespørselen på tvers av Knowledge Base-tjenester og kan hjelpe Support med å undersøke en mislykket forespørsel.
Bruk Python-demoen når du vil ha fungerende eksempler som demonstrerer disse konseptene i en applikasjon.
Kom i gang med Knowledge Base Python-demoen
Bruk API-referansen når du er klar til å implementere en spesifikk operasjon.
