Aloitus
Luo API-avain ja suorita ensimmäinen dokumenttihaku Nordveciä vastaan.
Tämä opas vie sinut nollasta ensimmäiseen hakutulokseesi.
1. Luo API-avain
Kirjaudu sisään ja luo avain työtilasi asetuksista. Raaka-avain näytetään vain kerran eikä koskaan uudestaan, joten tallenna se turvalliseen paikkaan. Avaimet on rajattu työtilaasi ja ne toimivat tunnistautumiseen kantajamerkkinä.
Lue Tunnistautuminen koko elinkaarestä (kierto, peruutus, siirtymäajat).
2. Hae dokumenteistasi
Suuntaa mikä tahansa HTTP-asiakasohjelma API-perusosoitteeseen, https://nordvec.com/api/v1, ja lähetä kyselysi. Tulokset palautetaan järjestettynä, ja jokainen niistä sisältää lähdedokumentin, josta se on peräisin. query on pakollinen; limit (1-50, oletus 20) on valinnainen.
curl https://nordvec.com/api/v1/documents/search \
-H "Authorization: Bearer $NORDVEC_API_KEY" \
-H "Content-Type: application/json" \
-d '{ "query": "quarterly revenue", "limit": 10 }'Jokainen tulos viittaa lähdedokumenttiinsa, joten voit tarkistaa osuman sen sijaan, että vain luottaisit siihen. Siinä on koko alustan idea.
3. Työskentele keskustelujen kanssa
Keskustelu on chat, joka perustuu dokumentteihisi ja jossa jokainen vastaus on viitattu. API:n avulla voit luoda keskusteluja sekä listata, hakea ja noutaa niitä:
# Create a conversation owned by your workspace
curl -X POST https://nordvec.com/api/v1/conversations \
-H "Authorization: Bearer $NORDVEC_API_KEY"