Summarization API for 2022-10-01-preview

dev/cognitiveservices/data-plane/Language/analyzeconversations-authoring.json

@@ -952,7 +952,7 @@
           "200": {
             "description": "List of all evaluation results.",
             "schema": {
-              "$ref": "#/definitions/ConversationalAnalysisAuthoringEvaluationSummary"
+              "$ref": "#/definitions/ConversationalAnalysisAuthoringEvaluationSummaryBase"
             }
           },
           "default": {
@@ -1730,7 +1730,13 @@
           "$ref": "#/definitions/ConversationalAnalysisAuthoringEvaluationOptions"
         }
       },
-      "x-ms-client-name": "EvaluationSummary"
+      "x-ms-client-name": "EvaluationSummary",
+      "allOf": [
+        {
+          "$ref": "#/definitions/ConversationalAnalysisAuthoringEvaluationSummaryBase"
+        }
+      ],
+      "x-ms-discriminator-value": "Conversation"
     },
     "ConversationalAnalysisAuthoringExportedConversationOrchestration": {
       "description": "Defines the orchestration details for a Conversational project target.",
@@ -2431,7 +2437,8 @@
     "ConversationalAnalysisAuthoringProjectKind": {
       "enum": [
         "Conversation",
-        "Orchestration"
+        "Orchestration",
+        "ConversationSummarization"
       ],
       "type": "string",
       "x-ms-enum": {
@@ -2445,6 +2452,10 @@
           {
             "value": "Orchestration",
             "description": "A project to connect and orchestrate Conversation, Custom question answering and LUIS projects together in one single project."
+          },
+          {
+            "value": "ConversationSummarization",
+            "description": "A project to build custom conversation summarization model."
           }
         ]
       },
@@ -3007,6 +3018,76 @@
         }
       },
       "x-ms-client-name": "Warning"
+    },
+    "ConversationalAnalysisAuthoringEvaluationSummaryBase": {
+      "description": "Represents the generic evaluation result summary.",
+      "required": [
+        "projectKind"
+      ],
+      "type": "object",
+      "properties": {
+        "projectKind": {
+          "description": "Represents the project type that the evaluation ran on.",
+          "$ref": "#/definitions/ConversationalAnalysisAuthoringProjectKind"
+        }
+      },
+      "discriminator": "projectKind"
+    },
+    "ConversationalAnalysisAuthoringSummarizationEvaluationSummary": {
+      "description": "Represents the evaluation summary for a custom conversation summarization project.",
+      "required": [
+        "customConversationSummarizationEvaluation"
+      ],
+      "allOf": [
+        {
+          "$ref": "#/definitions/ConversationalAnalysisAuthoringEvaluationSummaryBase"
+        }
+      ],
+      "properties": {
+        "customConversationSummarizationEvaluation": {
+          "description": "Contains the data related to conversation summarization evaluation.",
+          "$ref": "common.json#/definitions/AbstractiveSummarizationEvaluationSummary"
+        }
+      },
+      "x-ms-discriminator-value": "ConversationSummarization"
+    },
+    "ConversationalAnalysisAuthoringSummarizationExportedProjectAssets": {
+      "description": "Represents the exported assets of a conversation summarization project.",
+      "type": "object",
+      "required": [
+        "conversations"
+      ],
+      "allOf": [
+        {
+          "$ref": "#/definitions/ConversationalAnalysisAuthoringExportedProjectAssets"
+        }
+      ],
+      "properties": {
+        "conversations": {
+          "description": "The list of conversations belonging to the project.",
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/ConversationalAnalysisAuthoringSummarizationDataItem"
+          }
+        }
+      },
+      "x-ms-discriminator-value": "ConversationSummarization",
+      "x-ms-client-name": "ConversationSummarizationExportedProjectAssets"
+    },
+    "ConversationalAnalysisAuthoringSummarizationDataItem": {
+      "description": "Represents an exported data item for a custom abstractive summarization project.",
+      "type": "object",
+      "properties": {
+        "conversation": {
+          "$ref": "analyzeconversations.json#/definitions/Conversation"
+        }
+      },
+      "allOf": [
+        {
+          "$ref": "common.json#/definitions/ExportedCustomAbstractiveSummarizationDataItem"
+        }
+      ],
+      "x-ms-client-name": "ConversationalAnalysisAuthoringSummarizationDataItem"
     }
   },
   "parameters": {
@@ -3080,7 +3161,8 @@
       "type": "string",
       "enum": [
         "Conversation",
-        "Orchestration"
+        "Orchestration",
+        "ConversationSummarization"
       ],
       "x-ms-enum": {
         "name": "ProjectKind",
@@ -3093,6 +3175,10 @@
           {
             "value": "Orchestration",
             "description": "A project to connect and orchestrate Conversation, Custom question answering and LUIS projects together in one single project."
+          },
+          {
+            "value": "ConversationSummarization",
+            "description": "A project to build custom conversation summarization model."
           }
         ]
       },

dev/cognitiveservices/data-plane/Language/analyzeconversations.json

@@ -1732,7 +1732,7 @@
       "properties": {
         "itn": {
           "type": "string",
-          "description": "Inverse Text Normalization representation of input. The inverse-text-normalized form is the recognized text from Microsoft’s Speech to Text API, with phone numbers, numbers, abbreviations, and other transformations applied."
+          "description": "Inverse Text Normalization representation of input. The inverse-text-normalized form is the recognized text from Microsoft's Speech to Text API, with phone numbers, numbers, abbreviations, and other transformations applied."
         },
         "maskedItn": {
           "type": "string",
@@ -1752,6 +1752,9 @@
           "items": {
             "$ref": "#/definitions/WordLevelTiming"
           }
+        },
+        "utteranceLevelTiming": {
+          "$ref": "#/definitions/AudioTiming"
         }
       }
     },
@@ -2004,18 +2007,41 @@
             "type": "string",
             "enum": [
               "issue",
-              "resolution"
+              "resolution",
+              "chapterTitle",
+              "generic"
             ],
             "x-ms-enum": {
               "name": "SummaryAspect",
-              "modelAsString": true
+              "modelAsString": true,
+              "values": [
+                {
+                  "value": "issue",
+                  "description": "A summary of issues in transcripts of web chats and service call transcripts between customer-service agents, and your customers."
+                },
+                {
+                  "value": "resolution",
+                  "description": "A summary of resolutions in transcripts of web chats and service call transcripts between customer-service agents, and your customers."
+                },
+                {
+                  "value": "chapterTitle",
+                  "description": "A chapter title of any conversation. It is usually one phrase or several phrases naturally combined together. Long conversation tends to have more chapters. The chapter boundary can be found from the summary context."
+                },
+                {
+                  "value": "generic",
+                  "description": "A generic summary of any conversation."
+                }
+              ]
             }
           }
         }
       },
       "allOf": [
         {
           "$ref": "common.json#/definitions/PreBuiltTaskParameters"
+        },
+        {
+          "$ref": "common.json#/definitions/AbstractiveSummarizationTaskParameters"
         }
       ]
     },
@@ -2089,6 +2115,13 @@
         },
         "text": {
           "type": "string"
+        },
+        "contexts": {
+          "type": "array",
+          "description": "The context list of the summary.",
+          "items": {
+            "$ref": "common.json#/definitions/ItemizedSummaryContext"
+          }
         }
       },
       "required": [

dev/cognitiveservices/data-plane/Language/analyzetext-authoring.json

@@ -2342,7 +2342,8 @@
       "enum": [
         "CustomSingleLabelClassification",
         "CustomMultiLabelClassification",
-        "CustomEntityRecognition"
+        "CustomEntityRecognition",
+        "CustomAbstractiveSummarization"
       ],
       "type": "string",
       "x-ms-enum": {
@@ -2360,6 +2361,10 @@
           {
             "value": "CustomEntityRecognition",
             "description": "For building an extraction model to identify your domain categories using your own data."
+          },
+          {
+            "value": "CustomAbstractiveSummarization",
+            "description": "For building an abstractive summarization model using your own data."
           }
         ]
       },
@@ -2897,6 +2902,68 @@
         }
       },
       "x-ms-client-name": "Warning"
+    },
+    "TextAnalysisAuthoringCustomAbstractiveSummarizationEvaluationSummary": {
+      "description": "Represents the evaluation summary for a custom abstractive summarization project.",
+      "required": [
+        "customAbstractiveSummarizationEvaluation"
+      ],
+      "type": "object",
+      "allOf": [
+        {
+          "$ref": "#/definitions/TextAnalysisAuthoringEvaluationSummary"
+        }
+      ],
+      "properties": {
+        "customAbstractiveSummarizationEvaluation": {
+          "description": "Contains the data related to abstractive summarization evaluation.",
+          "$ref": "common.json#/definitions/AbstractiveSummarizationEvaluationSummary"
+        }
+      },
+      "x-ms-discriminator-value": "CustomAbstractiveSummarization",
+      "x-ms-client-name": "CustomAbstractiveSummarizationEvaluationSummary"
+    },
+    "TextAnalysisAuthoringExportedCustomAbstractiveSummarizationProjectAssets": {
+      "description": "Represents the exported assets for an abstractive summarization project.",
+      "type": "object",
+      "required": [
+        "documents"
+      ],
+      "allOf": [
+        {
+          "$ref": "#/definitions/TextAnalysisAuthoringExportedProjectAssets"
+        }
+      ],
+      "properties": {
+        "documents": {
+          "description": "The list of documents belonging to the project.",
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/TextAnalysisAuthoringExportedCustomAbstractiveSummarizationDocument"
+          }
+        }
+      },
+      "x-ms-discriminator-value": "CustomAbstractiveSummarization",
+      "x-ms-client-name": "ExportedCustomAbstractiveSummarizationProjectAssets"
+    },
+    "TextAnalysisAuthoringExportedCustomAbstractiveSummarizationDocument": {
+      "description": "Represents an exported document for a custom abstractive summarization project.",
+      "type": "object",
+      "required": [
+        "article"
+      ],
+      "properties": {
+        "article": {
+          "description": "The input article to be summarized.",
+          "type": "string"
+        }
+      },
+      "allOf": [
+        {
+          "$ref": "common.json#/definitions/ExportedCustomAbstractiveSummarizationDataItem"
+        }
+      ],
+      "x-ms-client-name": "ExportedCustomAbstractiveSummarizationDocument"
     }
   },
   "parameters": {
@@ -2946,7 +3013,8 @@
       "enum": [
         "CustomSingleLabelClassification",
         "CustomMultiLabelClassification",
-        "CustomEntityRecognition"
+        "CustomEntityRecognition",
+        "CustomAbstractiveSummarization"
       ],
       "x-ms-enum": {
         "name": "ProjectKind",
@@ -2963,6 +3031,10 @@
           {
             "value": "CustomEntityRecognition",
             "description": "For building an extraction model to identify your domain categories using your own data."
+          },
+          {
+            "value": "CustomAbstractiveSummarization",
+            "description": "For building an abstractive summarization model using your own data."
           }
         ]
       },