Hoppa yfir á aðal efni

API samþætting

Pushaðu gögnum forritalega í AI SmartTalk þekkingargrunninn þinn með því að nota REST API okkar. Fullkomið fyrir sérsniðnar samþættingar, sjálfvirkar rásir og hvaða gagnagjafa sem ekki er covered af innfæddum tengingum okkar.


Yfirlit

API samþættingin gerir þér kleift að:

  • Pusha skjölum beint í þekkingargrunninn þinn
  • Uppfæra efni forritalega
  • Eyða úreltum færslum
  • Byggja sérsniðnar gagnarásir
  • Samþætta við hvaða kerfi sem getur gert HTTP beiðnir

Forsendur

Fyrir en þú byrjar, tryggðu að þú hafir:

  • Virkan AI SmartTalk reikning
  • API aðgang virkjaðan (skoðaðu áætlunina þína)
  • Grunnþekkingu á REST APIs
  • Verkfæri til að gera HTTP beiðnir (curl, Postman, eða forritakóða þinn)

Að fá API auðkenni

Skref 1: Aðgangur að API stillingum

  1. Skráðu þig inn á AI SmartTalk reikninginn þinn
  2. Fara í StillingarSamþættingar
  3. Finndu API og smelltu á Sérsníða

Skref 2: Búa til API Token

  1. Smelltu á Búa til nýjan token
  2. Afritaðu Chat Model ID og API Token
  3. Geymdu þetta örugglega—tokenið er sýnt aðeins einu sinni!

⚠️ Öryggisviðvörun: Aldrei birta API tokenið þitt í kóða á viðskiptavinasíðu eða opinberum geymslum.


API Endapunktar

Grunn URL

https://api.aismarttalk.tech/v1

Auðkenning

Öll beiðni krafist API tokenið þitt í hausnum:

Authorization: Bearer YOUR_API_TOKEN

API Endpoints

Base URL

https://api.aismarttalk.tech/v1

Authentication

All requests require your API token in the header:

Authorization: Bearer YOUR_API_TOKEN

Import Documents

Endpoint

POST /documents/import

Request Body

{
"chatModelId": "your-chat-model-id",
"documents": [
{
"title": "Vöru Skjal",
"content": "Heildar efni skjalsins þíns fer hér...",
"url": "https://example.com/docs/product",
"metadata": {
"category": "documentation",
"language": "en"
}
}
]
}

Parameters

FieldTypeRequiredDescription
chatModelIdstringEinstakt auðkenni fyrir spjall módel þitt
documentsarrayArray af skjala hlutum
documents[].titlestringSkjal titill til auðkenningar
documents[].contentstringHeildar textaefni
documents[].urlstringHeimildar URL (til að vísa í)
documents[].metadataobjectSérsniðnar lykil-gildi pör

Response

{
"success": true,
"imported": 1,
"documents": [
{
"id": "doc_abc123",
"title": "Vöru Skjal",
"status": "processing"
}
]
}

Example: 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": "Leiðarvísir til að byrja",
"content": "Velkomin á okkar vettvang. Hér er hvernig á að byrja...",
"url": "https://docs.example.com/getting-started"
}
]
}'

Query Documents

Ask questions against your knowledge base programmatically.

Endpoint

POST /chat/query

Request Body

{
"chatModelId": "your-chat-model-id",
"query": "Hvernig endurstilli ég lykilorðið mitt?",
"options": {
"maxTokens": 500,
"temperature": 0.7
}
}

Response

{
"success": true,
"response": "Til að endurstilla lykilorðið þitt, farðu í Stillingar > Öryggi > Breyta lykilorði...",
"sources": [
{
"documentId": "doc_abc123",
"title": "Öryggisleiðarvísir",
"relevance": 0.95
}
]
}

Retrieve Documents

Get documents matching a query (without AI response).

Endpoint

POST /documents/search

Request Body

{
"chatModelId": "your-chat-model-id",
"query": "lykilorð öryggi",
"limit": 10
}

Response

{
"success": true,
"documents": [
{
"id": "doc_abc123",
"title": "Bestu venjur í öryggi",
"content": "...",
"relevance": 0.92
}
]
}

Kóðadæmi

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()

# Flytja inn skjal
result = import_document(
title="FAQ: Sending",
content="Við bjóðum upp á frítt sendingar á pöntunum yfir $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();
}

// Flytja inn skjal
importDocument(
'FAQ: Vöruskil',
'Þú getur skilað vörum innan 30 daga frá kaupum...',
'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' => 'Vöruupplýsingar',
'content' => 'Vörun okkar hefur eftirfarandi upplýsingar...',
'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));

Notkunartilvik

Sérsniðin CMS Samþætting

Samþætta efni frá sérsniðnu CMS:

  • Tengja við birtingarviðburði CMS
  • Ýta nýju/uppfærðu efni til AI SmartTalk
  • Fjarlægja eytt efni

Gagnaleiðsla

Flytja inn frá gagnageymslum:

  • Flytja út viðeigandi gögn í JSON
  • Batch-flutningur í gegnum API
  • Skipuleggja reglulegar uppfærslur

Vörur í netverslun

Samþætta vöruupplýsingar frá sérsniðnum kerfum:

  • Vöru lýsingar
  • Upplýsingar um sérstöðu
  • Verðupplýsingar

Innri Kerfi

Tengja innri verkfæri sem ekki eru studd beint:

  • Sérsniðin vefgagnasöfn
  • Gamlar gagnagrunnar
  • Sérsniðnar forritanir

Hraðamörk

EndapunkturHraðamörk
Skjal Innflutningur100 beiðnir/mínútu
Fyrirspurn60 beiðnir/mínútu
Leita60 beiðnir/mínútu

Athugið: Hraðamörk eru mismunandi eftir áætlun. Hafðu samband við stuðning fyrir hærri mörk.


Villumeðferð

Svarform villu

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

Algengar villukóðar

KóðiLýsingLausn
INVALID_TOKENSlæmur eða útrunninn tokenEndurnýja API token
INVALID_MODEL_IDÓþekktur spjallmódel IDAthugaðu Chat Model ID þitt
RATE_LIMITEDOf margar beiðnirFramkvæmdu afturhvarf, reyndu síðar
INVALID_REQUESTRanglega mynduð beiðniAthugaðu JSON uppbyggingu
DOCUMENT_TOO_LARGEEfni fer yfir mörkSkiptu í minni skjöl
QUOTA_EXCEEDEDMörk áætlunar náðUppfærðu eða hafðu samband við stuðning

Vandamálalausn

Auðkenning mistókst

VandamálLausn
401 ÓheimiltAthugaðu að token sé rétt og virk
Token virkar ekkiEndurnýjaðu token í stillingum
Útrunninn tokenTokens rennur ekki út, en hægt er að afturkalla þau

Innflutningsvandamál

VandamálLausn
Tóm svarAthugaðu að Content-Type sé application/json
Skjal birtist ekkiBíða eftir úrvinnslu; athugaðu Þekkingarhlutann
Aðeins hluti innflutningsSum skjöl gætu haft gildisvillur

Frammistöðuvandamál

VandamálLausn
Hæg innflutningurBatcha skjöl (max 100 fyrir beiðni)
TímasetningarMinnkaðu batch stærð, reyndu aftur með afturhvarfi
HraðamörkFramkvæmdu veldis afturhvarf

Bestu venjur

  1. Batch innflutningar: Sendu mörg skjöl í hverri beiðni (allt að 100)
  2. Einstök titlar: Notaðu lýsandi, einstaka titla fyrir hvert skjal
  3. Strúktúruð efni: Vel uppsett efni bætir svör AI
  4. Metadata merking: Notaðu metadata fyrir flokkun og síun
  5. Örugg tokens: Geymdu tokens í umhverfisbreytum
  6. Meðhöndla villur: Framkvæmdu endurtekningarlögmál með veldis afturhvarfi
  7. Fylgdu notkun: Fylgdu API köllum í samræmi við mörk áætlunarinnar

Tengd skjöl

Klárt að hækka þína
notendaupplifun?

Settu upp AI aðstoðarmenn sem gleðja viðskiptavini og stækka með fyrirtækinu þínu.

GDPR samhæft