Skip to content

Commit 7580518

Browse files
wangyuantaoyuantao-wang
wangyuantao
and
yuantao-wang
authored
make security exact match, fix prettier, spell check, delete QnA generate and update sdk-track2 (#20923)
* make security exact match * fix spell and prettier * fix prettier * fix spell * delete qna generate Co-authored-by: Yuantao Wang <yuantw@microsoft.com>
1 parent b879a8f commit 7580518

19 files changed

+164
-715
lines changed

‎custom-words.txt‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2744,6 +2744,10 @@ KubeProxyConfig
27442744
IPVS
27452745
TCPFIN
27462746
taginheritance
2747+
questionanswers
2748+
Satya
2749+
Nadella
2750+
Telangana
27472751
servicehealth
27482752
metricstaticthreshold
27492753
metricsdynamicthreshold

‎dev/cognitiveservices/data-plane/Language/analyzeconversations-authoring.json‎

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,14 +6,27 @@
66
"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>."
77
},
88
"securityDefinitions": {
9+
"AADToken": {
10+
"type": "oauth2",
11+
"authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize",
12+
"flow": "implicit",
13+
"description": "These are the [Azure Active Directory OAuth2](https://docs.microsoft.com/azure/active-directory/develop/v1-overview) Flows. When paired with [Azure role-based access](https://docs.microsoft.com/azure/role-based-access-control/overview) control it can be used to control access to Azure Maps REST APIs. Azure role-based access controls are used to designate access to one or more Azure Maps resource account or sub-resources. Any user, group, or service principal can be granted access via a built-in role or a custom role composed of one or more permissions to Azure Maps REST APIs.\n\nTo implement scenarios, we recommend viewing [authentication concepts](https://aka.ms/amauth). In summary, this security definition provides a solution for modeling application(s) via objects capable of access control on specific APIs and scopes.\n\n#### Notes\n* This security definition **requires** the use of the `x-ms-client-id` header to indicate which Azure Maps resource the application is requesting access to. This can be acquired from the [Maps management API](https://aka.ms/amauthdetails).\n* \nThe `Authorization URL` is specific to the Azure public cloud instance. Sovereign clouds have unique Authorization URLs and Azure Active directory configurations. \n* \nThe Azure role-based access control is configured from the [Azure management plane](https://aka.ms/amrbac) via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n* \nUsage of the [Azure Maps Web SDK](https://aka.ms/amaadmc) allows for configuration based setup of an application for multiple use cases.\n* Currently, Azure Active Directory [v1.0 or v2.0](https://docs.microsoft.com/azure/active-directory/develop/azure-ad-endpoint-comparison) supports Work, School, and Guests but does not support Personal accounts.",
14+
"scopes": {
15+
"https://cognitiveservices.azure.com/.default": "https://cognitiveservices.azure.com/.default"
16+
}
17+
},
918
"apim_key": {
1019
"type": "apiKey",
11-
"description": "A subscription key for a Language service resource.",
1220
"name": "Ocp-Apim-Subscription-Key",
1321
"in": "header"
1422
}
1523
},
1624
"security": [
25+
{
26+
"AADToken": [
27+
"https://cognitiveservices.azure.com/.default"
28+
]
29+
},
1730
{
1831
"apim_key": []
1932
}

‎dev/cognitiveservices/data-plane/Language/analyzeconversations.json‎

Lines changed: 15 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,14 +6,27 @@
66
"version": "2022-10-01-preview"
77
},
88
"securityDefinitions": {
9+
"AADToken": {
10+
"type": "oauth2",
11+
"authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize",
12+
"flow": "implicit",
13+
"description": "These are the [Azure Active Directory OAuth2](https://docs.microsoft.com/azure/active-directory/develop/v1-overview) Flows. When paired with [Azure role-based access](https://docs.microsoft.com/azure/role-based-access-control/overview) control it can be used to control access to Azure Maps REST APIs. Azure role-based access controls are used to designate access to one or more Azure Maps resource account or sub-resources. Any user, group, or service principal can be granted access via a built-in role or a custom role composed of one or more permissions to Azure Maps REST APIs.\n\nTo implement scenarios, we recommend viewing [authentication concepts](https://aka.ms/amauth). In summary, this security definition provides a solution for modeling application(s) via objects capable of access control on specific APIs and scopes.\n\n#### Notes\n* This security definition **requires** the use of the `x-ms-client-id` header to indicate which Azure Maps resource the application is requesting access to. This can be acquired from the [Maps management API](https://aka.ms/amauthdetails).\n* \nThe `Authorization URL` is specific to the Azure public cloud instance. Sovereign clouds have unique Authorization URLs and Azure Active directory configurations. \n* \nThe Azure role-based access control is configured from the [Azure management plane](https://aka.ms/amrbac) via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n* \nUsage of the [Azure Maps Web SDK](https://aka.ms/amaadmc) allows for configuration based setup of an application for multiple use cases.\n* Currently, Azure Active Directory [v1.0 or v2.0](https://docs.microsoft.com/azure/active-directory/develop/azure-ad-endpoint-comparison) supports Work, School, and Guests but does not support Personal accounts.",
14+
"scopes": {
15+
"https://cognitiveservices.azure.com/.default": "https://cognitiveservices.azure.com/.default"
16+
}
17+
},
918
"apim_key": {
1019
"type": "apiKey",
11-
"description": "A subscription key for a Language service resource.",
1220
"name": "Ocp-Apim-Subscription-Key",
1321
"in": "header"
1422
}
1523
},
1624
"security": [
25+
{
26+
"AADToken": [
27+
"https://cognitiveservices.azure.com/.default"
28+
]
29+
},
1730
{
1831
"apim_key": []
1932
}
@@ -135,8 +148,7 @@
135148
},
136149
"Successful Conversation Summarization Task Submit": {
137150
"$ref": "./examples/conversations/SuccessfulConversationSummarizationTaskSubmit.json"
138-
}
139-
,
151+
},
140152
"Successful Conversation Sentiment Analysis Job Request": {
141153
"$ref": "./examples/conversations/SuccessfulConversationSentimentSubmit.json"
142154
}

‎dev/cognitiveservices/data-plane/Language/analyzetext-authoring.json‎

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,14 +6,27 @@
66
"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>."
77
},
88
"securityDefinitions": {
9+
"AADToken": {
10+
"type": "oauth2",
11+
"authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize",
12+
"flow": "implicit",
13+
"description": "These are the [Azure Active Directory OAuth2](https://docs.microsoft.com/azure/active-directory/develop/v1-overview) Flows. When paired with [Azure role-based access](https://docs.microsoft.com/azure/role-based-access-control/overview) control it can be used to control access to Azure Maps REST APIs. Azure role-based access controls are used to designate access to one or more Azure Maps resource account or sub-resources. Any user, group, or service principal can be granted access via a built-in role or a custom role composed of one or more permissions to Azure Maps REST APIs.\n\nTo implement scenarios, we recommend viewing [authentication concepts](https://aka.ms/amauth). In summary, this security definition provides a solution for modeling application(s) via objects capable of access control on specific APIs and scopes.\n\n#### Notes\n* This security definition **requires** the use of the `x-ms-client-id` header to indicate which Azure Maps resource the application is requesting access to. This can be acquired from the [Maps management API](https://aka.ms/amauthdetails).\n* \nThe `Authorization URL` is specific to the Azure public cloud instance. Sovereign clouds have unique Authorization URLs and Azure Active directory configurations. \n* \nThe Azure role-based access control is configured from the [Azure management plane](https://aka.ms/amrbac) via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n* \nUsage of the [Azure Maps Web SDK](https://aka.ms/amaadmc) allows for configuration based setup of an application for multiple use cases.\n* Currently, Azure Active Directory [v1.0 or v2.0](https://docs.microsoft.com/azure/active-directory/develop/azure-ad-endpoint-comparison) supports Work, School, and Guests but does not support Personal accounts.",
14+
"scopes": {
15+
"https://cognitiveservices.azure.com/.default": "https://cognitiveservices.azure.com/.default"
16+
}
17+
},
918
"apim_key": {
1019
"type": "apiKey",
11-
"description": "A subscription key for a Language service resource.",
1220
"name": "Ocp-Apim-Subscription-Key",
1321
"in": "header"
1422
}
1523
},
1624
"security": [
25+
{
26+
"AADToken": [
27+
"https://cognitiveservices.azure.com/.default"
28+
]
29+
},
1730
{
1831
"apim_key": []
1932
}

‎dev/cognitiveservices/data-plane/Language/analyzetext.json‎

Lines changed: 16 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,14 +6,27 @@
66
"version": "2022-10-01-preview"
77
},
88
"securityDefinitions": {
9+
"AADToken": {
10+
"type": "oauth2",
11+
"authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize",
12+
"flow": "implicit",
13+
"description": "These are the [Azure Active Directory OAuth2](https://docs.microsoft.com/azure/active-directory/develop/v1-overview) Flows. When paired with [Azure role-based access](https://docs.microsoft.com/azure/role-based-access-control/overview) control it can be used to control access to Azure Maps REST APIs. Azure role-based access controls are used to designate access to one or more Azure Maps resource account or sub-resources. Any user, group, or service principal can be granted access via a built-in role or a custom role composed of one or more permissions to Azure Maps REST APIs.\n\nTo implement scenarios, we recommend viewing [authentication concepts](https://aka.ms/amauth). In summary, this security definition provides a solution for modeling application(s) via objects capable of access control on specific APIs and scopes.\n\n#### Notes\n* This security definition **requires** the use of the `x-ms-client-id` header to indicate which Azure Maps resource the application is requesting access to. This can be acquired from the [Maps management API](https://aka.ms/amauthdetails).\n* \nThe `Authorization URL` is specific to the Azure public cloud instance. Sovereign clouds have unique Authorization URLs and Azure Active directory configurations. \n* \nThe Azure role-based access control is configured from the [Azure management plane](https://aka.ms/amrbac) via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n* \nUsage of the [Azure Maps Web SDK](https://aka.ms/amaadmc) allows for configuration based setup of an application for multiple use cases.\n* Currently, Azure Active Directory [v1.0 or v2.0](https://docs.microsoft.com/azure/active-directory/develop/azure-ad-endpoint-comparison) supports Work, School, and Guests but does not support Personal accounts.",
14+
"scopes": {
15+
"https://cognitiveservices.azure.com/.default": "https://cognitiveservices.azure.com/.default"
16+
}
17+
},
918
"apim_key": {
1019
"type": "apiKey",
11-
"description": "A subscription key for a Language service resource.",
1220
"name": "Ocp-Apim-Subscription-Key",
1321
"in": "header"
1422
}
1523
},
1624
"security": [
25+
{
26+
"AADToken": [
27+
"https://cognitiveservices.azure.com/.default"
28+
]
29+
},
1730
{
1831
"apim_key": []
1932
}
@@ -89,7 +102,7 @@
89102
"Successful Sentiment Analysis Request": {
90103
"$ref": "./examples/text/SuccessfulSentimentAnalysisRequest.json"
91104
},
92-
"Successful Dynamic Classifcation Request": {
105+
"Successful Dynamic Classification Request": {
93106
"$ref": "./examples/text/SuccessfuDynamicClassificationRequest.json"
94107
}
95108
}
@@ -202,7 +215,7 @@
202215
"Successful Get Abstractive Summarization Result": {
203216
"$ref": "./examples/text/SuccessfulAbstractiveSummarizationTaskResult.json"
204217
},
205-
"Succesful Get Text Analysis Health DocumentType Request": {
218+
"Successful Get Text Analysis Health DocumentType Request": {
206219
"$ref": "./examples/text/SuccessfulHealthcareDocumentTypeTaskStatusRequest.json"
207220
}
208221
}

‎dev/cognitiveservices/data-plane/Language/common.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -769,7 +769,7 @@
769769
{
770770
"value": "mixed",
771771
"description": "Mixed sentiment."
772-
}
772+
}
773773
]
774774
}
775775
},

‎dev/cognitiveservices/data-plane/Language/examples/conversations/SuccessfulConversationSentimentSubmit.json‎

Lines changed: 37 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -1,46 +1,45 @@
11
{
2-
"parameters": {
3-
"Ocp-Apim-Subscription-Key": "{API key}",
4-
"api-version": "2022-10-01-preview",
5-
"Endpoint": "{Endpoint}",
6-
"jobId": "{Job ID}",
7-
"body": {
8-
"displayName": "Sentiment Analysis from a call center conversation",
9-
"analysisInput": {
10-
"conversations": [
11-
{
12-
"id": "1",
13-
"language": "en",
14-
"modality": "transcript",
15-
"conversationItems": [
16-
{
17-
"participantId": "1",
18-
"id": "1",
19-
"text": "I like the service. I do not like the food",
20-
"lexical": "i like the service i do not like the food"
21-
}
22-
]
23-
}
24-
]
25-
},
26-
"tasks": [
2+
"parameters": {
3+
"Ocp-Apim-Subscription-Key": "{API key}",
4+
"api-version": "2022-10-01-preview",
5+
"Endpoint": "{Endpoint}",
6+
"jobId": "{Job ID}",
7+
"body": {
8+
"displayName": "Sentiment Analysis from a call center conversation",
9+
"analysisInput": {
10+
"conversations": [
2711
{
28-
"taskName": "Conversation Sentiment Analysis",
29-
"kind": "ConversationalSentimentTask",
30-
"parameters": {
31-
"modelVersion": "latest",
32-
"predictionSource": "text"
33-
}
12+
"id": "1",
13+
"language": "en",
14+
"modality": "transcript",
15+
"conversationItems": [
16+
{
17+
"participantId": "1",
18+
"id": "1",
19+
"text": "I like the service. I do not like the food",
20+
"lexical": "i like the service i do not like the food"
21+
}
22+
]
3423
}
3524
]
36-
}
37-
},
38-
"responses": {
39-
"202": {
40-
"headers": {
41-
"Operation-Location": "{Endpoint}/language/analyze-conversation/jobs/{jobId}?api-version={api-version}"
25+
},
26+
"tasks": [
27+
{
28+
"taskName": "Conversation Sentiment Analysis",
29+
"kind": "ConversationalSentimentTask",
30+
"parameters": {
31+
"modelVersion": "latest",
32+
"predictionSource": "text"
33+
}
4234
}
35+
]
36+
}
37+
},
38+
"responses": {
39+
"202": {
40+
"headers": {
41+
"Operation-Location": "{Endpoint}/language/analyze-conversation/jobs/{jobId}?api-version={api-version}"
4342
}
4443
}
4544
}
46-
45+
}

‎dev/cognitiveservices/data-plane/Language/examples/conversations/SuccessfulConversationSentimentTaskStatusRequest.json‎

Lines changed: 51 additions & 52 deletions
Original file line numberDiff line numberDiff line change
@@ -1,61 +1,60 @@
11
{
2-
"parameters": {
3-
"Ocp-Apim-Subscription-Key": "{API key}",
4-
"api-version": "2022-10-01-preview",
5-
"Endpoint": "{Endpoint}",
6-
"jobId": "c0f2a446-05d9-48fc-ba8f-3ef4af8d0b18"
7-
},
8-
"responses": {
9-
"200": {
10-
"headers": {},
11-
"body": {
12-
"createdDateTime": "2022-10-01T8:00:25Z",
13-
"displayName": "Sentiment Analysis from a call center conversation",
14-
"expirationDateTime": "2022-10-03T8:0:25Z",
15-
"jobId": "c0f2a446-05d9-48fc-ba8f-3ef4af8d0b18",
16-
"lastUpdatedDateTime": "2022-10-01T8:00:50Z",
17-
"status": "succeeded",
18-
"tasks": {
19-
"completed": 1,
20-
"failed": 0,
21-
"inProgress": 0,
22-
"total": 1,
23-
"items": [
24-
{
25-
"kind": "ConversationalSentimentResults",
26-
"taskName": "Conversation Sentiment",
27-
"lastUpdateDateTime": "2022-10-01T8:00:50Z",
28-
"status": "succeeded",
29-
"results": {
30-
"conversations": [
31-
{
32-
"id": "1",
33-
"conversationItems": [
34-
{
35-
"id": "1",
36-
"participantId": "agent_1",
37-
"sentiment": "mixed",
38-
"confidenceScores": {
39-
"positive": 0.5,
40-
"neutral": 0.01,
41-
"negative": 0.49
42-
}
2+
"parameters": {
3+
"Ocp-Apim-Subscription-Key": "{API key}",
4+
"api-version": "2022-10-01-preview",
5+
"Endpoint": "{Endpoint}",
6+
"jobId": "c0f2a446-05d9-48fc-ba8f-3ef4af8d0b18"
7+
},
8+
"responses": {
9+
"200": {
10+
"headers": {},
11+
"body": {
12+
"createdDateTime": "2022-10-01T8:00:25Z",
13+
"displayName": "Sentiment Analysis from a call center conversation",
14+
"expirationDateTime": "2022-10-03T8:0:25Z",
15+
"jobId": "c0f2a446-05d9-48fc-ba8f-3ef4af8d0b18",
16+
"lastUpdatedDateTime": "2022-10-01T8:00:50Z",
17+
"status": "succeeded",
18+
"tasks": {
19+
"completed": 1,
20+
"failed": 0,
21+
"inProgress": 0,
22+
"total": 1,
23+
"items": [
24+
{
25+
"kind": "ConversationalSentimentResults",
26+
"taskName": "Conversation Sentiment",
27+
"lastUpdateDateTime": "2022-10-01T8:00:50Z",
28+
"status": "succeeded",
29+
"results": {
30+
"conversations": [
31+
{
32+
"id": "1",
33+
"conversationItems": [
34+
{
35+
"id": "1",
36+
"participantId": "agent_1",
37+
"sentiment": "mixed",
38+
"confidenceScores": {
39+
"positive": 0.5,
40+
"neutral": 0.01,
41+
"negative": 0.49
4342
}
44-
],
45-
"warnings": [],
46-
"statistics": {
47-
"transactionsCount": 1
4843
}
44+
],
45+
"warnings": [],
46+
"statistics": {
47+
"transactionsCount": 1
4948
}
50-
],
51-
"errors": [],
52-
"modelVersion": "2022-10-01-preview"
53-
}
49+
}
50+
],
51+
"errors": [],
52+
"modelVersion": "2022-10-01-preview"
5453
}
55-
]
56-
}
54+
}
55+
]
5756
}
5857
}
5958
}
6059
}
61-
60+
}

‎dev/cognitiveservices/data-plane/Language/examples/questionanswering/SuccessfulQueryKnowledgebases.json‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
"question": "how long it takes to charge surface?",
1111
"top": 3,
1212
"userId": "sd53lsY=",
13-
"confidenceScoreThreshold": 0.20,
13+
"confidenceScoreThreshold": 0.2,
1414
"context": {
1515
"previousQnaId": 9,
1616
"previousUserQuery": "Where are QnA Maker quickstarts?"
@@ -38,7 +38,7 @@
3838
},
3939
"answerSpanRequest": {
4040
"enable": true,
41-
"confidenceScoreThreshold": 0.20,
41+
"confidenceScoreThreshold": 0.2,
4242
"topAnswersWithSpan": 1
4343
},
4444
"includeUnstructuredSources": true
@@ -78,7 +78,7 @@
7878
},
7979
"answerSpan": {
8080
"text": "two to four hours",
81-
"confidenceScore": 0.30,
81+
"confidenceScore": 0.3,
8282
"offset": 33,
8383
"length": 50
8484
}

0 commit comments

Comments
 (0)