Skip to main content

chatReport

ChatReport Model​

Represents a report associated with a chat, providing classification details and metadata for review and resolution.

id (integer, Read-only)​

Unique identifier for the chat report.

category (string)​

Categorization of the report based on its context.

  • Enum: CORRECT, INCORRECT, NO_INFO

reason (string, Nullable)​

Specific reason for the report. Required for INCORRECT and NO_INFO; must be null for CORRECT.

Enum: NOT_IN_DOCS, INCORRECT_RESPONSE, INCORRECT_NO_INFO, NONE, CORRECT_NO_INFO, NEW_INFO_REQUEST

severity (string, Nullable)​

Severity level of the issue reported. Required for INCORRECT and NO_INFO; must be null for CORRECT.

Enum: INFO, LOW, MEDIUM, HIGH

topic (string) Required​

Topic associated with the report.

  • Min length: 1
  • Max length: 255

comments (string, Nullable)​

Optional user comments elaborating on the report.

status (string, Nullable)​

Current resolution status of the report.
Enum: NO_ISSUES, OPEN, IN_PROGRESS, SOLVED_IN_DEV, READY_FOR_QA, IN_QA, SOLVED_IN_TESTING, RESOLVED

created_at (string, Read-only, date-time)​

Timestamp indicating when the report was created.

updated_at (string, Read-only, date-time)​

Timestamp indicating the last time the report was updated.

chat (integer, Nullable, Optional)​

ID of the associated chat conversation. At least one of chat or assistant must be provided.

assistant (integer, Nullable, Optional)​

ID of the associated assistant. If chat is provided and assistant is omitted, the backend uses the chat's assistant.

Example​

{
  "category": "INCORRECT",
  "reason": "INCORRECT_RESPONSE",
  "severity": "HIGH",
  "topic": "string",
  "comments": "string",
  "status": "OPEN",
  "chat": 0,
  "assistant": 0
}