Izlaist uz galveno saturu

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

  1. Piesakieties savā AI SmartTalk kontā
  2. Dodieties uz IestatījumiIntegrācijas
  3. Atrodiet API un noklikšķiniet uz Konfigurēt

2. solis: API Tokena Ģenerēšana

  1. Noklikšķiniet uz Ģenerēt jaunu tokenu
  2. Nokopējiet savu Čata modeļa ID un API tokenu
  3. 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

LauksTipsNepieciešamsApraksts
chatModelIdstringJūsu unikālais čata modeļa identifikators
documentsarrayDokumentu objektu masīvs
documents[].titlestringDokumenta nosaukums identifikācijai
documents[].contentstringPilns teksta saturs
documents[].urlstringAvota URL (atsaucei)
documents[].metadataobjectPielā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 punktsLikmes ierobežojums
Dokumentu importēšana100 pieprasījumi/minūte
Vaicājums60 pieprasījumi/minūte
Meklēšana60 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

KodsAprakstsRisinājums
INVALID_TOKENNeatbilstošs vai beidzies tokensAtjaunojiet API tokenu
INVALID_MODEL_IDNezināms čata modeļa IDPārbaudiet savu Čata Modeļa ID
RATE_LIMITEDPārāk daudz pieprasījumuIeviesiet atpakaļejošo mehānismu, mēģiniet vēlāk
INVALID_REQUESTNepareiza pieprasījuma struktūraPārbaudiet JSON struktūru
DOCUMENT_TOO_LARGESaturs pārsniedz ierobežojumuSadaliet mazākos dokumentos
QUOTA_EXCEEDEDPlāna ierobežojumi sasniegtiUzlabojiet vai sazinieties ar atbalstu

Problēmu Novēršana

Autentifikācija Neizdodas

ProblēmaRisinājums
401 UnauthorizedPārbaudiet, vai tokens ir pareizs un aktīvs
Tokens nedarbojasAtjaunojiet tokenu iestatījumos
Beidzies tokensTokeni nebeidzas, bet var tikt atcelti

Importēšanas Problēmas

ProblēmaRisinājums
Tukša atbildePārbaudiet, vai Content-Type ir application/json
Dokuments neparādāsGaidiet apstrādi; pārbaudiet Zināšanu sadaļu
Daļēja importēšanaDažiem dokumentiem var būt validācijas kļūdas

Veiktspējas Problēmas

ProblēmaRisinājums
Lēni importiGrupējiet dokumentus (maks. 100 uz pieprasījumu)
Laika ierobežojumiSamaziniet grupas izmēru, mēģiniet ar atpakaļejošo mehānismu
Ierobežots pieprasījumu skaitsIeviesiet eksponenciālo atpakaļejošo mehānismu

Labākās Prakses

  1. Grupējiet importus: Nosūtiet vairākus dokumentus uz pieprasījumu (līdz 100)
  2. Unikāli nosaukumi: Izmantojiet aprakstošus, unikālus nosaukumus katram dokumentam
  3. Strukturēts saturs: Labi formatēts saturs uzlabo AI atbildes
  4. Metadatu marķēšana: Izmantojiet metadatus kategorizēšanai un filtrēšanai
  5. Droši tokeni: Glabājiet tokenus vides mainīgajos
  6. Apstrādājiet kļūdas: Ieviesiet atkārtošanas loģiku ar eksponenciālo atpakaļejošo mehānismu
  7. Uzraugiet lietošanu: Sekojiet API izsaukumiem pret jūsu plāna ierobežojumiem

Saistītā Dokumentācija

Gatavs uzlabot savu
lietotāju pieredzi?

Ieviesiet AI asistentus, kas iepriecina klientus un paplašinās kopā ar jūsu uzņēmumu.

GDPR atbilstīgs