Conversation Summary API (Beta)¶

The API summarizes the conversation between a user and an agent. The agent can be a virtual agent or a human agent. The API accepts the conversation Id or the transcripts as input and provides an auto-generated conversation summary.

The API uses open-source LLM fine-tuned and hosted by Kore.ai for summarizing conversations using a large number of sample conversation transcripts from various fields and industries.

Note

Currently, the API is in its beta phase and has some limitations. The API supports transcripts only in English (en) and is available only in our global deployment (https://bots.kore.ai). The generated summary may have factual inconsistencies and inaccurate representations due to limited coverage in the beta phase.

Method	POST
Endpoint	`https://{{host}}/api/public/streams/{{streamId}}/conversationSummary`
Content Type	`application/json`
Authorization	`auth: {{JWT}}` See How to generate the JWT Token.
API Scope	Bot Builder: Conversation Summary

Path Parameters¶

PARAMETER	REQUIRED/OPTIONAL	DESCRIPTION
host	required	Environment URL, for example, https://bots.kore.ai
streamId	required	Stream ID or Bot ID. You can access it from the General Settings page of the bot.

Sample Request¶

With Conversation Id as Input Mode

curl -X POST 'https://{{host}}/api/public/streams/{{streamId}}/conversationSummary' \
--header 'auth: {{YOUR_JWT_ACCESS_TOKEN}}' \
--header 'Content-Type: application/json' \
--data '{
    "lang": "en",
    "inputMode": {
        "conversationId": "64808537ba90cb4b384157cf"
    }
}'

With Transcript as Input Mode

curl -X POST \ 
'https://{{host}}/api/public/streams/{{streamId}}/conversationSummary' \
--header 'auth: {{YOUR_JWT_ACCESS_TOKEN}}' \
--header 'Content-Type: application/json' \
--data '{
    "lang": "en",
    "inputMode": {
        "transcript": "Agent: Thank you for calling spectrum community solutions. My name is Jeff I'\''ll be glad to assist you? Consumer: I just. My name is Tom link LINK. Agent: . Alright. How are you doing today sir. Alright. What can I do to help you? Consumer: Good how are you the yeah that? I get it right. Is it is Jeff. Agent: Yes sir. Consumer: Good. Okay. Okay. Okay um. So I'\''m was having a little I was having a DVD issue. I'\''ve got two boxes. The TV part is fine. I can get the channels in and everything is fine. Consumer: And the DVD. I'\''m. As a DVR. I guess DVR. Consumer: We'\''ve got a DVR capability on on the problem I'\''ll call at the primary box and then the secondary box upstairs the primary box is working. Consumer: Hundred percent. I can record channels. I can call them back up again. I can go forward and backwards. Everything is fully functional on the primary box for DVD the secondary box upstairs. Agent: Um-hum. Consumer: Um it it just doesn'\''t respond at all to the. You know I'\''m using the wand with the green button right in the middle the list button and it it just doesn'\''t respond at all to that. I'\''ve got full functionality on the TV channels in the guide. But but the list does not work at all. So I can'\''t protect a penny taped shows. Agent: Alright I definitely understand your concern. Dear Sir up. Glad look into this for you. Agent: Okay. So the first thing I'\''m gonna do is run a communication test if there'\''s. Consumer: Okay. Agent: If there'\''s any issues with the communication that would definitely cause problems with the DVR. Consumer: Okay. Agent: Because I need good communication going in and good communication. Going out for it. Deport that list up player programs etc. so I'\''m looking into that right now for you. Consumer: Very good. Consumer: Hello. Agent: Alright. In question for you sir. Have you had any problems with your Internet the past couple of days. Also. Consumer: Know the Internet seems fine. Agent: Okay. Alright. Because I ran a test in very quickly. Your DVR. Consumer: Okay. Agent: And your modem or Agenth failing. Agent: Let'\''s just waiting for the test to complete fully. Agent: Alright. So they'\''re Agenth failing on different frequencies. So. Agent: One more than likely has nothing to do with the other just a coincidence. But they Agenth are failing. Consumer: And and by Agenth you mean that the DVR boxes. Agent: Yes I did the DVR box that you have is failing Consumer: . Okay. Agent: In your modem just failing. Also. Consumer: Okay. Well? Yes. So we'\''ve got we'\''ve got a we'\''ve got an appointment scheduled for tomorrow at 3 o'\''clock? Should I just keep that in have a tech come in and take a look at it. Consumer: Very good. We'\''ll leave it in place then. Thank you. Agent: Absolutely. Alright you'\''re welcome ma'\''am, it'\''s gonna place some notes on the account. Agent: DVR failed signal level check in modem. Modem failed. Also. Agent: Alright great. So yes I would definitely say keep the appointment and technician gets here he can go through everything test everything and make sure everything is working properly for you. Consumer: Super. Thank you so much. Agent: Alright. You'\''re more than welcome sir. We do apologize for the inconvenience but we look forward to getting a technician out there and resolve an issue for you sir."
    }
}'

Request Body Parameters¶

PARAMETER	REQUIRED/OPTIONAL	DESCRIPTION
language	required	The language used for understanding the transcript and generating the summary. Currently, only the English language (en) is supported.
inputMode	required	One of the following modes in which the input can be provided to the API: ConversationId: A valid conversation session Id of the current bot. transcript: The conversation transcript in a specific format; see the sample code above.

Sample Response¶

{
    "ConversationSummary": "Consumer was having a DVD issue. He has two boxes. The TV part is fine. The DVD is a DVR. The list doesn't work at all. Consumer needs good communication going in and good communication going out for it.",
    "time": "2023-06-09T07:45:47.940Z"
}

Response Body Parameters¶

PARAMETER	DESCRIPTION
ConversationSummary	The auto-generated summary of the conversation.
time	Date & time of the summary generation.