Skip to content

Add the missing description to summarization parameter #20809

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 45 commits into from
Sep 30, 2022
Merged
Show file tree
Hide file tree
Changes from 38 commits
Commits
Show all changes
45 commits
Select commit Hold shift + click to select a range
f574803
add the missing description
wangyuantao Sep 21, 2022
4728032
fix wording
wangyuantao Sep 21, 2022
192c15a
Merge branch 'Azure:main' into lc
wangyuantao Sep 23, 2022
cd02418
fix prettier
yuantao-wang Sep 23, 2022
40e6bbe
remove endpoint format uri
yuantao-wang Sep 23, 2022
0c6ad62
fix lintdiff
yuantao-wang Sep 23, 2022
6b8a0ee
add format uri back
yuantao-wang Sep 23, 2022
a438b31
x-ms-parameterized-host hostTemplate consistent
yuantao-wang Sep 23, 2022
d092460
fix prettier
yuantao-wang Sep 23, 2022
3732811
fix typo
yuantao-wang Sep 23, 2022
ee2291e
fix model validation
yuantao-wang Sep 23, 2022
37af083
remove dup Language
yuantao-wang Sep 23, 2022
adfe0c7
prettier more
yuantao-wang Sep 23, 2022
166aef5
add more custom words like Telangana
yuantao-wang Sep 23, 2022
d0ed411
fix typo of documentKind
yuantao-wang Sep 23, 2022
dddd312
remove dup def of Endpoint in QnA gen
yuantao-wang Sep 23, 2022
babfe18
GeneratedQAs is [] not [][]
yuantao-wang Sep 23, 2022
7c8e244
revert custom words
yuantao-wang Sep 23, 2022
c178261
remove format uri again
yuantao-wang Sep 23, 2022
316dc4d
Merge branch 'main' into lc
wangyuantao Sep 23, 2022
6d0a8cb
add custom words back
yuantao-wang Sep 23, 2022
09a1d8d
fix documentKind in QnA examples
yuantao-wang Sep 23, 2022
c75a26d
test security check
yuantao-wang Sep 23, 2022
51239f5
fix QnA sample
yuantao-wang Sep 23, 2022
ea3fded
test security
yuantao-wang Sep 23, 2022
667ec78
revert security
yuantao-wang Sep 23, 2022
fe4eb43
consistent security
yuantao-wang Sep 26, 2022
5843bf6
delete QnA generate
yuantao-wang Sep 27, 2022
069a374
azure-sdk-for-net-track2
yuantao-wang Sep 27, 2022
be53877
Merge branch 'Azure:main' into lc
wangyuantao Sep 28, 2022
69ef8da
fix more validation errors
yuantao-wang Sep 28, 2022
a486385
revert authoring
yuantao-wang Sep 29, 2022
aecabc0
Merge branch 'lc' of https://github.com/wangyuantao/azure-rest-api-sp…
yuantao-wang Sep 29, 2022
055183a
Merge branch 'main' into lc
wangyuantao Sep 29, 2022
1da2ccb
fix authoring
yuantao-wang Sep 29, 2022
545d4ae
Merge branch 'lc' of https://github.com/wangyuantao/azure-rest-api-sp…
yuantao-wang Sep 29, 2022
cfd67f7
fix authoring
yuantao-wang Sep 29, 2022
44df77f
add 200 back to export qna authoring
yuantao-wang Sep 29, 2022
4d69d00
revert endpoint to Endpoint
yuantao-wang Sep 30, 2022
dd79fb5
Merge branch 'Azure:main' into lc
wangyuantao Sep 30, 2022
a6ad551
fix example of qna authoring
yuantao-wang Sep 30, 2022
48e305d
Merge branch 'lc' of https://github.com/wangyuantao/azure-rest-api-sp…
yuantao-wang Sep 30, 2022
875df36
prettier revert
yuantao-wang Sep 30, 2022
c9f050c
fix api version
yuantao-wang Sep 30, 2022
f5c0456
revert authoring
yuantao-wang Sep 30, 2022
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"swagger": "2.0",
"info": {
"title": "Microsoft Cognitive Language Service - Analyze Conversations Authoring",
"version": "2022-07-01-preview",
"version": "2022-10-01-preview",
"description": "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/en-us/azure/cognitive-services/language-service/overview\">https://docs.microsoft.com/en-us/azure/cognitive-services/language-service/overview</a>."
},
"securityDefinitions": {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -1651,6 +1651,7 @@
]
},
"ConversationSentimentResult": {
"type": "object",
"description": "The result from sentiment analysis operation for each conversation item.",
"required": [
"conversationItems"
Expand Down Expand Up @@ -1721,19 +1722,23 @@
"properties": {
"completed": {
"description": "Count of tasks completed successfully.",
"type": "integer"
"type": "integer",
"format": "int32"
},
"failed": {
"description": "Count of tasks that failed.",
"type": "integer"
"type": "integer",
"format": "int32"
},
"inProgress": {
"description": "Count of tasks in progress currently.",
"type": "integer"
"type": "integer",
"format": "int32"
},
"total": {
"description": "Total count of tasks submitted as part of the job.",
"type": "integer"
"type": "integer",
"format": "int32"
},
"items": {
"description": "List of results from tasks (if available).",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"swagger": "2.0",
"info": {
"title": "Microsoft Cognitive Language Service - Analyze Text Authoring",
"version": "2022-07-01-preview",
"version": "2022-10-01-preview",
"description": "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/en-us/azure/cognitive-services/language-service/overview\">https://docs.microsoft.com/en-us/azure/cognitive-services/language-service/overview</a>."
},
"securityDefinitions": {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -505,6 +505,7 @@
"x-ms-discriminator-value": "SentimentAnalysis"
},
"AnalyzeTextDynamicClassificationInput": {
"type": "object",
"properties": {
"analysisInput": {
"$ref": "#/definitions/MultiLanguageAnalysisInput"
Expand Down Expand Up @@ -916,7 +917,7 @@
"HealthcareProfession",
"Diagnosis",
"SymptomOrSign",
"ConditionalQualifier",
"ConditionQualifier",
"MedicationClass",
"MedicationName",
"Dosage",
Expand Down
11 changes: 4 additions & 7 deletions dev/cognitiveservices/data-plane/Language/common.json
Original file line number Diff line number Diff line change
Expand Up @@ -16,10 +16,7 @@
"description": "The error object.",
"$ref": "#/definitions/Error"
}
},
"required": [
"error"
]
}
},
"Error": {
"type": "object",
Expand Down Expand Up @@ -805,7 +802,8 @@
"properties": {
"sentenceCount": {
"type": "integer",
"format": "int32"
"format": "int32",
"description": "It controls the approximate number of sentences in the output summaries."
},
"stringIndexType": {
"$ref": "#/definitions/StringIndexType"
Expand Down Expand Up @@ -1540,12 +1538,11 @@
},
"parameters": {
"Endpoint": {
"name": "Endpoint",
"name": "endpoint",
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In /specification folder, the latest stable is uppercase "Endpoint", and latest preview is lowercase "endpoint", so no matter what we do here, it is a breaking change. So I will revert this to keep it in uppercase "Endpoint" so no breaking change to GA version. @heaths, Is that OK?

"description": "Supported Cognitive Services endpoint (e.g., https://<resource-name>.api.cognitiveservices.azure.com).",
"x-ms-parameter-location": "client",
"required": true,
"type": "string",
"format": "uri",
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is to make consistent with July preview. Is that OK? @heaths

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For anything new, I recommend declaring the uri format. The others should've been before, but it's consider a breaking change to do it after. Most languages will ignore it anyway and just do a string, but some lanugages - like C# - actually end up using a Uri class (correctly). If you don't, we'll have to transform it and we're trying to avoid that. The swaggers should be the main source of truth. They are the spec, afterall. :)

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@heaths there are so many conflict rules and I'm confused which rule trump which rule... This is existing stuff, not new. In /specification folder, the latest stable version and the latest preview has no format, only /dev folder has format uri. Given we cannot break anything GA, we should fix /dev folder as what I'm doing here - remove format uri, right?

"in": "path",
"x-ms-skip-url-encoding": true
},
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,9 @@
"participantId": "1",
"id": "1",
"text": "I like the service. I do not like the food",
"lexical": "i like the service i do not like the food"
"lexical": "i like the service i do not like the food",
"itn": "",
"maskedItn": ""
}
]
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,11 @@
"200": {
"headers": {},
"body": {
"createdDateTime": "2022-10-01T8:00:25Z",
"createdDateTime": "2022-04-01T15:00:45Z",
"displayName": "Sentiment Analysis from a call center conversation",
"expirationDateTime": "2022-10-03T8:0:25Z",
"expirationDateTime": "2022-04-01T15:00:45Z",
"jobId": "c0f2a446-05d9-48fc-ba8f-3ef4af8d0b18",
"lastUpdatedDateTime": "2022-10-01T8:00:50Z",
"lastUpdatedDateTime": "2022-04-01T15:00:45Z",
"status": "succeeded",
"tasks": {
"completed": 1,
Expand All @@ -24,7 +24,7 @@
{
"kind": "ConversationalSentimentResults",
"taskName": "Conversation Sentiment",
"lastUpdateDateTime": "2022-10-01T8:00:50Z",
"lastUpdateDateTime": "2022-04-01T15:00:45Z",
"status": "succeeded",
"results": {
"conversations": [
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@
"confidenceScore": 0.99,
"resolutions": [
{
"resolutionKind": "DateTime",
"resolutionKind": "DateTimeResolution",
"dateTimeSubKind": "Date",
"timex": "1975-04-04",
"value": "1975-04-04"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
"info": {
"title": "Microsoft Cognitive Language Service - Question Answering - Authoring",
"description": "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/en-us/azure/cognitive-services/text-analytics/overview\">https://docs.microsoft.com/en-us/azure/cognitive-services/text-analytics/overview</a>.",
"version": "2022-07-01-preview"
"version": "2022-10-01-preview"
},
"securityDefinitions": {
"AADToken": {
Expand Down Expand Up @@ -32,7 +32,7 @@
}
],
"x-ms-parameterized-host": {
"hostTemplate": "{Endpoint}/language/authoring",
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we know the reason for this change ?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It causes validation error. Let me revert this, and request exception.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Standalone fix for this: #20927

"hostTemplate": "{Endpoint}/language",
"useSchemePrefix": false,
"parameters": [
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
"info": {
"title": "Microsoft Cognitive Language Service - Question Answering",
"description": "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/en-us/azure/cognitive-services/text-analytics/overview\">https://docs.microsoft.com/en-us/azure/cognitive-services/text-analytics/overview</a>.",
"version": "2022-07-01-preview"
"version": "2022-10-01-preview"
},
"securityDefinitions": {
"AADToken": {
Expand Down