Agency Docs

AgencyMod API

Χρησιμοποίησε το AgencyMod με τον AgencyAI στο δικό σου σύστημα tickets, ιστότοπο ή helpdesk. Απαντά με όλα όσα έχεις ρυθμίσει στον πίνακα ελέγχου: όνομα, ύφος, επίπεδο, οδηγίες, γνώση, τεκμηρίωση και όσα έχει μάθει από την ομάδα σου.

Ξεκίνα

  1. 01Άνοιξε τον πίνακα ελέγχου, την καρτέλα AI, και δημιούργησε ένα κλειδί στο AgencyMod API. Αντίγραψέ το αμέσως, εμφανίζεται μόνο μία φορά.
  2. 02Αποθήκευσε το κλειδί στον server σου. Ποτέ σε ιστότοπο, εφαρμογή ή κάτι που μπορούν να ανοίξουν άλλοι.
  3. 03Στείλε τη συνομιλία ενός ticket στο API με την κεφαλίδα Authorization: Bearer και το κλειδί σου.
  4. 04Εμφάνισε την απάντηση στο ticket σου. Αν το needs_team είναι true, ειδοποίησε την ομάδα σου.

Παράδειγμα

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

Αίτημα

POST με σώμα JSON. Διαβάζονται αυτά τα πεδία: POST https://bot.agencyscripts.dev/api/v1/chat

messages
Η συνομιλία, με το παλαιότερο πρώτο, έως 20 μηνύματα. Το role είναι user για τον πελάτη και assistant για προηγούμενες απαντήσεις του bot, το content είναι το κείμενο. Το τελευταίο μήνυμα πρέπει να προέρχεται από τον χρήστη. Υποχρεωτικό.
customer
Το όνομα του πελάτη, ώστε το bot να μπορεί να του απευθυνθεί. Προαιρετικό.
messages[].name
Μέσα σε ένα μήνυμα: το όνομα του ατόμου που το έγραψε, χρήσιμο όταν γράφουν πολλοί σε ένα ticket. Προαιρετικό.

Απάντηση

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
Η απάντηση ως απλό κείμενο με απλό markdown.
needs_team
true αν πρέπει να αναλάβει άνθρωπος, για παράδειγμα για πληρωμές, bans ή προβλήματα που το bot δεν μπορεί να λύσει.
bot
Όνομα και avatar από το branding σου, ώστε η απάντηση να φαίνεται ακριβώς όπως στο Discord.
level
Το επίπεδο AgencyAI που απάντησε: V1, V1.5 ή V2.
usage
Το υπόλοιπο ορίου σε ποσοστό, το υπόλοιπο συμπλήρωσής σου και τα όρια αιτημάτων σου.
ai_notice
Μια σύντομη σημείωση ότι η απάντηση γράφτηκε από AI. Εμφάνισέ τη στους πελάτες σου, ώστε να ξέρουν πάντα ότι απάντησε AI.

Έλεγχος ορίου

Ένα αίτημα GET στο /api/v1/status με την ίδια κεφαλίδα επιστρέφει το όνομα και το avatar του bot και το υπόλοιπο ορίου σου, χωρίς να χρησιμοποιεί τίποτα από αυτό.

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

Όρια και όριο χρήσης

  1. 01Με Premium το API μπορεί να χρησιμοποιήσει έως τη μισή εβδομαδιαία ποσόστωση AI σου, ώστε να μένει πάντα όριο για το Discord. Το όριο μηδενίζεται κάθε Δευτέρα.
  2. 02Όταν τελειώσει το όριο του API, συνεχίζει με το υπόλοιπο συμπλήρωσής σου. Οι συμπληρώσεις γίνονται στον πίνακα ελέγχου, στην καρτέλα AI, και δεν λήγουν ποτέ.
  3. 03Χωρίς Premium παίρνεις ένα μικρό δοκιμαστικό όριο στο επίπεδο V1. Χρειάζεται τουλάχιστον 20 μέλη και το AgencyMod στον server σου για 7 ημέρες.
  4. 0420 αιτήματα ανά λεπτό ανά κλειδί, 1.000 αιτήματα την ημέρα με Premium και 150 χωρίς. Έως 5 κλειδιά ανά server.

Σφάλματα

400
Λείπει το messages, ή το τελευταίο μήνυμα δεν προέρχεται από τον χρήστη.
401
Το κλειδί λείπει, είναι λάθος ή έχει ανακληθεί.
402
Το όριο έχει εξαντληθεί. Συμπλήρωσε ή απόκτησε Premium.
403
Ο server δεν πληροί ακόμα τις προϋποθέσεις για το API χωρίς Premium.
429
Πολλά αιτήματα. Περίμενε λίγο και δοκίμασε ξανά.
503
Ο AgencyAI δεν απάντησε. Δοκίμασε ξανά.
ΑσφάλειαΌποιος έχει το κλειδί σου χρησιμοποιεί το όριο AI σου. Αν διαρρεύσει ένα κλειδί, ανάκλεσέ το στον πίνακα ελέγχου και δημιούργησε νέο. Το API είναι φτιαγμένο για κλήσεις από τον server σου, οι περιηγητές δεν μπορούν να το καλέσουν απευθείας.
Καλύτερες απαντήσειςΤο API χρησιμοποιεί την ίδια γνώση με το bot σου στο Discord. Συμπλήρωσε τη γνώση και τους συνδέσμους τεκμηρίωσης στην καρτέλα AI, και ενέκρινε τις προτάσεις εκπαίδευσης από λυμένα tickets. Κάθε εγκεκριμένη καταχώριση βελτιώνει ταυτόχρονα το Discord και το API.

Κάτι δεν είναι σαφές; Άνοιξε ticket στο help.agencyg.de στην κατηγορία AgencyMod ή ρώτα στο Discord μας. Πολιτική απορρήτου και όροι

Δεν προχωρά ούτε μετά από αυτή τη σελίδα; Από εδώ αναλαμβάνει η υποστήριξή μας.