GuidesAPI ReferenceSDKsIntegrationsWhat's New?

Refresh a summary

Suggest Edits

To refresh a previously generated Summary, you can use one of two methods:

  1. Regenerate the entire Summary: Deletes any previously created Summary and replaces it with a new one.

  2. Regenerate Summary for only new transcripts: Generates a Summary only for new messages in the conversation.

Regenerate the Summary

To regenerate the Summary that was already created, use the flag refresh=true.

When you regenerate the Summary with refresh=true flag, the previous Summary is deleted and a new one is created.

Pass the parameter refresh=true in the Summary request

The parameter refresh=true must be passed as a query parameter in the Summary request:

Request

POST https://api.symbl.ai/v1/conversations/{conversationId}/summary?refresh=true

Response

{
  "summary": [
    {
      "id": "3498579583479",
      "text": "John, Mark and Paul need to focus more on the Dev team and on the 
      product. In order to focus on the sales hires, Paul needs to know which 
      geographies they should focus on.",
      "messageRefs": [
        {
          "id": "248594875984"
        },
        {
          "id": "948538959348"
        },
        {
          "id": "538598359838"
        },
        {
          "id": "242948723984"
        },
        {
          "id": "234794875984"
        },
        {
          "id": "248545375984"
        },
        {
          "id": "244394875984"
        },
        {
          "id": "248232875984"
        },
        {
          "id": "248595675984"
        },
        {
          "id": "357194875984"
        },
        {
          "id": "236394875984"
        },
        {
          "id": "457594875984"
        }
      ],
      "startTime": "2022-08-23T01:13:21.784Z",
      "endTime": "2022-08-23T01:14:55.304Z",
    },
    {
      "id": "4385738475683",
      "text": "Mark and Tim will create a link, it will work on their environment 
      and use the same API. The video placement will use a cookie. The idea is to 
      eliminate effort on the consultancy team. Mark suggests a negation using 
      cookies. Rob and Tim agree that it simplifies things on their end.",
      "messageRefs": [
        {
          "id": "938475984357"
        },
        {
          "id": "458375843755"
        },
        {
          "id": "565375984357"
        },
        {
          "id": "932342454357"
        },
        {
          "id": "913434441357"
        },
        {
          "id": "234235235155"
        },
        {
          "id": "134235322465"
        },
        {
          "id": "235235346223"
        },
        {
          "id": "134245723252"
        },
        {
          "id": "458434533646"
        },
        {
          "id": "346346356124"
        },
        {
          "id": "356346346365"
        },
        {
          "id": "645123434625"
        },
        {
          "id": "346635642223"
        },
       {
          "id": "342342352523"
        },
       {
          "id": "324334534622"
        },
       {
          "id": "673546246245"
        },
       {
          "id": "235252456842"
        },
       {
          "id": "246734574683"
        },
       {
          "id": "735773463571"
        },
       {
          "id": "682352246362"
        },
       {
          "id": "574535734242"
        },
      ],
      "startTime": "2022-08-23T01:14:56.199Z",
      "endTime": "2022-08-23T01:15:43.721Z",
    }
  ]
}

Response fields

ParameterDescription
idThe identifier of this summary within the scope of the conversation.
textThe text of the summary.
messageRefs.idThe identifier of each message that makes up the summary.
startTimeThe timestamp indicating when the conversation started.
endTime.The timestamp indicating when the conversation ended.

Regenerate Summary for only new transcripts

When you have new or additional transcript messages, you can generate a Summary for only the new transcripts without regenerating the entire Summary.

Pass the parameter refresh=false in the Summary request

The parameter refresh=false must be passed as a query parameter in the Summary request. Use the conversationId of the original conversation:

Request

POST https://api.symbl.ai/v1/conversations/{conversationId}/summary?refresh=false

Response

{
  "summary": [
    {
      "id": "7298573211590",
      "text": "Stella, Rob and Mark met to outline the actual requirement for 
      the APIs. They have specified the details in the Product Requirement 
      Documentation. Some of the errors encountered in the past were related 
      to the implementation gaps. Tim will investigate the past errors and 
      share the same with the team",
      "messageRefs": [
        {
          "id": "248594875911"
        },
        {
          "id": "948538959102"
        },
        {
          "id": "538598359123"
        },
        {
          "id": "242948723322"
        },
        {
          "id": "234794875304"
        },
        {
          "id": "248545375300"
        },
        {
          "id": "244394875727"
        },
        {
          "id": "248232875200"
        },
      ],
      "startTime": "2022-08-23T01:15:44.025Z",
      "endTime": "2022-08-23T01:17:30.909Z",
    }
  ]
}

Summary guide

For more information about the Summary request and response parameters, see the Summary guide.

Updated about 2 months ago