action.summarize

Summarizes the conversation.

Name	Type	Default	Description
summarize Required	object	-	An object that contains the summarize parameters.

summarize Parameters

Name	Type	Default	Description
webhook Optional	string	-	The webhook URI to be called. Authentication can also be set in the url in the format of username:password@url.
prompt Optional	string	-	The prompt for summarization.

---

Object Example

YAML

live_transcribe:
  action:
    summarize:
      webhook: 'https://example.com/webhook'
      prompt: Summarize the key points of this conversation.

JSON

{
  "live_transcribe": {
    "action": {
      "summarize": {
        "webhook": "https://example.com/webhook",
        "prompt": "Summarize the key points of this conversation."
      }
    }
  }
}

Default Summarization

If the summarize action is called with a empty object, the default summarization prompt and webhook will be used.

YAML

live_transcribe:
  action:
    summarize: {}

JSON

{
  "live_transcribe": {
    "action": {
      "summarize": {}
    }
  }
}