AgencyMod API

AgencyModとAgencyAIを、お使いのチケットシステム、ウェブサイト、ヘルプデスクで利用できます。ダッシュボードで設定したすべての内容（名前、口調、レベル、指示、ナレッジ、ドキュメント、チームから学習した内容）を使って回答します。

ダッシュボードを開く AI設定

はじめに

01ダッシュボードのAIタブを開き、AgencyMod APIでキーを作成します。キーは一度だけ表示されるので、すぐにコピーしてください。
02キーはサーバー上に保存してください。ウェブサイト、アプリ、または他の人が開けるものには絶対に入力しないでください。
03ヘッダー Authorization: Bearer とキーを付けて、チケットの会話をAPIに送信します。
04回答をチケットに表示します。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);

リクエスト

JSON本文でPOSTします。次のフィールドが読み取られます: POST https://bot.agencyscripts.dev/api/v1/chat

messages: 会話を古い順に最大20件まで指定します。role はお客様の場合 user、以前のボットの回答の場合 assistant です。content はテキストです。最後のメッセージは user から送られている必要があります。必須です。
customer: お客様の名前です。ボットが呼びかける際に使用します。任意です。
messages[].name: メッセージ内の、書いた人の名前です。1つのチケットに複数人が書き込む場合に便利です。任意です。

レスポンス

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: 支払い、BAN、ボットでは解決できない問題など、人間が引き継ぐ必要がある場合は true です。
bot: ブランディングのボット名とアバターです。Discordと同じように回答を表示するために使います。
level: 回答したAgencyAIのレベルです。V1、V1.5、V2のいずれかです。
usage: 残りの利用枠（パーセント）、チャージ残高、リクエストの上限です。
ai_notice: 回答がAIによって作成されたことを示す短い注記です。お客様に表示して、AIが回答したことが常に分かるようにしてください。

利用枠を確認

同じヘッダーを付けて /api/v1/status にGETリクエストを送ると、ボットの名前とアバター、残りの利用枠が返されます。利用枠は消費されません。

cURL

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

上限と利用枠

01Premiumでは、APIは週のAI利用枠の最大半分まで使用できます。そのため、Discordのために常に利用枠が残ります。利用枠は毎週月曜日にリセットされます。
02APIの利用枠を使い切ると、チャージ残高で続行します。チャージはダッシュボードのAIタブから行えます。チャージ残高に期限はありません。
03Premiumがない場合、レベルV1の小さなお試し利用枠が付与されます。サーバーに少なくとも20人のメンバーがいて、7日間AgencyModが導入されている必要があります。
04キーごとに1分あたり20リクエスト、Premiumでは1日1,000リクエスト、Premiumがない場合は150リクエストです。サーバーごとに最大5つのキーを作成できます。

エラー

400: messages がないか、最後のメッセージが user からのものではありません。
401: キーがないか、間違っているか、取り消されています。
402: 利用枠を使い切りました。チャージするか、Premiumを取得してください。
403: サーバーが、Premiumなしの場合のAPIの条件をまだ満たしていません。
429: リクエストが多すぎます。少し待ってから、もう一度お試しください。
503: AgencyAIが応答しませんでした。もう一度お試しください。

セキュリティキーを持つ人はあなたのAI利用枠を使用します。キーが漏えいした場合は、ダッシュボードで取り消して新しいキーを作成してください。APIはサーバーからの呼び出し用に作られているため、ブラウザから直接呼び出すことはできません。

より良い回答のためにAPIは、Discordのボットと同じナレッジを使用します。AIタブでナレッジとドキュメントのリンクを入力し、解決済みチケットからの学習提案を承認してください。承認された項目は、DiscordとAPIの両方を同時に改善します。

わからないことがありますか? help.agencyg.de で AgencyMod のカテゴリにチケットを作成するか、Discord でご質問ください。プライバシーポリシーと利用規約