Skip to content

Commit f6e5db8

Browse files
committed
Update doc on source of truth
1 parent ac3f43b commit f6e5db8

1 file changed

Lines changed: 15 additions & 9 deletions

File tree

docs/CITATION.md

Lines changed: 15 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -30,10 +30,10 @@ The activity graph should have a [Message thing](#message-thing).
3030

3131
A [Message thing](https://schema.org/Message) represent the message activity itself and act as the root of the [activity graph](#activity-graph). It must have the following fields:
3232

33-
- `@context` of `"https://schema.org"`
34-
- `@id` of `""` (an empty string means self in JSON-LD fashion)
35-
- `@type` of `"Message"`
36-
- `type` of `"https://schema.org/Message"`
33+
- `@context` of `"https://schema.org"`
34+
- `@id` of `""` (an empty string means self in JSON-LD fashion)
35+
- `@type` of `"Message"`
36+
- `type` of `"https://schema.org/Message"`
3737

3838
### Non-URL citation
3939

@@ -53,7 +53,7 @@ Bot developers should implement citations as outlined in this section to ensure
5353

5454
Notes:
5555

56-
- The third citation is a non-URL citation, its link `cite:1` is currently ignored
56+
- The third citation is a non-URL citation, its link `cite:1` is ignored and treated as an opaque string
5757

5858
```
5959
Sure, you should override the default proxy settings[1]​[2], when your proxy server requires authentication[3].
@@ -73,8 +73,10 @@ Sure, you should override the default proxy settings[1]​[2], when your proxy s
7373

7474
Please refer to the graph for details of each fields. Notably:
7575

76-
- Only compact from is supported (i.e. nested objects), other forms and object references are not supported unless stated otherwise
77-
- Subclasses are not supported. If the object is expected to be `Message`, it must not be `EmailMessage` (subclass)
76+
- Only compact from is supported (i.e. nested objects), other forms and object references are not supported unless stated otherwise
77+
- Subclasses are not supported. If the object is expected to be `Message`, it must not be `EmailMessage` (subclass)
78+
79+
> Notes: In some older versions of Web Chat, we were using root-level and unconnected `Claim` thing. This is strictly used internally and its usage is being deprecated.
7880
7981
#### Sample payload
8082

@@ -193,7 +195,11 @@ We use `position` instead of `@id` to match the link definition in Markdown to t
193195

194196
### Source of truths
195197

196-
If there are deviations of information in Markdown and Message thing, the Message thing should take precedence over the Markdown, given the receiver understood the Message thing.
198+
> This is updated in PR [5564](https://github.com/microsoft/BotFramework-WebChat/pull/5564) in 2025-08-29.
199+
200+
~If there are deviations of information in Markdown and Message thing, the Message thing should take precedence over the Markdown, given the receiver understood the Message thing.~
201+
202+
If there are deviations of information in Markdown and Message thing, the Markdown should take precedence over the Message thing. This is to support plain text channels (text/SMS) as they do not have capacity to display content from the Message thing.
197203

198204
### `usageInfo` on the `Message` thing should be a blank node
199205

@@ -203,4 +209,4 @@ In JSON-LD, blank node means a node that does not have any contents but `@id` an
203209

204210
## Further reading
205211

206-
- [Microsoft Teams: Bot messages with AI-generated content](https://learn.microsoft.com/en-us/microsoftteams/platform/bots/how-to/bot-messages-ai-generated-content?tabs=after%2Cbotmessage#citations)
212+
- [Microsoft Teams: Bot messages with AI-generated content](https://learn.microsoft.com/en-us/microsoftteams/platform/bots/how-to/bot-messages-ai-generated-content?tabs=after%2Cbotmessage#citations)

0 commit comments

Comments
 (0)