Add May Preview and May GA Api for Analyze Conversations in Cognitive Services Language

specification/cognitiveservices/Language.Conversations/common.tsp

@@ -543,7 +543,7 @@ model SentimentConfidenceScores {
 }
 
 /** Enum that defines the length of the output summaries. */
-@added(Versions.v2023_11_15_preview)
+@added(Versions.v2024_05_01)
 union SummaryLengthBucket {
   string,
 
@@ -567,7 +567,7 @@ model AbstractiveSummarizationTaskParametersBase {
   stringIndexType?: StringIndexType = StringIndexType.TextElements_v8;
 
   /** (NOTE: Recommended to use summaryLength over sentenceCount) Controls the approximate length of the output summaries. */
-  @added(Versions.v2023_11_15_preview)
+  @added(Versions.v2024_05_01)
   summaryLength?: SummaryLengthBucket;
 }
 

specification/cognitiveservices/Language.Conversations/examples/2024-05-01/SuccessfulAnalyzeConversations.json

@@ -0,0 +1,63 @@
+{
+  "operationId": "AnalyzeConversations",
+  "title": "SuccessfulAnalyzeConversations",
+  "parameters": {
+    "Endpoint": "{Endpoint}",
+    "Ocp-Apim-Subscription-Key": "{API key}",
+    "Content-Type": "application/json",
+    "api-version": "2024-05-01",
+    "body": {
+      "kind": "Conversation",
+      "analysisInput": {
+        "conversationItem": {
+          "id": "1",
+          "participantId": "1",
+          "text": "play In the air tonight from Phil Collins"
+        }
+      },
+      "parameters": {
+        "projectName": "{project-name}",
+        "deploymentName": "{deployment-name}",
+        "stringIndexType": "TextElement_V8"
+      }
+    }
+  },
+  "responses": {
+    "200": {
+      "headers": {},
+      "body": {
+        "kind": "ConversationResult",
+        "result": {
+          "query": "play In the air tonight from Phil Collins",
+          "prediction": {
+            "topIntent": "PlayMusic",
+            "projectKind": "Conversation",
+            "intents": [
+              {
+                "category": "PlayMusic",
+                "confidenceScore": 1
+              },
+              {
+                "category": "SearchCreativeWork",
+                "confidenceScore": 0
+              },
+              {
+                "category": "AddToPlaylist",
+                "confidenceScore": 0
+              }
+            ],
+            "entities": [
+              {
+                "category": "Media.Artist",
+                "text": "Phil Collins",
+                "offset": 29,
+                "length": 12,
+                "confidenceScore": 1
+              }
+            ]
+          }
+        }
+      }
+    }
+  }
+}

specification/cognitiveservices/Language.Conversations/examples/2024-05-01/SuccessfulAnalyzeConversationsArbitration.json

@@ -0,0 +1,76 @@
+{
+  "operationId": "AnalyzeConversations",
+  "title": "SuccessfulAnalyzeConversationsArbitration",
+  "parameters": {
+    "Endpoint": "{Endpoint}",
+    "Ocp-Apim-Subscription-Key": "{API key}",
+    "Content-Type": "application/json",
+    "api-version": "2024-05-01",
+    "body": {
+      "kind": "Conversation",
+      "analysisInput": {
+        "conversationItem": {
+          "participantId": "1",
+          "id": "1",
+          "modality": "text",
+          "language": "en-GB",
+          "text": "How do I integrate QnA Maker and LUIS?"
+        }
+      },
+      "parameters": {
+        "projectName": "{project-name}",
+        "deploymentName": "{deployment-name}",
+        "verbose": true,
+        "isLoggingEnabled": false,
+        "stringIndexType": "TextElement_V8"
+      }
+    }
+  },
+  "responses": {
+    "200": {
+      "headers": {},
+      "body": {
+        "kind": "ConversationResult",
+        "result": {
+          "query": "trains from London",
+          "prediction": {
+            "topIntent": "Rail",
+            "projectKind": "Orchestration",
+            "intents": {
+              "Rail": {
+                "confidenceScore": 1,
+                "targetProjectKind": "Conversation",
+                "result": {
+                  "query": "trains from London",
+                  "prediction": {
+                    "topIntent": "Timetable",
+                    "projectKind": "Conversation",
+                    "intents": [
+                      {
+                        "category": "Timetable",
+                        "confidenceScore": 0.99968535
+                      },
+                      {
+                        "category": "Locomotive",
+                        "confidenceScore": 0.000314623
+                      }
+                    ],
+                    "entities": []
+                  }
+                }
+              },
+              "Tree": {
+                "confidenceScore": 0.2641529,
+                "targetProjectKind": "QuestionAnswering"
+              },
+              "None": {
+                "confidenceScore": 0,
+                "targetProjectKind": "NonLinked"
+              }
+            }
+          }
+        }
+      }
+    }
+  }
+}

specification/cognitiveservices/Language.Conversations/examples/2024-05-01/SuccessfulAnalyzeConversationsArbitrationDirectTarget.json

@@ -0,0 +1,77 @@
+{
+  "operationId": "AnalyzeConversations",
+  "title": "SuccessfulAnalyzeConversationsArbitrationDirectTarget",
+  "parameters": {
+    "Endpoint": "{Endpoint}",
+    "Ocp-Apim-Subscription-Key": "{API key}",
+    "Content-Type": "application/json",
+    "api-version": "2024-05-01",
+    "body": {
+      "kind": "Conversation",
+      "analysisInput": {
+        "conversationItem": {
+          "text": "Ports and connectors",
+          "participantId": "1",
+          "id": "1"
+        }
+      },
+      "parameters": {
+        "projectName": "prj1",
+        "deploymentName": "dep1",
+        "directTarget": "qnaProject",
+        "targetProjectParameters": {
+          "qnaProject": {
+            "targetProjectKind": "QuestionAnswering",
+            "callingOptions": {
+              "context": {
+                "previousUserQuery": "Meet Surface Pro 4",
+                "previousQnaId": 4
+              },
+              "top": 1,
+              "question": "App Service overview"
+            }
+          }
+        }
+      }
+    }
+  },
+  "responses": {
+    "200": {
+      "headers": {},
+      "body": {
+        "kind": "ConversationResult",
+        "result": {
+          "query": "Ports and connectors",
+          "prediction": {
+            "projectKind": "Orchestration",
+            "topIntent": "qnaTargetApp",
+            "intents": {
+              "qnaTargetApp": {
+                "targetProjectKind": "QuestionAnswering",
+                "confidenceScore": 1,
+                "result": {
+                  "answers": [
+                    {
+                      "questions": [
+                        "App Service overview"
+                      ],
+                      "answer": "The compute resources you use are determined by the *App Service plan* that you run your apps on.",
+                      "confidenceScore": 0.7384000000000001,
+                      "id": 1,
+                      "source": "https://docs.microsoft.com/en-us/azure/app-service/overview",
+                      "metadata": {},
+                      "dialog": {
+                        "isContextOnly": false,
+                        "prompts": []
+                      }
+                    }
+                  ]
+                }
+              }
+            }
+          }
+        }
+      }
+    }
+  }
+}

specification/cognitiveservices/Language.Conversations/examples/2024-05-01/SuccessfulAnalyzeConversationsJobsCancelRequest.json

@@ -0,0 +1,17 @@
+{
+  "operationId": "AnalyzeConversationsCancelJob",
+  "title": "SuccessfulAnalyzeConversationsJobsCancelRequest",
+  "parameters": {
+    "Ocp-Apim-Subscription-Key": "{API key}",
+    "api-version": "2024-05-01",
+    "Endpoint": "{Endpoint}",
+    "jobId": "c0f2a446-05d9-48fc-ba8f-3ef4af8d0b18"
+  },
+  "responses": {
+    "202": {
+      "headers": {
+        "Operation-Location": "{Endpoint}/language/analyze-conversations/jobs/{jobId}?api-version=2024-05-01"
+      }
+    }
+  }
+}

specification/cognitiveservices/Language.Conversations/examples/2024-05-01/SuccessfulConversationPIIExclusionSubmit.json

@@ -0,0 +1,76 @@
+{
+  "operationId": "AnalyzeConversationsSubmitJob",
+  "title": "SuccessfulConversationPIIExclusionSubmit",
+  "parameters": {
+    "Ocp-Apim-Subscription-Key": "{API key}",
+    "api-version": "2024-05-01",
+    "Endpoint": "{Endpoint}",
+    "jobId": "{Job ID}",
+    "body": {
+      "displayName": "Redacting PII data from transcribed audio",
+      "analysisInput": {
+        "conversations": [
+          {
+            "id": "1",
+            "language": "en",
+            "modality": "transcript",
+            "domain": "generic",
+            "conversationItems": [
+              {
+                "participantId": "1",
+                "id": "1",
+                "text": "Good morning John Doe.",
+                "itn": "good morning john doe",
+                "maskedItn": "good morning john doe",
+                "lexical": "good morning john doe",
+                "wordLevelTimings": [
+                  {
+                    "word": "good",
+                    "offset": 390000,
+                    "duration": 2700000
+                  },
+                  {
+                    "word": "morning",
+                    "offset": 4500000,
+                    "duration": 920000
+                  },
+                  {
+                    "word": "john",
+                    "offset": 590000,
+                    "duration": 2700000
+                  },
+                  {
+                    "word": "doe",
+                    "offset": 6300000,
+                    "duration": 920000
+                  }
+                ]
+              }
+            ]
+          }
+        ]
+      },
+      "tasks": [
+        {
+          "taskName": "Conversation PII",
+          "kind": "ConversationalPIITask",
+          "parameters": {
+            "modelVersion": "latest",
+            "excludePiiCategories": [
+              "Person"
+            ],
+            "redactionSource": "lexical",
+            "redactAudioTiming": true
+          }
+        }
+      ]
+    }
+  },
+  "responses": {
+    "202": {
+      "headers": {
+        "Operation-Location": "{Endpoint}/language/analyze-conversation/jobs/{jobId}?api-version=2024-05-01"
+      }
+    }
+  }
+}