Integrazioni

Questa guida mostra come collegare l'API di ricerca della documentazione agli strumenti più comuni: Intercom, Zendesk, Slack e chatbot personalizzati.

Intercom (Fin AI Agent)

L'AI Agent Fin di Intercom supporta i Data Connectors: origini di ricerca esterne che Fin consulta insieme agli articoli di Intercom. Collega l'API di ricerca della documentazione per consentire a Fin di rispondere alle domande direttamente dalla documentazione di Jamdesk.

---

Zendesk (MCP Server)

Le funzionalità di IA di Zendesk supportano i server MCP come origini di conoscenza. Usa il server MCP integrato di Jamdesk per collegare la documentazione agli agenti IA di Zendesk senza scrivere codice personalizzato.

---

Chatbot personalizzati

Aggiungi la ricerca nella documentazione a qualsiasi chatbot o app web con una chiamata fetch standard. CORS è abilitato, quindi i client basati su browser possono chiamare direttamente l'API senza un proxy backend.

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("---");
});

Creazione di uno strumento per un AI Agent

Passa i risultati della ricerca come contesto a un modello linguistico per generare risposte basate sulla documentazione:

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

---

Bot Slack

Crea un comando slash /docs di Slack che cerca nella documentazione e pubblica i risultati in qualsiasi canale.

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");
})();

Imposta JAMDESK_API_KEY nelle variabili d'ambiente della tua app Slack. Non inserire mai la chiave direttamente nel codice.

---

Hosting su sottopercorso (Cloudflare Worker)

Se utilizzi l'hosting su sottopercorso per pubblicare la documentazione su un percorso del tuo dominio (/docs per impostazione predefinita o un sottopercorso personalizzato come /help), anche la route /_api deve essere inoltrata tramite il tuo Cloudflare Worker, insieme al percorso della documentazione.

Aggiungi /_api all'array PROXY_PATHS nel worker, utilizzando il prefisso del percorso configurato nel dashboard:

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

In questo modo le richieste di ricerca a yoursite.com/_api/search (o a yoursite.com/help/_api/search, se utilizzi un sottopercorso personalizzato) vengono inoltrate al sito della documentazione Jamdesk.