Interface: GuardrailRequest

@kortexya/reasoninglayer / Guardrail / GuardrailRequest

Interface: GuardrailRequest

Defined in: src/types/guardrail.ts:187

Request body for the conversation guardrail.

Remarks

Body of POST /api/v1/guardrail/conversation. Uses the snake_case wire format (assistant_message, citation_features, service_description).

citationFeatures names the identifier features that constitute a citation in the caller’s corpus (e.g. document_id, page, passage_id, char_span). They are resolved from each supporting leaf fact and inlined on certified claims. The names are client-defined — source_uri (the ingestion convention) is always attempted regardless.

Example

const request: GuardrailRequest = {
  assistantMessage: 'Aspirin is contraindicated for this patient.',
  citationFeatures: ['document_id', 'page'],
  serviceDescription: 'A clinical decision-support assistant.',
};

Properties

assistantMessage

assistantMessage: string

Defined in: src/types/guardrail.ts:189

The assistant (or user) turn to decompose and certify.

citationFeatures?

optional citationFeatures: string[]

Defined in: src/types/guardrail.ts:195

Names of the identifier features that constitute a citation in the caller’s corpus. Resolved from each supporting leaf fact and inlined on certified claims.

serviceDescription?

optional serviceDescription: string | null

Defined in: src/types/guardrail.ts:200

Optional description of what the AI service is supposed to do (grounds capability claims).