Share via

ClientCitation interface

Package:
@microsoft/agents-activity

Represents a Teams client citation to be included in a message.

Remarks

Learn more about Bot messages with AI-generated content

Properties

@type

Required; must be "Claim"
appearance

Optional; if provided, the citation will be displayed in the message.
position

Required. Number and position of the citation.

Property Details

@type

Required; must be "Claim"

@type: "Claim"

Property Value

"Claim"

appearance

Optional; if provided, the citation will be displayed in the message.

appearance: { @type: "DigitalDocument", abstract: string, encodingFormat?: "application/vnd.microsoft.card.adaptive", image?: { @type: "ImageObject", name: ClientCitationIconName }, keywords?: string[], name: string, text?: string, url?: string, usageInfo?: SensitivityUsageInfo }

Property Value

{ @type: "DigitalDocument", abstract: string, encodingFormat?: "application/vnd.microsoft.card.adaptive", image?: { @type: "ImageObject", name: ClientCitationIconName }, keywords?: string[], name: string, text?: string, url?: string, usageInfo?: SensitivityUsageInfo }

position

Required. Number and position of the citation.

position: number

Property Value

number