Skip to content

feature: opt-in log data in /v1/checks response #2064

Description

@m-misiura

Did you check the docs?

  • I have read all the NeMo-Guardrails docs

Is your feature request related to a problem? Please describe.

The /v1/checks endpoint returns no observability into which rails ran, their execution order, or timing.

Describe the solution you'd like

Support an options.log field in the /v1/checks request (consistent with how /v1/chat/completions handles it) that enables opt-in log data in the response, e.g. activated_rails list. The response shape could add an optional log field that is only present when requested.

Describe alternatives you've considered

I considered relying solely on:

  • external observability only (tracing/metrics); this is useful but doesn't help with request-scoped debugging

Additional context

This issue is closely related to the RailsResult SDK contract question (issue for extending RailsResult with richer metadata (#2062)). If RailsResult is extended to include activated rails and per-rail status at the SDK level, surfacing log data here becomes straightforward; just expose the new fields in the response. If RailsResult stays thin, the endpoint would need to reach past check_async() into GenerationResponse/GenerationLog directly, which couples the server to internal structures. The approach taken on the SDK contract will likely inform the design here.

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or requeststatus: needs triageNew issues that have not yet been reviewed or categorized.

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions