Comhoiriúnacht API

Cuir sonraí isteach go clárnach i do bhunachar eolais AI SmartTalk ag baint úsáide as ár REST API. Oiriúnach do chomhtháthachtaí saincheaptha, píblínte uathoibríocha, agus aon fhoinse sonraí nach gcloítear le ár gconneoirí dúchasacha.

---

Forbhreathnú

Ligeann an comhoiriúnacht API duit:

• Doiciméid a chur go díreach chuig do bhunachar eolais
• Ábhar a nuashonrú go clárnach
• Iontrálacha seanbhunaithe a scriosadh
• Píblínte sonraí saincheaptha a thógáil
• Comhoiriúnú le haon chóras a bhfuil an cumas aige iarratais HTTP a dhéanamh

---

Réamhchoinníollacha

Sula dtosaíonn tú, déan cinnte go bhfuil:

• Cuntas AI SmartTalk gníomhach agat
• Rochtain API gníomhachtaithe (seiceáil do phlean)
• Eolas bunúsach ar REST APIs
• Uirlis chun iarratais HTTP a dhéanamh (curl, Postman, nó do chód feidhmchláir)

---

Ag fáil do Chreidiúnachtaí API

Céim 1: Rochtain ar Shocruithe API

1. Logáil isteach i do chuntas AI SmartTalk
2. Téigh chuig Socruithe → Comhoiriúnachtaí
3. Faigh API agus cliceáil Configúraigh

Céim 2: Cruthaigh Tóken API

1. Cliceáil Cruthaigh Tóken Nua
2. Cóipeáil do ID Múnla Comhrá agus Tóken API
3. Stóráil na sonraí seo go sábháilte—tá an tóken le feiceáil ach uair amháin!

⚠️ Rabhadh Slándála: Ná nocht do thóken API i gcód ar thaobh an chliant nó i stórtha poiblí.

---

Críochfoirt API

URL Bun

https://api.aismarttalk.tech/v1

Údarú

Teastaíonn do thóken API i gceann an iarratais:

Authorization: Bearer YOUR_API_TOKEN

---

API Endpoints

Bun URL

https://api.aismarttalk.tech/v1

Aithint

Éilíonn gach iarratas do thóken API sa cheann:

Authorization: Bearer YOUR_API_TOKEN

---

Iompórtáil Doiciméid

Endpoint

POST /documents/import

Comhlacht Iarratais

{
  "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"
      }
    }
  ]
}

Paraiméadair

Réimse	Cineál	Éigeantach	Cur síos
chatModelId	string	✅	Do shainaitheoir uathúil samhail comhrá
documents	array	✅	Raon de na nithe doiciméid
documents[].title	string	✅	Teideal doiciméid le haghaidh aitheantais
documents[].content	string	✅	Ábhar téacs iomlán
documents[].url	string	❌	URL foinsí (le haghaidh tagartha)
documents[].metadata	object	❌	Pócaí eochair-bhainistíochta saincheaptha

Freagra

{
  "success": true,
  "imported": 1,
  "documents": [
    {
      "id": "doc_abc123",
      "title": "Product Documentation",
      "status": "processing"
    }
  ]
}

Sampla: 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"
      }
    ]
  }'

---

Ceistigh Doiciméid

Cuir ceisteanna i gcoinne do bhunachar eolais go clár.

Endpoint

POST /chat/query

Comhlacht Iarratais

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

Freagra

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

---

Faigh Doiciméid

Faigh doiciméid a comhoibríonn le ceist (gan freagra AI).

Endpoint

POST /documents/search

Comhlacht Iarratais

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

Freagra

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

---

Samplaí Cóid

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="Tugaimid loingseoireacht saor in aisce ar ordaithe os cionn $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',
  'Is féidir leat earraí a thabhairt ar ais laistigh de 30 lá ó cheannach...',
  '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' => 'Sonraí an Táirge',
            'content' => 'Tá na sonraí seo a leanas ag ár widget...',
            '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));

---

Cásanna Úsáide

Comhoiriúnacht CMS Saincheaptha

Comhoiriúnacht ábhair ó CMS príobháideach:

• Ceangail le himeachtaí foilsithe CMS
• Cuir ábhar nua/nua-aistrithe chuig AI SmartTalk
• Bain ábhar scriosta

Conair Dháta

Iompórtáil ó stóras sonraí:

• Easpórtáil sonraí ábhartha go JSON
• Iompórtáil grúpa trí API
• Sceidealáil nuashonruithe rialta

Táirgí E-gnó

Comhoiriúnacht sonraí táirgí ó chóras saincheaptha:

• Cur síos ar tháirgí
• Sonraí
• Eolas praghsála

Córas Laistigh

Ceangail uirlisí laistigh nach dtacaítear leo go dúchasach:

• Wikis saincheaptha
• Bunachair shíoraí
• Feidhmchláir phríobháideacha

---

Teorainneacha Ráta

Críochfort	Teorainn Ráta
Iompórtáil Doiciméad	100 iarratais / nóiméad
Ceist	60 iarratais / nóiméad
Cuardach	60 iarratais / nóiméad

Nóta: Athraíonn teorainneacha ráta de réir plean. Déan teagmháil le tacaíocht le haghaidh teorainneacha níos airde.

---

Láimhseáil Earráidí

Formáid Freagartha Earráide

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

Códanna Earráide Coitianta

Cód	Cur Síos	Réiteach
INVALID_TOKEN	Token mícheart nó as dáta	Athghiniúint an API token
INVALID_MODEL_ID	ID múnla comhoibrithe nach bhfuil ar eolas	Seiceáil do ID Múnla Comhoibrithe
RATE_LIMITED	Ró-iarratais	Cur i bhfeidhm ar ais, déan iarracht níos déanaí
INVALID_REQUEST	Comhlacht iarratais mífhoirmiúil	Seiceáil struchtúr JSON
DOCUMENT_TOO_LARGE	Ábhar ag dul thar theorainn	Roinn isteach i doiciméid níos lú
QUOTA_EXCEEDED	Teorainneacha plean sroichte	Uasghrádú nó déan teagmháil le tacaíocht

---

Réiteach Fadhbanna

Teip ar Dhíghlasáil

Ceist	Réiteach
401 Neamhdhliste	Seiceáil go bhfuil an token ceart agus gníomhach
Token nach bhfuil ag obair	Athghiniúint an token i socruithe
Token as dáta	Ní théann na tokena as dáta, ach is féidir iad a chur ar ceal

Fadhbanna Iompórtála

Ceist	Réiteach
Freagra folamh	Seiceáil go bhfuil an Cineál Ábhair mar application/json
Doiciméad nach bhfuil le feiceáil	Fan le haghaidh próiseála; seiceáil an chuid Eolas
Iompórtáil páirteach	D'fhéadfadh roinnt doiciméid a bheith le hearráidí bailí

Fadhbanna Feidhmíochta

Ceist	Réiteach
Iompórtálacha mall	Batch doiciméid (uasmhéid 100 in iarratas)
Amanna ama	Laghdú ar mhéid an bhata, déan iarracht le hais
Teorainn ráta	Cur i bhfeidhm ar ais exponenciúil

---

Cleachtais is Fearr

1. Iompórtálacha bata: Seol doiciméid il in iarratas (suas le 100)
2. Teidil uathúla: Úsáid teidil tuairiscigh, uathúla do gach doiciméad
3. Ábhar struchtúrtha: Feabhsóidh ábhar go maith foirmiúil freagraí AI
4. Tiontú metadata: Úsáid metadata le haghaidh catagóireachta agus scagadh
5. Tokena slán: Stóráil tokena i n-athróg timpeallachta
6. Láimhseáil earráidí: Cur i bhfeidhm ar loighic athiarrachta le hais exponenciúil
7. Monatóireacht ar úsáid: Rianaigh glaonna API i gcoinne teorainneacha do phlean

---

Doiciméadacht Gaolmhar

• Forbhreathnú ar Chomhtháthachtaí
• Doiciméadacht API Iomlán
• Bainistíocht Bunachar Eolais
• SmartFlow Webhooks — Faigh imeachtaí