Searching knowledge

Search Help Center articles and indexed documents from your agent.

Call searchKnowledgeSources to search Help Center articles and indexed documents you already keep in Plain. It returns matching passages. Put those in your model prompt so the agent answers from your content. The API key needs knowledgeSource:read.

Two kinds of source:

• Help Center articles in Plain’s Help Center
• Indexed documents you have indexed for AI (docs site, marketing pages)

const results = await plain.query.searchKnowledgeSources({
  searchQuery: "how do I reset my password?",
  pageSize: 5,
});

for (const result of results) {
  console.log(result.content);

  if (result.__typename === "HelpCenterArticleSearchResult") {
    const article = await result.helpCenterArticle;
    console.log(article.title);
  } else if (result.__typename === "IndexedDocumentSearchResult") {
    const doc = await result.indexedDocument;
    console.log(doc.url);
  }
}

The return type is a union. Narrow with __typename (or instanceof). See union types.

pageSize defaults to 10 (1–50). searchQuery is 1–1000 characters.

Use results in a prompt

content is the matched passage. Concatenate the top results:

const results = await plain.query.searchKnowledgeSources({
  searchQuery: customerQuestion,
  pageSize: 5,
});

const knowledge = results.map((r) => r.content).join("\n\n---\n\n");

const reply = await myModel.generate({
  system: "You are a customer support agent. Answer only from the knowledge below.",
  prompt: `Knowledge:\n\n${knowledge}\n\nQuestion: ${customerQuestion}`,
});

Then reply, suggest, or note. Keep the article title or document URL if you want citations.

Options

Option	Type	What it does
types	[INDEXED_DOCUMENT | HELP_CENTER_ARTICLE]	Restrict to one kind. Omit to search both.
labelTypeIds	[ID!]	Only indexed documents with these label types.
includeNonCustomerFacing	Boolean	Include Help Centers that are not customer-facing. Default false.

Help Center only:

const results = await plain.query.searchKnowledgeSources({
  searchQuery: customerQuestion,
  options: { types: ["HELP_CENTER_ARTICLE"] },
});

labelTypeIds without types searches indexed documents only. Labels do not apply to Help Center articles.

Resources

• GraphQL SDK
• Build a support agent
• Help Center