API ինտեգրում

Տվյալները ծրագրային կերպով մղեք ձեր AI SmartTalk գիտելիքների բազա՝ օգտագործելով մեր REST API-ը: Հարմար է հարմարեցված ինտեգրացիաների, ավտոմատացված pipelines-ի և ցանկացած տվյալների աղբյուրի համար, որը չի ընդգրկվում մեր բնիկ միացիչներով:

---

Ընդհանուր տեղեկություններ

API ինտեգրումը ձեզ թույլ է տալիս.

• Մղել փաստաթղթեր անմիջապես ձեր գիտելիքների բազա
• Թարմացնել բովանդակություն ծրագրային կերպով
• Ջնջել հին գրառումներ
• Կառուցել հարմարեցված տվյալների pipelines
• Ինտեգրվել ցանկացած համակարգի հետ, որը կարող է կատարել HTTP հարցումներ

---

Պահանջներ

Մինչ սկսելը, համոզվեք, որ ունեք.

• Ակտիվ AI SmartTalk հաշիվ
• API մուտք գործելու հնարավորություն (փոխեք ձեր պլանը)
• REST API-ների հիմունքների մասին հիմնական գիտելիքներ
• HTTP հարցումներ կատարելու գործիք (curl, Postman, կամ ձեր ծրագրային կոդը)

---

Ձեր API հավատարմագրերի ստացումը

Քայլ 1: մուտք գործել API կարգավորումներ

1. Մուտք գործեք ձեր AI SmartTalk հաշիվ
2. Նավարկեք դեպի Կարգավորումներ → Ինտեգրումներ
3. Գտեք API և սեղմեք Կարգավորել

Քայլ 2: Ստեղծել API նշան

1. Սեղմեք Ստեղծել նոր նշան
2. Պատճենեք ձեր Chat Model ID և API Token
3. Պահպանեք դրանք անվտանգ՝ նշանը ցույց է տրվում միայն մեկ անգամ!

⚠️ Անվտանգության զգուշացում: Մի երբեք բացահայտեք ձեր API նշանը հաճախորդի կողմի կոդում կամ հանրային ռեպոզիտորիաներում:

---

API վերջնակետեր

Հիմնական URL

https://api.aismarttalk.tech/v1

Ավտորիզացիա

Բոլոր հարցումները պահանջում են ձեր API նշանը գլխում:

Authorization: Bearer YOUR_API_TOKEN

---

API Endpoints

Base URL

https://api.aismarttalk.tech/v1

Authentication

Բոլոր հարցումները պահանջում են ձեր API տոքենը գլխիկում:

Authorization: Bearer YOUR_API_TOKEN

---

Import Documents

Endpoint

POST /documents/import

Request Body

{
  "chatModelId": "your-chat-model-id",
  "documents": [
    {
      "title": "Product Documentation",
      "content": "Full content of your document goes here...",
      "url": "https://example.com/docs/product",
      "metadata": {
        "category": "documentation",
        "language": "en"
      }
    }
  ]
}

Parameters

Field	Type	Required	Description
chatModelId	string	✅	Ձեր յուրահատուկ զրույցի մոդելի նույնականիչը
documents	array	✅	Փաստաթղթերի օբյեկտների զանգված
documents[].title	string	✅	Փաստաթղթի վերնագիրը նույնականացման համար
documents[].content	string	✅	Լրիվ տեքստային բովանդակություն
documents[].url	string	❌	Հիմնական URL (հղման համար)
documents[].metadata	object	❌	Անհատական բանալի-արժեք զույգեր

Response

{
  "success": true,
  "imported": 1,
  "documents": [
    {
      "id": "doc_abc123",
      "title": "Product Documentation",
      "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": "Getting Started Guide",
        "content": "Welcome to our platform. Here is how to get started...",
        "url": "https://docs.example.com/getting-started"
      }
    ]
  }'

---

Query Documents

Հարցեր տվեք ձեր գիտելիքների բազային ծրագրային կերպով:

Endpoint

POST /chat/query

Request Body

{
  "chatModelId": "your-chat-model-id",
  "query": "How do I reset my password?",
  "options": {
    "maxTokens": 500,
    "temperature": 0.7
  }
}

Response

{
  "success": true,
  "response": "To reset your password, navigate to Settings > Security > Change Password...",
  "sources": [
    {
      "documentId": "doc_abc123",
      "title": "Security Guide",
      "relevance": 0.95
    }
  ]
}

---

Retrieve Documents

Ստացեք փաստաթղթեր, որոնք համապատասխանում են հարցմանը (без AI պատասխան):

Endpoint

POST /documents/search

Request Body

{
  "chatModelId": "your-chat-model-id",
  "query": "password security",
  "limit": 10
}

Response

{
  "success": true,
  "documents": [
    {
      "id": "doc_abc123",
      "title": "Security Best Practices",
      "content": "...",
      "relevance": 0.92
    }
  ]
}

---

Կոդի Օրինակներ

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: Shipping",
    content="We offer free shipping on orders over $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: Returns',
  'You can return items within 30 days of purchase...',
  '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' => 'Product Specifications',
            'content' => 'Our widget has the following specifications...',
            '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));

---

Օգտագործման Գործիքներ

Անհատական CMS Ինտեգրում

Ներքին CMS-ից բովանդակության սինխրոնացում:

• Միանալ CMS-ի հրապարակման իրադարձություններին
• Նոր/թարմացված բովանդակություն ուղարկել AI SmartTalk
• Հեռացնել ջնջված բովանդակությունը

Տվյալների Փողով

Ներմուծում տվյալների պահոցներից:

• Հետադարձել համապատասխան տվյալները JSON ձևաչափով
• Բաժանորդային ներմուծում API-ի միջոցով
• Պարբերաբար թարմացումներ ծրագրավորել

Էլեկտրոնային առևտրի Ապրանքներ

Սինխրոնացնել ապրանքների տվյալները անհատական համակարգերից:

• Ապրանքի նկարագրություններ
• Տեխնիկական բնութագրեր
• Գների տեղեկություններ

Ներքին Համակարգեր

Միացնել ներքին գործիքներ, որոնք բնորոշ չեն աջակցվում:

• Անհատական վիքիներ
• Հին տվյալների բազաներ
• Անհատական ծրագրեր

---

Հաշվարկային սահմաններ

Վերջնակետ	Հաշվարկային սահման
Փաստաթղթի ներմուծում	100 հարցում/րոպե
Հարցում	60 հարցում/րոպե
Որոնում	60 հարցում/րոպե

Նշում: Հաշվարկային սահմանները տարբեր են ըստ ծրագրի: Կապվեք աջակցության հետ ավելի բարձր սահմանների համար:

---

Ошибка обработка

Ошибка Ответ Формат

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

Հաճախակի սխալների կոդեր

Կոդ	Նկարագրություն	Հետաքրքրություն
INVALID_TOKEN	Վատ կամ ժամկետանց նշան	Վերածնեք API նշանը
INVALID_MODEL_ID	Անհայտ զրույցի մոդելի ID	Проверить ваш Chat Model ID
RATE_LIMITED	Շատ հարցումներ	Կիրառեք հետաձգում, կրկնեք ավելի ուշ
INVALID_REQUEST	Սխալ ձևավորված հարցման մարմին	Проверить структуру JSON
DOCUMENT_TOO_LARGE	Բովանդակությունը գերազանցում է սահմանը	Տեղափոխեք ավելի փոքր փաստաթղթերի
QUOTA_EXCEEDED	Ծրագրի սահմանները հասել են	Վերանորոգեք կամ կապվեք աջակցության հետ

---

Խնդիրների լուծում

Հավաստագրման ձախողումներ

Խնդիր	Հետաքրքրություն
401 Անհավատարմագրված	Проверить, որ նշանը ճիշտ և ակտիվ է
Նշանը չի աշխատում	Վերածնեք նշանը կարգավորումների մեջ
Ժամկետանց նշան	Նշանները չեն ժամկետանցվում, բայց կարող են չեղարկվել

Ներմուծման խնդիրներ

Խնդիր	Հետաքրքրություն
դատարկ պատասխան	Проверить, որ Content-Type-ը application/json է
Փաստաթուղթը չի երևում	Սպասեք մշակման; проверять Knowledge բաժինը
Կիսատ ներմուծում	Որոշ փաստաթղթեր կարող են ունենալ վավերացման սխալներ

Կատարողական խնդիրներ

Խնդիր	Հետաքրքրություն
Աργա ներմուծումներ	Բաժիններ փաստաթղթերը (մաքս. 100 հարցման համար)
Ժամկետանցումներ	Կրճատեք խմբի չափը, կրկնեք հետաձգումով
Հաշվարկային սահման	Կիրառեք էքսպոնենցիալ հետաձգում

---

Լավագույն պրակտիկաներ

1. Բաժիններ ներմուծումներ: Ապահովեք մի քանի փաստաթղթեր յուրաքանչյուր հարցման համար (մինչև 100)
2. Հատուկ վերնագրեր: Օգտագործեք նկարագրական, հատուկ վերնագրեր յուրաքանչյուր փաստաթղթի համար
3. Կառուցված բովանդակություն: Լավ ձևավորված բովանդակությունը բարելավում է AI պատասխանները
4. Մետադատում նշում: Օգտագործեք մետադատում դասակարգման և ֆիլտրավորման համար
5. Ապահով նշաններ: Պահպանեք նշանները միջավայրի փոփոխականներում
6. Սխալները կառավարեք: Կիրառեք կրկնման տրամաբանություն էքսպոնենցիալ հետաձգումով
7. Դիտեք օգտագործումը: Հաշվեք API զանգերը ձեր ծրագրի սահմանների դեմ

---

Հասարակացված փաստաթղթեր

• Ինտեգրացիաների ընդհանուր տեսություն
• Ամբողջ API փաստաթղթավորում
• Գիտելիքների բազայի կառավարում
• SmartFlow Webhooks — Ստացեք իրադարձություններ