tsv compile

specification/cognitiveservices/Language.AnalyzeText/main.tsp

@@ -20,13 +20,13 @@ using TypeSpec.Versioning;
 using Azure.Core;
 using Azure.Core.Traits;
 
+/** The language service API is a suite of natural language processing (NLP) skills built with best-in-class Microsoft machine learning algorithms.  The API can be used to analyze unstructured text for tasks such as sentiment analysis, key phrase extraction, language detection and question answering. Further documentation can be found in <a href=\"https://docs.microsoft.com/azure/cognitive-services/language-service/overview\">https://docs.microsoft.com/azure/cognitive-services/language-service/overview</a>.0 */
 @useAuth(
   TypeSpec.Http.ApiKeyAuth<
     TypeSpec.Http.ApiKeyLocation.header,
     "Ocp-Apim-Subscription-Key"
   >
 )
-/** The language service API is a suite of natural language processing (NLP) skills built with best-in-class Microsoft machine learning algorithms.  The API can be used to analyze unstructured text for tasks such as sentiment analysis, key phrase extraction, language detection and question answering. Further documentation can be found in <a href=\"https://docs.microsoft.com/azure/cognitive-services/language-service/overview\">https://docs.microsoft.com/azure/cognitive-services/language-service/overview</a>.0 */
 @service({
   title: "Microsoft Cognitive Language Service - Text Analysis",
 })
@@ -62,27 +62,27 @@ alias ServiceTraits = NoRepeatableRequests &
 
 alias languageOperations = ResourceOperations<ServiceTraits, ErrorResponse>;
 
+/** Request text analysis over a collection of documents. */
 #suppress "@azure-tools/typespec-azure-core/use-standard-operations"
 @post
 @route("/:analyze-text")
-/** Request text analysis over a collection of documents. */
 op analyzeText is RpcOperation<
   AnalyzeTextTask & AnalyzeTextQueryParameters,
   AnalyzeTextTaskResult,
   {},
   ErrorResponse
 >;
 
-#suppress "@azure-tools/typespec-azure-core/use-standard-operations"
 /** Get the status of an analysis job. A job can consist of one or more tasks. After all tasks succeed, the job transitions to the succeeded state and results are available for each task. */
+#suppress "@azure-tools/typespec-azure-core/use-standard-operations"
 @summary("Get analysis status and results")
 op analyzeTextJobStatus is languageOperations.ResourceRead<
   AnalyzeTextJobState,
   AnalyzeTextJobQueryParameters
 >;
 
-#suppress "@azure-tools/typespec-azure-core/use-standard-operations"
 /** Submit a collection of text documents for analysis. Specify one or more unique tasks to be executed as a long-running operation. */
+#suppress "@azure-tools/typespec-azure-core/use-standard-operations"
 @route("/analyze-text/jobs")
 @pollingOperation(analyzeTextJobStatus)
 op analyzeTextSubmitJob is Foundations.LongRunningOperation<
@@ -92,16 +92,16 @@ op analyzeTextSubmitJob is Foundations.LongRunningOperation<
   ErrorResponse
 >;
 
-#suppress "@azure-tools/typespec-azure-core/use-standard-operations"
 /** Cancel a long-running Text Analysis job. */
+#suppress "@azure-tools/typespec-azure-core/use-standard-operations"
 @summary("Cancel a long-running Text Analysis job.")
 @pollingOperation(analyzeTextJobStatus)
 @route("/analyze-text/jobs/{jobId}:cancel")
 @post
 op analyzeTextCancelJob is Foundations.LongRunningOperation<
   {
-    @path
     /** The job ID to cancel. */
+    @path
     jobId: uuid;
   },
   AcceptedResponse,

specification/cognitiveservices/Language.AnalyzeText/models/common.models.tsp

@@ -12,8 +12,8 @@ using Azure.Core.Traits;
 
 namespace Language.AnalyzeText;
 
-#suppress "@azure-tools/typespec-azure-core/casing-style" "The names of Model types must use PascalCase"
 /** These are the [Azure Active Directory OAuth2](https://docs.microsoft.com/azure/active-directory/develop/v1-overview) Flows. When paired with [Azure role-based access](https://docs.microsoft.com/azure/role-based-access-control/overview) control it can be used to control access to Azure Maps REST APIs. Azure role-based access controls are used to designate access to one or more Azure Maps resource account or sub-resources. Any user, group, or service principal can be granted access via a  built-in role or a custom role composed of one or more permissions to Azure Maps REST APIs.\n\nTo implement scenarios, we recommend viewing [authentication concepts](https://aka.ms/amauth). In summary, this security definition provides a solution for modeling application(s) via objects capable of access control on specific APIs and scopes.\n\n#### Notes\n* This security definition **requires** the use of the `x-ms-client-id` header to indicate which Azure Maps resource the application is requesting access to. This can be acquired from the [Maps management API](https://aka.ms/amauthdetails).\n* \nThe `Authorization URL` is specific to the Azure public cloud instance. Sovereign clouds have unique Authorization URLs and Azure Active directory configurations. \n* \nThe Azure role-based access control is configured from the [Azure management plane](https://aka.ms/amrbac) via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n* \nUsage of the [Azure Maps Web SDK](https://aka.ms/amaadmc) allows for configuration based setup of an application for multiple use cases.\n* Currently, Azure Active Directory [v1.0 or v2.0](https://docs.microsoft.com/azure/active-directory/develop/azure-ad-endpoint-comparison) supports Work, School, and Guests but does not support Personal accounts. */
+#suppress "@azure-tools/typespec-azure-core/casing-style" "The names of Model types must use PascalCase"
 model AADToken
   is OAuth2Auth<[
     {
@@ -187,22 +187,22 @@ model MultiLanguageAnalysisInput {
   documents?: Array<MultiLanguageInput>;
 }
 
-@discriminator("kind")
 /** Collection of documents to analyze and a single task to execute. */
+@discriminator("kind")
 model AnalyzeTextTask {
   /** The kind of task to perform. */
   kind: AnalyzeTextTaskKind;
 }
+/** The long running task to be performed by the service on the input documents. */
 #suppress "@azure-tools/typespec-azure-core/casing-style"
 @discriminator("kind")
-/** The long running task to be performed by the service on the input documents. */
 model AnalyzeTextLROTask is TaskIdentifier {
   /** The kind of task to perform. */
   kind: AnalyzeTextLROTaskKind;
 }
 
-@discriminator("kind")
 /** The result object for the analyze task. */
+@discriminator("kind")
 model AnalyzeTextTaskResult {
   /** The kind of task result. */
   kind: AnalyzeTextTaskResultsKind;
@@ -219,8 +219,8 @@ model AnalyzeTextJobsInput {
   /** List of tasks to be performed as part of the LRO. */
   tasks: Array<AnalyzeTextLROTask>;
 
-  @added(Versions.v2023_11_15_preview)
   /** Default language to use for records requesting automatic language detection. */
+  @added(Versions.v2023_11_15_preview)
   defaultLanguage?: string;
 }
 
@@ -309,8 +309,8 @@ union Status {
   cancelling: "cancelling",
 }
 
-#suppress "@azure-tools/typespec-azure-core/casing-style"
 /** Contains the AnalyzeText long running operation result object. */
+#suppress "@azure-tools/typespec-azure-core/casing-style"
 @discriminator("kind")
 model AnalyzeTextLROResult {
   ...TaskState;
@@ -700,8 +700,8 @@ union ErrorCode {
   Warning: "Warning",
 }
 
-#suppress "@azure-tools/typespec-azure-core/no-closed-literal-union" // defined as closed enum
 /** Predicted sentiment for document (Negative, Neutral, Positive, or Mixed). */
+#suppress "@azure-tools/typespec-azure-core/no-closed-literal-union" // defined as closed enum
 union DocumentSentimentValue {
   /** Positive statement */
   positive: "positive",
@@ -728,8 +728,8 @@ model SentimentConfidenceScores {
   negative: float64;
 }
 
-@added(Versions.v2023_11_15_preview)
 /** Enum that defines the length of the output summaries. */
+@added(Versions.v2023_11_15_preview)
 union SummaryLengthBucket {
   string,
 
@@ -743,17 +743,17 @@ union SummaryLengthBucket {
   long: "long",
 }
 
-@added(Versions.v2023_04_01)
 /** Supported parameters for an Abstractive Summarization task. */
+@added(Versions.v2023_04_01)
 model AbstractiveSummarizationTaskParametersBase {
   /** Controls the approximate number of sentences in the output summaries. */
   sentenceCount?: int32;
 
   /** String index type */
   stringIndexType?: StringIndexType = StringIndexType.TextElements_v8;
 
-  @added(Versions.v2023_11_15_preview)
   /** (NOTE: Recommended to use summaryLength over sentenceCount) Controls the approximate length of the output summaries. */
+  @added(Versions.v2023_11_15_preview)
   summaryLength?: SummaryLengthBucket;
 }
 

specification/cognitiveservices/Language.AnalyzeText/models/custom.healthcare.tsp

@@ -4,15 +4,15 @@ using Azure.ClientGenerator.Core;
 using TypeSpec.Versioning;
 
 namespace Language.AnalyzeText;
-@added(Versions.v2023_11_15_preview)
 /** Supported parameters for a custom Healthcare task. */
+@added(Versions.v2023_11_15_preview)
 model CustomHealthcareTaskParameters is CustomTaskParameters {
   /** Optional parameter to provide the string index type used to interpret string offsets. Defaults to TextElements (Graphemes). */
   stringIndexType?: StringIndexType = StringIndexType.TextElements_v8;
 }
 
-#suppress "@azure-tools/typespec-azure-core/casing-style"
 /** Contains the custom healthcare task definition. */
+#suppress "@azure-tools/typespec-azure-core/casing-style"
 @added(Versions.v2023_11_15_preview)
 model CustomHealthcareLROTask extends AnalyzeTextLROTask {
   /** Kind of the task. */
@@ -22,22 +22,22 @@ model CustomHealthcareLROTask extends AnalyzeTextLROTask {
   parameters?: CustomHealthcareTaskParameters;
 }
 
-@added(Versions.v2023_11_15_preview)
 /** Contains the custom healthcare result for the request. */
+@added(Versions.v2023_11_15_preview)
 model CustomHealthcareResult is CustomResult {
   /** List of custom healthcare results for the document. */
   documents: Array<CustomHealthcareEntitiesDocumentResultWithDocumentDetectedLanguage>;
 }
 
-@added(Versions.v2023_11_15_preview)
 /** Contains the document custom healthcare results with detected language. */
+@added(Versions.v2023_11_15_preview)
 model CustomHealthcareEntitiesDocumentResultWithDocumentDetectedLanguage
   is CustomHealthcareEntitiesDocumentResult {
   ...DocumentDetectedLanguage;
 }
 
-@added(Versions.v2023_11_15_preview)
 /** Contains the document custom healthcare results. */
+@added(Versions.v2023_11_15_preview)
 model CustomHealthcareEntitiesDocumentResult is DocumentResult {
   /** Healthcare entities. */
   entities: Array<CustomHealthcareEntity>;
@@ -53,9 +53,9 @@ model CustomHealthcareEntity is HealthcareEntity {
   entityComponentInformation?: Array<EntityComponentInformation>;
 }
 
+/** Contains the custom healthcare job result. */
 #suppress "@azure-tools/typespec-azure-core/casing-style"
 @added(Versions.v2023_11_15_preview)
-/** Contains the custom healthcare job result. */
 model CustomHealthcareLROResult extends AnalyzeTextLROResult {
   /** Kind of the task. */
   kind: AnalyzeTextLROResultsKind.CustomHealthcareLROResults;

specification/cognitiveservices/Language.AnalyzeText/models/custom.text.tsp

@@ -16,8 +16,8 @@ model CustomEntitiesTaskParameters is CustomTaskParameters {
   stringIndexType?: StringIndexType = StringIndexType.TextElements_v8;
 }
 
-#suppress "@azure-tools/typespec-azure-core/casing-style"
 /** Contains the custom text LRO task. */
+#suppress "@azure-tools/typespec-azure-core/casing-style"
 model CustomEntitiesLROTask extends AnalyzeTextLROTask {
   /** Kind of the task. */
   kind: AnalyzeTextLROTaskKind.CustomEntityRecognition;
@@ -32,8 +32,8 @@ model CustomEntitiesResult is CustomResult {
   documents: Array<EntitiesDocumentResult>;
 }
 
-@added(Versions.v2023_11_15_preview)
 /** Contains the list of detected custom entities result for the documents along with detected language. */
+@added(Versions.v2023_11_15_preview)
 model CustomEntitiesResultWithDocumentDetectedLanguage is CustomResult {
   /** Enumeration of the document results with detected language. */
   documents: Array<EntitiesDocumentResultWithDetectedLanguage>;
@@ -42,8 +42,8 @@ model CustomEntitiesResultWithDocumentDetectedLanguage is CustomResult {
 /** Supported parameters for a Custom Single Classification task. */
 model CustomSingleLabelClassificationTaskParameters is CustomTaskParameters;
 
-#suppress "@azure-tools/typespec-azure-core/casing-style"
 /** Use custom models to classify text into single label taxonomy */
+#suppress "@azure-tools/typespec-azure-core/casing-style"
 model CustomSingleLabelClassificationLROTask extends AnalyzeTextLROTask {
   /** Kind of the task. */
   kind: AnalyzeTextLROTaskKind.CustomSingleLabelClassification;
@@ -58,8 +58,8 @@ model CustomLabelClassificationResult is CustomResult {
   documents: Array<ClassificationDocumentResult>;
 }
 
-@added(Versions.v2023_11_15_preview)
 /** Contains the custom label classification with detected language results. */
+@added(Versions.v2023_11_15_preview)
 model CustomLabelClassificationResultWithDocumentDetectedLanguage
   is CustomResult {
   /** Response by document */
@@ -78,8 +78,8 @@ model ClassificationResult {
 /** Supported parameters for a Custom Multi Classification task. */
 model CustomMultiLabelClassificationTaskParameters is CustomTaskParameters;
 
-#suppress "@azure-tools/typespec-azure-core/casing-style"
 /** Use custom models to classify text into multi label taxonomy */
+#suppress "@azure-tools/typespec-azure-core/casing-style"
 model CustomMultiLabelClassificationLROTask extends AnalyzeTextLROTask {
   /** Kind of the task. */
   kind: AnalyzeTextLROTaskKind.CustomMultiLabelClassification;
@@ -100,8 +100,8 @@ model ClassificationDocumentResultWithDetectedLanguage
   ...DocumentDetectedLanguage;
 }
 
-#suppress "@azure-tools/typespec-azure-core/casing-style"
 /** Contains the custom entity recognition job result. */
+#suppress "@azure-tools/typespec-azure-core/casing-style"
 model CustomEntityRecognitionLROResult extends AnalyzeTextLROResult {
   /** Kind of the task. */
   kind: AnalyzeTextLROResultsKind.CustomEntityRecognitionLROResults;
@@ -111,8 +111,8 @@ model CustomEntityRecognitionLROResult extends AnalyzeTextLROResult {
   results: CustomEntitiesResultWithDocumentDetectedLanguage;
 }
 
-#suppress "@azure-tools/typespec-azure-core/casing-style"
 /** Contains the custom single label classification job result. */
+#suppress "@azure-tools/typespec-azure-core/casing-style"
 model CustomSingleLabelClassificationLROResult extends AnalyzeTextLROResult {
   /** Kind of the task. */
   kind: AnalyzeTextLROResultsKind.CustomSingleLabelClassificationLROResults;
@@ -125,8 +125,8 @@ model CustomSingleLabelClassificationLROResult extends AnalyzeTextLROResult {
   results: CustomLabelClassificationResultWithDocumentDetectedLanguage;
 }
 
-#suppress "@azure-tools/typespec-azure-core/casing-style"
 /** Contains the custom multi label classification job result. */
+#suppress "@azure-tools/typespec-azure-core/casing-style"
 model CustomMultiLabelClassificationLROResult extends AnalyzeTextLROResult {
   /** Kind of the task. */
   kind: AnalyzeTextLROResultsKind.CustomMultiLabelClassificationLROResults;
@@ -139,8 +139,8 @@ model CustomMultiLabelClassificationLROResult extends AnalyzeTextLROResult {
   results: CustomLabelClassificationResultWithDocumentDetectedLanguage;
 }
 
-@added(Versions.v2023_11_15_preview)
 /** Contains the analyze text dynamic classifications input. */
+@added(Versions.v2023_11_15_preview)
 model AnalyzeTextDynamicClassificationInput extends AnalyzeTextTask {
   /** Kind of the task. */
   kind: AnalyzeTextTaskKind.DynamicClassification;
@@ -152,16 +152,16 @@ model AnalyzeTextDynamicClassificationInput extends AnalyzeTextTask {
   parameters?: DynamicClassificationTaskParameters;
 }
 
-@added(Versions.v2023_11_15_preview)
 /** Contains the Dynamic Classification document result. */
+@added(Versions.v2023_11_15_preview)
 model DynamicClassificationDocumentResult is DocumentResult {
   /** Array of classification results. */
   classifications: Array<ClassificationResult>;
 }
 
+/** This object contains information of the detected entity components. The possible component types may expand in the future. Parsing code should handle unexpected values gracefully */
 @added(Versions.v2023_11_15_preview)
 @discriminator("entityComponentKind")
-/** This object contains information of the detected entity components. The possible component types may expand in the future. Parsing code should handle unexpected values gracefully */
 model EntityComponentInformation {
   /** Kind of entity component. */
   entityComponentKind: entityComponentKind;
@@ -182,8 +182,8 @@ union entityComponentKind {
   ListComponent: "ListComponent",
 }
 
-@added(Versions.v2023_11_15_preview)
 /** This object contains information of the prebuilt component of the detected entity. */
+@added(Versions.v2023_11_15_preview)
 model PrebuiltComponent extends EntityComponentInformation {
   /** Kind of entity component. */
   entityComponentKind: entityComponentKind.PrebuiltComponent;
@@ -192,8 +192,8 @@ model PrebuiltComponent extends EntityComponentInformation {
   value?: string;
 }
 
-@added(Versions.v2023_11_15_preview)
 /** This object contains information of the learned component of the detected entity. */
+@added(Versions.v2023_11_15_preview)
 model LearnedComponent extends EntityComponentInformation {
   /** Kind of entity component. */
   entityComponentKind: entityComponentKind.LearnedComponent;
@@ -202,8 +202,8 @@ model LearnedComponent extends EntityComponentInformation {
   value?: string;
 }
 
-@added(Versions.v2023_11_15_preview)
 /** This object contains information of the list component of the detected entity. */
+@added(Versions.v2023_11_15_preview)
 model ListComponent extends EntityComponentInformation {
   /** Kind of entity component. */
   entityComponentKind: entityComponentKind.ListComponent;
@@ -212,8 +212,8 @@ model ListComponent extends EntityComponentInformation {
   value?: string;
 }
 
-@added(Versions.v2023_11_15_preview)
 /** Supported parameters for a Dynamic Classification task. */
+@added(Versions.v2023_11_15_preview)
 model DynamicClassificationTaskParameters is PreBuiltTaskParameters {
   /** Specifies either one or multiple categories per document. Defaults to multi classification which may return more than one class for each document. */
   classificationType?: ClassificationType = ClassificationType.Multi;
@@ -222,8 +222,8 @@ model DynamicClassificationTaskParameters is PreBuiltTaskParameters {
   categories: Array<string>;
 }
 
-@added(Versions.v2023_11_15_preview)
 /** Specifies either one or multiple categories per document. Defaults to multi classification which may return more than one class for each document. */
+@added(Versions.v2023_11_15_preview)
 union ClassificationType {
   string,
 
@@ -234,15 +234,15 @@ union ClassificationType {
   Single: "Single",
 }
 
-@added(Versions.v2023_11_15_preview)
 /** Contains the Dynamic Classification result. */
+@added(Versions.v2023_11_15_preview)
 model DynamicClassificationResult is PreBuiltResult {
   /** Response by document */
   documents: Array<DynamicClassificationDocumentResult>;
 }
 
-@added(Versions.v2023_11_15_preview)
 /** Result for Dynamic Classification task. */
+@added(Versions.v2023_11_15_preview)
 model DynamicClassificationTaskResult extends AnalyzeTextTaskResult {
   /** Kind of task result */
   kind: AnalyzeTextTaskResultsKind.DynamicClassificationResults;