集成

本指南介绍如何将 Docs Search API 连接到最常用的工具：Intercom、Zendesk、Slack 和自定义聊天机器人。

Intercom（Fin AI Agent）

Intercom 的 Fin AI Agent 支持 Data Connectors：Fin 可与 Intercom 文章一起查询的外部搜索源。连接 Docs Search API 后，Fin 可以直接从 Jamdesk 文档中回答问题。

---

Zendesk（MCP 服务器）

Zendesk 的 AI 功能支持将 MCP 服务器作为知识源。使用 Jamdesk 内置的 MCP 服务器，无需编写自定义代码即可将文档连接到 Zendesk 的 AI 代理。

---

自定义聊天机器人

通过标准的 fetch 调用，为任何聊天机器人或 Web 应用添加文档搜索。由于已启用 CORS，基于浏览器的客户端无需后端代理即可直接调用 API。

async function searchDocs(query) {
  const response = await fetch(
    "https://your-project.jamdesk.app/_api/search",
    {
      method: "POST",
      headers: {
        "Authorization": "Bearer jd_live_c83003a54ae0a83123454c3f7ec82f0a",
        "Content-Type": "application/json",
      },
      body: JSON.stringify({ query, limit: 5 }),
    }
  );

  if (!response.ok) {
    const { error } = await response.json();
    throw new Error(error);
  }

  const data = await response.json();
  return data.results;
}

// Example usage
const results = await searchDocs("How do I configure a custom domain?");

results.forEach((result) => {
  console.log(`[${result.score.toFixed(2)}] ${result.title}`);
  console.log(result.content);
  console.log(result.url);
  console.log("---");
});

构建 AI 代理工具

将搜索结果作为上下文传递给语言模型，以生成基于文档的回答：

import Anthropic from "@anthropic-ai/sdk";

const client = new Anthropic();

async function answerFromDocs(userQuestion) {
  // 1. Search your docs
  const results = await searchDocs(userQuestion);
  const context = results
    .map((r) => `[${r.title}](${r.url})\n${r.content}`)
    .join("\n\n---\n\n");

  // 2. Pass context to Claude
  const message = await client.messages.create({
    model: "claude-sonnet-4-5-20241022",
    max_tokens: 1024,
    messages: [
      {
        role: "user",
        content: `Answer the following question using only the provided documentation excerpts.
If the answer isn't in the docs, say so.

Documentation:
${context}

Question: ${userQuestion}`,
      },
    ],
  });

  return message.content[0].text;
}

---

Slack 机器人

构建一个 /docs Slack 斜杠命令，搜索文档并将结果发布到任意频道。

import { App } from "@slack/bolt";

const app = new App({
  token: process.env.SLACK_BOT_TOKEN,
  signingSecret: process.env.SLACK_SIGNING_SECRET,
});

app.command("/docs", async ({ command, ack, respond }) => {
  await ack();

  const query = command.text.trim();
  if (!query) {
    await respond("Usage: `/docs <your question>`");
    return;
  }

  try {
    const response = await fetch(
      "https://your-project.jamdesk.app/_api/search",
      {
        method: "POST",
        headers: {
          "Authorization": `Bearer ${process.env.JAMDESK_API_KEY}`,
          "Content-Type": "application/json",
        },
        body: JSON.stringify({ query, limit: 3 }),
      }
    );

    const data = await response.json();

    if (data.results.length === 0) {
      await respond(`No results found for: _${query}_`);
      return;
    }

    const blocks = [
      {
        type: "section",
        text: {
          type: "mrkdwn",
          text: `*Results for:* _${query}_`,
        },
      },
      { type: "divider" },
      ...data.results.flatMap((result) => [
        {
          type: "section",
          text: {
            type: "mrkdwn",
            text: `*<${result.url}|${result.title}>*\n${result.content}`,
          },
        },
        { type: "divider" },
      ]),
    ];

    await respond({ blocks });
  } catch (err) {
    await respond(`Error searching docs: ${err.message}`);
  }
});

(async () => {
  await app.start(process.env.PORT || 3000);
  console.log("Slack bot is running");
})();

在 Slack 应用的环境变量中设置 JAMDESK_API_KEY。切勿将密钥硬编码。

---

子路径托管（Cloudflare Worker）

如果您使用子路径托管，将文档通过域名下的某个路径提供服务（默认为 /docs，也可以使用 /help 等自定义子路径），则还需要通过 Cloudflare Worker 代理 /_api 路由，并同时代理文档路径。

将 /_api 添加到 Worker 中的 PROXY_PATHS 数组，并使用您在仪表板中配置的路径前缀：

const PROXY_PATHS = [
  "/docs",  // or your custom subpath, e.g. "/help"
  "/_jd",
  "/_api",  // Add this line
];

这样，发送到 yoursite.com/_api/search 的搜索请求（如果使用自定义子路径，则为 yoursite.com/help/_api/search）就会转发到您的 Jamdesk 文档站点。