Jump to

• Request
• Response

Create a Call Summary

post

/api/v1/aia/sg/call-summary/summaries

Post a conversation transcript and request the summarization service to generate the AI summary for the conversation.

Request

There are no request parameters for this operation.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : AIASummaryRequest

Type: object

Title: AIASummaryRequest

Response containing the result of a summarization request, including the conversation_id, config_id, summary for the conversation, and a list of tags.

Show Source

• configId(required): string
  Title: Configid

  The configuration ID of the summarization request for the customer.
• conversationId(required): string
  Title: Conversationid

  Maximum Length: 256

  The conversation ID of the summarization request.
• conversations(required): array Conversations
  Title: Conversations

  Minimum Number of Items: 1

  The list of conversations to summarize.
• formatInstructions: object SummaryFormatInstructions
  Title: SummaryFormatInstructions

  The basic configuration for the output of a summarization request.

{
    "properties":{
        "conversationId":{
            "type":"string",
            "maxLength":256,
            "title":"Conversationid",
            "description":"The conversation ID of the summarization request."
        },
        "configId":{
            "type":"string",
            "title":"Configid",
            "description":"The configuration ID of the summarization request for the customer."
        },
        "conversations":{
            "items":{
                "properties":{
                    "tag":{
                        "type":"string",
                        "maxLength":32,
                        "title":"Tag",
                        "description":"The tag of the conversation, it can be speaker A, B, or combined. This field defines the speakers included in a conversation."
                    },
                    "conversation":{
                        "type":"string",
                        "title":"Conversation",
                        "description":"The text of the conversation to be summarized."
                    },
                    "metadata":{
                        "properties":{
                            "timestamp":{
                                "anyOf":[
                                    {
                                        "type":"number"
                                    },
                                    {
                                        "type":"integer"
                                    }
                                ],
                                "title":"Timestamp",
                                "description":"The timestamp for the conversation."
                            }
                        },
                        "type":"object",
                        "required":[
                            "timestamp"
                        ],
                        "title":"ConversationMetadata",
                        "description":"Metadata for each conversation channel."
                    }
                },
                "type":"object",
                "required":[
                    "metadata"
                ],
                "title":"ConversationChannel",
                "description":"The content of a conversation channel and its metadata."
            },
            "type":"array",
            "minItems":1,
            "title":"Conversations",
            "description":"The list of conversations to summarize."
        },
        "formatInstructions":{
            "properties":{
                "length":{
                    "anyOf":[
                        {
                            "type":"string",
                            "enum":[
                                "short",
                                "long"
                            ],
                            "title":"SummaryLength",
                            "description":"An enum that defines the available summary lengths."
                        },
                        {
                            "type":"null"
                        }
                    ],
                    "description":"The desired length of the generated summary."
                },
                "format":{
                    "anyOf":[
                        {
                            "type":"string",
                            "enum":[
                                "paragraph",
                                "bullet"
                            ],
                            "title":"SummaryFormat",
                            "description":"An enum that defines the available section formats."
                        },
                        {
                            "type":"null"
                        }
                    ],
                    "description":"Desired format of the generated summary."
                },
                "section":{
                    "anyOf":[
                        {
                            "type":"string",
                            "enum":[
                                "no_section",
                                "issue_action"
                            ],
                            "title":"SummarySection",
                            "description":"Enum that defines available section formats."
                        },
                        {
                            "type":"null"
                        }
                    ],
                    "description":"The desired format of the generated summary."
                },
                "minTags":{
                    "anyOf":[
                        {
                            "type":"integer"
                        },
                        {
                            "type":"null"
                        }
                    ],
                    "title":"Mintags",
                    "description":"The minimum number of requested tags for a given input."
                },
                "maxTags":{
                    "anyOf":[
                        {
                            "type":"integer"
                        },
                        {
                            "type":"null"
                        }
                    ],
                    "title":"Maxtags",
                    "description":"The maximum number of requested tags for a given input."
                }
            },
            "type":"object",
            "title":"SummaryFormatInstructions",
            "description":"The basic configuration for the output of a summarization request.",
            "default":{
            }
        }
    },
    "type":"object",
    "required":[
        "conversationId",
        "configId",
        "conversations"
    ],
    "title":"AIASummaryRequest",
    "description":"Response containing the result of a summarization request, including the conversation_id, config_id, summary for the conversation, and a list of tags."
}

Nested Schema : Conversations

Type: array

Title: Conversations

Minimum Number of Items: 1

The list of conversations to summarize.

Show Source

• Array of: object ConversationChannel
  Title: ConversationChannel

  The content of a conversation channel and its metadata.

{
    "items":{
        "properties":{
            "tag":{
                "type":"string",
                "maxLength":32,
                "title":"Tag",
                "description":"The tag of the conversation, it can be speaker A, B, or combined. This field defines the speakers included in a conversation."
            },
            "conversation":{
                "type":"string",
                "title":"Conversation",
                "description":"The text of the conversation to be summarized."
            },
            "metadata":{
                "properties":{
                    "timestamp":{
                        "anyOf":[
                            {
                                "type":"number"
                            },
                            {
                                "type":"integer"
                            }
                        ],
                        "title":"Timestamp",
                        "description":"The timestamp for the conversation."
                    }
                },
                "type":"object",
                "required":[
                    "timestamp"
                ],
                "title":"ConversationMetadata",
                "description":"Metadata for each conversation channel."
            }
        },
        "type":"object",
        "required":[
            "metadata"
        ],
        "title":"ConversationChannel",
        "description":"The content of a conversation channel and its metadata."
    },
    "type":"array",
    "minItems":1,
    "title":"Conversations",
    "description":"The list of conversations to summarize."
}

Nested Schema : SummaryFormatInstructions

Type: object

Title: SummaryFormatInstructions

The basic configuration for the output of a summarization request.

Default Value: { }

Show Source

• format:
  Desired format of the generated summary.
• length:
  The desired length of the generated summary.
• maxTags:
  Title: Maxtags

  The maximum number of requested tags for a given input.
• minTags:
  Title: Mintags

  The minimum number of requested tags for a given input.
• section:
  The desired format of the generated summary.

{
    "properties":{
        "length":{
            "anyOf":[
                {
                    "type":"string",
                    "enum":[
                        "short",
                        "long"
                    ],
                    "title":"SummaryLength",
                    "description":"An enum that defines the available summary lengths."
                },
                {
                    "type":"null"
                }
            ],
            "description":"The desired length of the generated summary."
        },
        "format":{
            "anyOf":[
                {
                    "type":"string",
                    "enum":[
                        "paragraph",
                        "bullet"
                    ],
                    "title":"SummaryFormat",
                    "description":"An enum that defines the available section formats."
                },
                {
                    "type":"null"
                }
            ],
            "description":"Desired format of the generated summary."
        },
        "section":{
            "anyOf":[
                {
                    "type":"string",
                    "enum":[
                        "no_section",
                        "issue_action"
                    ],
                    "title":"SummarySection",
                    "description":"Enum that defines available section formats."
                },
                {
                    "type":"null"
                }
            ],
            "description":"The desired format of the generated summary."
        },
        "minTags":{
            "anyOf":[
                {
                    "type":"integer"
                },
                {
                    "type":"null"
                }
            ],
            "title":"Mintags",
            "description":"The minimum number of requested tags for a given input."
        },
        "maxTags":{
            "anyOf":[
                {
                    "type":"integer"
                },
                {
                    "type":"null"
                }
            ],
            "title":"Maxtags",
            "description":"The maximum number of requested tags for a given input."
        }
    },
    "type":"object",
    "title":"SummaryFormatInstructions",
    "description":"The basic configuration for the output of a summarization request.",
    "default":{
    }
}

Nested Schema : ConversationChannel

Type: object

Title: ConversationChannel

The content of a conversation channel and its metadata.

Show Source

• conversation: string
  Title: Conversation

  The text of the conversation to be summarized.
• metadata(required): object ConversationMetadata
  Title: ConversationMetadata

  Metadata for each conversation channel.
• tag: string
  Title: Tag

  Maximum Length: 32

  The tag of the conversation, it can be speaker A, B, or combined. This field defines the speakers included in a conversation.

{
    "properties":{
        "tag":{
            "type":"string",
            "maxLength":32,
            "title":"Tag",
            "description":"The tag of the conversation, it can be speaker A, B, or combined. This field defines the speakers included in a conversation."
        },
        "conversation":{
            "type":"string",
            "title":"Conversation",
            "description":"The text of the conversation to be summarized."
        },
        "metadata":{
            "properties":{
                "timestamp":{
                    "anyOf":[
                        {
                            "type":"number"
                        },
                        {
                            "type":"integer"
                        }
                    ],
                    "title":"Timestamp",
                    "description":"The timestamp for the conversation."
                }
            },
            "type":"object",
            "required":[
                "timestamp"
            ],
            "title":"ConversationMetadata",
            "description":"Metadata for each conversation channel."
        }
    },
    "type":"object",
    "required":[
        "metadata"
    ],
    "title":"ConversationChannel",
    "description":"The content of a conversation channel and its metadata."
}

Nested Schema : ConversationMetadata

Type: object

Title: ConversationMetadata

Metadata for each conversation channel.

Show Source

• timestamp(required):
  Title: Timestamp

  The timestamp for the conversation.

{
    "properties":{
        "timestamp":{
            "anyOf":[
                {
                    "type":"number"
                },
                {
                    "type":"integer"
                }
            ],
            "title":"Timestamp",
            "description":"The timestamp for the conversation."
        }
    },
    "type":"object",
    "required":[
        "timestamp"
    ],
    "title":"ConversationMetadata",
    "description":"Metadata for each conversation channel."
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful Response

Body ()

Root Schema : AIASummaryResponse

Type: object

Title: AIASummaryResponse

Response containing the result of a summarization request, including the conversation_id, config_id, summary for the conversation, and a list of tags.

Show Source

• configId(required): string
  Title: Configid

  The configuration ID of the summarization request for the customer.
• conversationId(required): string
  Title: Conversationid

  Maximum Length: 256

  The conversation ID of the summarization request
• summary: string
  Title: Summary

  Default Value: The summary generated for the input conversation.
• tags: array Tags
  Title: Tags

{
    "properties":{
        "conversationId":{
            "type":"string",
            "maxLength":256,
            "title":"Conversationid",
            "description":"The conversation ID of the summarization request"
        },
        "configId":{
            "type":"string",
            "title":"Configid",
            "description":"The configuration ID of the summarization request for the customer."
        },
        "summary":{
            "type":"string",
            "title":"Summary",
            "default":"The summary generated for the input conversation."
        },
        "tags":{
            "items":{
                "type":"string"
            },
            "type":"array",
            "title":"Tags",
            "default":"The tags assigned to the conversation.",
            "example":"Billing"
        }
    },
    "type":"object",
    "required":[
        "conversationId",
        "configId"
    ],
    "title":"AIASummaryResponse",
    "description":"Response containing the result of a summarization request, including the conversation_id, config_id, summary for the conversation, and a list of tags."
}

Nested Schema : Tags

Type: array

Title: Tags

Default Value: The tags assigned to the conversation.

Show Source

• Array of: string

{
    "items":{
        "type":"string"
    },
    "type":"array",
    "title":"Tags",
    "default":"The tags assigned to the conversation.",
    "example":"Billing"
}

Example:

Billing

422 Response

Validation Error

Body ()

Root Schema : HTTPValidationError

Type: object

Title: HTTPValidationError

Show Source

• detail: array Detail
  Title: Detail

{
    "properties":{
        "detail":{
            "items":{
                "properties":{
                    "loc":{
                        "items":{
                            "anyOf":[
                                {
                                    "type":"string"
                                },
                                {
                                    "type":"integer"
                                }
                            ]
                        },
                        "type":"array",
                        "title":"Location"
                    },
                    "msg":{
                        "type":"string",
                        "title":"Message"
                    },
                    "type":{
                        "type":"string",
                        "title":"Error Type"
                    }
                },
                "type":"object",
                "required":[
                    "loc",
                    "msg",
                    "type"
                ],
                "title":"ValidationError"
            },
            "type":"array",
            "title":"Detail"
        }
    },
    "type":"object",
    "title":"HTTPValidationError"
}

Nested Schema : Detail

Type: array

Title: Detail

Show Source

• Array of: object ValidationError
  Title: ValidationError

{
    "items":{
        "properties":{
            "loc":{
                "items":{
                    "anyOf":[
                        {
                            "type":"string"
                        },
                        {
                            "type":"integer"
                        }
                    ]
                },
                "type":"array",
                "title":"Location"
            },
            "msg":{
                "type":"string",
                "title":"Message"
            },
            "type":{
                "type":"string",
                "title":"Error Type"
            }
        },
        "type":"object",
        "required":[
            "loc",
            "msg",
            "type"
        ],
        "title":"ValidationError"
    },
    "type":"array",
    "title":"Detail"
}

Nested Schema : ValidationError

Type: object

Title: ValidationError

Show Source

• loc(required): array Location
  Title: Location
• msg(required): string
  Title: Message
• type(required): string
  Title: Error Type

{
    "properties":{
        "loc":{
            "items":{
                "anyOf":[
                    {
                        "type":"string"
                    },
                    {
                        "type":"integer"
                    }
                ]
            },
            "type":"array",
            "title":"Location"
        },
        "msg":{
            "type":"string",
            "title":"Message"
        },
        "type":{
            "type":"string",
            "title":"Error Type"
        }
    },
    "type":"object",
    "required":[
        "loc",
        "msg",
        "type"
    ],
    "title":"ValidationError"
}

Nested Schema : Location

Type: array

Title: Location

Show Source

• Array of:

{
    "items":{
        "anyOf":[
            {
                "type":"string"
            },
            {
                "type":"integer"
            }
        ]
    },
    "type":"array",
    "title":"Location"
}

Back to Top