Interface: PropertyGraphQueryRequest

@kortexya/reasoninglayer / PropertyGraphQueryRequest

Interface: PropertyGraphQueryRequest

Defined in: src/types/property-graph.ts:23

Request accepted by the GQL/Cypher/Gremlin compatibility endpoints.

Remarks

Sent to POST /api/v1/gql, /api/v1/cypher, /api/v1/gremlin and their /translate counterparts. The tenant is determined from the X-Tenant-Id header.

The query text is parsed in the source language and lowered to an OSFQL program, which is what actually executes against the OSF knowledge base. There is no separate property-graph store — nodes and edges are Psi-terms.

Example

const request: PropertyGraphQueryRequest = {
  query: 'MATCH (p:person) RETURN p',
};

Properties

query

query: string

Defined in: src/types/property-graph.ts:25

GQL, Cypher, or Gremlin query text.