Share via

AIEntity interface

Package:
@microsoft/agents-activity

Represents a generic Entity.

Extends
Entity

Properties

@context

Required as 'https://schema.org
@id

Must be left blank. This is for Bot Framework schema.
@type

Required as 'Message
additionalType

Indicate that the content was generated by AI.
citation

Optional; if citations object is included, the sent activity will include the citations, referenced in the activity text.
type

Required as 'https://schema.org/Message'
usageInfo

Optional; if usage_info object is included, the sent activity will include the sensitivity usage information.

Property Details

@context

Required as 'https://schema.org

@context: "https://schema.org"

Property Value

"https://schema.org"

@id

Must be left blank. This is for Bot Framework schema.

@id: ""

Property Value

""

@type

Required as 'Message

@type: "Message"

Property Value

"Message"

additionalType

Indicate that the content was generated by AI.

additionalType: ["AIGeneratedContent"]

Property Value

["AIGeneratedContent"]

citation

Optional; if citations object is included, the sent activity will include the citations, referenced in the activity text.

citation?: ClientCitation[]

Property Value

ClientCitation[]

type

Required as 'https://schema.org/Message'

type: "https://schema.org/Message"

Property Value

"https://schema.org/Message"

usageInfo

Optional; if usage_info object is included, the sent activity will include the sensitivity usage information.

usageInfo?: SensitivityUsageInfo

Property Value

SensitivityUsageInfo