GETTING STARTED
Introduction to AgentAssist
Architecture and Configuration
Glossary
FAQ
Release Notes
Recent Updates
Previous Versions

SET UP AgentAssist
AgentAssist Setup Guide
Sign Up for AgentAssist
Conversation Automation
Automations Board
Create a Bot
Add Multiple Bots
Create Use Cases
Overview
FAQs Setup
Create Dialog Tasks
Welcome Event
LLM and Generative AI
Access Custom Data in Agent AI Bot
Search AI
Agent Coaching
Playbook
Customizing the Agent AI Widget
Configure Auto Summarization with Custom Dialog Tasks
Feedback Settings
Widget Theming (Layout Customization)
Supported Languages

INTEGRATIONS
AgentAssist Integration with Third-Party Applications
Amazon Connect
Amazon Connect with AgentAssist Voice Installation Guide
Amazon Connect with AgentAssist Chat Using Custom CCP
Amazon Connect with AgentAssist – Voice via AWS Third Party Applications
Channels
Voice
Configure Voice Channel
Configure Speech Recognition
Chat
SmartAssist
Configure AgentAssist
Demos
Voice Demo
Chat Demo
Salesforce
OmniChannel
Chat
Omni-Channel Configuration - Chat
AgentAssist Configuration - Chat
Web Messaging Configuration (New Chat)
Voice
Salesforce Service Cloud Voice (Amazon Connect Telephony)
Genesys Adapters
AgentAssist Voice Integration with Genesys CTI
Agent AI Voice Integration with CX Cloud from Genesys and Salesforce
NICE-CTI
Kore Agent AI with Salesforce NICE CX-CTI
Demos
Voice Demo
Chat Demo
Zendesk
Set up AgentAssist for Zendesk
Genesys
AgentAssist Integration with Genesys - Manual Setup Instructions
Agent AI Integration with Genesys Cloud CX using Kore Data Table
Set Up AgentAssist for Genesys
Change AgentAssist Bot in Genesys
Integrate Kore.ai Bot on Genesys Cloud CX Messaging
ServiceNow
NICE CX
NICE MAX Desktop (Chat and Voice)
NICE Agent Desktop (Voice)
Talkdesk
Twilio

AGENT EXPERIENCE
AgentAssist Widget
Bot Override and Automations

ANALYTICS
Conversation Logs
Dashboard
Agent AI ROI Analyzer (Beta)
APIs
Raw Data API v1
Raw Data API v2
Conversation Summary Trigger
Control Transcription API

Raw Data API v2

This updated version of the Raw Data API offers the following additional conversation data for deeper insights into AgentAssist interactions and conversation flows:

  • Feedback (reason code and feedback text in addition to like/dislike) from the agent.
  • Complete generated answers with feedback.
  • Comprehensive agent activity tracking.
  • Full end-user utterances.
  • Dialog task execution details.
  • Agent search bar activity timing.
  • Name of the queue involved in the conversation.
  • Number of times an agent uses the scroll up and scroll down buttons.
  • Names of the URLs an agent clicks.
  • Total number of words or phrases suggested to the agent.
  • Total number of words or phrases accepted by the agent.
  • Total number of words or phrases entered by the agent.
  • Total number of words suggested for correction by the agent.
  • Total number of auto-corrected words accepted by the agent.
Method  GET
Endpoint
https://{{host}}/agentassist/api/v1/public/{{streamid}}/v2/agentassistinteractions?from=YYYY-MM-DD-HH24:mm:SS&to=YYYY-MM-DD-HH24:mm:SS&offset=NNNNN&limit=0..100
Content Type application/json
Authorization  auth: {{JWT}}

See How to generate the JWT Token.

API Scope AgentAssist Analytics

Query Parameters

PARAMETER DESCRIPTION MANDATE
from Start date and time of the interactions in YYYY-MM-DD HH24:mm:SS format. Required
to End date and time of the interactions in YYYY-MM-DD HH24:mm:SS format. Required

Sample Request

curl --location 'https://{{host}}/agentassist/api/v1/public/st-f6ea0c31-f910-5b8e-82d8-dcbbc63xxxxx/v2/agentassistinteractions?from=2024-07-10T06%3A49%3A45&to=2024-07-10T07%3A06%3A25' \
--header 'accountId: 65433af84e520234494xxxxx' \
--header 'auth: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhcHBJZCI6ImNzLTE5ZjA0NzU0LWQ4MzQtNTgxOC04NzE0LWYyNGZlYzYxODgxNyJ9.DEVT2UGCTjryY_bDVGmun4-Vcp_R9-b0iRonWaB-MMA'

Headers

  • accountId (required): The account ID associated with the API request.
  • auth (required): Authentication token in the format Bearer <token>.

Sample Response

{

    "numResults": 3,

    "data": [

        {

            "conversationID": "atesta-m8rxxxxx",

            "botSessionID": "67e4f9805622dd06277xxxxx",

            "channel": "chat",

            "segmentID": "ac-9c35de2-14b3-472e-bebc-3b5d0daxxxxx",

            "segmentStartTime": "2025-03-27T07:08:47.597Z",

            "segmentEndTime": "2025-03-27T07:10:36.738Z",

            "countScrollUp": 3,

            "countScrollDn": 2,

            "agent": {

                "agentId": "a-m8r0iiln"

            },

            "tags": [

                {

                    "type": "message",

                    "name": "MessageKey",

                    "value": "MessageKeyVALUE",

                    "messageID": "ms-50f37525-736d-5182-8a54-94711d442730",

                    "createdAt": "2025-03-27T07:08:49.286Z"

                },

                {

                    "type": "session",

                    "name": "SessionKey",

                    "value": "SessionKeyVALUE",

                    "createdAt": "2025-03-27T07:08:48.096Z"

                }

            ],

            "summary": {

                "summaryId": "smr-adab467-72e9-4ec5-8d7a-2aabd1ab2bb0",

                "participant": {

                    "identity": "a-m8r0iiln",

                    "type": "AGENT",

                    "startTime": [],

                    "endTime": []

                },

                "type": "final",

                "summary": "",

                "editedSummary": "We're sorry, but there was a problem generating the summary for this conversation. Please create your own summary",

                "isError": true,

                "isDisabled": false,

                "isEdited": true,

                "exeStartTime": 1743059436693,

                "positionId": "dg-5rp9haf9nn",

                "sumSubTime": 1743059460053,

                "time": 23.36,

                "feedback": {

                    "response": "Down",

                    "reasonCode": [],

                    "comment": "end of summary"

                }

            },

            "agentActions": [

                {

                    "actionType": "SearchBarEntry",

                    "action": {

                        "searchPhrase": "Healthcare System in India, Healthcare India - IBEF",

                        "typingStartTime": "2025-03-27T07:10:02.278Z",

                        "executionStartTime": "2025-03-27T07:10:22.234Z",

                        "displayTime": "2025-03-27T07:10:25.419Z",

                        "suggestionsShown": [

                            "tech are using the wrng worlkss  teh",

                            "teh are using wrnog workds for the tesnsig",

                            "Healthcare System in India, Healthcare India - IBEF"

                        ],

                        "suggestionUsed": 1,

                        "phraseInput": "health teh ",

                        "correctionsPresented": 5,

                        "correctionsAccepted": 0,

                        "countDisplayedAnswers": {

                            "countDialogTasks": 0,

                            "countFaqs": 4,

                            "countWebPages": 5,

                            "countFiles": 2,

                            "countAnswers": 0,

                            "countFromNonNativeDataSource": 0

                        },

                        "suggestions": {

                            "faqs": [

                                {

                                    "sources": [

                                        {

                                            "title": "Which Insurance Companies offer Health Insurance Policies in India?",

                                            "url": "",

                                            "sourceType": "searchassist"

                                        }

                                    ],

                                    "content": "Which Insurance Companies offer Health Insurance Policies in India?",

                                    "positionId": "dg-r74fpqb3at",

                                    "appInfo": {

                                        "appName": "Prod SA",

                                        "featureFlag": "external",

                                        "product": "searchai",

                                        "_id": "67d2bf2595de4b4d5bb32e84",

                                        "displayLines": 4

                                    }

                                },

                                {

                                    "sources": [

                                        {

                                            "title": "Resend OTP",

                                            "url": "",

                                            "sourceType": "searchassist"

                                        }

                                    ],

                                    "content": "Resend OTP",

                                    "positionId": "dg-9d54h4frdq",

                                    "appInfo": {

                                        "appName": "Prod SA",

                                        "featureFlag": "external",

                                        "product": "searchai",

                                        "_id": "67d2bf2595de4b4d5bb32e84",

                                        "displayLines": 4

                                    }

                                },

                                {

                                    "sources": [

                                        {

                                            "title": "What is AYUSH Hospital?",

                                            "url": "",

                                            "sourceType": "searchassist"

                                        }

                                    ],

                                    "content": "What is AYUSH Hospital?",

                                    "positionId": "dg-cxd507th16",

                                    "appInfo": {

                                        "appName": "Prod SA",

                                        "featureFlag": "external",

                                        "product": "searchai",

                                        "_id": "67d2bf2595de4b4d5bb32e84",

                                        "displayLines": 4

                                    }

                                },

                                {

                                    "sources": [

                                        {

                                            "title": "What is AYUSH Treatment? Whether AYUSH Treatment is allowed in all Health Insurance Policies?",

                                            "url": "",

                                            "sourceType": "searchassist"

                                        }

                                    ],

                                    "content": "What is AYUSH Treatment? Whether AYUSH Treatment is allowed in all Health Insurance Policies?",

                                    "positionId": "dg-6xl89hve93h",

                                    "appInfo": {

                                        "appName": "Prod SA",

                                        "featureFlag": "external",

                                        "product": "searchai",

                                        "_id": "67d2bf2595de4b4d5bb32e84",

                                        "displayLines": 4

                                    }

                                }

                            ],

                            "web": [

                                {

                                    "sources": [

                                        {

                                            "title": "Healthcare System in India, Healthcare India - IBEF",

                                            "url": "https://searchassist.kore.ai/searchassistapi/redirect?rurl=https%3A%2F%2Fwww.ibef.org%2Findustry%2Fhealthcare-india&requestId=fsh-d3151f01-dd6d-5e3f-9229-956019b4343d&contentId=fc-00b44114-9bde-44ae-8084-9bb999676e8c&hId=955b136584ad076fd0309d69a6e3f3377e0920e960140f2cbdc955ca934d1c50"

                                        }

                                    ],

                                    "content": "",

                                    "positionId": "dg-ia5xj3w1yd",

                                    "appInfo": {

                                        "appName": "Prod SA",

                                        "featureFlag": "external",

                                        "product": "searchai",

                                        "_id": "67d2bf2595de4b4d5bb32e84",

                                        "displayLines": 4

                                    }

                                },

                                {

                                    "sources": [

                                        {

                                            "title": "Healthcare in India - Wikipedia",

                                            "url": "https://searchassist.kore.ai/searchassistapi/redirect?rurl=https%3A%2F%2Fen.wikipedia.org%2Fwiki%2FHealthcare_in_India&requestId=fsh-d3151f01-dd6d-5e3f-9229-956019b4343d&contentId=fc-6a06e2f8-90d0-4786-95bc-e8a27c3ff07e&hId=9f48681f49da231e23e26f724b14982af0fab99e37481748b2270f90e7e6b7f7"

                                        }

                                    ],

                                    "content": "",

                                    "positionId": "dg-vhmrypq1wj",

                                    "appInfo": {

                                        "appName": "Prod SA",

                                        "featureFlag": "external",

                                        "product": "searchai",

                                        "_id": "67d2bf2595de4b4d5bb32e84",

                                        "displayLines": 4

                                    }

                                },

                                {

                                    "sources": [

                                        {

                                            "title": "India's Ayush Industry & National AYUSH Mission | IBEF",

                                            "url": "https://searchassist.kore.ai/searchassistapi/redirect?rurl=https%3A%2F%2Fwww.ibef.org%2Findustry%2Fayush&requestId=fsh-d3151f01-dd6d-5e3f-9229-956019b4343d&contentId=fc-9a13b295-68c5-4557-94ba-81b6b7f07e90&hId=5aa0dcbff3bcac7296ea50804593759ffa5e2bda8f19abea62c626442657b2c0"

                                        }

                                    ],

                                    "content": "",

                                    "positionId": "dg-mtzuxnhj55l",

                                    "appInfo": {

                                        "appName": "Prod SA",

                                        "featureFlag": "external",

                                        "product": "searchai",

                                        "_id": "67d2bf2595de4b4d5bb32e84",

                                        "displayLines": 4

                                    }

                                },

                                {

                                    "sources": [

                                        {

                                            "title": "Banking in India: Growth, Trends, and Opportunities | IBEF",

                                            "url": "https://searchassist.kore.ai/searchassistapi/redirect?rurl=https%3A%2F%2Fwww.ibef.org%2Findustry%2Fbanking-india&requestId=fsh-d3151f01-dd6d-5e3f-9229-956019b4343d&contentId=fc-22a47b6a-e277-4a0a-9461-b4d5a2892fa2&hId=80e6d5170e6c1fd3dba566ba55dbcc1e33cdd8fc46c6fc5649504140851ac1f4"

                                        }

                                    ],

                                    "content": "",

                                    "positionId": "dg-zhx6h4ouktk",

                                    "appInfo": {

                                        "appName": "Prod SA",

                                        "featureFlag": "external",

                                        "product": "searchai",

                                        "_id": "67d2bf2595de4b4d5bb32e84",

                                        "displayLines": 4

                                    }

                                },

                                {

                                    "sources": [

                                        {

                                            "title": "Indian Agriculture Sector, Farming in India | IBEF",

                                            "url": "https://searchassist.kore.ai/searchassistapi/redirect?rurl=https%3A%2F%2Fwww.ibef.org%2Findustry%2Fagriculture-india&requestId=fsh-d3151f01-dd6d-5e3f-9229-956019b4343d&contentId=fc-ce79586c-3d4e-48a4-899c-7b149f2e5341&hId=8123ccc5b0412d4d6d3bee33e7ec97756c566921ad3a30907748426ade275aa6"

                                        }

                                    ],

                                    "content": "",

                                    "positionId": "dg-5vvxexjlll",

                                    "appInfo": {

                                        "appName": "Prod SA",

                                        "featureFlag": "external",

                                        "product": "searchai",

                                        "_id": "67d2bf2595de4b4d5bb32e84",

                                        "displayLines": 4

                                    }

                                }

                            ],

                            "file": [

                                {

                                    "sources": [

                                        {

                                            "title": "PM",

                                            "url": "https://searchassist.kore.ai/searchassistapi/redirect?rurl=https%3A%2F%2Fnha.gov.in%2FPM-JAY&requestId=fsh-d3151f01-dd6d-5e3f-9229-956019b4343d&contentId=fc-5a9dc6d5-3eef-5401-94e8-713cf93ea19d&hId=b5806f5bfd92daf057022b418ea1b84043eb18a6d28050117f56671925bdc19f"

                                        }

                                    ],

                                    "content": "flag [img/resources/flag.jpg] भारत सरकार GOVERNMENT OF <span class=\"highlightText\">INDIA</span> [https://www.mygov.in/] * 14555 [tel:14555] * Screen Reader Access [https://pmjay.gov.in/screen_reader] * Skip to main content * /sitemap.xml * https://www.facebook.com/AyushmanBharatGoI * https://twitter.com/ayushmannha * https://www.youtube.com/channel/UCkd7w2rww0HQB4lZ-l3dB6g * https://www.linkedin.com/company/ayushmanbharatgoi/ * https://www.instagram.com/ayushmanbharatnha/ * Quora image [img/gallery/quora.png] [https://www.quora.com/profile/Ayushman-Bharat-9?ch=3&amp;share=25d97ee9&amp;srid=bdecg] * A+ [javascript:;] * A [javascript:;] * A- [javascript:;] NHA [img/resources/logo.svg] [https://nha.gov.in/] IYC [img/resources/iyc.png] [https://nha.gov.in/] NATIONAL HEALTH AUTHORITY PM-JAY [img/resources/pmjay.png] [https://pmjay.gov.in/] * index.php * Home [https://nha.gov.in/] * About Us * NHA [NHA.php] * Who's who [Whos-who.php] * PM-JAY [PM-JAY.php] * ABDM [NDHM.php] * PM-JAY [https://pmjay.gov.in/] * ABDM [https://ndhm.gov.in/] * Blog [https://pmjay.gov.in/Blogs-list] * Connect with Us * Careers [Careers.php] * Contact Us [Contact-Us.php] * Tenders and Procurement [Tenders-Procurement.php] * Circulars [circulars.php] * PMJAY Dashboard [https://dashboard.pmjay.gov.in/pmj/#/] * ABDM Dashboard [https://dashboard.abdm.gov.in/abdm/] * PMJAY for 70+ * Enrol for PMJAY for 70+ [https://beneficiary.nha.gov.in/] * List of Empanelled Hospitals [https://hem.nha.gov.in/search] * FAQs [img/resources/English_FAQs_related_to_the_benefits_for_senior_citizens.pdf] * How to Make Ayushman Card [https://youtube.com/playlist?list=PLYcj0BpCoCc4yDCm7A4xxsjkg4gmxnWre&amp;si=6B2-_rj9TFB0fA-k] * Give a Missed Call [missedcall.php] * Am I Eligible [img/resources/am-i-eligible.png] [https://beneficiary.nha.gov.in/] * find1 [img/resources/find1.png] [https://hospitals.pmjay.gov.in/Search/empnlWorkFlow.htm?actionFlag=ViewRegisteredHosptlsNew] * Grievance Portal [img/resources/grivence.png] [https://cgrms.pmjay.gov.in/GRMS/] [https://pmjay.gov.in/MAP/images/icons/inner_bg2.png] ABOUT PRADHAN MANTRI JAN AROGYA YOJANA (PM-JAY) * Home [index.php] * About Pradhan Mantri Jan Arogya Yojana (PM-JAY) * About Ayushman Bharat * Background * Criteria/Coverage * Implementation * Financing * Hospital Empanelment * Packages and Rates * IT System * Awareness * Support Systems * Convergence AYUSHMAN BHARAT Ayushman Bharat, a flagship scheme of Government of India, was launched as",

                                    "appInfo": {

                                        "appName": "Prod SA",

                                        "featureFlag": "external",

                                        "product": "searchai",

                                        "_id": "67d2bf2595de4b4d5bb32e84",

                                        "displayLines": 4

                                    }

                                },

                                {

                                    "sources": [

                                        {

                                            "title": "NLM",

                                            "url": "https://searchassist.kore.ai/searchassistapi/redirect?rurl=https%3A%2F%2Fpmc.ncbi.nlm.nih.gov%2Farticles%2FPMC3093249%2F&requestId=fsh-d3151f01-dd6d-5e3f-9229-956019b4343d&contentId=fc-3137891f-fc01-5678-ba83-c6d6aaa910de&hId=bd9e0969b148275c4ce053ddc2c6b8a4bba1e21e1f6833cb6ef7cee9e023ed9b"

                                        }

                                    ],

                                    "content": "Skip to main content [/static/img/us_flag.svg] An official website of the United States government Here's how you know Here's how you know [/static/img/icon-dot-gov.svg] Official websites use .gov A .gov website belongs to an official government organization in the United States. [/static/img/icon-https.svg] Secure .gov websites use HTTPS A lock ( Locked padlock icon ) or https:// means you've safely connected to the .gov website. Share sensitive information only on official, secure websites. NCBI home page [/static/img/ncbi-logos/nih-nlm-ncbi--white.svg] [https://www.ncbi.nlm.nih.gov/] Search Log in * Dashboard [https://www.ncbi.nlm.nih.gov/myncbi/] * Publications [https://www.ncbi.nlm.nih.gov/myncbi/collections/bibliography/] * Account settings [https://www.ncbi.nlm.nih.gov/account/settings/] * Log out Search… Search NCBI Primary site navigation Close [/static/img/usa-icons/close.svg] Search Search [data:] Logged in as: * Dashboard [https://www.ncbi.nlm.nih.gov/myncbi/] * Publications [https://www.ncbi.nlm.nih.gov/myncbi/collections/bibliography/] * Account settings [https://www.ncbi.nlm.nih.gov/account/settings/] Log in Search PMC Full-Text Archive Search in PMC Search [/static/img/usa-icons-bg/search--white.svg] * Advanced Search [https://www.ncbi.nlm.nih.gov/pmc/advanced/] * Journal List [/journals/] * User Guide [/about/userguide/] * * https://doi.org/10.1016/S0140-6736(10)61894-6 * pdf/nihms292456.pdf * * * PERMALINK Copy As a library, NLM provides access to scientific literature. Inclusion in an NLM database does not imply endorsement of, or agreement with, the contents by NLM or the National Institutes of Health. Learn more: PMC Disclaimer [/about/disclaimer/] | PMC Copyright Notice [/about/copyright/] NIHPA Author Manuscripts logo [https://cdn.ncbi.nlm.nih.gov/pmc/banners/logo-nihpa.png] Lancet . Author manuscript; available in PMC: 2011 May 12. Published in final edited form as: Lancet. 2011 Jan 10;377(9764):505–515. doi: 10.1016/S0140-6736(10)61894-6 [https://doi.org/10.1016/S0140-6736(10)61894-6] * Search in PMC [https://www.ncbi.nlm.nih.gov/pmc/?term=%22Lancet%22%5Bjour%5D] * Search in PubMed [https://pubmed.ncbi.nlm.nih.gov/?term=%22Lancet%22%5Bjour%5D] * View in NLM Catalog [https://www.ncbi.nlm.nih.gov/nlmcatalog?term=%22Lancet%22%5BTitle%20Abbreviation%5D] * Add to search [?term=%22Lancet%22%5Bjour%5D] HEALTH CARE AND EQUITY IN INDIA Yarlini Balarajan [https://pubmed.ncbi.nlm.nih.gov/?term=%22Ba",

                                    "appInfo": {

                                        "appName": "Prod SA",

                                        "featureFlag": "external",

                                        "product": "searchai",

                                        "_id": "67d2bf2595de4b4d5bb32e84",

                                        "displayLines": 4

                                    }

                                }

                            ]

                        }

                    },

                    "used": []

                }

            ],

            "proActiveSuggestions": [

                {

                    "utterance": "purchase TV",

                    "countDisplayedAnswers": {

                        "countDialogTasks": 0,

                        "countFaqs": 0,

                        "countWebPages": 0,

                        "countFiles": 0,

                        "countAnswers": 0,

                        "countFromNonNativeDataSource": 0

                    },

                    "used": [

                        {

                            "targetType": "DialogTask",

                            "target": {

                                "positionId": "dg-3afuyhf79k",

                                "name": "purchase TV",

                                "runType": "assist",

                                "status": "completed",

                                "startTime": "2025-03-27T07:08:49.339Z",

                                "endTime": "2025-03-27T07:09:40.284Z",

                                "suggestionsCount": {

                                    "tellCustomer": 1,

                                    "askCustomer": 2,

                                    "tellUsed": 0,

                                    "askUsed": 0

                                },

                                "linksClicked": []

                            },

                            "feedback": {

                                "response": "Up",

                                "reasonCode": [],

                                "comment": ""

                            }

                        }

                    ]

                },

                {

                    "displayTime": "2025-03-27T07:09:43.222Z",

                    "utterance": "{\"type\":\"template\",\"payload\":{\"template_type\":\"quick_replies\",\"text\":\"Which TV would you like to buy ?\",\"quick_replies\":[{\"content_type\":\"text\",\"title\":\"Samsung\",\"payload\":\"Samsung\"},{\"content_type\":\"text\",\"title\":\"Sansui\",\"payload\":\"Sansui\"},{\"content_type\":\"text\",\"title\":\"LG\",\"payload\":\"LG\"},{\"content_type\":\"text\",\"title\":\"Onida\",\"payload\":\"Onida\"},{\"content_type\":\"text\",\"title\":\"Lava\",\"payload\":\"Lava\"}]}}",

                    "countDisplayedAnswers": {

                        "countDialogTasks": 1,

                        "countFaqs": 0,

                        "countWebPages": 0,

                        "countFiles": 0,

                        "countAnswers": 0,

                        "countFromNonNativeDataSource": 0

                    },

                    "suggestions": {

                        "dialogs": [

                            {

                                "name": "purchase TV"

                            }

                        ]

                    },

                    "used": []

                }

            ]

        },

{

            "conversationID": "atesta-m8rxxxxx",

            "botSessionID": "67e5209e8fc756c9fefxxxxx",

            "channel": "email",

            "segmentID": "ac-ec989d6-1965-4bd6-bc84-34b76c0xxxxx",

            "segmentStartTime": "2025-03-27T09:55:41.947Z",

            "segmentEndTime": "2025-03-27T09:58:54.181Z",

            "countScrollUp": 1,

            "countScrollDn": 2,

            "agent": {

                "agentId": "a-m8r6h92k"

            },

            "tags": [],

            "agentActions": [

                {

                    "actionType": "LibrarySelection",

                    "used": [

                        {

                            "targetType": "DialogTask",

                            "target": {

                                "positionId": "dg-cqcuexjo2p",

                                "name": "Pay Bill",

                                "runType": "assist",

                                "status": "completed",

                                "startTime": "2025-03-27T09:58:30.395Z",

                                "endTime": "2025-03-27T09:58:42.460Z",

                                "suggestionsCount": {

                                    "tellCustomer": 0,

                                    "askCustomer": 3,

                                    "tellUsed": 0,

                                    "askUsed": 0

                                },

                                "linksClicked": []

                            }

                        }

                    ]

                },

                {

                    "actionType": "SearchBarEntry",

                    "action": {

                        "searchPhrase": "test",

                        "typingStartTime": "2025-03-27T09:58:45.121Z",

                        "executionStartTime": "2025-03-27T09:58:46.486Z",

                        "displayTime": "2025-03-27T09:58:49.127Z",

                        "suggestionsShown": [

                            "adaptive card faq testing",

                            "This is a test for button FAQ",

                            "adaptive card faq testin"

                        ],

                        "suggestionUsed": 0,

                        "phraseInput": "test",

                        "correctionsPresented": 0,

                        "correctionsAccepted": 0,

                        "countDisplayedAnswers": {

                            "countDialogTasks": 0,

                            "countFaqs": 0,

                            "countWebPages": 2,

                            "countFiles": 2,

                            "countAnswers": 0,

                            "countFromNonNativeDataSource": 0

                        },

                        "suggestions": {

                            "web": [

                                {

                                    "sources": [

                                        {

                                            "title": "Wikipedia:About - Wikipedia",

                                            "url": "https://searchassist.kore.ai/searchassistapi/redirect?rurl=https%3A%2F%2Fen.wikipedia.org%2Fwiki%2FWikipedia%3AAbout&requestId=fsh-86e3cdd2-1922-5ede-885a-1192a629752f&contentId=fc-d8986c20-b145-4ad4-b239-4582913e3269&hId=594d052f433f639e32a6f8f07e340d0d744a536c5579b05000919289d27bf296"

                                        }

                                    ],

                                    "content": "",

                                    "positionId": "dg-ctbh23jnjs",

                                    "appInfo": {

                                        "appName": "Prod SA",

                                        "featureFlag": "external",

                                        "product": "searchai",

                                        "_id": "67d2bf2595de4b4d5bb32e84",

                                        "displayLines": 4

                                    }

                                },

                                {

                                    "sources": [

                                        {

                                            "title": "Wikipedia:File upload wizard - Wikipedia",

                                            "url": "https://searchassist.kore.ai/searchassistapi/redirect?rurl=https%3A%2F%2Fen.wikipedia.org%2Fwiki%2FWikipedia%3AFile_upload_wizard&requestId=fsh-86e3cdd2-1922-5ede-885a-1192a629752f&contentId=fc-a0f634ae-3eed-4fa9-ba5d-ca2e2e397b52&hId=a6a48119e5f71da7cd82b9acba567a5c5f1885af72466c9386aed09488f25a0c"

                                        }

                                    ],

                                    "content": "",

                                    "positionId": "dg-4xxqtysxtj",

                                    "appInfo": {

                                        "appName": "Prod SA",

                                        "featureFlag": "external",

                                        "product": "searchai",

                                        "_id": "67d2bf2595de4b4d5bb32e84",

                                        "displayLines": 4

                                    }

                                }

                            ],

                            "file": [

                                {

                                    "sources": [

                                        {

                                            "title": "PM",

                                            "url": "https://searchassist.kore.ai/searchassistapi/redirect?rurl=https%3A%2F%2Fnha.gov.in%2FPM-JAY&requestId=fsh-86e3cdd2-1922-5ede-885a-1192a629752f&contentId=fc-5a9dc6d5-3eef-5401-94e8-713cf93ea19d&hId=4bbb6d4a613bace86b8ad085bf6d34faf493708f174227f5fc56be4333dce96b"

                                        }

                                    ],

                                    "content": "flag [img/resources/flag.jpg] भारत सरकार GOVERNMENT OF INDIA [https://www.mygov.in/] * 14555 [tel:14555] * Screen Reader Access [https://pmjay.gov.in/screen_reader] * Skip to main content * /sitemap.xml * https://www.facebook.com/AyushmanBharatGoI * https://twitter.com/ayushmannha * https://www.youtube.com/channel/UCkd7w2rww0HQB4lZ-l3dB6g * https://www.linkedin.com/company/ayushmanbharatgoi/ * https://www.instagram.com/ayushmanbharatnha/ * Quora image [img/gallery/quora.png] [https://www.quora.com/profile/Ayushman-Bharat-9?ch=3&share=25d97ee9&srid=bdecg] * A+ [javascript:;] * A [javascript:;] * A- [javascript:;] NHA [img/resources/logo.svg] [https://nha.gov.in/] IYC [img/resources/iyc.png] [https://nha.gov.in/] NATIONAL HEALTH AUTHORITY PM-JAY [img/resources/pmjay.png] [https://pmjay.gov.in/] * index.php * Home [https://nha.gov.in/] * About Us * NHA [NHA.php] * Who's who [Whos-who.php] * PM-JAY [PM-JAY.php] * ABDM [NDHM.php] * PM-JAY [https://pmjay.gov.in/] * ABDM [https://ndhm.gov.in/] * Blog [https://pmjay.gov.in/Blogs-list] * Connect with Us * Careers [Careers.php] * Contact Us [Contact-Us.php] * Tenders and Procurement [Tenders-Procurement.php] * Circulars [circulars.php] * PMJAY Dashboard [https://dashboard.pmjay.gov.in/pmj/#/] * ABDM Dashboard [https://dashboard.abdm.gov.in/abdm/] * PMJAY for 70+ * Enrol for PMJAY for 70+ [https://beneficiary.nha.gov.in/] * List of Empanelled Hospitals [https://hem.nha.gov.in/search] * FAQs [img/resources/English_FAQs_related_to_the_benefits_for_senior_citizens.pdf] * How to Make Ayushman Card [https://youtube.com/playlist?list=PLYcj0BpCoCc4yDCm7A4xxsjkg4gmxnWre&si=6B2-_rj9TFB0fA-k] * Give a Missed Call [missedcall.php] * Am I Eligible [img/resources/am-i-eligible.png] [https://beneficiary.nha.gov.in/] * find1 [img/resources/find1.png] [https://hospitals.pmjay.gov.in/Search/empnlWorkFlow.htm?actionFlag=ViewRegisteredHosptlsNew] * Grievance Portal [img/resources/grivence.png] [https://cgrms.pmjay.gov.in/GRMS/] [https://pmjay.gov.in/MAP/images/icons/inner_bg2.png] ABOUT PRADHAN MANTRI JAN AROGYA YOJANA (PM-JAY) * Home [index.php] * About Pradhan Mantri Jan Arogya Yojana (PM-JAY) * About Ayushman Bharat * Background * Criteria/Coverage * Implementation * Financing * Hospital Empanelment * Packages and Rates * IT System * Awareness * Support Systems * Convergence AYUSHMAN BHARAT Ayushman Bharat, a flagship scheme of Government of India, was launched as",

                                    "appInfo": {

                                        "appName": "Prod SA",

                                        "featureFlag": "external",

                                        "product": "searchai",

                                        "_id": "67d2bf2595de4b4d5bb32e84",

                                        "displayLines": 4

                                    }

                                },

                                {

                                    "sources": [

                                        {

                                            "title": "NLM",

                                            "url": "https://searchassist.kore.ai/searchassistapi/redirect?rurl=https%3A%2F%2Fpmc.ncbi.nlm.nih.gov%2Farticles%2FPMC3093249%2F&requestId=fsh-86e3cdd2-1922-5ede-885a-1192a629752f&contentId=fc-3137891f-fc01-5678-ba83-c6d6aaa910de&hId=6b26f7a1b5a381176156d91699f5a6f9b979d8d516335ee58d831feb4c970a52"

                                        }

                                    ],

                                    "content": "Skip to main content [/static/img/us_flag.svg] An official website of the United States government Here's how you know Here's how you know [/static/img/icon-dot-gov.svg] Official websites use .gov A .gov website belongs to an official government organization in the United States. [/static/img/icon-https.svg] Secure .gov websites use HTTPS A lock ( Locked padlock icon ) or https:// means you've safely connected to the .gov website. Share sensitive information only on official, secure websites. NCBI home page [/static/img/ncbi-logos/nih-nlm-ncbi--white.svg] [https://www.ncbi.nlm.nih.gov/] Search Log in * Dashboard [https://www.ncbi.nlm.nih.gov/myncbi/] * Publications [https://www.ncbi.nlm.nih.gov/myncbi/collections/bibliography/] * Account settings [https://www.ncbi.nlm.nih.gov/account/settings/] * Log out Search… Search NCBI Primary site navigation Close [/static/img/usa-icons/close.svg] Search Search [data:] Logged in as: * Dashboard [https://www.ncbi.nlm.nih.gov/myncbi/] * Publications [https://www.ncbi.nlm.nih.gov/myncbi/collections/bibliography/] * Account settings [https://www.ncbi.nlm.nih.gov/account/settings/] Log in Search PMC Full-Text Archive Search in PMC Search [/static/img/usa-icons-bg/search--white.svg] * Advanced Search [https://www.ncbi.nlm.nih.gov/pmc/advanced/] * Journal List [/journals/] * User Guide [/about/userguide/] * * https://doi.org/10.1016/S0140-6736(10)61894-6 * pdf/nihms292456.pdf * * * PERMALINK Copy As a library, NLM provides access to scientific literature. Inclusion in an NLM database does not imply endorsement of, or agreement with, the contents by NLM or the National Institutes of Health. Learn more: PMC Disclaimer [/about/disclaimer/] | PMC Copyright Notice [/about/copyright/] NIHPA Author Manuscripts logo [https://cdn.ncbi.nlm.nih.gov/pmc/banners/logo-nihpa.png] Lancet . Author manuscript; available in PMC: 2011 May 12. Published in final edited form as: Lancet. 2011 Jan 10;377(9764):505–515. doi: 10.1016/S0140-6736(10)61894-6 [https://doi.org/10.1016/S0140-6736(10)61894-6] * Search in PMC [https://www.ncbi.nlm.nih.gov/pmc/?term=%22Lancet%22%5Bjour%5D] * Search in PubMed [https://pubmed.ncbi.nlm.nih.gov/?term=%22Lancet%22%5Bjour%5D] * View in NLM Catalog [https://www.ncbi.nlm.nih.gov/nlmcatalog?term=%22Lancet%22%5BTitle%20Abbreviation%5D] * Add to search [?term=%22Lancet%22%5Bjour%5D] HEALTH CARE AND EQUITY IN INDIA Yarlini Balarajan [https://pubmed.ncbi.nlm.nih.gov/?term=%22Ba",

                                    "appInfo": {

                                        "appName": "Prod SA",

                                        "featureFlag": "external",

                                        "product": "searchai",

                                        "_id": "67d2bf2595de4b4d5bb32e84",

                                        "displayLines": 4

                                    }

                                }

                            ]

                        }

                    },

                    "used": []

                }

            ],

            "proActiveSuggestions": []

        },

{

            "conversationID": "e160c0a1-c4ff-415f-abba-27b62bbxxxxx",

            "botSessionID": "67e52794aac9173b40axxxxx",

            "channel": "chat",

            "segmentID": "ac-c2a1d33-6661-4acc-a86b-44d92e3xxxxx",

            "segmentStartTime": "2025-03-27T10:26:43.597Z",

            "segmentEndTime": "2025-03-27T10:28:25.093Z",

            "countScrollUp": 0,

            "countScrollDn": 0,

            "agent": {

                "agentId": "3f4ff148-6759-4b80-934c-edf0b1147e91"

            },

            "tags": [],

            "summary": {

                "summaryId": "smr-ee39c23-6a09-464d-8584-9c8ab6672b4b",

                "participant": {

                    "identity": "3f4ff148-6759-4b80-934c-edf0b1147e91",

                    "name": "Jayasri thota",

                    "type": "agent"

                },

                "type": "final",

                "summary": "The customer initiated the conversation but did not provide further information or actions.",

                "editedSummary": "",

                "isError": false,

                "isDisabled": false,

                "isEdited": false,

                "time": 0.2815239429473877,

                "modelType": "",

                "summaryModel": "kore",

                "exeStartTime": 1743071305058,

                "identity": "3f4ff148-6759-4b80-934c-edf0b1147e91",

                "positionId": "dg-ob4myq2sr"

            },

            "agentActions": [],

            "proActiveSuggestions": []

        }

    ],

    "hasMore": false

}

Response Body Parameters

PARAMETER TYPE AND FORMAT DESCRIPTION AND EXAMPLE
numResults Integer number of results sent in this response
hasMore Boolean (True / False) if there are any more pages left with results.

Example: “false” without the double-quotes

data Array of segment objects Each segment is a part of a conversation that is driven by one primary agent.
data[].conversationID unique id of the conversation – from customer
data[].botSessionID Alphanumeric string unique id of the session – from Kore.

Example: “667fc3b587b5fd0fbf97d4de”

data[].channel String channel name – from customer.

Example: “chat”

data[].segmentID Type-prefixed uuid unique id of the segment, prefixed by “ac” – from Kore.

Example: “ac-de166b2-1e14-4141-9061-9bca0203b068”

data[].agent Object object containing data of the primary agent servicing this portion (aka segment) of the conversation.

All data is optional (except agentID), and comes from the customer via the process API

data[].agent.firstName String agent’s first name – from customer.

Example: “John”

data[].agent.lastName String agent’s last name – from customer.

Example: “Smith”

data[].agent.email String of valid email address agent’s email address – from customer.

Example: “john.smith@example.com”

data[].agent.name String agent name – from customer.

Example: “John Smith”

data[].agent.agentId String unique id of the agent- from customer.

Example: “jsmith01”

data[].tags Array of tag objects Each tag is one created by bot developers at various points in the Dialog.

All tags emitted by the bot at any point during this portion of the conversation will be returned here.

data[].tags[].type Type of tag can be a message-level tag,a session-level or a user-level tag.

Example: one of “user”,”message”, “session”

data[].tags[].name String key value of the tag – from the client’s bot developer
data[].tags[].value String value of the tag – from the client’s bot developer
data[].tags[].messageID Type-prefixed uuid uuid of the message (prefix: “ms”) that emitted this tag – from Kore.

Example: “ms-de166b2-1e14-4141-9061-9bca0203b068”

data[].tags[].createdAt Date: YYYY-MM-DDTHH24:mm:SS.NNNZ UTC-based time when this tag was emitted.

Example: “2024-06-29T08:37:35.937Z”

data[].segmentStartTime Date: YYYY-MM-DDTHH24:mm:SS.NNNZ UTC-based time when this portion of the conversation began.

Example: “2024-06-29T08:37:35.937Z”

data[].segmentEndTime Date: YYYY-MM-DDTHH24:mm:SS.NNNZ UTC-based time when this portion of the conversation end.

Example: “2024-06-29T08:37:35.937Z”

summary Object Contains the summary details of the interaction.
summary.summary String A concise summary of the customer’s request and agent’s response.

Example: “The customer requested to order a pizza…”

summary.editedSummary String An edited version of the summary, providing additional context or changes.

Example: “The customer requested to order a pizza… edited…”

summary.isError Boolean Indicates if there was an error in the interaction.

Example: false

summary.isDisabled Boolean Indicates if the summary is disabled.

Example: false

summary.feedback Object Contains feedback related to the interaction.
summary.feedback.response String The overall response from the feedback.

Example: “Down”

summary.feedback.reasonCode Array List of reasons for the feedback.

Example: [“Inaccurate Content”, “Too Lengthy”, “Not Satisfactory”]

summary.feedback.comment String Any additional comments from the user.

Example: “hehbdh”

summary.isEdited Boolean Indicates if the summary has been edited.

Example: true

summary.summaryModel String Indicates the model used for summarization.

Example: “kore”

summary.time Number (milliseconds) The time taken for the process in milliseconds.

Example: 98.685

summary.exeStartTime Number (milliseconds) The execution start time in milliseconds since the epoch.

Example: 1727345858881

summary.agentId String The unique identifier for the agent handling the request.

Example: “phani-876”

summary.sumSubTime Number (milliseconds) The time when the summary was submitted in milliseconds since the epoch.

Example: 1727345957566

data[].agentActions Array of objects array of objects each of which denotes an Agent’s action, which can be:

1. Attempt to Search via Search Bar

2. Running a DialogTask from the Library opening in Search bar

data[].agentActions[].actionType String type of Agent’s action.

Example: one of “SearchBarEntry”, “LibrarySelection”

data[].agentActions[].action Object object containing data related to an Agent’s attempt to search.

Will be of type SearchBarEntry.

data[].agentActions[].used Array of objects objects detailing which of the SearchBarEntries or the DialogTasks

were used – as in Sent, Copied, Executed, given Feedback, or had their links clicked

data[].agentActions[].used[].targetType String specifies the type of object used by the agent.

Example: one of “DialogTask”, “FAQ”, “Answer”, “File”, “WebPage”, “GeneralDataSource”

data[].agentActions[].used[].target Object object containing details of use of any DialogTask or data source
data[].proActiveSuggestions Array of objects objects containing suggestions given proactively by Agent AI.

These can be:

1. Suggestions given proactively based on Customer’s latest utterance

2. Suggestions given proactively based on preshown text, such as Summary.

data[].proActiveSuggestions[].utterance String entire utterance by the end Customer – redacted if redaction is enabled.

Example: “What is my account balance?”

data[].proActiveSuggestions[].suggestions Suggestion object each Suggestion by Agent AI, whether it is a DialogTask, an Answer, FAQ, Article or any other
data[].proActiveSuggestions[].displayTime Date: YYYY-MM-DDTHH24:mm:SS.NNNZ time at which this list of suggestions was displayed (UTC).

Example: “2024-06-29T08:37:35.937Z”

data[].proActiveSuggestions[].countDisplayedAnswers Object contains counts of all displayed suggestions by type
data[].proActiveSuggestions[].countDisplayedAnswers.countDialogTasks Integer Number of DialogTasks suggested
data[].proActiveSuggestions[].countDisplayedAnswers.countFaqs Integer Number of Faqs suggested
data[].proActiveSuggestions[].countDisplayedAnswers.countAnswers Integer Number of Answers suggested
data[].proActiveSuggestions[].countDisplayedAnswers.countFiles Integer Number of Files suggested
data[].proActiveSuggestions[].countDisplayedAnswers.countWebPages Integer Number of Web pages suggested
data[].proActiveSuggestions[].countDisplayedAnswers.countFromNonNativeDataSource Integer Number of suggestions from non-native data sources
data[].proActiveSuggestions[].used Array of objects objects detailing which of the suggestions were used – as in Sent, Copied, Executed, given Feedback, or had their links clicked
data[].proActiveSuggestions[].used[].targetType String specifies the type of object used by the agent.

Example: one of “DialogTask”, “FAQ”, “Answer”, “File”, “WebPage”, “GeneralDataSource”

data[].proActiveSuggestions[].used[].target Object object containing details of use of any DialogTask or data source
SearchBarEntry Object This details an action by the Agent – when he enters text on the Search Bar.
SearchBarEntry.searchPhrase String The search query entered by the agent. Example: “Return string to the given question using the provided Content and source_name…”
SearchBarEntry.typingStartTime Date: YYYY-MM-DDTHH24:mm:SS.NNNZ Timestamp of when typing started. Example: “2024-07-10T06:52:36.447Z”
SearchBarEntry.executionStartTime Date: YYYY-MM-DDTHH24:mm:SS.NNNZ Timestamp of when the search execution began. Example: “2024-07-10T06:52:36.871Z”
SearchBarEntry.displayTime Date: YYYY-MM-DDTHH24:mm:SS.NNNZ Timestamp of when the search results were displayed. Example: “2024-07-10T06:52:40.359Z”
suggestionsShown Array of Strings List of suggestions shown during the agent action. Example: [“tech are using the wrng worlkss teh”, “teh are using wrnog workds for the tesnsig”, “Healthcare System in India, Healthcare India – IBEF”]
suggestionUsed Integer The number of suggestions used by the agent. Example: 1
phraseInput String The phrases entered by the agent. Example: “health teh”
correctionsPresented Integer The number of corrections presented to the agent. Example: 5
correctionsAccepted Integer The number of corrections accepted by the agent. Example: 0
SearchBarEntry.countDisplayedAnswers Object contains counts of all displayed suggestions by type
SearchBarEntry.countDisplayedAnswers.countDialogTasks Integer Number of DialogTasks suggested
SearchBarEntry.countDisplayedAnswers.countFaqs Integer Number of Faqs suggested
SearchBarEntry.countDisplayedAnswers.countAnswers Integer Number of Answers suggested
SearchBarEntry.countDisplayedAnswers.countFiles Integer Number of Files suggested
SearchBarEntry.countDisplayedAnswers.countWebPages Integer Number of Web pages suggested
SearchBarEntry.countDisplayedAnswers.countFromNonNativeDataSource Integer Number of suggestions from non-native data sources
SearchBarEntry.suggestions Suggestion object each Suggestion by Agent AI, whether it is a DialogTask, an Answer, FAQ, Article or any other
DialogTask Object This object is shown in a used array when a DialogTask is run.
DialogTask.name String name of the DialogTask – from the client’s bot developer.

Example: “Cancel account”

DialogTask.runType String How did the agent run it? Using the “Run” button, or the “Run with Agent input” button.

Example: one of “RunAssist”, “RunWithAgentInput”

DialogTask.status String Outcome of the DialogTask.

Example: one of “Completed”, “PrematurelyTerminated”, “TimedOut”, “Error”

DialogTask.SuggestionsCount Object count of suggestions made by DialogTask by ask/tell prompt type.
DialogTask.SuggestionsCount.askSuggestions Integer count of suggestions that prompt with “Ask Customer”
DialogTask.SuggestionsCount.tellSuggestions Integer count of suggestions that prompt with “Tell Customer”
DialogTask.SuggestionsCount.askUsed Integer count of “Ask” suggestions that were sent or copied over to Customer
DialogTask.SuggestionsCount.tellUsed Integer count of “Tell” suggestions that were sent or copied over to Customer
DialogTask.startTime Date: YYYY-MM-DDTHH24:mm:SS.NNNZ time at which this DialogTask began to run

Example: “2024-06-29T08:37:35.937Z”

DialogTask.endTime Date: YYYY-MM-DDTHH24:mm:SS.NNNZ time at which this DialogTask ended its run.

Example: “2024-06-29T08:37:35.937Z”

DialogTask.feedback Object feedback given by Agent to this DialogTask
faq Object this object is shown in a used array when an faq Q&A pair is used
faq.title String Title of the FAQ Q&A pair.

Example: “FAQ 3.2”

faq.status String How was it used? Sent or Copied?

Example: one of “Sent”, “Copied”

faq.usedTime Date: YYYY-MM-DDTHH24:mm:SS.NNNZ time at which this FAQ was sent or copied.

Example: “2024-06-29T08:37:35.937Z”

answer Object this object is shown in a used array when an Answer from Search AI is used
answer.status String shows if the Answer has been Sent or Copied. If not sent or copied, but used otherwise, it will be blank. “Used Otherwise” means its “Show more” may have been clicked, one of its links may have been clicked, or the Agent gave feedback to it.

Example: one of “Sent”, “Copied”, or blank

answer.usedTime Date: YYYY-MM-DDTHH24:mm:SS.NNNZ time at which this Answer was sent or copied. If not, it will be blank.

Example: “2024-06-29T08:37:35.937Z”

answer.showMoreClicked Boolean (True / False) if the Show More button for this answer was clicked.

Example: “false” without the double-quotes

answer.answerLinkClicked Array of URL links links in the Answer clicked by the Agent.

Example: [“http://www.google.com“]

answer.internalInfoMoreClicked Boolean (True / False) if the Show More button for this answer was clicked.

Example: “false” without the double-quotes

answer.positionId Type-prefixed uuid prefixed by “dg-“, a position ID referring to a displayed suggestion in the “suggestions” object.

Example: “dg-3id77hn44k”

answer.feedback Object feedback given by Agent to this Answer
webpage Object this object is shown in a used array when a webpage is used by the Agent
webpage.url String – URL URL of the webpage
webpage.status String How was it used? Sent or Copied?

Example: one of “Sent”, “Copied”

webpage.usedTime Date: YYYY-MM-DDTHH24:mm:SS.NNNZ time at which this webpage was sent or copied.

Example: “2024-06-29T08:37:35.937Z”

file Object this object is shown in a used array when a file is used by the Agent
file.path String – filepath path of the file.

Example: “/home/docs/configuration_parameters.doc”

file.status String How was it used? Sent or Copied?

Example: one of “Sent”, “Copied”

file.usedTime Date: YYYY-MM-DDTHH24:mm:SS.NNNZ time at which this file was sent or copied.

Example: “2024-06-29T08:37:35.937Z”

general-data-source Object this object is shown in a used array when a non-native data source is used by the Agent
general-data-source.connector String name of the data source.

Example: “MSSharepoint”

general-data-source.uri URI URI of the resource.

Example: “https://TestServer/TestSite/Reports/Doc/Company%20Sales.rdl

general-data-source.status String How was it used? Sent or Copied?

Example: one of “Sent”, “Copied”

general-data-source.usedTime Date: YYYY-MM-DDTHH24:mm:SS.NNNZ time at which this resource was sent or copied.

Example: “2024-06-29T08:37:35.937Z”

feedback Object contains feedback from an Agent to certain suggestions.
feedback.response String The Agent can choose Thumbs Up or Down.

Example: one of “up”, “down”

feedback.reasonCode Array of strings the Agent may choose multiple reason codes, and these are configurable.

Example: [“Wrong Intent”, “Missed Context”]

feedback.comment String freeform textual feedback from the Agent.

Example: “This is not the correct Dialog. The customer said ‘Cancel account’, and the Dialog is about renewal”.

suggestions Object containing all displayed suggestions, whether from a SearchBarEntry action by the Agent or a proActiveSuggestion triggered by a Customer’s utterance
suggestions.dialogs Array of objects each object contains the particulars of a DialogTask displayed to Agent
suggestions.dialogs[].name String name of the DialogTask – from the client’s bot developer.

Example: “Cancel Account”

suggestions.answers Array of objects each object contains details of an Answer displayed
suggestions.answers[].content String Generated Answer content.

Example: “A potentially very long answer that may be generated by an LLM”.

suggestions.answers[].positionId Type-prefixed uuid prefixed by “dg-“, this field acts as a key for this particular answer, later referred to by an Answer object in a used array.

Example: “dg-3id77hn44k”

suggestions.answers[].sources Array of objects array of source links from which the Answer was generated.
suggestions.answers[].sources[].title String Title of the page linked, that was one of the sources for the Answer.

Example: AWS EC2 On-demand pricing

suggestions.answers[].sources[].url String – URL The link itself.

Example: “https://aws.amazon.com/ec2/pricing/on-demand/

suggestions.answers[].internalFlag Boolean (True / False) Example: “false” without the double-quotes
queueInfo

  • queueId
  • queueName
String Unique name and ID number of the queue involved in the conversation.

Example: “CreditCard”, “qu-2335c1-8et33-33535-133535”

countScrollUp and countScrollDn Integer Number of times an agent clicks the scroll up and/or scroll down buttons.
linksClicked String List of the URL/s an agent clicks with timestamps during a conversation.

Example: “https://www.apple.com/in/”, 2024-12-17T11:04:37.163Z

 

 

Raw Data API v2

This updated version of the Raw Data API offers the following additional conversation data for deeper insights into AgentAssist interactions and conversation flows:

  • Feedback (reason code and feedback text in addition to like/dislike) from the agent.
  • Complete generated answers with feedback.
  • Comprehensive agent activity tracking.
  • Full end-user utterances.
  • Dialog task execution details.
  • Agent search bar activity timing.
  • Name of the queue involved in the conversation.
  • Number of times an agent uses the scroll up and scroll down buttons.
  • Names of the URLs an agent clicks.
  • Total number of words or phrases suggested to the agent.
  • Total number of words or phrases accepted by the agent.
  • Total number of words or phrases entered by the agent.
  • Total number of words suggested for correction by the agent.
  • Total number of auto-corrected words accepted by the agent.
Method  GET
Endpoint
https://{{host}}/agentassist/api/v1/public/{{streamid}}/v2/agentassistinteractions?from=YYYY-MM-DD-HH24:mm:SS&to=YYYY-MM-DD-HH24:mm:SS&offset=NNNNN&limit=0..100
Content Type application/json
Authorization  auth: {{JWT}}

See How to generate the JWT Token.

API Scope AgentAssist Analytics

Query Parameters

PARAMETER DESCRIPTION MANDATE
from Start date and time of the interactions in YYYY-MM-DD HH24:mm:SS format. Required
to End date and time of the interactions in YYYY-MM-DD HH24:mm:SS format. Required

Sample Request

curl --location 'https://{{host}}/agentassist/api/v1/public/st-f6ea0c31-f910-5b8e-82d8-dcbbc63xxxxx/v2/agentassistinteractions?from=2024-07-10T06%3A49%3A45&to=2024-07-10T07%3A06%3A25' \
--header 'accountId: 65433af84e520234494xxxxx' \
--header 'auth: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhcHBJZCI6ImNzLTE5ZjA0NzU0LWQ4MzQtNTgxOC04NzE0LWYyNGZlYzYxODgxNyJ9.DEVT2UGCTjryY_bDVGmun4-Vcp_R9-b0iRonWaB-MMA'

Headers

  • accountId (required): The account ID associated with the API request.
  • auth (required): Authentication token in the format Bearer <token>.

Sample Response

{

    "numResults": 3,

    "data": [

        {

            "conversationID": "atesta-m8rxxxxx",

            "botSessionID": "67e4f9805622dd06277xxxxx",

            "channel": "chat",

            "segmentID": "ac-9c35de2-14b3-472e-bebc-3b5d0daxxxxx",

            "segmentStartTime": "2025-03-27T07:08:47.597Z",

            "segmentEndTime": "2025-03-27T07:10:36.738Z",

            "countScrollUp": 3,

            "countScrollDn": 2,

            "agent": {

                "agentId": "a-m8r0iiln"

            },

            "tags": [

                {

                    "type": "message",

                    "name": "MessageKey",

                    "value": "MessageKeyVALUE",

                    "messageID": "ms-50f37525-736d-5182-8a54-94711d442730",

                    "createdAt": "2025-03-27T07:08:49.286Z"

                },

                {

                    "type": "session",

                    "name": "SessionKey",

                    "value": "SessionKeyVALUE",

                    "createdAt": "2025-03-27T07:08:48.096Z"

                }

            ],

            "summary": {

                "summaryId": "smr-adab467-72e9-4ec5-8d7a-2aabd1ab2bb0",

                "participant": {

                    "identity": "a-m8r0iiln",

                    "type": "AGENT",

                    "startTime": [],

                    "endTime": []

                },

                "type": "final",

                "summary": "",

                "editedSummary": "We're sorry, but there was a problem generating the summary for this conversation. Please create your own summary",

                "isError": true,

                "isDisabled": false,

                "isEdited": true,

                "exeStartTime": 1743059436693,

                "positionId": "dg-5rp9haf9nn",

                "sumSubTime": 1743059460053,

                "time": 23.36,

                "feedback": {

                    "response": "Down",

                    "reasonCode": [],

                    "comment": "end of summary"

                }

            },

            "agentActions": [

                {

                    "actionType": "SearchBarEntry",

                    "action": {

                        "searchPhrase": "Healthcare System in India, Healthcare India - IBEF",

                        "typingStartTime": "2025-03-27T07:10:02.278Z",

                        "executionStartTime": "2025-03-27T07:10:22.234Z",

                        "displayTime": "2025-03-27T07:10:25.419Z",

                        "suggestionsShown": [

                            "tech are using the wrng worlkss  teh",

                            "teh are using wrnog workds for the tesnsig",

                            "Healthcare System in India, Healthcare India - IBEF"

                        ],

                        "suggestionUsed": 1,

                        "phraseInput": "health teh ",

                        "correctionsPresented": 5,

                        "correctionsAccepted": 0,

                        "countDisplayedAnswers": {

                            "countDialogTasks": 0,

                            "countFaqs": 4,

                            "countWebPages": 5,

                            "countFiles": 2,

                            "countAnswers": 0,

                            "countFromNonNativeDataSource": 0

                        },

                        "suggestions": {

                            "faqs": [

                                {

                                    "sources": [

                                        {

                                            "title": "Which Insurance Companies offer Health Insurance Policies in India?",

                                            "url": "",

                                            "sourceType": "searchassist"

                                        }

                                    ],

                                    "content": "Which Insurance Companies offer Health Insurance Policies in India?",

                                    "positionId": "dg-r74fpqb3at",

                                    "appInfo": {

                                        "appName": "Prod SA",

                                        "featureFlag": "external",

                                        "product": "searchai",

                                        "_id": "67d2bf2595de4b4d5bb32e84",

                                        "displayLines": 4

                                    }

                                },

                                {

                                    "sources": [

                                        {

                                            "title": "Resend OTP",

                                            "url": "",

                                            "sourceType": "searchassist"

                                        }

                                    ],

                                    "content": "Resend OTP",

                                    "positionId": "dg-9d54h4frdq",

                                    "appInfo": {

                                        "appName": "Prod SA",

                                        "featureFlag": "external",

                                        "product": "searchai",

                                        "_id": "67d2bf2595de4b4d5bb32e84",

                                        "displayLines": 4

                                    }

                                },

                                {

                                    "sources": [

                                        {

                                            "title": "What is AYUSH Hospital?",

                                            "url": "",

                                            "sourceType": "searchassist"

                                        }

                                    ],

                                    "content": "What is AYUSH Hospital?",

                                    "positionId": "dg-cxd507th16",

                                    "appInfo": {

                                        "appName": "Prod SA",

                                        "featureFlag": "external",

                                        "product": "searchai",

                                        "_id": "67d2bf2595de4b4d5bb32e84",

                                        "displayLines": 4

                                    }

                                },

                                {

                                    "sources": [

                                        {

                                            "title": "What is AYUSH Treatment? Whether AYUSH Treatment is allowed in all Health Insurance Policies?",

                                            "url": "",

                                            "sourceType": "searchassist"

                                        }

                                    ],

                                    "content": "What is AYUSH Treatment? Whether AYUSH Treatment is allowed in all Health Insurance Policies?",

                                    "positionId": "dg-6xl89hve93h",

                                    "appInfo": {

                                        "appName": "Prod SA",

                                        "featureFlag": "external",

                                        "product": "searchai",

                                        "_id": "67d2bf2595de4b4d5bb32e84",

                                        "displayLines": 4

                                    }

                                }

                            ],

                            "web": [

                                {

                                    "sources": [

                                        {

                                            "title": "Healthcare System in India, Healthcare India - IBEF",

                                            "url": "https://searchassist.kore.ai/searchassistapi/redirect?rurl=https%3A%2F%2Fwww.ibef.org%2Findustry%2Fhealthcare-india&requestId=fsh-d3151f01-dd6d-5e3f-9229-956019b4343d&contentId=fc-00b44114-9bde-44ae-8084-9bb999676e8c&hId=955b136584ad076fd0309d69a6e3f3377e0920e960140f2cbdc955ca934d1c50"

                                        }

                                    ],

                                    "content": "",

                                    "positionId": "dg-ia5xj3w1yd",

                                    "appInfo": {

                                        "appName": "Prod SA",

                                        "featureFlag": "external",

                                        "product": "searchai",

                                        "_id": "67d2bf2595de4b4d5bb32e84",

                                        "displayLines": 4

                                    }

                                },

                                {

                                    "sources": [

                                        {

                                            "title": "Healthcare in India - Wikipedia",

                                            "url": "https://searchassist.kore.ai/searchassistapi/redirect?rurl=https%3A%2F%2Fen.wikipedia.org%2Fwiki%2FHealthcare_in_India&requestId=fsh-d3151f01-dd6d-5e3f-9229-956019b4343d&contentId=fc-6a06e2f8-90d0-4786-95bc-e8a27c3ff07e&hId=9f48681f49da231e23e26f724b14982af0fab99e37481748b2270f90e7e6b7f7"

                                        }

                                    ],

                                    "content": "",

                                    "positionId": "dg-vhmrypq1wj",

                                    "appInfo": {

                                        "appName": "Prod SA",

                                        "featureFlag": "external",

                                        "product": "searchai",

                                        "_id": "67d2bf2595de4b4d5bb32e84",

                                        "displayLines": 4

                                    }

                                },

                                {

                                    "sources": [

                                        {

                                            "title": "India's Ayush Industry & National AYUSH Mission | IBEF",

                                            "url": "https://searchassist.kore.ai/searchassistapi/redirect?rurl=https%3A%2F%2Fwww.ibef.org%2Findustry%2Fayush&requestId=fsh-d3151f01-dd6d-5e3f-9229-956019b4343d&contentId=fc-9a13b295-68c5-4557-94ba-81b6b7f07e90&hId=5aa0dcbff3bcac7296ea50804593759ffa5e2bda8f19abea62c626442657b2c0"

                                        }

                                    ],

                                    "content": "",

                                    "positionId": "dg-mtzuxnhj55l",

                                    "appInfo": {

                                        "appName": "Prod SA",

                                        "featureFlag": "external",

                                        "product": "searchai",

                                        "_id": "67d2bf2595de4b4d5bb32e84",

                                        "displayLines": 4

                                    }

                                },

                                {

                                    "sources": [

                                        {

                                            "title": "Banking in India: Growth, Trends, and Opportunities | IBEF",

                                            "url": "https://searchassist.kore.ai/searchassistapi/redirect?rurl=https%3A%2F%2Fwww.ibef.org%2Findustry%2Fbanking-india&requestId=fsh-d3151f01-dd6d-5e3f-9229-956019b4343d&contentId=fc-22a47b6a-e277-4a0a-9461-b4d5a2892fa2&hId=80e6d5170e6c1fd3dba566ba55dbcc1e33cdd8fc46c6fc5649504140851ac1f4"

                                        }

                                    ],

                                    "content": "",

                                    "positionId": "dg-zhx6h4ouktk",

                                    "appInfo": {

                                        "appName": "Prod SA",

                                        "featureFlag": "external",

                                        "product": "searchai",

                                        "_id": "67d2bf2595de4b4d5bb32e84",

                                        "displayLines": 4

                                    }

                                },

                                {

                                    "sources": [

                                        {

                                            "title": "Indian Agriculture Sector, Farming in India | IBEF",

                                            "url": "https://searchassist.kore.ai/searchassistapi/redirect?rurl=https%3A%2F%2Fwww.ibef.org%2Findustry%2Fagriculture-india&requestId=fsh-d3151f01-dd6d-5e3f-9229-956019b4343d&contentId=fc-ce79586c-3d4e-48a4-899c-7b149f2e5341&hId=8123ccc5b0412d4d6d3bee33e7ec97756c566921ad3a30907748426ade275aa6"

                                        }

                                    ],

                                    "content": "",

                                    "positionId": "dg-5vvxexjlll",

                                    "appInfo": {

                                        "appName": "Prod SA",

                                        "featureFlag": "external",

                                        "product": "searchai",

                                        "_id": "67d2bf2595de4b4d5bb32e84",

                                        "displayLines": 4

                                    }

                                }

                            ],

                            "file": [

                                {

                                    "sources": [

                                        {

                                            "title": "PM",

                                            "url": "https://searchassist.kore.ai/searchassistapi/redirect?rurl=https%3A%2F%2Fnha.gov.in%2FPM-JAY&requestId=fsh-d3151f01-dd6d-5e3f-9229-956019b4343d&contentId=fc-5a9dc6d5-3eef-5401-94e8-713cf93ea19d&hId=b5806f5bfd92daf057022b418ea1b84043eb18a6d28050117f56671925bdc19f"

                                        }

                                    ],

                                    "content": "flag [img/resources/flag.jpg] भारत सरकार GOVERNMENT OF <span class=\"highlightText\">INDIA</span> [https://www.mygov.in/] * 14555 [tel:14555] * Screen Reader Access [https://pmjay.gov.in/screen_reader] * Skip to main content * /sitemap.xml * https://www.facebook.com/AyushmanBharatGoI * https://twitter.com/ayushmannha * https://www.youtube.com/channel/UCkd7w2rww0HQB4lZ-l3dB6g * https://www.linkedin.com/company/ayushmanbharatgoi/ * https://www.instagram.com/ayushmanbharatnha/ * Quora image [img/gallery/quora.png] [https://www.quora.com/profile/Ayushman-Bharat-9?ch=3&amp;share=25d97ee9&amp;srid=bdecg] * A+ [javascript:;] * A [javascript:;] * A- [javascript:;] NHA [img/resources/logo.svg] [https://nha.gov.in/] IYC [img/resources/iyc.png] [https://nha.gov.in/] NATIONAL HEALTH AUTHORITY PM-JAY [img/resources/pmjay.png] [https://pmjay.gov.in/] * index.php * Home [https://nha.gov.in/] * About Us * NHA [NHA.php] * Who's who [Whos-who.php] * PM-JAY [PM-JAY.php] * ABDM [NDHM.php] * PM-JAY [https://pmjay.gov.in/] * ABDM [https://ndhm.gov.in/] * Blog [https://pmjay.gov.in/Blogs-list] * Connect with Us * Careers [Careers.php] * Contact Us [Contact-Us.php] * Tenders and Procurement [Tenders-Procurement.php] * Circulars [circulars.php] * PMJAY Dashboard [https://dashboard.pmjay.gov.in/pmj/#/] * ABDM Dashboard [https://dashboard.abdm.gov.in/abdm/] * PMJAY for 70+ * Enrol for PMJAY for 70+ [https://beneficiary.nha.gov.in/] * List of Empanelled Hospitals [https://hem.nha.gov.in/search] * FAQs [img/resources/English_FAQs_related_to_the_benefits_for_senior_citizens.pdf] * How to Make Ayushman Card [https://youtube.com/playlist?list=PLYcj0BpCoCc4yDCm7A4xxsjkg4gmxnWre&amp;si=6B2-_rj9TFB0fA-k] * Give a Missed Call [missedcall.php] * Am I Eligible [img/resources/am-i-eligible.png] [https://beneficiary.nha.gov.in/] * find1 [img/resources/find1.png] [https://hospitals.pmjay.gov.in/Search/empnlWorkFlow.htm?actionFlag=ViewRegisteredHosptlsNew] * Grievance Portal [img/resources/grivence.png] [https://cgrms.pmjay.gov.in/GRMS/] [https://pmjay.gov.in/MAP/images/icons/inner_bg2.png] ABOUT PRADHAN MANTRI JAN AROGYA YOJANA (PM-JAY) * Home [index.php] * About Pradhan Mantri Jan Arogya Yojana (PM-JAY) * About Ayushman Bharat * Background * Criteria/Coverage * Implementation * Financing * Hospital Empanelment * Packages and Rates * IT System * Awareness * Support Systems * Convergence AYUSHMAN BHARAT Ayushman Bharat, a flagship scheme of Government of India, was launched as",

                                    "appInfo": {

                                        "appName": "Prod SA",

                                        "featureFlag": "external",

                                        "product": "searchai",

                                        "_id": "67d2bf2595de4b4d5bb32e84",

                                        "displayLines": 4

                                    }

                                },

                                {

                                    "sources": [

                                        {

                                            "title": "NLM",

                                            "url": "https://searchassist.kore.ai/searchassistapi/redirect?rurl=https%3A%2F%2Fpmc.ncbi.nlm.nih.gov%2Farticles%2FPMC3093249%2F&requestId=fsh-d3151f01-dd6d-5e3f-9229-956019b4343d&contentId=fc-3137891f-fc01-5678-ba83-c6d6aaa910de&hId=bd9e0969b148275c4ce053ddc2c6b8a4bba1e21e1f6833cb6ef7cee9e023ed9b"

                                        }

                                    ],

                                    "content": "Skip to main content [/static/img/us_flag.svg] An official website of the United States government Here's how you know Here's how you know [/static/img/icon-dot-gov.svg] Official websites use .gov A .gov website belongs to an official government organization in the United States. [/static/img/icon-https.svg] Secure .gov websites use HTTPS A lock ( Locked padlock icon ) or https:// means you've safely connected to the .gov website. Share sensitive information only on official, secure websites. NCBI home page [/static/img/ncbi-logos/nih-nlm-ncbi--white.svg] [https://www.ncbi.nlm.nih.gov/] Search Log in * Dashboard [https://www.ncbi.nlm.nih.gov/myncbi/] * Publications [https://www.ncbi.nlm.nih.gov/myncbi/collections/bibliography/] * Account settings [https://www.ncbi.nlm.nih.gov/account/settings/] * Log out Search… Search NCBI Primary site navigation Close [/static/img/usa-icons/close.svg] Search Search [data:] Logged in as: * Dashboard [https://www.ncbi.nlm.nih.gov/myncbi/] * Publications [https://www.ncbi.nlm.nih.gov/myncbi/collections/bibliography/] * Account settings [https://www.ncbi.nlm.nih.gov/account/settings/] Log in Search PMC Full-Text Archive Search in PMC Search [/static/img/usa-icons-bg/search--white.svg] * Advanced Search [https://www.ncbi.nlm.nih.gov/pmc/advanced/] * Journal List [/journals/] * User Guide [/about/userguide/] * * https://doi.org/10.1016/S0140-6736(10)61894-6 * pdf/nihms292456.pdf * * * PERMALINK Copy As a library, NLM provides access to scientific literature. Inclusion in an NLM database does not imply endorsement of, or agreement with, the contents by NLM or the National Institutes of Health. Learn more: PMC Disclaimer [/about/disclaimer/] | PMC Copyright Notice [/about/copyright/] NIHPA Author Manuscripts logo [https://cdn.ncbi.nlm.nih.gov/pmc/banners/logo-nihpa.png] Lancet . Author manuscript; available in PMC: 2011 May 12. Published in final edited form as: Lancet. 2011 Jan 10;377(9764):505–515. doi: 10.1016/S0140-6736(10)61894-6 [https://doi.org/10.1016/S0140-6736(10)61894-6] * Search in PMC [https://www.ncbi.nlm.nih.gov/pmc/?term=%22Lancet%22%5Bjour%5D] * Search in PubMed [https://pubmed.ncbi.nlm.nih.gov/?term=%22Lancet%22%5Bjour%5D] * View in NLM Catalog [https://www.ncbi.nlm.nih.gov/nlmcatalog?term=%22Lancet%22%5BTitle%20Abbreviation%5D] * Add to search [?term=%22Lancet%22%5Bjour%5D] HEALTH CARE AND EQUITY IN INDIA Yarlini Balarajan [https://pubmed.ncbi.nlm.nih.gov/?term=%22Ba",

                                    "appInfo": {

                                        "appName": "Prod SA",

                                        "featureFlag": "external",

                                        "product": "searchai",

                                        "_id": "67d2bf2595de4b4d5bb32e84",

                                        "displayLines": 4

                                    }

                                }

                            ]

                        }

                    },

                    "used": []

                }

            ],

            "proActiveSuggestions": [

                {

                    "utterance": "purchase TV",

                    "countDisplayedAnswers": {

                        "countDialogTasks": 0,

                        "countFaqs": 0,

                        "countWebPages": 0,

                        "countFiles": 0,

                        "countAnswers": 0,

                        "countFromNonNativeDataSource": 0

                    },

                    "used": [

                        {

                            "targetType": "DialogTask",

                            "target": {

                                "positionId": "dg-3afuyhf79k",

                                "name": "purchase TV",

                                "runType": "assist",

                                "status": "completed",

                                "startTime": "2025-03-27T07:08:49.339Z",

                                "endTime": "2025-03-27T07:09:40.284Z",

                                "suggestionsCount": {

                                    "tellCustomer": 1,

                                    "askCustomer": 2,

                                    "tellUsed": 0,

                                    "askUsed": 0

                                },

                                "linksClicked": []

                            },

                            "feedback": {

                                "response": "Up",

                                "reasonCode": [],

                                "comment": ""

                            }

                        }

                    ]

                },

                {

                    "displayTime": "2025-03-27T07:09:43.222Z",

                    "utterance": "{\"type\":\"template\",\"payload\":{\"template_type\":\"quick_replies\",\"text\":\"Which TV would you like to buy ?\",\"quick_replies\":[{\"content_type\":\"text\",\"title\":\"Samsung\",\"payload\":\"Samsung\"},{\"content_type\":\"text\",\"title\":\"Sansui\",\"payload\":\"Sansui\"},{\"content_type\":\"text\",\"title\":\"LG\",\"payload\":\"LG\"},{\"content_type\":\"text\",\"title\":\"Onida\",\"payload\":\"Onida\"},{\"content_type\":\"text\",\"title\":\"Lava\",\"payload\":\"Lava\"}]}}",

                    "countDisplayedAnswers": {

                        "countDialogTasks": 1,

                        "countFaqs": 0,

                        "countWebPages": 0,

                        "countFiles": 0,

                        "countAnswers": 0,

                        "countFromNonNativeDataSource": 0

                    },

                    "suggestions": {

                        "dialogs": [

                            {

                                "name": "purchase TV"

                            }

                        ]

                    },

                    "used": []

                }

            ]

        },

{

            "conversationID": "atesta-m8rxxxxx",

            "botSessionID": "67e5209e8fc756c9fefxxxxx",

            "channel": "email",

            "segmentID": "ac-ec989d6-1965-4bd6-bc84-34b76c0xxxxx",

            "segmentStartTime": "2025-03-27T09:55:41.947Z",

            "segmentEndTime": "2025-03-27T09:58:54.181Z",

            "countScrollUp": 1,

            "countScrollDn": 2,

            "agent": {

                "agentId": "a-m8r6h92k"

            },

            "tags": [],

            "agentActions": [

                {

                    "actionType": "LibrarySelection",

                    "used": [

                        {

                            "targetType": "DialogTask",

                            "target": {

                                "positionId": "dg-cqcuexjo2p",

                                "name": "Pay Bill",

                                "runType": "assist",

                                "status": "completed",

                                "startTime": "2025-03-27T09:58:30.395Z",

                                "endTime": "2025-03-27T09:58:42.460Z",

                                "suggestionsCount": {

                                    "tellCustomer": 0,

                                    "askCustomer": 3,

                                    "tellUsed": 0,

                                    "askUsed": 0

                                },

                                "linksClicked": []

                            }

                        }

                    ]

                },

                {

                    "actionType": "SearchBarEntry",

                    "action": {

                        "searchPhrase": "test",

                        "typingStartTime": "2025-03-27T09:58:45.121Z",

                        "executionStartTime": "2025-03-27T09:58:46.486Z",

                        "displayTime": "2025-03-27T09:58:49.127Z",

                        "suggestionsShown": [

                            "adaptive card faq testing",

                            "This is a test for button FAQ",

                            "adaptive card faq testin"

                        ],

                        "suggestionUsed": 0,

                        "phraseInput": "test",

                        "correctionsPresented": 0,

                        "correctionsAccepted": 0,

                        "countDisplayedAnswers": {

                            "countDialogTasks": 0,

                            "countFaqs": 0,

                            "countWebPages": 2,

                            "countFiles": 2,

                            "countAnswers": 0,

                            "countFromNonNativeDataSource": 0

                        },

                        "suggestions": {

                            "web": [

                                {

                                    "sources": [

                                        {

                                            "title": "Wikipedia:About - Wikipedia",

                                            "url": "https://searchassist.kore.ai/searchassistapi/redirect?rurl=https%3A%2F%2Fen.wikipedia.org%2Fwiki%2FWikipedia%3AAbout&requestId=fsh-86e3cdd2-1922-5ede-885a-1192a629752f&contentId=fc-d8986c20-b145-4ad4-b239-4582913e3269&hId=594d052f433f639e32a6f8f07e340d0d744a536c5579b05000919289d27bf296"

                                        }

                                    ],

                                    "content": "",

                                    "positionId": "dg-ctbh23jnjs",

                                    "appInfo": {

                                        "appName": "Prod SA",

                                        "featureFlag": "external",

                                        "product": "searchai",

                                        "_id": "67d2bf2595de4b4d5bb32e84",

                                        "displayLines": 4

                                    }

                                },

                                {

                                    "sources": [

                                        {

                                            "title": "Wikipedia:File upload wizard - Wikipedia",

                                            "url": "https://searchassist.kore.ai/searchassistapi/redirect?rurl=https%3A%2F%2Fen.wikipedia.org%2Fwiki%2FWikipedia%3AFile_upload_wizard&requestId=fsh-86e3cdd2-1922-5ede-885a-1192a629752f&contentId=fc-a0f634ae-3eed-4fa9-ba5d-ca2e2e397b52&hId=a6a48119e5f71da7cd82b9acba567a5c5f1885af72466c9386aed09488f25a0c"

                                        }

                                    ],

                                    "content": "",

                                    "positionId": "dg-4xxqtysxtj",

                                    "appInfo": {

                                        "appName": "Prod SA",

                                        "featureFlag": "external",

                                        "product": "searchai",

                                        "_id": "67d2bf2595de4b4d5bb32e84",

                                        "displayLines": 4

                                    }

                                }

                            ],

                            "file": [

                                {

                                    "sources": [

                                        {

                                            "title": "PM",

                                            "url": "https://searchassist.kore.ai/searchassistapi/redirect?rurl=https%3A%2F%2Fnha.gov.in%2FPM-JAY&requestId=fsh-86e3cdd2-1922-5ede-885a-1192a629752f&contentId=fc-5a9dc6d5-3eef-5401-94e8-713cf93ea19d&hId=4bbb6d4a613bace86b8ad085bf6d34faf493708f174227f5fc56be4333dce96b"

                                        }

                                    ],

                                    "content": "flag [img/resources/flag.jpg] भारत सरकार GOVERNMENT OF INDIA [https://www.mygov.in/] * 14555 [tel:14555] * Screen Reader Access [https://pmjay.gov.in/screen_reader] * Skip to main content * /sitemap.xml * https://www.facebook.com/AyushmanBharatGoI * https://twitter.com/ayushmannha * https://www.youtube.com/channel/UCkd7w2rww0HQB4lZ-l3dB6g * https://www.linkedin.com/company/ayushmanbharatgoi/ * https://www.instagram.com/ayushmanbharatnha/ * Quora image [img/gallery/quora.png] [https://www.quora.com/profile/Ayushman-Bharat-9?ch=3&share=25d97ee9&srid=bdecg] * A+ [javascript:;] * A [javascript:;] * A- [javascript:;] NHA [img/resources/logo.svg] [https://nha.gov.in/] IYC [img/resources/iyc.png] [https://nha.gov.in/] NATIONAL HEALTH AUTHORITY PM-JAY [img/resources/pmjay.png] [https://pmjay.gov.in/] * index.php * Home [https://nha.gov.in/] * About Us * NHA [NHA.php] * Who's who [Whos-who.php] * PM-JAY [PM-JAY.php] * ABDM [NDHM.php] * PM-JAY [https://pmjay.gov.in/] * ABDM [https://ndhm.gov.in/] * Blog [https://pmjay.gov.in/Blogs-list] * Connect with Us * Careers [Careers.php] * Contact Us [Contact-Us.php] * Tenders and Procurement [Tenders-Procurement.php] * Circulars [circulars.php] * PMJAY Dashboard [https://dashboard.pmjay.gov.in/pmj/#/] * ABDM Dashboard [https://dashboard.abdm.gov.in/abdm/] * PMJAY for 70+ * Enrol for PMJAY for 70+ [https://beneficiary.nha.gov.in/] * List of Empanelled Hospitals [https://hem.nha.gov.in/search] * FAQs [img/resources/English_FAQs_related_to_the_benefits_for_senior_citizens.pdf] * How to Make Ayushman Card [https://youtube.com/playlist?list=PLYcj0BpCoCc4yDCm7A4xxsjkg4gmxnWre&si=6B2-_rj9TFB0fA-k] * Give a Missed Call [missedcall.php] * Am I Eligible [img/resources/am-i-eligible.png] [https://beneficiary.nha.gov.in/] * find1 [img/resources/find1.png] [https://hospitals.pmjay.gov.in/Search/empnlWorkFlow.htm?actionFlag=ViewRegisteredHosptlsNew] * Grievance Portal [img/resources/grivence.png] [https://cgrms.pmjay.gov.in/GRMS/] [https://pmjay.gov.in/MAP/images/icons/inner_bg2.png] ABOUT PRADHAN MANTRI JAN AROGYA YOJANA (PM-JAY) * Home [index.php] * About Pradhan Mantri Jan Arogya Yojana (PM-JAY) * About Ayushman Bharat * Background * Criteria/Coverage * Implementation * Financing * Hospital Empanelment * Packages and Rates * IT System * Awareness * Support Systems * Convergence AYUSHMAN BHARAT Ayushman Bharat, a flagship scheme of Government of India, was launched as",

                                    "appInfo": {

                                        "appName": "Prod SA",

                                        "featureFlag": "external",

                                        "product": "searchai",

                                        "_id": "67d2bf2595de4b4d5bb32e84",

                                        "displayLines": 4

                                    }

                                },

                                {

                                    "sources": [

                                        {

                                            "title": "NLM",

                                            "url": "https://searchassist.kore.ai/searchassistapi/redirect?rurl=https%3A%2F%2Fpmc.ncbi.nlm.nih.gov%2Farticles%2FPMC3093249%2F&requestId=fsh-86e3cdd2-1922-5ede-885a-1192a629752f&contentId=fc-3137891f-fc01-5678-ba83-c6d6aaa910de&hId=6b26f7a1b5a381176156d91699f5a6f9b979d8d516335ee58d831feb4c970a52"

                                        }

                                    ],

                                    "content": "Skip to main content [/static/img/us_flag.svg] An official website of the United States government Here's how you know Here's how you know [/static/img/icon-dot-gov.svg] Official websites use .gov A .gov website belongs to an official government organization in the United States. [/static/img/icon-https.svg] Secure .gov websites use HTTPS A lock ( Locked padlock icon ) or https:// means you've safely connected to the .gov website. Share sensitive information only on official, secure websites. NCBI home page [/static/img/ncbi-logos/nih-nlm-ncbi--white.svg] [https://www.ncbi.nlm.nih.gov/] Search Log in * Dashboard [https://www.ncbi.nlm.nih.gov/myncbi/] * Publications [https://www.ncbi.nlm.nih.gov/myncbi/collections/bibliography/] * Account settings [https://www.ncbi.nlm.nih.gov/account/settings/] * Log out Search… Search NCBI Primary site navigation Close [/static/img/usa-icons/close.svg] Search Search [data:] Logged in as: * Dashboard [https://www.ncbi.nlm.nih.gov/myncbi/] * Publications [https://www.ncbi.nlm.nih.gov/myncbi/collections/bibliography/] * Account settings [https://www.ncbi.nlm.nih.gov/account/settings/] Log in Search PMC Full-Text Archive Search in PMC Search [/static/img/usa-icons-bg/search--white.svg] * Advanced Search [https://www.ncbi.nlm.nih.gov/pmc/advanced/] * Journal List [/journals/] * User Guide [/about/userguide/] * * https://doi.org/10.1016/S0140-6736(10)61894-6 * pdf/nihms292456.pdf * * * PERMALINK Copy As a library, NLM provides access to scientific literature. Inclusion in an NLM database does not imply endorsement of, or agreement with, the contents by NLM or the National Institutes of Health. Learn more: PMC Disclaimer [/about/disclaimer/] | PMC Copyright Notice [/about/copyright/] NIHPA Author Manuscripts logo [https://cdn.ncbi.nlm.nih.gov/pmc/banners/logo-nihpa.png] Lancet . Author manuscript; available in PMC: 2011 May 12. Published in final edited form as: Lancet. 2011 Jan 10;377(9764):505–515. doi: 10.1016/S0140-6736(10)61894-6 [https://doi.org/10.1016/S0140-6736(10)61894-6] * Search in PMC [https://www.ncbi.nlm.nih.gov/pmc/?term=%22Lancet%22%5Bjour%5D] * Search in PubMed [https://pubmed.ncbi.nlm.nih.gov/?term=%22Lancet%22%5Bjour%5D] * View in NLM Catalog [https://www.ncbi.nlm.nih.gov/nlmcatalog?term=%22Lancet%22%5BTitle%20Abbreviation%5D] * Add to search [?term=%22Lancet%22%5Bjour%5D] HEALTH CARE AND EQUITY IN INDIA Yarlini Balarajan [https://pubmed.ncbi.nlm.nih.gov/?term=%22Ba",

                                    "appInfo": {

                                        "appName": "Prod SA",

                                        "featureFlag": "external",

                                        "product": "searchai",

                                        "_id": "67d2bf2595de4b4d5bb32e84",

                                        "displayLines": 4

                                    }

                                }

                            ]

                        }

                    },

                    "used": []

                }

            ],

            "proActiveSuggestions": []

        },

{

            "conversationID": "e160c0a1-c4ff-415f-abba-27b62bbxxxxx",

            "botSessionID": "67e52794aac9173b40axxxxx",

            "channel": "chat",

            "segmentID": "ac-c2a1d33-6661-4acc-a86b-44d92e3xxxxx",

            "segmentStartTime": "2025-03-27T10:26:43.597Z",

            "segmentEndTime": "2025-03-27T10:28:25.093Z",

            "countScrollUp": 0,

            "countScrollDn": 0,

            "agent": {

                "agentId": "3f4ff148-6759-4b80-934c-edf0b1147e91"

            },

            "tags": [],

            "summary": {

                "summaryId": "smr-ee39c23-6a09-464d-8584-9c8ab6672b4b",

                "participant": {

                    "identity": "3f4ff148-6759-4b80-934c-edf0b1147e91",

                    "name": "Jayasri thota",

                    "type": "agent"

                },

                "type": "final",

                "summary": "The customer initiated the conversation but did not provide further information or actions.",

                "editedSummary": "",

                "isError": false,

                "isDisabled": false,

                "isEdited": false,

                "time": 0.2815239429473877,

                "modelType": "",

                "summaryModel": "kore",

                "exeStartTime": 1743071305058,

                "identity": "3f4ff148-6759-4b80-934c-edf0b1147e91",

                "positionId": "dg-ob4myq2sr"

            },

            "agentActions": [],

            "proActiveSuggestions": []

        }

    ],

    "hasMore": false

}

Response Body Parameters

PARAMETER TYPE AND FORMAT DESCRIPTION AND EXAMPLE
numResults Integer number of results sent in this response
hasMore Boolean (True / False) if there are any more pages left with results.

Example: “false” without the double-quotes

data Array of segment objects Each segment is a part of a conversation that is driven by one primary agent.
data[].conversationID unique id of the conversation – from customer
data[].botSessionID Alphanumeric string unique id of the session – from Kore.

Example: “667fc3b587b5fd0fbf97d4de”

data[].channel String channel name – from customer.

Example: “chat”

data[].segmentID Type-prefixed uuid unique id of the segment, prefixed by “ac” – from Kore.

Example: “ac-de166b2-1e14-4141-9061-9bca0203b068”

data[].agent Object object containing data of the primary agent servicing this portion (aka segment) of the conversation.

All data is optional (except agentID), and comes from the customer via the process API

data[].agent.firstName String agent’s first name – from customer.

Example: “John”

data[].agent.lastName String agent’s last name – from customer.

Example: “Smith”

data[].agent.email String of valid email address agent’s email address – from customer.

Example: “john.smith@example.com”

data[].agent.name String agent name – from customer.

Example: “John Smith”

data[].agent.agentId String unique id of the agent- from customer.

Example: “jsmith01”

data[].tags Array of tag objects Each tag is one created by bot developers at various points in the Dialog.

All tags emitted by the bot at any point during this portion of the conversation will be returned here.

data[].tags[].type Type of tag can be a message-level tag,a session-level or a user-level tag.

Example: one of “user”,”message”, “session”

data[].tags[].name String key value of the tag – from the client’s bot developer
data[].tags[].value String value of the tag – from the client’s bot developer
data[].tags[].messageID Type-prefixed uuid uuid of the message (prefix: “ms”) that emitted this tag – from Kore.

Example: “ms-de166b2-1e14-4141-9061-9bca0203b068”

data[].tags[].createdAt Date: YYYY-MM-DDTHH24:mm:SS.NNNZ UTC-based time when this tag was emitted.

Example: “2024-06-29T08:37:35.937Z”

data[].segmentStartTime Date: YYYY-MM-DDTHH24:mm:SS.NNNZ UTC-based time when this portion of the conversation began.

Example: “2024-06-29T08:37:35.937Z”

data[].segmentEndTime Date: YYYY-MM-DDTHH24:mm:SS.NNNZ UTC-based time when this portion of the conversation end.

Example: “2024-06-29T08:37:35.937Z”

summary Object Contains the summary details of the interaction.
summary.summary String A concise summary of the customer’s request and agent’s response.

Example: “The customer requested to order a pizza…”

summary.editedSummary String An edited version of the summary, providing additional context or changes.

Example: “The customer requested to order a pizza… edited…”

summary.isError Boolean Indicates if there was an error in the interaction.

Example: false

summary.isDisabled Boolean Indicates if the summary is disabled.

Example: false

summary.feedback Object Contains feedback related to the interaction.
summary.feedback.response String The overall response from the feedback.

Example: “Down”

summary.feedback.reasonCode Array List of reasons for the feedback.

Example: [“Inaccurate Content”, “Too Lengthy”, “Not Satisfactory”]

summary.feedback.comment String Any additional comments from the user.

Example: “hehbdh”

summary.isEdited Boolean Indicates if the summary has been edited.

Example: true

summary.summaryModel String Indicates the model used for summarization.

Example: “kore”

summary.time Number (milliseconds) The time taken for the process in milliseconds.

Example: 98.685

summary.exeStartTime Number (milliseconds) The execution start time in milliseconds since the epoch.

Example: 1727345858881

summary.agentId String The unique identifier for the agent handling the request.

Example: “phani-876”

summary.sumSubTime Number (milliseconds) The time when the summary was submitted in milliseconds since the epoch.

Example: 1727345957566

data[].agentActions Array of objects array of objects each of which denotes an Agent’s action, which can be:

1. Attempt to Search via Search Bar

2. Running a DialogTask from the Library opening in Search bar

data[].agentActions[].actionType String type of Agent’s action.

Example: one of “SearchBarEntry”, “LibrarySelection”

data[].agentActions[].action Object object containing data related to an Agent’s attempt to search.

Will be of type SearchBarEntry.

data[].agentActions[].used Array of objects objects detailing which of the SearchBarEntries or the DialogTasks

were used – as in Sent, Copied, Executed, given Feedback, or had their links clicked

data[].agentActions[].used[].targetType String specifies the type of object used by the agent.

Example: one of “DialogTask”, “FAQ”, “Answer”, “File”, “WebPage”, “GeneralDataSource”

data[].agentActions[].used[].target Object object containing details of use of any DialogTask or data source
data[].proActiveSuggestions Array of objects objects containing suggestions given proactively by Agent AI.

These can be:

1. Suggestions given proactively based on Customer’s latest utterance

2. Suggestions given proactively based on preshown text, such as Summary.

data[].proActiveSuggestions[].utterance String entire utterance by the end Customer – redacted if redaction is enabled.

Example: “What is my account balance?”

data[].proActiveSuggestions[].suggestions Suggestion object each Suggestion by Agent AI, whether it is a DialogTask, an Answer, FAQ, Article or any other
data[].proActiveSuggestions[].displayTime Date: YYYY-MM-DDTHH24:mm:SS.NNNZ time at which this list of suggestions was displayed (UTC).

Example: “2024-06-29T08:37:35.937Z”

data[].proActiveSuggestions[].countDisplayedAnswers Object contains counts of all displayed suggestions by type
data[].proActiveSuggestions[].countDisplayedAnswers.countDialogTasks Integer Number of DialogTasks suggested
data[].proActiveSuggestions[].countDisplayedAnswers.countFaqs Integer Number of Faqs suggested
data[].proActiveSuggestions[].countDisplayedAnswers.countAnswers Integer Number of Answers suggested
data[].proActiveSuggestions[].countDisplayedAnswers.countFiles Integer Number of Files suggested
data[].proActiveSuggestions[].countDisplayedAnswers.countWebPages Integer Number of Web pages suggested
data[].proActiveSuggestions[].countDisplayedAnswers.countFromNonNativeDataSource Integer Number of suggestions from non-native data sources
data[].proActiveSuggestions[].used Array of objects objects detailing which of the suggestions were used – as in Sent, Copied, Executed, given Feedback, or had their links clicked
data[].proActiveSuggestions[].used[].targetType String specifies the type of object used by the agent.

Example: one of “DialogTask”, “FAQ”, “Answer”, “File”, “WebPage”, “GeneralDataSource”

data[].proActiveSuggestions[].used[].target Object object containing details of use of any DialogTask or data source
SearchBarEntry Object This details an action by the Agent – when he enters text on the Search Bar.
SearchBarEntry.searchPhrase String The search query entered by the agent. Example: “Return string to the given question using the provided Content and source_name…”
SearchBarEntry.typingStartTime Date: YYYY-MM-DDTHH24:mm:SS.NNNZ Timestamp of when typing started. Example: “2024-07-10T06:52:36.447Z”
SearchBarEntry.executionStartTime Date: YYYY-MM-DDTHH24:mm:SS.NNNZ Timestamp of when the search execution began. Example: “2024-07-10T06:52:36.871Z”
SearchBarEntry.displayTime Date: YYYY-MM-DDTHH24:mm:SS.NNNZ Timestamp of when the search results were displayed. Example: “2024-07-10T06:52:40.359Z”
suggestionsShown Array of Strings List of suggestions shown during the agent action. Example: [“tech are using the wrng worlkss teh”, “teh are using wrnog workds for the tesnsig”, “Healthcare System in India, Healthcare India – IBEF”]
suggestionUsed Integer The number of suggestions used by the agent. Example: 1
phraseInput String The phrases entered by the agent. Example: “health teh”
correctionsPresented Integer The number of corrections presented to the agent. Example: 5
correctionsAccepted Integer The number of corrections accepted by the agent. Example: 0
SearchBarEntry.countDisplayedAnswers Object contains counts of all displayed suggestions by type
SearchBarEntry.countDisplayedAnswers.countDialogTasks Integer Number of DialogTasks suggested
SearchBarEntry.countDisplayedAnswers.countFaqs Integer Number of Faqs suggested
SearchBarEntry.countDisplayedAnswers.countAnswers Integer Number of Answers suggested
SearchBarEntry.countDisplayedAnswers.countFiles Integer Number of Files suggested
SearchBarEntry.countDisplayedAnswers.countWebPages Integer Number of Web pages suggested
SearchBarEntry.countDisplayedAnswers.countFromNonNativeDataSource Integer Number of suggestions from non-native data sources
SearchBarEntry.suggestions Suggestion object each Suggestion by Agent AI, whether it is a DialogTask, an Answer, FAQ, Article or any other
DialogTask Object This object is shown in a used array when a DialogTask is run.
DialogTask.name String name of the DialogTask – from the client’s bot developer.

Example: “Cancel account”

DialogTask.runType String How did the agent run it? Using the “Run” button, or the “Run with Agent input” button.

Example: one of “RunAssist”, “RunWithAgentInput”

DialogTask.status String Outcome of the DialogTask.

Example: one of “Completed”, “PrematurelyTerminated”, “TimedOut”, “Error”

DialogTask.SuggestionsCount Object count of suggestions made by DialogTask by ask/tell prompt type.
DialogTask.SuggestionsCount.askSuggestions Integer count of suggestions that prompt with “Ask Customer”
DialogTask.SuggestionsCount.tellSuggestions Integer count of suggestions that prompt with “Tell Customer”
DialogTask.SuggestionsCount.askUsed Integer count of “Ask” suggestions that were sent or copied over to Customer
DialogTask.SuggestionsCount.tellUsed Integer count of “Tell” suggestions that were sent or copied over to Customer
DialogTask.startTime Date: YYYY-MM-DDTHH24:mm:SS.NNNZ time at which this DialogTask began to run

Example: “2024-06-29T08:37:35.937Z”

DialogTask.endTime Date: YYYY-MM-DDTHH24:mm:SS.NNNZ time at which this DialogTask ended its run.

Example: “2024-06-29T08:37:35.937Z”

DialogTask.feedback Object feedback given by Agent to this DialogTask
faq Object this object is shown in a used array when an faq Q&A pair is used
faq.title String Title of the FAQ Q&A pair.

Example: “FAQ 3.2”

faq.status String How was it used? Sent or Copied?

Example: one of “Sent”, “Copied”

faq.usedTime Date: YYYY-MM-DDTHH24:mm:SS.NNNZ time at which this FAQ was sent or copied.

Example: “2024-06-29T08:37:35.937Z”

answer Object this object is shown in a used array when an Answer from Search AI is used
answer.status String shows if the Answer has been Sent or Copied. If not sent or copied, but used otherwise, it will be blank. “Used Otherwise” means its “Show more” may have been clicked, one of its links may have been clicked, or the Agent gave feedback to it.

Example: one of “Sent”, “Copied”, or blank

answer.usedTime Date: YYYY-MM-DDTHH24:mm:SS.NNNZ time at which this Answer was sent or copied. If not, it will be blank.

Example: “2024-06-29T08:37:35.937Z”

answer.showMoreClicked Boolean (True / False) if the Show More button for this answer was clicked.

Example: “false” without the double-quotes

answer.answerLinkClicked Array of URL links links in the Answer clicked by the Agent.

Example: [“http://www.google.com“]

answer.internalInfoMoreClicked Boolean (True / False) if the Show More button for this answer was clicked.

Example: “false” without the double-quotes

answer.positionId Type-prefixed uuid prefixed by “dg-“, a position ID referring to a displayed suggestion in the “suggestions” object.

Example: “dg-3id77hn44k”

answer.feedback Object feedback given by Agent to this Answer
webpage Object this object is shown in a used array when a webpage is used by the Agent
webpage.url String – URL URL of the webpage
webpage.status String How was it used? Sent or Copied?

Example: one of “Sent”, “Copied”

webpage.usedTime Date: YYYY-MM-DDTHH24:mm:SS.NNNZ time at which this webpage was sent or copied.

Example: “2024-06-29T08:37:35.937Z”

file Object this object is shown in a used array when a file is used by the Agent
file.path String – filepath path of the file.

Example: “/home/docs/configuration_parameters.doc”

file.status String How was it used? Sent or Copied?

Example: one of “Sent”, “Copied”

file.usedTime Date: YYYY-MM-DDTHH24:mm:SS.NNNZ time at which this file was sent or copied.

Example: “2024-06-29T08:37:35.937Z”

general-data-source Object this object is shown in a used array when a non-native data source is used by the Agent
general-data-source.connector String name of the data source.

Example: “MSSharepoint”

general-data-source.uri URI URI of the resource.

Example: “https://TestServer/TestSite/Reports/Doc/Company%20Sales.rdl

general-data-source.status String How was it used? Sent or Copied?

Example: one of “Sent”, “Copied”

general-data-source.usedTime Date: YYYY-MM-DDTHH24:mm:SS.NNNZ time at which this resource was sent or copied.

Example: “2024-06-29T08:37:35.937Z”

feedback Object contains feedback from an Agent to certain suggestions.
feedback.response String The Agent can choose Thumbs Up or Down.

Example: one of “up”, “down”

feedback.reasonCode Array of strings the Agent may choose multiple reason codes, and these are configurable.

Example: [“Wrong Intent”, “Missed Context”]

feedback.comment String freeform textual feedback from the Agent.

Example: “This is not the correct Dialog. The customer said ‘Cancel account’, and the Dialog is about renewal”.

suggestions Object containing all displayed suggestions, whether from a SearchBarEntry action by the Agent or a proActiveSuggestion triggered by a Customer’s utterance
suggestions.dialogs Array of objects each object contains the particulars of a DialogTask displayed to Agent
suggestions.dialogs[].name String name of the DialogTask – from the client’s bot developer.

Example: “Cancel Account”

suggestions.answers Array of objects each object contains details of an Answer displayed
suggestions.answers[].content String Generated Answer content.

Example: “A potentially very long answer that may be generated by an LLM”.

suggestions.answers[].positionId Type-prefixed uuid prefixed by “dg-“, this field acts as a key for this particular answer, later referred to by an Answer object in a used array.

Example: “dg-3id77hn44k”

suggestions.answers[].sources Array of objects array of source links from which the Answer was generated.
suggestions.answers[].sources[].title String Title of the page linked, that was one of the sources for the Answer.

Example: AWS EC2 On-demand pricing

suggestions.answers[].sources[].url String – URL The link itself.

Example: “https://aws.amazon.com/ec2/pricing/on-demand/

suggestions.answers[].internalFlag Boolean (True / False) Example: “false” without the double-quotes
queueInfo

  • queueId
  • queueName
String Unique name and ID number of the queue involved in the conversation.

Example: “CreditCard”, “qu-2335c1-8et33-33535-133535”

countScrollUp and countScrollDn Integer Number of times an agent clicks the scroll up and/or scroll down buttons.
linksClicked String List of the URL/s an agent clicks with timestamps during a conversation.

Example: “https://www.apple.com/in/”, 2024-12-17T11:04:37.163Z