chore: deprecate old Text analytics APIs to prepare for refactor

microsoft · Aug 23, 2022 · 069be83 · 069be83
1 parent 2052e13
commit 069be83
Show file tree

Hide file tree

Showing 2 changed files with 24 additions and 0 deletions.
diff --git a/cognitive/src/main/scala/com/microsoft/azure/synapse/ml/cognitive/TextAnalytics.scala b/cognitive/src/main/scala/com/microsoft/azure/synapse/ml/cognitive/TextAnalytics.scala
@@ -215,8 +215,10 @@ trait HasStringIndexType extends HasServiceParams {
   def setStringIndexType(v: String): this.type = setScalarParam(stringIndexType, v)
 }
 
+@deprecated(message = "Please use `com.microsoft.azure.synapse.ml.cognitive.TextSentiment`", since = "v0.10.1")
 object TextSentimentV2 extends ComplexParamsReadable[TextSentimentV2]
 
+@deprecated(message = "Please use `com.microsoft.azure.synapse.ml.cognitive.TextSentiment`", since = "v0.10.1")
 class TextSentimentV2(override val uid: String)
   extends TextAnalyticsBase(uid) with BasicLogging with HasHandler {
   logClass()
@@ -229,8 +231,10 @@ class TextSentimentV2(override val uid: String)
 
 }
 
+@deprecated(message = "Please use `com.microsoft.azure.synapse.ml.cognitive.LanguageDetector`", since = "v0.10.1")
 object LanguageDetectorV2 extends ComplexParamsReadable[LanguageDetectorV2]
 
+@deprecated(message = "Please use `com.microsoft.azure.synapse.ml.cognitive.LanguageDetector`", since = "v0.10.1")
 class LanguageDetectorV2(override val uid: String)
   extends TextAnalyticsBase(uid) with BasicLogging with HasHandler {
   logClass()
@@ -242,8 +246,10 @@ class LanguageDetectorV2(override val uid: String)
   def urlPath: String = "/text/analytics/v2.0/languages"
 }
 
+@deprecated(message = "Please use `com.microsoft.azure.synapse.ml.cognitive.EntityDetector`", since = "v0.10.1")
 object EntityDetectorV2 extends ComplexParamsReadable[EntityDetectorV2]
 
+@deprecated(message = "Please use `com.microsoft.azure.synapse.ml.cognitive.EntityDetector`", since = "v0.10.1")
 class EntityDetectorV2(override val uid: String)
   extends TextAnalyticsBase(uid) with BasicLogging with HasHandler {
   logClass()
@@ -255,8 +261,10 @@ class EntityDetectorV2(override val uid: String)
   def urlPath: String = "/text/analytics/v2.0/entities"
 }
 
+@deprecated(message = "Please use `com.microsoft.azure.synapse.ml.cognitive.NER`", since = "v0.10.1")
 object NERV2 extends ComplexParamsReadable[NERV2]
 
+@deprecated(message = "Please use `com.microsoft.azure.synapse.ml.cognitive.NER`", since = "v0.10.1")
 class NERV2(override val uid: String) extends TextAnalyticsBase(uid) with BasicLogging with HasHandler {
   logClass()
 
@@ -267,8 +275,10 @@ class NERV2(override val uid: String) extends TextAnalyticsBase(uid) with BasicL
   def urlPath: String = "/text/analytics/v2.1/entities"
 }
 
+@deprecated(message = "Please use `com.microsoft.azure.synapse.ml.cognitive.KeyPhraseExtractor`", since = "v0.10.1")
 object KeyPhraseExtractorV2 extends ComplexParamsReadable[KeyPhraseExtractorV2]
 
+@deprecated(message = "Please use `com.microsoft.azure.synapse.ml.cognitive.KeyPhraseExtractor`", since = "v0.10.1")
 class KeyPhraseExtractorV2(override val uid: String)
   extends TextAnalyticsBase(uid) with BasicLogging with HasHandler {
   logClass()

diff --git a/cognitive/src/main/scala/com/microsoft/azure/synapse/ml/cognitive/TextAnalyticsSDK.scala b/cognitive/src/main/scala/com/microsoft/azure/synapse/ml/cognitive/TextAnalyticsSDK.scala
@@ -194,8 +194,10 @@ private[ml] abstract class TextAnalyticsSDKBase[T]()
   override def copy(extra: ParamMap): Transformer = defaultCopy(extra)
 }
 
+@deprecated(message = "Please use `com.microsoft.azure.synapse.ml.cognitive.LanguageDetector`", since = "v0.10.1")
 object LanguageDetectorSDK extends ComplexParamsReadable[LanguageDetectorSDK]
 
+@deprecated(message = "Please use `com.microsoft.azure.synapse.ml.cognitive.LanguageDetector`", since = "v0.10.1")
 class LanguageDetectorSDK(override val uid: String)
   extends TextAnalyticsSDKBase[DetectedLanguageSDK]() {
   logClass()
@@ -223,8 +225,10 @@ class LanguageDetectorSDK(override val uid: String)
   }
 }
 
+@deprecated(message = "Please use `com.microsoft.azure.synapse.ml.cognitive.KeyPhraseExtractor`", since = "v0.10.1")
 object KeyPhraseExtractorSDK extends ComplexParamsReadable[KeyPhraseExtractorSDK]
 
+@deprecated(message = "Please use `com.microsoft.azure.synapse.ml.cognitive.KeyPhraseExtractor`", since = "v0.10.1")
 class KeyPhraseExtractorSDK(override val uid: String)
   extends TextAnalyticsSDKBase[KeyphraseSDK]() {
   logClass()
@@ -252,8 +256,10 @@ class KeyPhraseExtractorSDK(override val uid: String)
   }
 }
 
+@deprecated(message = "Please use `com.microsoft.azure.synapse.ml.cognitive.TextSentiment`", since = "v0.10.1")
 object TextSentimentSDK extends ComplexParamsReadable[TextSentiment]
 
+@deprecated(message = "Please use `com.microsoft.azure.synapse.ml.cognitive.TextSentiment`", since = "v0.10.1")
 class TextSentimentSDK(override val uid: String)
   extends TextAnalyticsSDKBase[SentimentScoredDocumentSDK]() with HasOpinionMining {
   logClass()
@@ -282,8 +288,10 @@ class TextSentimentSDK(override val uid: String)
   }
 }
 
+@deprecated(message = "Please use `com.microsoft.azure.synapse.ml.cognitive.PII`", since = "v0.10.1")
 object PIISDK extends ComplexParamsReadable[PII]
 
+@deprecated(message = "Please use `com.microsoft.azure.synapse.ml.cognitive.PII`", since = "v0.10.1")
 class PIISDK(override val uid: String) extends TextAnalyticsSDKBase[PIIEntityCollectionSDK]() {
   logClass()
 
@@ -310,8 +318,10 @@ class PIISDK(override val uid: String) extends TextAnalyticsSDKBase[PIIEntityCol
   }
 }
 
+@deprecated(message = "Please use `com.microsoft.azure.synapse.ml.cognitive.AnalyzeHealthText`", since = "v0.10.1")
 object HealthcareSDK extends ComplexParamsReadable[HealthcareSDK]
 
+@deprecated(message = "Please use `com.microsoft.azure.synapse.ml.cognitive.AnalyzeHealthText`", since = "v0.10.1")
 class HealthcareSDK(override val uid: String) extends TextAnalyticsSDKBase[HealthEntitiesResultSDK]() {
   logClass()
 
@@ -341,8 +351,10 @@ class HealthcareSDK(override val uid: String) extends TextAnalyticsSDKBase[Healt
   }
 }
 
+@deprecated(message = "Please use `com.microsoft.azure.synapse.ml.cognitive.EntityDetector`", since = "v0.10.1")
 object EntityDetectorSDK extends ComplexParamsReadable[EntityDetectorSDK]
 
+@deprecated(message = "Please use `com.microsoft.azure.synapse.ml.cognitive.EntityDetector`", since = "v0.10.1")
 class EntityDetectorSDK(override val uid: String) extends TextAnalyticsSDKBase[LinkedEntityCollectionSDK]() {
   logClass()
 
@@ -369,8 +381,10 @@ class EntityDetectorSDK(override val uid: String) extends TextAnalyticsSDKBase[L
   }
 }
 
+@deprecated(message = "Please use `com.microsoft.azure.synapse.ml.cognitive.NER`", since = "v0.10.1")
 object NERSDK extends ComplexParamsReadable[NERSDK]
 
+@deprecated(message = "Please use `com.microsoft.azure.synapse.ml.cognitive.NER`", since = "v0.10.1")
 class NERSDK(override val uid: String) extends TextAnalyticsSDKBase[NERCollectionSDK]() {
   logClass()