AgencyMod API

Használd az AgencyModot az AgencyAI-val a saját jegyrendszeredben, weboldaladon vagy helpdeskedben. Mindent figyelembe vesz, amit az irányítópulton beállítottál: név, hangnem, szint, utasítások, tudásanyag, dokumentáció, és mindent, amit a csapatodtól tanult.

Irányítópult megnyitása AI-beállítások

Kezdés

01Nyisd meg az irányítópultot, az AI fület, és hozz létre kulcsot az AgencyMod API alatt. Azonnal másold ki, mert csak egyszer látható.
02Tárold a kulcsot a szerveredén. Soha ne tedd weboldalba, appba vagy bármi olyanba, amit mások is megnyithatnak.
03Küldd el a jegy beszélgetését az API-nak a Authorization: Bearer fejléccel és a kulcsoddal.
04Jelenítsd meg a választ a jegyedben. Ha a needs_team értéke true, értesítsd a csapatodat.

Példa

cURL

curl https://bot.agencyscripts.dev/api/v1/chat \
  -H "Authorization: Bearer amk_..." \
  -H "Content-Type: application/json" \
  -d '{"customer":"Alex","messages":[{"role":"user","content":"How do I join the server?"}]}'

JavaScript (Node.js)

const antwort = await fetch("https://bot.agencyscripts.dev/api/v1/chat", {
  method: "POST",
  headers: {
    Authorization: "Bearer " + process.env.AGENCYMOD_KEY,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    customer: "Alex",
    messages: [
      { role: "user", content: "How do I join the server?" },
    ],
  }),
});
const { answer, needs_team } = await antwort.json();

PHP

$ch = curl_init("https://bot.agencyscripts.dev/api/v1/chat");
curl_setopt_array($ch, [
  CURLOPT_POST => true,
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer " . getenv("AGENCYMOD_KEY"),
    "Content-Type: application/json",
  ],
  CURLOPT_POSTFIELDS => json_encode([
    "customer" => "Alex",
    "messages" => [["role" => "user", "content" => "How do I join the server?"]],
  ]),
]);
$antwort = json_decode(curl_exec($ch), true);

Kérés

POST kérés JSON törzzsel. Ezek a mezők kerülnek beolvasásra: POST https://bot.agencyscripts.dev/api/v1/chat

messages: A beszélgetés, a legrégebbitől a legújabbig, legfeljebb 20 üzenet. A role a vevőnél user, a korábbi bot-válaszoknál assistant, a content pedig a szöveg. Az utolsó üzenetnek a usertől kell származnia. Kötelező.
customer: Az ügyfél neve, hogy a bot megszólíthassa. Opcionális.
messages[].name: Egy üzeneten belül: annak a személynek a neve, aki írta. Akkor hasznos, ha többen írnak ugyanabban a jegyben. Opcionális.

Válasz

JSON

{
  "answer": "...",
  "needs_team": false,
  "bot": { "name": "AgencyMod", "avatar": "https://cdn.discordapp.com/..." },
  "level": "V1",
  "usage": {
    "available_percent": 92.5,
    "credit_percent": 0,
    "requests_today": 14,
    "requests_per_day": 1000,
    "requests_per_minute": 20,
    "premium": true
  },
  "ai_notice": "This answer was generated automatically by an AI (AgencyAI)."
}

answer: A válasz egyszerű szövegként, egyszerű markdownnal.
needs_team: true, ha embernek kell átvennie, például fizetések, kitiltások vagy olyan problémák esetén, amelyeket a bot nem tud megoldani.
bot: A név és az avatár a márkázásodból, hogy a válasz pontosan úgy jelenjen meg, mint a Discordban.
level: Az AgencyAI szint, amely válaszolt: V1, V1.5 vagy V2.
usage: A fennmaradó keret százalékban, a feltöltött egyenleged és a kérési korlátaid.
ai_notice: Rövid megjegyzés, hogy a választ AI írta. Mutasd meg az ügyfeleidnek, hogy mindig tudják, ha AI válaszolt.

Keret ellenőrzése

A /api/v1/status címre küldött GET kérés ugyanazzal a fejléccel visszaadja a bot nevét és avatárját, valamint a fennmaradó keretedet, anélkül hogy bármit felhasználna belőle.

cURL

curl https://bot.agencyscripts.dev/api/v1/status \
  -H "Authorization: Bearer amk_..."

Korlátok és keret

01Premiummal az API a heti AI-kereted legfeljebb felét használhatja, így a Discordnak mindig marad keret. A keret minden hétfőn újraindul.
02Ha az API-keret kimerül, a feltöltött egyenleggel folytatódik. A feltöltések az irányítópult AI fülén találhatók, és soha nem járnak le.
03Premium nélkül kis próbakeretet kapsz a V1 szinten. Ehhez legalább 20 tag és 7 napig az AgencyMod a szerveren kell.
04Kulcsonként percenként 20 kérés, Premiummal naponta 1000, Premium nélkül 150. Szerverenként legfeljebb 5 kulcs.

Hibák

400: A messages hiányzik, vagy az utolsó üzenet nem a usertől származik.
401: A kulcs hiányzik, hibás vagy visszavonták.
402: A keret elfogyott. Tölts fel, vagy szerezz Premiumot.
403: A szerver Premium nélkül még nem felel meg az API követelményeinek.
429: Túl sok kérés. Várj egy kicsit, és próbáld újra.
503: Az AgencyAI nem válaszolt. Próbáld újra.

BiztonságBárki, akinek megvan a kulcsod, a te AI-keretedet használja. Ha egy kulcs kiszivárog, vonod vissza az irányítópulton, és hozz létre újat. Az API a szerveredről érkező hívásokra készült, a böngészők nem hívhatják közvetlenül.

Jobb válaszokAz API ugyanazt a tudást használja, mint a bot a Discordban. Töltsd ki a tudásanyagot és a dokumentációs linkeket az AI fülön, és hagyd jóvá a megoldott jegyekből érkező tanítási javaslatokat. Minden jóváhagyott bejegyzés egyszerre javítja a Discordot és az API-t.

Valami nem világos? Nyiss ticketet a help.agencyg.de oldalon, az AgencyMod kategóriában, vagy kérdezz a Discord szerverünkön. Adatvédelmi szabályzat és felhasználási feltételek