API-liittymä tukee työnkulkuja kokoelmien ja asiakirjojen hallintaan, sisällön käsittelyyn sekä tekoälyominaisuuksien, kuten kysymyksiin vastaamisen, tiivistämisen, haun ja rakenteellisen poiminnan, käyttämiseen. Käytä tätä sivua ymmärtääksesi, miten nämä osat toimivat yhdessä, ja käytä sitten API-viitettä päätepisteiden käyttöönoton yksityiskohtiin.
Varmista, että sinulla on seuraavat:
Jos et ole määrittänyt API-käyttöoikeutta, katso Knowledge Basen API-käyttöoikeuden määrittäminen.
Tyypillinen Knowledge Basen API-työnkulku noudattaa seuraavaa järjestystä:
Todenna → Kokoelma → Asiakirja → Indeksi → Päättely → Vastaus
Kokoelma määrittää tietoalueen, jota sovelluksesi käyttää. Kun luot kokoelman, vastaus sisältää sen yksilöivän nimiavaruuden, jota käytät seuraavissa toiminnoissa.
Esimerkiksi:
{
"namespace": "<collection-namespace>",
"name": "example-collection"
}
Säilytä kokoelman namespace-arvo asiakirja- ja päättelypyyntöjä varten.
Asiakirjat ladataan kokoelmiin ja niille määritetään yksilöivät asiakirjatunnisteet.
Latausvastaus tunnistaa asiakirjan, jotta sovelluksesi voi seurata käsittelyä ja viitata siihen myöhemmissä pyynnöissä.
{
"document_id": "<document-id>",
"document_name": "example.pdf"
}
Asiakirjan lataaminen palveluun ja sen indeksointi ovat erilliset vaiheet.
Lataaminen siirtää tiedoston Knowledge Baseen. Indeksointi poimii sen sisällön ja käsittelee tämän sisällön tekoälytoimintojen käyttöön.
Sovelluksesi tulee varmistaa, että käsittely on valmistunut ennen asiakirjaan kohdistuvien päättelypyyntöjen lähettämistä.
Päättelytoiminnot soveltavat Knowledge Basen tekoälyominaisuuksia käsiteltyyn sisältöön.
Saatavilla olevia toimintoja ovat:
Käytä API-viitettä määrittääksesi päätepisteen ja pyynnön rakenteen haluamallesi toiminnolle.
Päättelyvastauksissa palautetaan generoitu tulos, ja ne voivat sisältää tulosta tukevia attribuutiotietoja.
Toiminnosta riippuen attribuutiotiedot voivat kertoa tulokseen liittyvän lähdesisällön, sivun ja koordinaatit. Sovelluksesi määrittää, miten nämä tiedot esitetään käyttäjälle.
Yksinkertaisin sovellustyönkulku on kokoelman luominen, asiakirjan lisääminen, käsittelyn odottaminen ja sitten päättelytoiminnon suorittaminen.
Luo kokoelma, joka sisältää sovelluksesi lähdeasiakirjat.
Säilytä vastauksessa palautettu namespace-arvo:
collection_namespace = <returned-namespace>
Käytät tätä arvoa lisätessäsi asiakirjoja ja käynnistäessäsi toimintoja, jotka kohdistuvat kokoelmaan.
Lataa asiakirja kokoelmaan ja säilytä palautettu asiakirjan tunnus:
document_id = <returned-document-id>
Asiakirjan tunnus yksilöi ladatun asiakirjan tiedostonimestä riippumatta.
Aloita tarvittava indeksointitoiminto ja tarkista sitten asiakirjan tila, kunnes käsittely on valmis.
Älä oleta, että onnistunut lataus tarkoittaa asiakirjan olevan valmis tekoälytoimintoja varten.
Tyypillinen sovellustyönkulku:
Lataa asiakirja
↓
Aloita indeksointi
↓
Tarkista käsittelyn tila
↓
Valmis
Jos käsittely epäonnistuu, ratkaise asiakirjan käsittelyongelma ennen päättelypyynnön lähettämistä.
Käsittelyn valmistuttua lähetä kokoelman namespace-arvo, asiakirjan tunnus ja mikä tahansa päätepisteen vaatima toimintokohtainen syöte.
Esimerkiksi kysymykseen vastaamisen pyyntö käsitteellisesti toimittaa seuraavat:
Kokoelma: <collection-namespace>
Asiakirja: <document-id>
Kysymys: Mitkä ovat keskeiset löydökset?
Käytä API-viitettä varsinaista pyyntöskeemaa varten.
Käytä palautettua vastausta tai purettua tietoa sovelluksessasi.
Jos vastaus sisältää attribuutiotiedot, voit käyttää niitä yhdistämään generoidun tiedon takaisin sitä tukevaan asiakirjasisältöön.
Asiakirjan elinkaari vaikuttaa siihen, milloin sovelluksesi voi käyttää ladattua sisältöä.
| Vaihe | Mitä tapahtuu | Sovelluksen toiminto |
|---|---|---|
| Lataa | Tiedosto lisätään Knowledge Baseen ja saa asiakirjatunnuksen. | Säilytä asiakirjatunnus. |
| Indeksoiminen | Sisältö puretaan ja käsitellään tekoälykäyttöä varten. | Seuraa asiakirjan tilaa. |
| Valmis | Käsitelty sisältö on käytettävissä päättelyä varten. | Lähetä tekoälypyyntöjä. |
| Epäonnistui | Käsittely ei onnistunut. | Korjaa virhe ennen jatkamista. |
Tämä ero on erityisen tärkeä automatisoiduissa työnkuluissa. Sovelluksen tulisi tarkistaa käsittelyn tila sen sijaan, että se lähettäisi päättelypyynnön heti latauksen jälkeen.
Valitse toiminto sen mukaan, mitä sovelluksesi tulee tehdä lähdesisällölle.
Voit lähettää kysymys-vastaus-toiminnon avulla luonnollisella kielellä kysymyksiä kokoelman tai asiakirjan sisällöstä.
API tarjoaa sekä suoratoistoisen että ei-suoratoistoisen kysymys-vastaus-toiminnon.
Suoratoistoinen kysymys-vastaus-toiminto palauttaa vastauksen vaiheittain, kun sitä generoidaan. Käytä tätä, kun käyttöliittymäsi näyttää generoitua sisältöä asteittain.
Suoratoistoinen kysymys-vastaus-toiminto tukee myös sen hallintaa, sovelletaanko pyyntöön mukautettuja ohjeita. Voit myös hallita, generoidaanko päättely suoratoistoisessa kysymys-vastaus-toiminnon vastauksessa.
Ei-suoratoistettu kysymys-vastaus-toiminto odottaa generoinnin valmistumista ja palauttaa lopullisen vastauksen. Käytä tätä, kun sovelluksesi ei tarvitse näyttää osittaista tulostetta.
Käytä tiivistämistä generoidaksesi asiakirjasisällön tiivistetyn esityksen.
API-viite määrittelee nykyiset pyyntöjen vaatimukset ja tuetut syötteet.
Käytä kontekstihakua hakeaksesi määritettyyn hakutekstiin liittyvää sisältöä.
Tämä voi auttaa sovelluksia tunnistamaan olennaista lähdemateriaalia generoimatta keskusteluvastausta.
Käytä poimintaa, kun sovelluksesi tarvitsee rakenteisia arvoja asiakirjasisällöstä.
Poimintamääritys voi tunnistaa tietoja kuten:
Ominaisuuden nimi: contract_value
Tyyppi: integer
Kuvaus: Sopimuksen arvo
Kehote: Tunnista suurin sopimusarvo dollareissa.
Palautettu tulos voi sisältää tunnistetun arvon, luotettavuustiedot ja lähdeviittauksen.
API tarjoaa useita tapoja määrittää, mitkä sisällöt osallistuvat pyyntöön.
Käytä kokoelma- ja asiakirjatunnisteita määrittääksesi toiminnon käytettävissä olevan ensisijaisen sisällön.
Tunnisteet liitetään asiakirjoihin kokoelmien sijaan.
Asiakirjatunnisteet ovat käytettävissä vain Knowledge Base -APIssa, eikä niitä näytetä tavallisessa käyttöliittymässä.
Voit käyttää tunnisteita tuetuissa toiminnoissa suodattaaksesi pyynnössä huomioon otettavat asiakirjat. Esimerkiksi sovellus voisi merkitä asiakirjaryhmän talousasiakirjoiksi ja rajoittaa kysymyksen kyseisellä tunnisteella merkittyihin asiakirjoihin.
Liitteet ovat erillisiä kokoelman asiakirjoista.
Liitteen lisääminen keskusteluun ei lisää kyseistä tiedostoa kokoelmaan. Liite voi silti tuoda kontekstia generoituun vastaukseen yhdessä kokoelmasislällon ja keskusteluhistorian kanssa.
Käytä liitepäätepisteitä, kun sovelluksesi tarvitsee väliaikaista tai keskustelukohtaista sisältöä lisäämättä sitä pysyvästi kokoelmaan.
Päättelyvastaukset voivat sisältää attribuutiotietoja, jotka yhdistävät generoidun tulosteen sitä tukevaan lähdesisältöön.
Attribuutiotiedot voivat sisältää tietoja, kuten:
API tarjoaa nämä tiedot datana. Sovelluksesi on vastuussa siitä, miten tämä data esitetään.
Sovellus voi esimerkiksi käyttää palautettuja koordinaatteja rakentaakseen lähdetietojen korostusnäkymän, joka tunnistaa generoitua vastausta tukevat sijainnit.
API-toiminnot käyttävät todennetun identiteetin käytettävissä olevia käyttöoikeuksia.
Pyyntö voi epäonnistua, jos todennetulta identiteetiltä puuttuu pääsy pyydettyyn kokoelmaan, asiakirjaan tai toimintoon.
Vianetsinnässä:
X-Request-ID tunnistaa pyynnön Knowledge Base -palveluissa ja voi auttaa tukipalvelua tutkimaan epäonnistunutta pyyntöä.
Käytä Python-esimerkkiä, kun haluat toimivia esimerkkejä, jotka havainnollistavat näitä käsitteitä sovelluksessa.
Aloita Knowledge Basen Python-esittelyn avulla
Käytä API-viitettä, kun olet valmis toteuttamaan tietyn toiminnon.
