Comments (5)
Notes from follow-up review meeting w/ Mike Kistler & Jeff Richter:
The changes to address comments from the prior review look fine, but there needs to be uniform versioning across the service to comply with Azure's Versioning Policy. We'll let this go in this PR but should be fixed as soon as possible and definitely before any new GA.
from azure-rest-api-specs.
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.
- Your choice to use TypeSpec for that or just stick with OpenAPI
We used OpenAPI spec.
- Don't put preview in the URL
Changed to v0.2-preview. This versioning scheme is consistent with rest of Speech Services (batch) (eg. https://eastus.ingestion.speech.microsoft.com/v0.2-preview/registrations)
- Use PATCH (preferred) or PUT for Create
Speech Services uses POST for create. https://learn.microsoft.com/en-us/azure/ai-services/speech-service/batch-transcription-create?pivots=rest-api#create-a-transcription-job. We opted for consistency.
- Also PATCH for Update (version tolerant)
Speech Services uses PATCH for update (Change pending 5/1/2024)
- Use only the operation templates from the TypeSpec Azure library
Per discussion above, we opted for OpenAI Spec
- Names for storage properties should be more descriptive
Updated.
- 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
Updated to
"trigger": {
"kind": "EventGrid|Polling"
"filter": null,
"systemTopicResourceId": "/subscriptions/2c2e6d10-4e48-40fd-8f4d-d9fb770d0c6d/resourceGroups/speechingestiontest/providers/Microsoft.EventGrid/systemTopics/systemtopicbyos"
},
Speech needs to get to a consistent versioning scheme and version all APIs together
We opted for versioning scheme consistent with Batch Transcription Service (GA)
Is there just one SDK or multiple SDKs for Speech?
AFAIK, there's handcrafted (Carbon - Rob Chambers) and generated (azure-rest-api-specs\specification\cognitiveservices\data-plane\Speech\BatchTextToSpeech) for Batch Transcription but I haven't seen the latter. Started an email thread with Oliver who owns Speech Services all up.
Are the SDKs Track 1 or Track 2 ?
Rob Chambers
Need to make this consistent with the rest of the GA service
Choices are made based on consistency.
Pull Request #28888
from azure-rest-api-specs.
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: #28888
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.
Related Issues (20)
- Trusted Launch SSE+CMK Azure Compute Gallery confusing error
- [BUG] Names containing spaces can result in double encoding and the incorrect ID.
- Fix avocado warnings in the spec repo by adding README to Assistants spec
- [BUG] RAI Policy content filters array has non-unique x-ms-identifiers HOT 1
- Remove `filename` from `uploadFile` operation in AOAI Assistants SDK
- [Question] For virtual WAN/virtual Hub, there is no way to fetch the HubVirtualNetworkConnectionStatus via Python SDK HOT 2
- The union `CreateFileSearchToolResourceOptions` is not correctly defined. Extract `vectorStoreIds` variant into a model.
- [FEATURE REQ] Missing GitHub.Network/networkSettings
- [BUG] Discriminated set models contain same value on discriminator values in MFE
- [BUG] Discriminated set models contain same value on discriminator values in purview HOT 1
- [FEATURE REQ] OpenAI Files API
- [DevCenter ] API Review HOT 2
- [Trusted Launch - Trusted Launch] API Review HOT 2
- [TypeSpecValidation/LinterRuleset] Improve error message when tspconfig contains old ruleset
- [BUG] AzDO Rest API providing invalid JSON Format
- [BUG] Microsoft.ApiManagement/service@2023-05-01-preview - Error HOT 1
- [Azure OpenAI Service - Azure OpenAI Service] API Review
- [Azure OpenAI Service - Azure OpenAI Service] API Review
- [Azure OpenAI Service - Azure OpenAI Service] API Review
- [Azure OpenAI Service - Azure OpenAI Service] API Review
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from azure-rest-api-specs.