[AI.TextTranslation] Disambiguate example titles (#24323)

mikeharder · web-flow · commit aa1f08c2bfb9 · 2023-06-06T12:56:34.000-07:00
- Causes error in TypeSpec 0.45.0
- Also change casing of textType in example to match spec
  - Fixes error ENUM_CASE_MISMATCH in Swagger ModelValidation
diff --git a/specification/translation/Azure.AI.TextTranslation/examples/3.0/FindSentenceBoundaries_MinimumSet_Gen.json b/specification/translation/Azure.AI.TextTranslation/examples/3.0/FindSentenceBoundaries_MinimumSet_Gen.json
@@ -1,5 +1,5 @@
 {
-  "title": "Find Sentence Boundaries",
+  "title": "Find Sentence Boundaries with minimum properties",
   "operationId": "FindSentenceBoundaries",
   "parameters": {
     "api-version": "3.0",
diff --git a/specification/translation/Azure.AI.TextTranslation/examples/3.0/GetLanguages_MinimumSet_Gen.json b/specification/translation/Azure.AI.TextTranslation/examples/3.0/GetLanguages_MinimumSet_Gen.json
@@ -1,5 +1,5 @@
 {
-  "title": "Gets the set of languages currently supported by other operations of the Translator.",
+  "title": "Gets the set of languages currently supported by other operations of the Translator with minimum properties.",
   "operationId": "GetLanguages",
   "parameters": {
     "api-version": "3.0"
diff --git a/specification/translation/Azure.AI.TextTranslation/examples/3.0/LookupDictionaryEntries_MinimumSet_Gen.json b/specification/translation/Azure.AI.TextTranslation/examples/3.0/LookupDictionaryEntries_MinimumSet_Gen.json
@@ -1,5 +1,5 @@
 {
-  "title": "Lookup Dictionary Entries",
+  "title": "Lookup Dictionary Entries with minimum properties",
   "operationId": "LookupDictionaryEntries",
   "parameters": {
     "from": "en",
diff --git a/specification/translation/Azure.AI.TextTranslation/examples/3.0/LookupDictionaryExamples_MinimumSet_Gen.json b/specification/translation/Azure.AI.TextTranslation/examples/3.0/LookupDictionaryExamples_MinimumSet_Gen.json
@@ -1,5 +1,5 @@
 {
-  "title": "Lookup Dictionary Examples",
+  "title": "Lookup Dictionary Examples with minimum properties",
   "operationId": "LookupDictionaryExamples",
   "parameters": {
     "from": "en",
diff --git a/specification/translation/Azure.AI.TextTranslation/examples/3.0/Translate_MaximumSet_Gen.json b/specification/translation/Azure.AI.TextTranslation/examples/3.0/Translate_MaximumSet_Gen.json
@@ -7,7 +7,7 @@
       "cs"
     ],
     "from": "en",
-    "textType": "plain",
+    "textType": "Plain",
     "category": "custom",
     "profanityAction": "NoAction",
     "profanityMarker": "Asterisk",
diff --git a/specification/translation/Azure.AI.TextTranslation/examples/3.0/Translate_MinimumSet_Gen.json b/specification/translation/Azure.AI.TextTranslation/examples/3.0/Translate_MinimumSet_Gen.json
@@ -1,5 +1,5 @@
 {
-  "title": "Translate Text",
+  "title": "Translate Text with minimum properties",
   "operationId": "Translate",
   "parameters": {
     "to": [
diff --git a/specification/translation/Azure.AI.TextTranslation/examples/3.0/Transliterate_MinimumSet_Gen.json b/specification/translation/Azure.AI.TextTranslation/examples/3.0/Transliterate_MinimumSet_Gen.json
@@ -1,5 +1,5 @@
 {
-  "title": "Transliterate Text",
+  "title": "Transliterate Text with minimum properties",
   "operationId": "Transliterate",
   "parameters": {
     "language": "zh-Hans",
diff --git a/specification/translation/data-plane/Azure.AI.TextTranslation/stable/v3.0/examples/FindSentenceBoundaries_MaximumSet_Gen.json b/specification/translation/data-plane/Azure.AI.TextTranslation/stable/v3.0/examples/FindSentenceBoundaries_MaximumSet_Gen.json
@@ -0,0 +1,28 @@
+{
+  "title": "Find Sentence Boundaries",
+  "operationId": "FindSentenceBoundaries",
+  "parameters": {
+    "X-ClientTraceId": "svun",
+    "language": "en",
+    "script": "Latn",
+    "api-version": "3.0",
+    "requestBody": [
+      {
+        "text": "How are you? I am fine. What did you do today?"
+      }
+    ]
+  },
+  "responses": {
+    "200": {
+      "body": [
+        {
+          "sentLen": [
+            13,
+            11,
+            22
+          ]
+        }
+      ]
+    }
+  }
+}
diff --git a/specification/translation/data-plane/Azure.AI.TextTranslation/stable/v3.0/examples/FindSentenceBoundaries_MinimumSet_Gen.json b/specification/translation/data-plane/Azure.AI.TextTranslation/stable/v3.0/examples/FindSentenceBoundaries_MinimumSet_Gen.json
@@ -1,5 +1,5 @@
 {
-  "title": "Find Sentence Boundaries",
+  "title": "Find Sentence Boundaries with minimum properties",
   "operationId": "FindSentenceBoundaries",
   "parameters": {
     "api-version": "3.0",
diff --git a/specification/translation/data-plane/Azure.AI.TextTranslation/stable/v3.0/examples/GetLanguages_MaximumSet_Gen.json b/specification/translation/data-plane/Azure.AI.TextTranslation/stable/v3.0/examples/GetLanguages_MaximumSet_Gen.json
@@ -0,0 +1,80 @@
+{
+  "title": "Gets the set of languages currently supported by other operations of the Translator.",
+  "operationId": "GetLanguages",
+  "parameters": {
+    "X-ClientTraceId": "kayfnugjec",
+    "scope": "translation,transliteration,dictionary",
+    "Accept-Language": "en",
+    "If-None-Match": "fpnhruttllvc",
+    "api-version": "3.0"
+  },
+  "responses": {
+    "200": {
+      "body": {
+        "translation": {
+          "en": {
+            "name": "English",
+            "nativeName": "English",
+            "dir": "ltr"
+          },
+          "es": {
+            "name": "Spanish",
+            "nativeName": "Español",
+            "dir": "ltr"
+          }
+        },
+        "transliteration": {
+          "ar": {
+            "name": "Arabic",
+            "nativeName": "العربية",
+            "scripts": [
+              {
+                "code": "Arab",
+                "name": "Arabic",
+                "nativeName": "العربية",
+                "dir": "rtl",
+                "toScripts": [
+                  {
+                    "code": "Latn",
+                    "name": "Latin",
+                    "nativeName": "اللاتينية",
+                    "dir": "ltr"
+                  }
+                ]
+              },
+              {
+                "code": "Latn",
+                "name": "Latin",
+                "nativeName": "اللاتينية",
+                "dir": "ltr",
+                "toScripts": [
+                  {
+                    "code": "Arab",
+                    "name": "Arabic",
+                    "nativeName": "العربية",
+                    "dir": "rtl"
+                  }
+                ]
+              }
+            ]
+          }
+        },
+        "dictionary": {
+          "cs": {
+            "name": "Czech",
+            "nativeName": "Čeština",
+            "dir": "ltr",
+            "translations": [
+              {
+                "name": "English",
+                "nativeName": "English",
+                "dir": "ltr",
+                "code": "en"
+              }
+            ]
+          }
+        }
+      }
+    }
+  }
+}
diff --git a/specification/translation/data-plane/Azure.AI.TextTranslation/stable/v3.0/examples/GetLanguages_MinimumSet_Gen.json b/specification/translation/data-plane/Azure.AI.TextTranslation/stable/v3.0/examples/GetLanguages_MinimumSet_Gen.json
@@ -1,5 +1,5 @@
 {
-  "title": "Gets the set of languages currently supported by other operations of the Translator.",
+  "title": "Gets the set of languages currently supported by other operations of the Translator with minimum properties.",
   "operationId": "GetLanguages",
   "parameters": {
     "api-version": "3.0"
diff --git a/specification/translation/data-plane/Azure.AI.TextTranslation/stable/v3.0/examples/LookupDictionaryEntries_MaximumSet_Gen.json b/specification/translation/data-plane/Azure.AI.TextTranslation/stable/v3.0/examples/LookupDictionaryEntries_MaximumSet_Gen.json
@@ -0,0 +1,87 @@
+{
+  "title": "Lookup Dictionary Entries",
+  "operationId": "LookupDictionaryEntries",
+  "parameters": {
+    "X-ClientTraceId": "yqst",
+    "from": "en",
+    "to": "es",
+    "api-version": "3.0",
+    "requestBody": [
+      {
+        "text": "fly"
+      }
+    ]
+  },
+  "responses": {
+    "200": {
+      "body": [
+        {
+          "normalizedSource": "fly",
+          "displaySource": "fly",
+          "translations": [
+            {
+              "normalizedTarget": "volar",
+              "displayTarget": "volar",
+              "posTag": "VERB",
+              "confidence": 0.4081,
+              "prefixWord": "",
+              "backTranslations": [
+                {
+                  "normalizedText": "fly",
+                  "displayText": "fly",
+                  "numExamples": 15,
+                  "frequencyCount": 4637
+                },
+                {
+                  "normalizedText": "flying",
+                  "displayText": "flying",
+                  "numExamples": 15,
+                  "frequencyCount": 1365
+                },
+                {
+                  "normalizedText": "blow",
+                  "displayText": "blow",
+                  "numExamples": 15,
+                  "frequencyCount": 503
+                },
+                {
+                  "normalizedText": "flight",
+                  "displayText": "flight",
+                  "numExamples": 15,
+                  "frequencyCount": 135
+                }
+              ]
+            },
+            {
+              "normalizedTarget": "mosca",
+              "displayTarget": "mosca",
+              "posTag": "NOUN",
+              "confidence": 0.2668,
+              "prefixWord": "",
+              "backTranslations": [
+                {
+                  "normalizedText": "fly",
+                  "displayText": "fly",
+                  "numExamples": 15,
+                  "frequencyCount": 1697
+                },
+                {
+                  "normalizedText": "flyweight",
+                  "displayText": "flyweight",
+                  "numExamples": 0,
+                  "frequencyCount": 48
+                },
+                {
+                  "normalizedText": "flies",
+                  "displayText": "flies",
+                  "numExamples": 9,
+                  "frequencyCount": 34
+                }
+              ]
+            }
+          ]
+        }
+      ]
+    }
+  }
+}
diff --git a/specification/translation/data-plane/Azure.AI.TextTranslation/stable/v3.0/examples/LookupDictionaryEntries_MinimumSet_Gen.json b/specification/translation/data-plane/Azure.AI.TextTranslation/stable/v3.0/examples/LookupDictionaryEntries_MinimumSet_Gen.json
@@ -1,5 +1,5 @@
 {
-  "title": "Lookup Dictionary Entries",
+  "title": "Lookup Dictionary Entries with minimum properties",
   "operationId": "LookupDictionaryEntries",
   "parameters": {
     "from": "en",
diff --git a/specification/translation/data-plane/Azure.AI.TextTranslation/stable/v3.0/examples/LookupDictionaryExamples_MaximumSet_Gen.json b/specification/translation/data-plane/Azure.AI.TextTranslation/stable/v3.0/examples/LookupDictionaryExamples_MaximumSet_Gen.json
@@ -0,0 +1,44 @@
+{
+  "title": "Lookup Dictionary Examples",
+  "operationId": "LookupDictionaryExamples",
+  "parameters": {
+    "X-ClientTraceId": "vykwwekvcncclrmsyjhbok",
+    "from": "en",
+    "to": "es",
+    "api-version": "3.0",
+    "requestBody": [
+      {
+        "text": "fly",
+        "translation": "volar"
+      }
+    ]
+  },
+  "responses": {
+    "200": {
+      "body": [
+        {
+          "normalizedSource": "fly",
+          "normalizedTarget": "volar",
+          "examples": [
+            {
+              "sourcePrefix": "They need machines to ",
+              "sourceTerm": "fly",
+              "sourceSuffix": ".",
+              "targetPrefix": "Necesitan máquinas para ",
+              "targetTerm": "volar",
+              "targetSuffix": "."
+            },
+            {
+              "sourcePrefix": "That should really ",
+              "sourceTerm": "fly",
+              "sourceSuffix": ".",
+              "targetPrefix": "Eso realmente debe ",
+              "targetTerm": "volar",
+              "targetSuffix": "."
+            }
+          ]
+        }
+      ]
+    }
+  }
+}
diff --git a/specification/translation/data-plane/Azure.AI.TextTranslation/stable/v3.0/examples/LookupDictionaryExamples_MinimumSet_Gen.json b/specification/translation/data-plane/Azure.AI.TextTranslation/stable/v3.0/examples/LookupDictionaryExamples_MinimumSet_Gen.json
@@ -1,5 +1,5 @@
 {
-  "title": "Lookup Dictionary Examples",
+  "title": "Lookup Dictionary Examples with minimum properties",
   "operationId": "LookupDictionaryExamples",
   "parameters": {
     "from": "en",
diff --git a/specification/translation/data-plane/Azure.AI.TextTranslation/stable/v3.0/examples/Translate_MaximumSet_Gen.json b/specification/translation/data-plane/Azure.AI.TextTranslation/stable/v3.0/examples/Translate_MaximumSet_Gen.json
@@ -0,0 +1,63 @@
+{
+  "title": "Translate Text",
+  "operationId": "Translate",
+  "parameters": {
+    "X-ClientTraceId": "ndbkaatzsnoetqkiehappoza",
+    "to": [
+      "cs"
+    ],
+    "from": "en",
+    "textType": "Plain",
+    "category": "custom",
+    "profanityAction": "NoAction",
+    "profanityMarker": "Asterisk",
+    "includeAlignment": true,
+    "includeSentenceLength": true,
+    "suggestedFrom": "en",
+    "fromScript": "Latn",
+    "toScript": "Latn",
+    "allowFallback": true,
+    "api-version": "3.0",
+    "requestBody": [
+      {
+        "text": "This is a test."
+      }
+    ]
+  },
+  "responses": {
+    "200": {
+      "body": [
+        {
+          "detectedLanguage": {
+            "language": "en",
+            "score": 1.0
+          },
+          "translations": [
+            {
+              "to": "cs",
+              "text": "Tohle je test.",
+              "transliteration": {
+                "text": "Tohle je test.",
+                "script": "Latn"
+              },
+              "alignment": {
+                "proj": "okrxvzsagjgzrrv"
+              },
+              "sentLen": {
+                "srcSentLen": [
+                  30
+                ],
+                "transSentLen": [
+                  24
+                ]
+              }
+            }
+          ],
+          "sourceText": {
+            "text": "This is a test"
+          }
+        }
+      ]
+    }
+  }
+}
diff --git a/specification/translation/data-plane/Azure.AI.TextTranslation/stable/v3.0/examples/Translate_MinimumSet_Gen.json b/specification/translation/data-plane/Azure.AI.TextTranslation/stable/v3.0/examples/Translate_MinimumSet_Gen.json
@@ -1,5 +1,5 @@
 {
-  "title": "Translate Text",
+  "title": "Translate Text with minimum properties",
   "operationId": "Translate",
   "parameters": {
     "to": [
diff --git a/specification/translation/data-plane/Azure.AI.TextTranslation/stable/v3.0/examples/Transliterate_MaximumSet_Gen.json b/specification/translation/data-plane/Azure.AI.TextTranslation/stable/v3.0/examples/Transliterate_MaximumSet_Gen.json
diff --git a/specification/translation/data-plane/Azure.AI.TextTranslation/stable/v3.0/examples/Transliterate_MinimumSet_Gen.json b/specification/translation/data-plane/Azure.AI.TextTranslation/stable/v3.0/examples/Transliterate_MinimumSet_Gen.json
diff --git a/specification/translation/data-plane/Azure.AI.TextTranslation/stable/v3.0/openapi.json b/specification/translation/data-plane/Azure.AI.TextTranslation/stable/v3.0/openapi.json

Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,5 @@`
`1`	`1`	`{`
`2`		`- "title": "Find Sentence Boundaries",`
	`2`	`+ "title": "Find Sentence Boundaries with minimum properties",`
`3`	`3`	`"operationId": "FindSentenceBoundaries",`
`4`	`4`	`"parameters": {`
`5`	`5`	`"api-version": "3.0",`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,5 @@`
`1`	`1`	`{`
`2`		`- "title": "Gets the set of languages currently supported by other operations of the Translator.",`
	`2`	`+ "title": "Gets the set of languages currently supported by other operations of the Translator with minimum properties.",`
`3`	`3`	`"operationId": "GetLanguages",`
`4`	`4`	`"parameters": {`
`5`	`5`	`"api-version": "3.0"`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,5 @@`
`1`	`1`	`{`
`2`		`- "title": "Lookup Dictionary Entries",`
	`2`	`+ "title": "Lookup Dictionary Entries with minimum properties",`
`3`	`3`	`"operationId": "LookupDictionaryEntries",`
`4`	`4`	`"parameters": {`
`5`	`5`	`"from": "en",`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,5 @@`
`1`	`1`	`{`
`2`		`- "title": "Lookup Dictionary Examples",`
	`2`	`+ "title": "Lookup Dictionary Examples with minimum properties",`
`3`	`3`	`"operationId": "LookupDictionaryExamples",`
`4`	`4`	`"parameters": {`
`5`	`5`	`"from": "en",`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,5 @@`
`1`	`1`	`{`
`2`		`- "title": "Translate Text",`
	`2`	`+ "title": "Translate Text with minimum properties",`
`3`	`3`	`"operationId": "Translate",`
`4`	`4`	`"parameters": {`
`5`	`5`	`"to": [`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,5 @@`
`1`	`1`	`{`
`2`		`- "title": "Transliterate Text",`
	`2`	`+ "title": "Transliterate Text with minimum properties",`
`3`	`3`	`"operationId": "Transliterate",`
`4`	`4`	`"parameters": {`
`5`	`5`	`"language": "zh-Hans",`