View as Markdown
Writer icon

Writer ACTION

Ask Knowledge Graph

Ask a natural-language question grounded in one or more of your Writer Knowledge Graphs (RAG). Returns an answer with its sources. Use List Knowledge Graphs first to resolve the graph id(s) you want to query. For free-form generation not grounded in your documents, use Send Prompt instead. Example: call with graphIds=["a1b2..."] and question="What are the park hours?" -> returns { question, answer, sources, references }. If a graph has no relevant content it returns a graceful 'no relevant information' answer rather than an error. See the documentation
  • Action
  • Read only
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Writer account once, then configure and run Ask Knowledge Graph from your backend or agent.

import { PipedreamClient } from "@pipedream/sdk"

const pd = new PipedreamClient({
  projectId: process.env.PIPEDREAM_PROJECT_ID!,
  clientId: process.env.PIPEDREAM_CLIENT_ID!,
  clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
  projectEnvironment: "production",
})

const result = await pd.actions.run({
  id: "writer-ask-knowledge-graph",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    writer: { authProvisionId: "apn_xxxxxxx" },
    graphIds: ["Graph IDs"],
    question: "Question",
  },
})

console.log(result)

SCHEMA

Inputs

Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.

Ask Knowledge Graph inputs
Property Type Description
graphIds Graph IDs string[]
One or more Knowledge Graph UUIDs to query (at least one). Resolve ids with List Knowledge Graphs.
Required
question Question string
The natural-language question to answer from the selected Knowledge Graph(s). Example: What are the park hours?
Required
subqueries Subqueries boolean
Whether to break the question into subqueries for a more thorough search. Defaults to false.
Optional
queryConfig Query Config object

Advanced configuration for the Knowledge Graph query, controlling search behavior, grounding, and citations. All keys are optional — supply only the ones you want to override. Supported keys:

  • max_subquestions (integer, 1-10, default 6) — max subquestions generated for complex queries. Higher = more detail, lower = faster.
  • search_weight (integer, 0-100, default 50) — ranking weight; higher (→100) favors keyword matching, lower (→0) favors semantic similarity.
  • grounding_level (number, 0.0-1.0, default 0) — how closely answers stick to source material; higher (→1.0) allows more creative interpretation, lower (→0.0) stays grounded.
  • max_snippets (integer, 1-60, default 30) — max context snippets retrieved. Values below 5 may return no results; recommended range 5-25.
  • max_tokens (integer, 100-8000, default 4000) — max tokens in the generated answer. Higher = longer answers, lower = shorter/faster.
  • keyword_threshold (number, 0.0-1.0, default 0.7) — keyword-match strictness; higher (→1.0) requires stronger keyword matches.
  • semantic_threshold (number, 0.0-1.0, default 0.7) — semantic-similarity strictness; higher (→1.0) requires stronger similarity.
  • inline_citations (boolean, default false) — include inline citations in the response showing which sources were used. Example: { "max_subquestions": 4, "grounding_level": 0.2, "inline_citations": true }.
Optional

REFERENCE

Tool details

Behavior hints are published with the component in the Pipedream registry and surface as MCP tool annotations, so an agent can reason about a tool before it calls it.

Registry key
writer-ask-knowledge-graph
Version
0.0.2
App
Writer
Authentication
API key
Read-only
Yes
Destructive
No
Open world
Yes