Microsoft.Agents.Core.Models Namespace

The AadResourceUrls.

Defines values for CardAction Types.

Define values for common event names used by activities of type Event.

Defines values for ActivityImportance.

The type ActivityTreatment indicates that this object will contain metadata to indicate to clients how the activity should be handled.

Treatment types for ActivityTreatment.

Defines values for ActivityTypes.

Defines the structure that arrives in the Activity.Value.Action for Invoke activity with Name of 'adaptiveCard/action'.

Defines the structure that is returned as the result of an Invoke activity with Name of 'adaptiveCard/action'.

Defines the structure that arrives in the Activity.Value for Invoke activity with Name of 'adaptiveCard/action'.

The AI Citations Entity.

An animation card (Ex: gif or short video clip).

Represents how the citation will be rendered.

An attachment within an activity.

Defines values for AttachmentLayoutTypes.

Audio card.

A basic card.

Constants used to populate the CallerId property.

A card action represents a clickable or interactive button for use within cards or as suggested actions. They are used to solicit input from users.Despite their name, card actions are not limited to use solely on cards.

Card actions are meaningful only when sent to channels.

Channels decide how each action manifests in their user experience.In most cases, the cards are clickable. In others, they may be selected by speech input.In cases where the channel does not offer an interactive activation experience (e.g., when interacting over SMS), the channel may not support activation whatsoever.The decision about how to render actions is controlled by normative requirements elsewhere in this document (e.g.within the card format, or within the suggested actions definition).

An image on a card.

Channel account information needed to route a message.

Represents a channel identifier, optionally including a sub-channel. Provides parsing, equality, and conversion operations for channel IDs.

Channel definitions. The various "support" methods come from: https://learn.microsoft.com/en-us/azure/bot-service/bot-service-channels-reference?view=azure-bot-service-4.0

Citations used in the message.

The client citation.

The client citation appearance.

Represents the different possible values for the client citation icon name.

The value field of a ICommandResultActivity contains metadata related to a command result. An optional extensible data payload may be included if defined by the command result activity name. The presence of an error field indicates that the original command failed to complete.

The value field of a ICommandActivity contains metadata related to a command. An optional extensible data payload may be included if defined by the command activity name.

Defines values for ContactRelationUpdateActionTypes.

Conversation accounts represent the identity of conversations within a channel. In channels that support only a single conversation between two accounts (e.g. SMS), the conversation account is persistent and does not have a predetermined start or end. In channels that support multiple parallel conversations (e.g. email), each conversation will likely have a unique ID.

Parameters for creating a new conversation.

The conversationReference type contains a reference into another conversation. In its most minimal form, this reference may only contain the IDs of the target conversation. Implementers may wish to carry additional information in the conversationReference, such as the identity and roles of participants, and the ID of a specific activity within the conversation. Consumers of the conversationReference type are not provided any de facto guarantees about the validity or consistency of the IDs within the object; this is instead conferred by the sender who created the object.

The conversationReference type is frequently used to store a reference to a conversation so it can be later retrieved and used to continue a conversation.

DeliveryModes define how an Agent receiving an Activity replies to the sender. DeliveryMode

Defines values for EndOfConversationCodes.

Entities carry metadata about an activity or conversation. Each entity's meaning and shape is defined by the type field. Additional type-specific fields sit as peers to the type field.

Some Microsoft entities may have a preexisting field called type. Parties integrating these entities into the activity entity format are advised to define field-level mapping to resolve conflicts with the type field name and other incompatibilities with serialization requirement A2001 as part of the IRI defining the entity type.

Frequently, entities used within Activity Protocol are also expressed elsewhere using JSON-LD[17]. The entity format is designed to be compatible with JSON-LD contexts, but does not require senders or receivers to implement JSON-LD to successfully process an entity.

Object representing error information.

Contents of the reply to an operation which returns expected Activity replies.

Extension methods for converting strongly typed Card objects to Attachment.

Set of key-value pairs. Advantage of this section is that key and value properties will be rendered with default style information with some delimiter between them. So there is no need for developer to specify style information.

GeoCoordinates (entity type: "https://schema.org/GeoCoordinates").

Contains utility methods for creating various event types.

Defines values for handoff event names.

A Hero card (card with a single, large image).

Public Extensions for IActivity. type

Object representing inner http error.

Defines values for InputHints.

Defines values for InstallationUpdateActionTypes.

A tuple class containing an HTTP status code and a JSON-serializable object.

A tuple class containing an HTTP status code and a JSON-serializable object. The HTTP status code is, in the invoke activity scenario, what will be set in the resulting POST. The body of the resulting POST will be the JSON-serialized content from the Body property.

Media card.

Supplementary parameter for media events.

Media URL.

Mention information (entity type: "mention").

Contains utility methods for various message types a Agent can return.

Message reaction object.

Defines values for MessageReactionTypes.

A card representing a request to perform a sign in via OAuth.

Page of members.

Place (entity type: "https://schema.org/Place").

A receipt card.

An item on a receipt card.

A response containing a resource ID.

Defines values for RoleTypes.

Defines the query options in the SearchInvokeValue for Invoke activity with Name of 'application/search'.

Defines the structure that is returned as the result of an Invoke activity with Name of 'adaptiveCard/search'.

Defines values for SearchInvokeTypes. See SearchInvokeValue.

Defines the structure that arrives in the Activity.Value for Invoke activity with Name of 'application/search'.

Represents a reference to a programmatic action.

Indicates whether the semantic action is starting, continuing, or done.

The sensitivity usage info.

The sensitivity usage info pattern.

A card representing a request to sign in.

Names for signin invoke operations in the token protocol.

A type containing information for single sign-on.

Defines constants that can be used in the processing of speech interactions.

Stream information will be included in an Entity in the Activity.

The type of streaming message being sent.

SuggestedActions that can be performed.

Defines values for TextFormatTypes.

Refers to a substring of content within another field.

Thing (entity type: "https://schema.org/Thing").

A thumbnail card (card with a single, small thumbnail image).

Thumbnail URL.

A request to exchange a token.

The response object of a token exchange invoke.

The TokenExchangeRequest.

Record for a token exchange request that is sent as part of Authentication.

State object passed to the Token Service.

Helps provide polling for token details.

Response schema sent back from Azure Token Service required to initiate a user token direct post.

A request to receive a user token.

A response that includes a user token.

The status of a particular token.

Transcript.

Video card.

An Activity is the basic communication type for the Activity Protocol used with Agents.

Asynchronous external command.

Asynchronous external command result.

A user has added an Agent to their contact list, removed the Agent from their contact list, or otherwise changed the relationship between user and Agent.

The referenced conversation has been updated.

Conversation is ending, or a request to end the conversation.

Asynchronous external event.

Control of the conversation has been transferred, or a request to transfer control of the conversation.

An Agent was installed or removed from a channel.

Synchronous request to invoke an operation.

A message in a conversation.

Represents a request to delete a previous message activity in a conversation.

A reaction to a Message Activity.

Represents a request to update a previous message activity in a conversation.

Represents a private suggestion to the Recipient about another activity.

Represents a point in a Agent's logic, to help with Agent debugging.

The From address is typing.