[Speech Services - Speech Analytics] API Review about azure-rest-api-specs HOT 2 OPEN

Meeting updated by Nate Ko

Service Name: Speech Services - Speech Analytics
Review Created By: Nate Ko
Review Date: 04/02/2024 01:00 PM PT
Release Plan: 1257
PR: #28521
Hero Scenarios Link: Not Provided
Core Concepts Doc Link: here

Description: The Ingestion Service is a new feature of Speech Services. Customers can use the service to register a storage account to enable
automatic processing of files when new files are added to their blob storage account. The processing currently includes transcription of the audio files and post analytics call via webhook (eg. PromptFlow online endpoint).

The service adds /registrations API where customer configures information about their storage account, transcription behavior and webhook endpoint for post analytics. For authentication, the API supports cognitive services key and token. Prior to registering, customer needs to enable MI on the cognitive services resource and assign the roles (Storage Blob Data Contributor, Cognitive Services User, AzureML Data Scientist) for the service to access to customer's storage, makes a batch transcription call and call the (PromptFlow) analytics endpoint.

Detailed meeting information and documents provided can be accessed here
For more information that will help prepare you for this review, the requirements, and office hours, visit the documentation here

from azure-rest-api-specs.

Notes from API Review 4/2/24

• Don't put preview in the URL
• Use PATCH (preferred) or PUT for Create
  • Also PATCH for Update (version tolerant)
• Use only the operation templates from the TypeSpec Azure library
  • ResourceCreateOrUpdate for Create and Update
• Names for storage properties should be more descriptive
• Consider whether to make the storage configuration more generic if other storage providers will be supported in the future.
• "polling" might be clearer that "poll"
• Might want to model this as a polymorphic resource type on deliveryMode
• Speech needs to get to a consistent versioning scheme and version all APIs together
  • Is there just one SDK or multiple SDKs for Speech?
  • Are the SDKs Track 1 or Track 2 ? Rob Chambers
• Need to make this consistent with the rest of the GA service
  • Your choice to use TypeSpec for that or just stick with OpenAPI

Recommend come to API Stewardship office hours to work a plan for this.

from azure-rest-api-specs.