Skip to content

docs: add guidance for modifying messages during chat moderation #3379

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
splindsay-92 wants to merge 1 commit into
base: main
Choose a base branch
from
+15 −0
Open

docs: add guidance for modifying messages during chat moderation #3379

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions src/pages/docs/chat/moderation/custom/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,13 +54,28 @@ The request has the following JSON format.
"action": "accept|reject",
"rejectionDetail": {
"key": "string"
},
"message": {
"text": "string",
"metadata": {
"key": "any"
},
"headers": {
"key": "string"
}
}
}
```
</Code>

* `action`: Must be either `accept` or `reject`. `accept` means that the message will be published to the chat room, `reject` means it will be rejected.
* `rejectionDetail`: Optional. If provided with `action: "reject"`, a map of string key-value pairs containing structured information about why the message was rejected. Both keys and values must be strings. This information may be sent back to clients via the `ErrorInfo.detail` field. The total response payload must not exceed 32 KiB in size.
* `message`: Optional. Omit this object to publish the original message unchanged. Provide it to modify the message before it is published.

When provided, the `message` object behaves as a full replacement of the original message's `text`, `metadata`, and `headers`, not a partial update:

* `text` is required and cannot be empty. Moderation fails if `text` is missing or empty.
* `metadata` and `headers` are optional. If you omit either one, it is removed from the published message. To preserve the original `metadata` or `headers`, copy them from the request `message` into the response.

### Error handling <a id="error"/>

Expand Down