Skip to content
Ishvana Ishvana Docs

Suggest Rewrites

POST
/api/writing/proseguard/suggest-rewrites

Generate deterministic rewrite suggestions for ProseGuard violations.

Phase A9 of the M15 DE migration replaced the LLM rewrite pass with :func:backend.core.services.writing.proseguard_rewrite_engine.suggest_rewrite, a rule-family-keyed recipe engine. Violations whose rule_id has no registered recipe are dropped from the response (matches the LLM-pass failure semantics so the frontend keeps rendering only the suggestions it can act on).

Request Body required

Section titled “Request Body required ”
SuggestRewritesRequest

Request to generate AI-powered rewrite suggestions for ProseGuard violations.

object
violations
required
Violations
Array<object>
ViolationForRewrite

A single violation to generate a rewrite suggestion for.

object
ruleId
required
Ruleid
string
violatingText
required
Violatingtext
string
context
required
Context
string
message
required
Message
string
documentId
Documentid
string
""

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Successful Response

SuggestRewritesResponse

Response with suggested rewrites for violations.

object
suggestions
Suggestions
Array<object>
RewriteSuggestion

A suggested rewrite for a violation.

object
violationIndex
required
Violationindex
integer
originalText
required
Originaltext
string
suggestedRewrite
required
Suggestedrewrite
string
explanation
required
Explanation
string

422

Section titled “422 ”

Validation Error

HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object