mikekistler
commented
11 months ago Notes from API Review meeting 11/14/23
- If the customer provides a SAS URI from a private source, will you make sure that the data never travels over the public network?
- Will you be moving to TypeSpec? Yes ... that is in progress but not ready for this feature.
- Should review the folder structure offline.
- Should authorization type be explicit? Yes, explicit is best.
- With a property like
authorizationKind - Keyvault did this recently ... you might want to see how they did it.
- ManagedIdentity -- system assigned unless clientId is passed, then user assigned
- With a property like
- Could you return key parts of the results inline, perhaps specified in a query param, rather than parsing the JSON file?
- The concern with the JSON file is that there is no schema for this -- not in the REST API anyway.
- Is there any concern with putting the information in both places?
- It seems likely that users will want the information directly
- There are a lot of models that look the same as AnalyzeText. Might want to make these common to avoid drift going forward.
- The API allows multiple documents, so the output must be pageable
- All the AnalyzeText jobs support pagination
Please address the above and then this looks good for preview.
New API Review meeting has been requested.
Service Name: Cognitive Services Text Analytics API Review Created By: Mohamed Abbas Review Date: 11/14/2023 01:00 PM PT Onboarding Record: PR: Hero Scenarios Link: Not Provided Core Concepts Doc Link: Not Provided
Description: Adding new analyze-documents APIs to Cognitive Services - Language APIs. The document analysis APIs will follow the same structure as the existing analyze-text APIs, but target non-text files (E.g. pdf, docx, ..etc).
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