Skip to content

Commit aba14a9

Browse files
moabbamoabba
authored
Update Language authoring and runtime APIs to follow the same convention (2022-05-01) (#18836)
* Update authoring and runtime APIs to follow the same convention * Update the examples * Remove other references to "named" in "named entity recognition" * Remove more 'named' from the swagger
1 parent 838f036 commit aba14a9

19 files changed

+260
-285
lines changed

‎specification/cognitiveservices/data-plane/Language/stable/2022-05-01/analyzeconversations-authoring.json‎

Lines changed: 57 additions & 50 deletions
Original file line numberDiff line numberDiff line change
@@ -1076,8 +1076,14 @@
10761076
}
10771077
],
10781078
"responses": {
1079-
"204": {
1080-
"description": "The job was successfully canceled."
1079+
"202": {
1080+
"description": "A successful call results with an Operation-Location header used to check the status of the job.",
1081+
"headers": {
1082+
"operation-location": {
1083+
"description": "The location of the status API for monitoring the job cancellation.",
1084+
"type": "string"
1085+
}
1086+
}
10811087
},
10821088
"default": {
10831089
"description": "Error response.",
@@ -1090,7 +1096,8 @@
10901096
"Successful Cancel Training Job": {
10911097
"$ref": "./examples/analyzeconversations-authoring/SuccessfulCancelTrainingJob.json"
10921098
}
1093-
}
1099+
},
1100+
"x-ms-long-running-operation": true
10941101
}
10951102
},
10961103
"/authoring/analyze-conversations/projects/global/deletion-jobs/{jobId}": {
@@ -1430,7 +1437,7 @@
14301437
}
14311438
}
14321439
},
1433-
"x-ms-discriminator-value": "conversation",
1440+
"x-ms-discriminator-value": "Conversation",
14341441
"x-ms-client-name": "ConversationExportedProjectAssets"
14351442
},
14361443
"ConversationalAnalysisAuthoringConversationExportedUtterance": {
@@ -1725,7 +1732,7 @@
17251732
},
17261733
"x-ms-client-name": "EvaluationSummary"
17271734
},
1728-
"ConversationalAnalysisAuthoringExportedCluOrchestration": {
1735+
"ConversationalAnalysisAuthoringExportedConversationOrchestration": {
17291736
"description": "Defines the orchestration details for a Conversational project target.",
17301737
"required": [
17311738
"projectName",
@@ -1742,12 +1749,12 @@
17421749
"type": "string"
17431750
}
17441751
},
1745-
"x-ms-client-name": "ExportedCluOrchestration"
1752+
"x-ms-client-name": "ExportedConversationOrchestration"
17461753
},
1747-
"ConversationalAnalysisAuthoringExportedCluOrchestrationOptions": {
1754+
"ConversationalAnalysisAuthoringExportedConversationOrchestrationOptions": {
17481755
"description": "Represents the orchestration options for a Conversational project target.",
17491756
"required": [
1750-
"cluOrchestration"
1757+
"conversationOrchestration"
17511758
],
17521759
"type": "object",
17531760
"allOf": [
@@ -1756,13 +1763,13 @@
17561763
}
17571764
],
17581765
"properties": {
1759-
"cluOrchestration": {
1766+
"conversationOrchestration": {
17601767
"description": "The Conversational project target details.",
1761-
"$ref": "#/definitions/ConversationalAnalysisAuthoringExportedCluOrchestration"
1768+
"$ref": "#/definitions/ConversationalAnalysisAuthoringExportedConversationOrchestration"
17621769
}
17631770
},
1764-
"x-ms-discriminator-value": "clu",
1765-
"x-ms-client-name": "ExportedCluOrchestrationOptions"
1771+
"x-ms-discriminator-value": "Conversation",
1772+
"x-ms-client-name": "ExportedConversationOrchestrationOptions"
17661773
},
17671774
"ConversationalAnalysisAuthoringExportedEntityList": {
17681775
"description": "Represents a list component of an entity.",
@@ -1855,22 +1862,22 @@
18551862
"$ref": "#/definitions/ConversationalAnalysisAuthoringExportedLuisOrchestration"
18561863
}
18571864
},
1858-
"x-ms-discriminator-value": "luis",
1865+
"x-ms-discriminator-value": "Luis",
18591866
"x-ms-client-name": "ExportedLuisOrchestrationOptions"
18601867
},
18611868
"ConversationalAnalysisAuthoringExportedOrchestrationOptions": {
18621869
"description": "Represents the options used to define the orchestration behavior of an intent.",
18631870
"required": [
1864-
"kind"
1871+
"targetProjectKind"
18651872
],
18661873
"type": "object",
18671874
"properties": {
1868-
"kind": {
1875+
"targetProjectKind": {
18691876
"description": "The kind of the target used in the orchestration flow.",
1870-
"$ref": "#/definitions/ConversationalAnalysisAuthoringOrchestrationKind"
1877+
"$ref": "#/definitions/ConversationalAnalysisAuthoringOrchestrationTargetProjectKind"
18711878
}
18721879
},
1873-
"discriminator": "kind",
1880+
"discriminator": "targetProjectKind",
18741881
"x-ms-client-name": "ExportedOrchestrationOptions"
18751882
},
18761883
"ConversationalAnalysisAuthoringExportedPrebuiltEntity": {
@@ -1932,27 +1939,27 @@
19321939
},
19331940
"ConversationalAnalysisAuthoringExportedProjectFormat": {
19341941
"enum": [
1935-
"clu",
1936-
"luis"
1942+
"Conversation",
1943+
"Luis"
19371944
],
19381945
"type": "string",
19391946
"x-ms-enum": {
19401947
"name": "ExportedProjectFormat",
19411948
"modelAsString": true,
19421949
"values": [
19431950
{
1944-
"value": "clu",
1951+
"value": "Conversation",
19451952
"description": "Specifies the format for a conversational project."
19461953
},
19471954
{
1948-
"value": "luis",
1955+
"value": "Luis",
19491956
"description": "Specifies the format for an application that was exported from LUIS."
19501957
}
19511958
]
19521959
},
19531960
"x-ms-client-name": "ExportedProjectFormat"
19541961
},
1955-
"ConversationalAnalysisAuthoringExportedQnaOrchestration": {
1962+
"ConversationalAnalysisAuthoringExportedQuestionAnsweringOrchestration": {
19561963
"description": "Defines the orchestration details for a Question Answering project target.",
19571964
"required": [
19581965
"projectName"
@@ -1964,12 +1971,12 @@
19641971
"type": "string"
19651972
}
19661973
},
1967-
"x-ms-client-name": "ExportedQnaOrchestration"
1974+
"x-ms-client-name": "ExportedQuestionAnsweringOrchestration"
19681975
},
1969-
"ConversationalAnalysisAuthoringExportedQnaOrchestrationOptions": {
1976+
"ConversationalAnalysisAuthoringExportedQuestionAnsweringOrchestrationOptions": {
19701977
"description": "Represents the orchestration options for a Question Answering project target.",
19711978
"required": [
1972-
"qnaOrchestration"
1979+
"questionAnsweringOrchestration"
19731980
],
19741981
"type": "object",
19751982
"allOf": [
@@ -1978,13 +1985,13 @@
19781985
}
19791986
],
19801987
"properties": {
1981-
"qnaOrchestration": {
1988+
"questionAnsweringOrchestration": {
19821989
"description": "The Question Answering project details.",
1983-
"$ref": "#/definitions/ConversationalAnalysisAuthoringExportedQnaOrchestration"
1990+
"$ref": "#/definitions/ConversationalAnalysisAuthoringExportedQuestionAnsweringOrchestration"
19841991
}
19851992
},
1986-
"x-ms-discriminator-value": "qna",
1987-
"x-ms-client-name": "ExportedQnaOrchestrationOptions"
1993+
"x-ms-discriminator-value": "QuestionAnswering",
1994+
"x-ms-client-name": "ExportedQuestionAnsweringOrchestrationOptions"
19881995
},
19891996
"ConversationalAnalysisAuthoringExportedUtteranceEntityLabel": {
19901997
"description": "Represents an entity label for an utterance.",
@@ -2256,7 +2263,7 @@
22562263
}
22572264
}
22582265
},
2259-
"x-ms-discriminator-value": "orchestration",
2266+
"x-ms-discriminator-value": "Orchestration",
22602267
"x-ms-client-name": "OrchestrationExportedProjectAssets"
22612268
},
22622269
"ConversationalAnalysisAuthoringOrchestrationExportedUtterance": {
@@ -2286,18 +2293,18 @@
22862293
},
22872294
"x-ms-client-name": "OrchestrationExportedUtterance"
22882295
},
2289-
"ConversationalAnalysisAuthoringOrchestrationKind": {
2296+
"ConversationalAnalysisAuthoringOrchestrationTargetProjectKind": {
22902297
"enum": [
2291-
"luis",
2292-
"clu",
2293-
"qna"
2298+
"Luis",
2299+
"Conversation",
2300+
"QuestionAnswering"
22942301
],
22952302
"type": "string",
22962303
"x-ms-enum": {
2297-
"name": "OrchestrationKind",
2304+
"name": "OrchestrationTargetProjectKind",
22982305
"modelAsString": true
22992306
},
2300-
"x-ms-client-name": "OrchestrationKind"
2307+
"x-ms-client-name": "OrchestrationTargetProjectKind"
23012308
},
23022309
"ConversationalAnalysisAuthoringPrebuiltEntities": {
23032310
"description": "Represents a list of the retrieved supported prebuilt entities.",
@@ -2423,21 +2430,21 @@
24232430
},
24242431
"ConversationalAnalysisAuthoringProjectKind": {
24252432
"enum": [
2426-
"conversation",
2427-
"orchestration"
2433+
"Conversation",
2434+
"Orchestration"
24282435
],
24292436
"type": "string",
24302437
"x-ms-enum": {
24312438
"name": "ProjectKind",
24322439
"modelAsString": true,
24332440
"values": [
24342441
{
2435-
"value": "conversation",
2442+
"value": "Conversation",
24362443
"description": "A project to build natural language into apps, bots, and IoT devices."
24372444
},
24382445
{
2439-
"value": "orchestration",
2440-
"description": "A project to connect and orchestrate CLU, Custom question answering and LUIS projects together in one single project."
2446+
"value": "Orchestration",
2447+
"description": "A project to connect and orchestrate Conversation, Custom question answering and LUIS projects together in one single project."
24412448
}
24422449
]
24432450
},
@@ -3009,19 +3016,19 @@
30093016
"description": "The format of the exported project file to use.",
30103017
"type": "string",
30113018
"enum": [
3012-
"clu",
3013-
"luis"
3019+
"Conversation",
3020+
"Luis"
30143021
],
30153022
"x-ms-enum": {
30163023
"name": "ExportedProjectFormat",
30173024
"modelAsString": true,
30183025
"values": [
30193026
{
3020-
"value": "clu",
3027+
"value": "Conversation",
30213028
"description": "Specifies the format for a conversational project."
30223029
},
30233030
{
3024-
"value": "luis",
3031+
"value": "Luis",
30253032
"description": "Specifies the format for an application that was exported from LUIS."
30263033
}
30273034
]
@@ -3072,20 +3079,20 @@
30723079
"required": true,
30733080
"type": "string",
30743081
"enum": [
3075-
"conversation",
3076-
"orchestration"
3082+
"Conversation",
3083+
"Orchestration"
30773084
],
30783085
"x-ms-enum": {
30793086
"name": "ProjectKind",
30803087
"modelAsString": true,
30813088
"values": [
30823089
{
3083-
"value": "conversation",
3090+
"value": "Conversation",
30843091
"description": "A project to build natural language into apps, bots, and IoT devices."
30853092
},
30863093
{
3087-
"value": "orchestration",
3088-
"description": "A project to connect and orchestrate CLU, Custom question answering and LUIS projects together in one single project."
3094+
"value": "Orchestration",
3095+
"description": "A project to connect and orchestrate Conversation, Custom question answering and LUIS projects together in one single project."
30893096
}
30903097
]
30913098
},

0 commit comments

Comments
 (0)