MEmetacognition
NLQ

Nlq Execute

post/nlq/execute

Request

Request body

querystring required

Natural language query to execute

enable_pruningboolean

Enable schema pruning (planner)

use_local_intelligenceboolean

Use local intelligent planner (planner)

executeboolean

If true, execute IntentGraph via intent matching

enrichboolean

If true, enrich results with neighboring nodes/edges for agent context (DEPRECATED - use intent matching)

enrich_limitinteger

Max neighbors per edge type during enrichment (DEPRECATED)

compactboolean

If true, return agent-friendly output (redact internal fields, keep only relevant context)

require_helix_qlboolean

DEPRECATED: If true, fail when planner doesn't return helix_ql (legacy mode)

Response

Successful Response

executedboolean required

Whether intent matching was performed

helixdb_querystring nullable

DEPRECATED: Legacy HelixQL query string (not used in intent matching mode)

chunksobject[]

DEPRECATED: Resolved chunk contents (use intent_matches.evidence instead)

unresolved_chunk_idsstring[]

DEPRECATED: Unresolved chunk IDs (not used in intent matching mode)

contextobject

DEPRECATED: Agent context (use intent_matches.bindings/documents instead)

helixdb_resultobject nullable

DEPRECATED: Legacy HelixDB query result (use intent_matches instead)

helixdb_errorstring nullable

Error message if intent matching failed

nlq_status'ok' | 'degraded' | 'failed' | 'not_executed' | 'no_data'

Outcome of retrieval. ok: executed cleanly. degraded: results returned but something was relaxed or a secondary leg failed (see degraded_reasons). failed: graph/vector retrieval failed and returned nothing (HTTP status is still 200). not_executed: plan-only request (execute=false). no_data: this tenant has no knowledge graph yet (the planner is not called).

degraded_reasonsstring[]

Stable codes for why nlq_status is degraded/failed: graph_unavailable, vector_unavailable, plan_unavailable, graph_relation_substituted, graph_relation_dropped, graph_relation_unverified, graph_plan_relaxed

Changes

No recorded changes to this operation across all 1 revision of this API.