Wangamber/feat/stt typespec align

[amber-yujueWang]

Data Plane API Specification Update Pull Request

Tip

Overwhelmed by all this guidance? See the Getting help section at the bottom of this PR description.

This pull request introduces the initial TypeSpec implementation for the Azure Speech Batch Transcription API and Speech Transcription API. It includes the main service definition, detailed models, client configuration, and example API requests and responses. The changes lay the groundwork for code generation and documentation of the API.

PR review workflow diagram

Please understand this diagram before proceeding. It explains how to get your PR approved & merged.

API Info: The Basics

This pull request introduces a new TypeSpec-based API specification for Azure Speech Batch Transcription, including service definition, models, client configuration, and example API requests and responses. The changes establish the foundational structure for the Batch Transcription API and provide comprehensive models and usage examples for key operations.

API Specification and Service Definition

• Added the main service definition in main.tsp, specifying the Azure Speech BatchTranscription API, authentication, server configuration, and versioning.
• Defined client configuration and custom client naming for properties in client.tsp, improving SDK usability across languages.

Data Models and Operations

• Introduced detailed data models for transcription jobs, properties, files, and related entities in models.tsp, including support for pagination, error handling, and custom resource operations.

Most of the information about your service should be captured in the issue that serves as your API Spec engagement record.

• Link to API Spec engagement record issue:

Is this review for (select one):

• a private preview
• a public preview
• GA release

Change Scope

TypeSpec for existing manually created open api docs (just inference parts) and inference job management.

Viewing API changes

For convenient view of the API changes made by this PR, refer to the URLs provided in the table
in the Generated ApiView comment added to this PR. You can use ApiView to show API versions diff.

Suppressing failures

If one or multiple validation error/warning suppression(s) is detected in your PR, please follow the
Swagger-Suppression-Process
to get approval.

Release planner

A release plan should have been created. If not, please create one as it will help guide you through the REST API and SDK creation process.

❔Got questions? Need additional info?? We are here to help!

Contact us!

The Azure API Review Board is dedicated to helping you create amazing APIs. You can read about our mission and learn more about our process on our wiki.

• 💬 Teams Channel
• 💌 email

Click here for links to tools, specs, guidelines & other good stuff

Tooling

• Open API validation tools were run on this PR. Go here to see how to fix errors
• Spectral Linting

Guidelines & Specifications

• Azure REST API Guidelines
• OpenAPI Style Guidelines
• Azure Breaking Change Policy

Helpful Links

• Schedule a data plane REST API spec review

Getting help

• First, please carefully read through this PR description, from top to bottom.
• If you don't have permissions to remove or add labels to the PR, request write access per aka.ms/azsdk/access#request-access-to-rest-api-or-sdk-repositories
• To understand what you must do next to merge this PR, see the Next Steps to Merge comment. It will appear within few minutes of submitting this PR and will continue to be up-to-date with current PR state.
• For guidance on fixing this PR CI check failures, see the hyperlinks provided in given failure
  and https://aka.ms/ci-fix.
• If the PR CI checks appear to be stuck in queued state, please add a comment with contents /azp run.
  This should result in a new comment denoting a PR validation pipeline has started and the checks should be updated after few minutes.
• If the help provided by the previous points is not enough, post to https://aka.ms/azsdk/support/specreview-channel and link to this PR.