API Integrācija
Pārsūtiet datus programmatiski uz savu AI SmartTalk zināšanu bāzi, izmantojot mūsu REST API. Ideāli piemērots pielāgotām integrācijām, automatizētām caurulēm un jebkuram datu avotam, kas nav iekļauts mūsu iebūvētajos savienotājos.
Pārskats
API integrācija ļauj jums:
- Pārsūtīt dokumentus tieši uz jūsu zināšanu bāzi
- Atjaunināt saturu programmatiski
- Dzēst novecojušus ierakstus
- Izveidot pielāgotas datu caurules
- Integrēties ar jebkuru sistēmu, kas var veikt HTTP pieprasījumus
Prasības
Pirms sākat, pārliecinieties, ka jums ir:
- Aktīvs AI SmartTalk konts
- API piekļuve iespējota (pārbaudiet savu plānu)
- Pamatzināšanas par REST API
- Rīks HTTP pieprasījumu veikšanai (curl, Postman vai jūsu lietojumprogrammas kods)
Jūsu API Akreditācijas Datu Iegūšana
1. solis: Piekļuve API Iestatījumiem
- Piesakieties savā AI SmartTalk kontā
- Dodieties uz Iestatījumi → Integrācijas
- Atrodiet API un noklikšķiniet uz Konfigurēt
2. solis: API Tokena Ģenerēšana
- Noklikšķiniet uz Ģenerēt jaunu tokenu
- Nokopējiet savu Čata modeļa ID un API tokenu
- Uzglabājiet tos droši — token tiek rādīts tikai vienu reizi!
⚠️ Drošības brīdinājums: Nekad neizpaudiet savu API tokenu klienta puses kodā vai publiskās repozitorijās.
API Beigu Punkts
Bāzes URL
https://api.aismarttalk.tech/v1
Autentifikācija
Visiem pieprasījumiem ir nepieciešams jūsu API tokena galvene:
Authorization: Bearer YOUR_API_TOKEN
Dokumentu Importēšana
Beigu punkts
POST /documents/import
Pieprasījuma ķermenis
{
"chatModelId": "your-chat-model-id",
"documents": [
{
"title": "Produktu dokumentācija",
"content": "Pilns jūsu dokumenta saturs šeit...",
"url": "https://example.com/docs/product",
"metadata": {
"category": "documentation",
"language": "en"
}
}
]
}
Parametri
| Lauks | Tips | Nepieciešams | Apraksts |
|---|---|---|---|
chatModelId | string | ✅ | Jūsu unikālais čata modeļa identifikators |
documents | array | ✅ | Dokumentu objektu masīvs |
documents[].title | string | ✅ | Dokumenta nosaukums identifikācijai |
documents[].content | string | ✅ | Pilns teksta saturs |
documents[].url | string | ❌ | Avota URL (atsaucei) |
documents[].metadata | object | ❌ | Pielāgotas atslēgas-vērtības pāri |
Atbilde
{
"success": true,
"imported": 1,
"documents": [
{
"id": "doc_abc123",
"title": "Produktu dokumentācija",
"status": "processing"
}
]
}
Piemērs: 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": "Sākuma rokasgrāmata",
"content": "Laipni lūdzam mūsu platformā. Šeit ir, kā sākt...",
"url": "https://docs.example.com/getting-started"
}
]
}'
Dokumentu Vaicājumi
Uzdodiet jautājumus pret savu zināšanu bāzi programmatiski.
Beigu punkts
POST /chat/query
Pieprasījuma ķermenis
{
"chatModelId": "your-chat-model-id",
"query": "Kā es varu atiestatīt savu paroli?",
"options": {
"maxTokens": 500,
"temperature": 0.7
}
}
Atbilde
{
"success": true,
"response": "Lai atiestatītu savu paroli, dodieties uz Iestatījumi > Drošība > Mainīt paroli...",
"sources": [
{
"documentId": "doc_abc123",
"title": "Drošības rokasgrāmata",
"relevance": 0.95
}
]
}
Dokumentu Iegūšana
Iegūstiet dokumentus, kas atbilst vaicājumam (bez AI atbildes).
Beigu punkts
POST /documents/search
Pieprasījuma ķermenis
{
"chatModelId": "your-chat-model-id",
"query": "paroles drošība",
"limit": 10
}
Atbilde
{
"success": true,
"documents": [
{
"id": "doc_abc123",
"title": "Drošības labākās prakses",
"content": "...",
"relevance": 0.92
}
]
}
Koda Piemēri
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ēt dokumentu
result = import_document(
title="BUJ: Piegāde",
content="Mēs piedāvājam bezmaksas piegādi pasūtījumiem virs $50...",
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ēt dokumentu
importDocument(
'BUJ: Atgriešana',
'Jūs varat atgriezt preces 30 dienu laikā pēc pirkuma...',
'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' => 'Produktu specifikācijas',
'content' => 'Mūsu ierīcei ir šādas specifikācijas...',
'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));
Lietošanas Gadījumi
Pielāgota CMS Integrācija
Sinhronizējiet saturu no īpašas CMS:
- Pievienojieties CMS publicēšanas notikumiem
- Pārsūtiet jaunu/atjauninātu saturu uz AI SmartTalk
- Noņemiet dzēsto saturu
Datu Caurule
Importējiet no datu noliktavām:
- Eksportējiet attiecīgos datus uz JSON
- Masveida importēšana caur API
- Plānojiet regulāras atjaunināšanas
E-komercijas Produkti
Sinhronizējiet produktu datus no pielāgotām sistēmām:
- Produktu apraksti
- Specifikācijas
- Cenu informācija
Iekšējās Sistēmas
Savienojiet iekšējās rīkus, kas nav atbalstīti dabiski:
- Pielāgotas vikipēdijas
- Novecojušas datu bāzes
- Īpašas lietojumprogrammas
Likmes Ierobežojumi
| Beigu punkts | Likmes ierobežojums |
|---|---|
| Dokumentu importēšana | 100 pieprasījumi/minūte |
| Vaicājums | 60 pieprasījumi/minūte |
| Meklēšana | 60 pieprasījumi/minūte |
Piezīme: Likmes ierobežojumi atšķiras atkarībā no plāna. Sazinieties ar atbalsta dienestu, lai saņemtu augstākus ierobežojumus.
Kļūdu Apstrāde
Kļūdu Atbildes Formāts
{
"success": false,
"error": {
"code": "INVALID_TOKEN",
"message": "Norādītais API tokens ir nederīgs vai beidzies"
}
}
Biežākie Kļūdu Kode
| Kods | Apraksts | Risinājums |
|---|---|---|
INVALID_TOKEN | Neatbilstošs vai beidzies tokens | Atjaunojiet API tokenu |
INVALID_MODEL_ID | Nezināms čata modeļa ID | Pārbaudiet savu Čata Modeļa ID |
RATE_LIMITED | Pārāk daudz pieprasījumu | Ieviesiet atpakaļejošo mehānismu, mēģiniet vēlāk |
INVALID_REQUEST | Nepareiza pieprasījuma struktūra | Pārbaudiet JSON struktūru |
DOCUMENT_TOO_LARGE | Saturs pārsniedz ierobežojumu | Sadaliet mazākos dokumentos |
QUOTA_EXCEEDED | Plāna ierobežojumi sasniegti | Uzlabojiet vai sazinieties ar atbalstu |
Problēmu Novēršana
Autentifikācija Neizdodas
| Problēma | Risinājums |
|---|---|
| 401 Unauthorized | Pārbaudiet, vai tokens ir pareizs un aktīvs |
| Tokens nedarbojas | Atjaunojiet tokenu iestatījumos |
| Beidzies tokens | Tokeni nebeidzas, bet var tikt atcelti |
Importēšanas Problēmas
| Problēma | Risinājums |
|---|---|
| Tukša atbilde | Pārbaudiet, vai Content-Type ir application/json |
| Dokuments neparādās | Gaidiet apstrādi; pārbaudiet Zināšanu sadaļu |
| Daļēja importēšana | Dažiem dokumentiem var būt validācijas kļūdas |
Veiktspējas Problēmas
| Problēma | Risinājums |
|---|---|
| Lēni importi | Grupējiet dokumentus (maks. 100 uz pieprasījumu) |
| Laika ierobežojumi | Samaziniet grupas izmēru, mēģiniet ar atpakaļejošo mehānismu |
| Ierobežots pieprasījumu skaits | Ieviesiet eksponenciālo atpakaļejošo mehānismu |
Labākās Prakses
- Grupējiet importus: Nosūtiet vairākus dokumentus uz pieprasījumu (līdz 100)
- Unikāli nosaukumi: Izmantojiet aprakstošus, unikālus nosaukumus katram dokumentam
- Strukturēts saturs: Labi formatēts saturs uzlabo AI atbildes
- Metadatu marķēšana: Izmantojiet metadatus kategorizēšanai un filtrēšanai
- Droši tokeni: Glabājiet tokenus vides mainīgajos
- Apstrādājiet kļūdas: Ieviesiet atkārtošanas loģiku ar eksponenciālo atpakaļejošo mehānismu
- Uzraugiet lietošanu: Sekojiet API izsaukumiem pret jūsu plāna ierobežojumiem
Saistītā Dokumentācija
- Integrāciju Pārskats
- Pilna API Dokumentācija
- Zināšanu Bāzes Pārvaldība
- SmartFlow Webhooki — Saņemiet notikumus