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 savu zināšanu bāzi
- Atjaunināt saturu programmatiski
- Dzēst novecojušas 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)
API Akreditācijas saņemšana
1. solis: Piekļuve API iestatījumiem
- Pierakstieties savā AI SmartTalk kontā
- Dodieties uz Iestatījumi → Integrācijas
- Atrodiet API un noklikšķiniet uz Konfigurēt
2. solis: Izveidot API Token
- Noklikšķiniet uz Izveidot jaunu token
- Nokopējiet savu Čata modeļa ID un API token
- Uzglabājiet tos droši—token tiek rādīts tikai vienu reizi!
⚠️ Drošības brīdinājums: Nekad neizpaužiet savu API token klienta puses kodā vai publiskos repozitorijos.
API Beigu punkti
Bāzes URL
https://api.aismarttalk.tech/v1
Autentifikācija
Visiem pieprasījumiem ir nepieciešams jūsu API token galvenē:
Authorization: Bearer YOUR_API_TOKEN
API Beigās
Bāzes URL
https://api.aismarttalk.tech/v1
Autentifikācija
Visām pieprasījumiem ir nepieciešams jūsu API tokens galvenē:
Authorization: Bearer YOUR_API_TOKEN
Importēt Dokumentus
Beigās
POST /documents/import
Pieprasījuma Ķermenis
{
"chatModelId": "your-chat-model-id",
"documents": [
{
"title": "Produkta 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āgoti atslēgas-vērtības pāri |
Atbilde
{
"success": true,
"imported": 1,
"documents": [
{
"id": "doc_abc123",
"title": "Produkta 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": "Iepazīšanās Ceļvedis",
"content": "Laipni lūdzam mūsu platformā. Šeit ir, kā uzsākt...",
"url": "https://docs.example.com/getting-started"
}
]
}'
Vaicāt Dokumentus
Uzdodiet jautājumus pret savu zināšanu bāzi programmatiski.
Beigās
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 Ceļvedis",
"relevance": 0.95
}
]
}
Iegūt Dokumentus
Iegūstiet dokumentus, kas atbilst vaicājumam (bez AI atbildes).
Beigās
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 a document
result = import_document(
title="FAQ: 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 a document
importDocument(
'FAQ: Atgriešana',
'Jūs varat atgriezt preces 30 dienu laikā pēc iegādes...',
'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 rīks ir ar šādām specifikācijām...',
'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 patentētas CMS:
- Pievienojieties CMS publicēšanas notikumiem
- Nosūtiet jaunu/atjauninātu saturu uz AI SmartTalk
- Noņemiet dzēsto saturu
Datu cauruļvads
Importējiet no datu noliktavām:
- Eksportējiet attiecīgos datus uz JSON
- Partiju imports 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
- Patentētas lietojumprogrammas
Likmes ierobežojumi
| Beigu punkts | Ierobežojumu likme |
|---|---|
| Dokumentu imports | 100 pieprasījumi/minūtē |
| Vaicājums | 60 pieprasījumi/minūtē |
| Meklēšana | 60 pieprasījumi/minūtē |
Piezīme: 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": "The provided API token is invalid or expired"
}
}
Biežākās kļūdu kodi
| Kods | Apraksts | Risinājums |
|---|---|---|
INVALID_TOKEN | Nepareizs 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, mēģiniet vēlāk |
INVALID_REQUEST | Nepareizi izveidots pieprasījuma ķermenis | 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 Neautorizēts | Pārbaudiet, vai tokens ir pareizs un aktīvs |
| Tokens nedarbojas | Atjaunojiet tokenu iestatījumos |
| Beidzies tokens | Tokeni nebeidzas, bet var tikt atsaukti |
Importēšanas problēmas
| Problēma | Risinājums |
|---|---|
| Tukša atbilde | Pārbaudiet, vai Content-Type ir application/json |
| Dokuments neparādās | Gaida apstrādi; pārbaudiet Zināšanu sadaļu |
| Daļēja importa | 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 |
| Ierobežots pieprasījums | Ieviesiet eksponenciālo atpakaļejošo |
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
- Uzraugiet lietojumu: Sekojiet API izsaukumiem pret jūsu plāna ierobežojumiem