Edit

Display custom context in Conversation summary

Important

Power Virtual Agents capabilities and features are now part of Microsoft Copilot Studio following significant investments in generative AI and enhanced integrations across Microsoft Copilot.

Some articles and screenshots might refer to Power Virtual Agents while we update documentation and training content.

The data type of the context variables is a JSON object with two properties: isDisplayable and Value.

The JSON object has the following schema:

{
            "type": "object",
             "properties": {
                    "isDisplayable": {
                        " description": " Context variable should display in agent UI or not",
                        "type": "boolean"
                    },
                    "Value": {
                         " description": " Context variable value pass through bot , this can be string Boolean or number",
                        "type": "string or Boolean or Number"
                    }
                },
                "required": [ "isDisplayable", "Value" ]            
        }

The input value for isDisplayable is:

  • Boolean (true or false)

The input value for Value can be:

  • Boolean
  • String
  • Number

To display the context variables in the Conversation Summary Control of conversations for Copilot Studio and Azure bots, use the isDisplayable property in the body of setContextProvider method.

Example: {\"isDisplayable\":\"true\"," +"\"Value\":\"context variable value as string\"}

The input value for isDisplayable is a Boolean value (true or false). The input value for Value can be a string, Boolean value, or number.

To display context variables in the ../use/oc-customer-summary.md#view-conversation-summary for conversations that use Microsoft Copilot Studio or Azure bots, include the isDisplayable property in the body of the reference/methods/setContextProvider.md method.

The following example displays a string context variable:

{ "isDisplayable": true, "Value": "Context variable value" }

When isDisplayable is set to true, the context variable appears on the third tab of the Conversation Summary control. The Value property contains the user's response or other information in string, Boolean, or number format.

Conversation Summary control displaying custom context variables.

Send custom context
setContextProvider

  • Last updated on