API Integratsioon

Saate andmeid programmiliselt edastada oma AI SmartTalk teadmistebaasi, kasutades meie REST API-d. Ideaalne kohandatud integratsioonide, automatiseeritud andmevoogude ja mis tahes andmeallika jaoks, mida meie sisseehitatud ühendused ei kata.

---

Ülevaade

API integratsioon võimaldab teil:

• Edastada dokumente otse oma teadmistebaasi
• Uuendada sisu programmiliselt
• Kustutada aegunud kirjeid
• Ehita kohandatud andmevooge
• Integreerida mis tahes süsteemiga, mis suudab teha HTTP päringuid

---

Eeltingimused

Enne alustamist veenduge, et teil on:

• Aktiivne AI SmartTalk konto
• API juurdepääs lubatud (kontrollige oma plaani)
• Põhiteadmised REST API-dest
• Tööriist HTTP päringute tegemiseks (curl, Postman või teie rakenduse kood)

---

API Credentialide Saamine

1. Samm: Juurdepääs API Seadetele

1. Logige sisse oma AI SmartTalk kontole
2. Liikuge Seaded → Integratsioonid
3. Leidke API ja klõpsake Seadista

2. Samm: Generige API Token

1. Klõpsake Genera uus token
2. Kopeerige oma Chat Model ID ja API Token
3. Salvestage need turvaliselt—tokenit näidatakse ainult üks kord!

⚠️ Turvahoitus: Ärge kunagi avaldage oma API tokenit kliendi poolel koodis või avalikes hoidlates.

---

API Lõpp-punktid

Baas URL

https://api.aismarttalk.tech/v1

Autentimine

Kõik päringud nõuavad teie API tokenit päises:

Authorization: Bearer YOUR_API_TOKEN

---

API Lõpp-punktid

Põhi URL

https://api.aismarttalk.tech/v1

Autentimine

Kõik päringud nõuavad teie API tokenit päises:

Authorization: Bearer YOUR_API_TOKEN

---

Dokumentide Importimine

Lõpp-punkt

POST /documents/import

Päringu Keha

{
  "chatModelId": "your-chat-model-id",
  "documents": [
    {
      "title": "Toote Dokumentatsioon",
      "content": "Teie dokumendi täisteksti sisu läheb siia...",
      "url": "https://example.com/docs/product",
      "metadata": {
        "category": "documentation",
        "language": "en"
      }
    }
  ]
}

Parameetrid

Väli	Tüüp	Nõutav	Kirjeldus
chatModelId	string	✅	Teie ainulaadne vestlusmudeli identifikaator
documents	array	✅	Dokumentide objektide massiiv
documents[].title	string	✅	Dokumendi pealkiri tuvastamiseks
documents[].content	string	✅	Täisteksti sisu
documents[].url	string	❌	Allika URL (viitamiseks)
documents[].metadata	object	❌	Kohandatud võtme-väärtuse paarid

Vastus

{
  "success": true,
  "imported": 1,
  "documents": [
    {
      "id": "doc_abc123",
      "title": "Toote Dokumentatsioon",
      "status": "processing"
    }
  ]
}

Näide: cURL

curl -X POST https://api.aismarttalk.tech/v1/documents/import \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "chatModelId": "your-chat-model-id",
    "documents": [
      {
        "title": "Käivitamisjuhend",
        "content": "Tere tulemast meie platvormile. Siin on, kuidas alustada...",
        "url": "https://docs.example.com/getting-started"
      }
    ]
  }'

---

Dokumentide Küsitlemine

Esitage küsimusi oma teadmistebaasi vastu programmiliselt.

Lõpp-punkt

POST /chat/query

Päringu Keha

{
  "chatModelId": "your-chat-model-id",
  "query": "Kuidas ma saan oma parooli lähtestada?",
  "options": {
    "maxTokens": 500,
    "temperature": 0.7
  }
}

Vastus

{
  "success": true,
  "response": "Oma parooli lähtestamiseks minge seadistustesse > Turvalisus > Muuda parooli...",
  "sources": [
    {
      "documentId": "doc_abc123",
      "title": "Turvalisuse Juhend",
      "relevance": 0.95
    }
  ]
}

---

Dokumentide Saamine

Saage dokumente, mis vastavad päringule (ilma AI vastuseta).

Lõpp-punkt

POST /documents/search

Päringu Keha

{
  "chatModelId": "your-chat-model-id",
  "query": "parooli turvalisus",
  "limit": 10
}

Vastus

{
  "success": true,
  "documents": [
    {
      "id": "doc_abc123",
      "title": "Turvalisuse Parimad Tavad",
      "content": "...",
      "relevance": 0.92
    }
  ]
}

---

Koodinäited

Python

import requests

API_TOKEN = "your-api-token"
CHAT_MODEL_ID = "your-chat-model-id"

def import_document(title: str, content: str, url: str = None):
    response = requests.post(
        "https://api.aismarttalk.tech/v1/documents/import",
        headers={
            "Authorization": f"Bearer {API_TOKEN}",
            "Content-Type": "application/json"
        },
        json={
            "chatModelId": CHAT_MODEL_ID,
            "documents": [{
                "title": title,
                "content": content,
                "url": url
            }]
        }
    )
    return response.json()

# Import a document
result = import_document(
    title="KKK: Saatmine",
    content="Pakume tasuta saatmist tellimustele, mille väärtus ületab 50 dollarit...",
    url="https://shop.example.com/faq/shipping"
)
print(result)

JavaScript / Node.js

const API_TOKEN = 'your-api-token';
const CHAT_MODEL_ID = 'your-chat-model-id';

async function importDocument(title, content, url = null) {
  const response = await fetch('https://api.aismarttalk.tech/v1/documents/import', {
    method: 'POST',
    headers: {
      'Authorization': `Bearer ${API_TOKEN}`,
      'Content-Type': 'application/json'
    },
    body: JSON.stringify({
      chatModelId: CHAT_MODEL_ID,
      documents: [{
        title,
        content,
        url
      }]
    })
  });
  return response.json();
}

// Import a document
importDocument(
  'KKK: Tagastused',
  'Saate tooteid tagastada 30 päeva jooksul pärast ostmist...',
  'https://shop.example.com/faq/returns'
).then(console.log);

PHP

<?php
$apiToken = 'your-api-token';
$chatModelId = 'your-chat-model-id';

$data = [
    'chatModelId' => $chatModelId,
    'documents' => [
        [
            'title' => 'Toote Spetsifikatsioonid',
            'content' => 'Meie vidinal on järgmised spetsifikatsioonid...',
            'url' => 'https://example.com/products/widget'
        ]
    ]
];

$ch = curl_init('https://api.aismarttalk.tech/v1/documents/import');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    'Authorization: Bearer ' . $apiToken,
    'Content-Type: application/json'
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($data));

$response = curl_exec($ch);
curl_close($ch);

print_r(json_decode($response, true));

---

Kasutuse Näited

Kohandatud CMS Integreerimine

Sünkroniseerige sisu omandiõigusega CMS-ist:

• Ühendage CMS-i avaldamise sündmustega
• Edastage uus/uuendatud sisu AI SmartTalki
• Eemaldage kustutatud sisu

Andmevoog

Importige andmehoidlatest:

• Ekspordige asjakohased andmed JSON-formaadis
• Korraga import API kaudu
• Planeerige regulaarsed uuendused

E-kaubanduse Tooted

Sünkroniseerige tooteandmed kohandatud süsteemidest:

• Toote kirjeldused
• Spetsifikatsioonid
• Hindade teave

Sisemised Süsteemid

Ühendage sisemised tööriistad, mida ei toetata loomulikult:

• Kohandatud vikid
• Ajaloolised andmebaasid
• Omandiõigusega rakendused

---

Kiiruspiirangud

Lõpp-punkt	Kiiruspiirang
Dokumendi import	100 päringut/minut
Küsitlus	60 päringut/minut
Otsing	60 päringut/minut

Märkus: Kiiruspiirangud varieeruvad plaani järgi. Kontaktige tuge kõrgemate piirangute saamiseks.

---

Veahaldus

Veateate formaat

{
  "success": false,
  "error": {
    "code": "INVALID_TOKEN",
    "message": "The provided API token is invalid or expired"
  }
}

Tavalised veakoodid

Kood	Kirjeldus	Lahendus
INVALID_TOKEN	Vale või aegunud token	Regenerige API token
INVALID_MODEL_ID	Tundmatu vestlusmudeli ID	Kontrollige oma vestlusmudeli ID-d
RATE_LIMITED	Liiga palju päringuid	Rakendage tagasihoid, proovige hiljem uuesti
INVALID_REQUEST	Vale vorminguga päringu keha	Kontrollige JSON struktuuri
DOCUMENT_TOO_LARGE	Sisu ületab piiri	Jagage väiksemateks dokumentideks
QUOTA_EXCEEDED	Plaani piirangud on saavutatud	Uuendage või võtke ühendust toega

---

Probleemide lahendamine

Autentimine ebaõnnestub

Probleem	Lahendus
401 Autoriseerimata	Kontrollige, et token on õige ja aktiivne
Token ei tööta	Regenerige token seadetes
Aegunud token	Tokenid ei aegu, kuid võivad olla tühistatud

Impordi probleemid

Probleem	Lahendus
Tühi vastus	Kontrollige, et Content-Type on application/json
Dokument ei ilmu	Oodake töötlemist; kontrollige teadmiste jaotist
Osaline import	Mõned dokumendid võivad sisaldada valideerimisvigu

Tulemuslikkuse probleemid

Probleem	Lahendus
Aeglased impordid	Grupi dokumendid (kuni 100 päringu kohta)
Aegumine	Vähendage grupi suurust, proovige tagasihoiduga uuesti
Kiirus piiratud	Rakendage eksponentsiaalset tagasihoidu

---

Parimad tavad

1. Grupiviisiline import: Saatke mitu dokumenti ühe päringu jooksul (kuni 100)
2. Ainulaadsed pealkirjad: Kasutage iga dokumendi jaoks kirjeldavaid ja ainulaadseid pealkirju
3. Struktureeritud sisu: Hästi vormindatud sisu parandab AI vastuseid
4. Metaandmete märgistamine: Kasutage metaandmeid kategoriseerimiseks ja filtreerimiseks
5. Turvalised tokenid: Salvestage tokenid keskkonnamuutujatesse
6. Vead käsitlemine: Rakendage uuesti proovimise loogikat eksponentsiaalse tagasihoiduga
7. Kasutuse jälgimine: Jälgige API kõnesid oma plaani piirangute suhtes

---

Seotud dokumentatsioon

• Integratsioonide ülevaade
• Täielik API dokumentatsioon
• Teadmistebaasi haldamine
• SmartFlow Webhookid — Saage sündmusi