diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2023-11-15-preview/SuccessfulAnalyzeConversations.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2023-11-15-preview/SuccessfulAnalyzeConversations.json deleted file mode 100644 index b7c349c9c4ae..000000000000 --- a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2023-11-15-preview/SuccessfulAnalyzeConversations.json +++ /dev/null @@ -1,63 +0,0 @@ -{ - "operationId": "AnalyzeConversations", - "title": "SuccessfulAnalyzeConversations", - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "Content-Type": "application/json", - "api-version": "2023-11-15-preview", - "body": { - "kind": "Conversation", - "analysisInput": { - "conversationItem": { - "id": "1", - "participantId": "1", - "text": "play In the air tonight from Phil Collins" - } - }, - "parameters": { - "projectName": "{project-name}", - "deploymentName": "{deployment-name}", - "stringIndexType": "TextElement_V8" - } - } - }, - "responses": { - "200": { - "headers": {}, - "body": { - "kind": "ConversationResult", - "result": { - "query": "play In the air tonight from Phil Collins", - "prediction": { - "topIntent": "PlayMusic", - "projectKind": "Conversation", - "intents": [ - { - "category": "PlayMusic", - "confidenceScore": 1 - }, - { - "category": "SearchCreativeWork", - "confidenceScore": 0 - }, - { - "category": "AddToPlaylist", - "confidenceScore": 0 - } - ], - "entities": [ - { - "category": "Media.Artist", - "text": "Phil Collins", - "offset": 29, - "length": 12, - "confidenceScore": 1 - } - ] - } - } - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2023-11-15-preview/SuccessfulAnalyzeConversationsArbitrationDirectTarget.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2023-11-15-preview/SuccessfulAnalyzeConversationsArbitrationDirectTarget.json deleted file mode 100644 index b7c39ef12d28..000000000000 --- a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2023-11-15-preview/SuccessfulAnalyzeConversationsArbitrationDirectTarget.json +++ /dev/null @@ -1,77 +0,0 @@ -{ - "operationId": "AnalyzeConversations", - "title": "SuccessfulAnalyzeConversationsArbitrationDirectTarget", - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "Content-Type": "application/json", - "api-version": "2023-11-15-preview", - "body": { - "kind": "Conversation", - "analysisInput": { - "conversationItem": { - "text": "Ports and connectors", - "participantId": "1", - "id": "1" - } - }, - "parameters": { - "projectName": "prj1", - "deploymentName": "dep1", - "directTarget": "qnaProject", - "targetProjectParameters": { - "qnaProject": { - "targetProjectKind": "QuestionAnswering", - "callingOptions": { - "context": { - "previousUserQuery": "Meet Surface Pro 4", - "previousQnaId": 4 - }, - "top": 1, - "question": "App Service overview" - } - } - } - } - } - }, - "responses": { - "200": { - "headers": {}, - "body": { - "kind": "ConversationResult", - "result": { - "query": "Ports and connectors", - "prediction": { - "projectKind": "Orchestration", - "topIntent": "qnaTargetApp", - "intents": { - "qnaTargetApp": { - "targetProjectKind": "QuestionAnswering", - "confidenceScore": 1, - "result": { - "answers": [ - { - "questions": [ - "App Service overview" - ], - "answer": "The compute resources you use are determined by the *App Service plan* that you run your apps on.", - "confidenceScore": 0.7384000000000001, - "id": 1, - "source": "https://docs.microsoft.com/en-us/azure/app-service/overview", - "metadata": {}, - "dialog": { - "isContextOnly": false, - "prompts": [] - } - } - ] - } - } - } - } - } - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2023-11-15-preview/SuccessfulAnalyzeConversationsJobsCancelRequest.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2023-11-15-preview/SuccessfulAnalyzeConversationsJobsCancelRequest.json deleted file mode 100644 index 8a06b3663db0..000000000000 --- a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2023-11-15-preview/SuccessfulAnalyzeConversationsJobsCancelRequest.json +++ /dev/null @@ -1,17 +0,0 @@ -{ - "operationId": "AnalyzeConversationsCancelJob", - "title": "SuccessfulAnalyzeConversationsJobsCancelRequest", - "parameters": { - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2023-11-15-preview", - "Endpoint": "{Endpoint}", - "jobId": "c0f2a446-05d9-48fc-ba8f-3ef4af8d0b18" - }, - "responses": { - "202": { - "headers": { - "Operation-Location": "{Endpoint}/language/analyze-conversations/jobs/{jobId}?api-version=2023-11-15-preview" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2023-11-15-preview/SuccessfulConversationPIIExclusionSubmit.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2023-11-15-preview/SuccessfulConversationPIIExclusionSubmit.json deleted file mode 100644 index 6855d85571fd..000000000000 --- a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2023-11-15-preview/SuccessfulConversationPIIExclusionSubmit.json +++ /dev/null @@ -1,76 +0,0 @@ -{ - "operationId": "AnalyzeConversationsSubmitJob", - "title": "SuccessfulConversationPIIExclusionSubmit", - "parameters": { - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2023-11-15-preview", - "Endpoint": "{Endpoint}", - "jobId": "{Job ID}", - "body": { - "displayName": "Redacting PII data from transcribed audio", - "analysisInput": { - "conversations": [ - { - "id": "1", - "language": "en", - "modality": "transcript", - "domain": "generic", - "conversationItems": [ - { - "participantId": "1", - "id": "1", - "text": "Good morning John Doe.", - "itn": "good morning john doe", - "maskedItn": "good morning john doe", - "lexical": "good morning john doe", - "wordLevelTimings": [ - { - "word": "good", - "offset": 390000, - "duration": 2700000 - }, - { - "word": "morning", - "offset": 4500000, - "duration": 920000 - }, - { - "word": "john", - "offset": 590000, - "duration": 2700000 - }, - { - "word": "doe", - "offset": 6300000, - "duration": 920000 - } - ] - } - ] - } - ] - }, - "tasks": [ - { - "taskName": "Conversation PII", - "kind": "ConversationalPIITask", - "parameters": { - "modelVersion": "latest", - "excludePiiCategories": [ - "Person" - ], - "redactionSource": "lexical", - "redactAudioTiming": true - } - } - ] - } - }, - "responses": { - "202": { - "headers": { - "Operation-Location": "{Endpoint}/language/analyze-conversation/jobs/{jobId}?api-version=2023-11-15-preview" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2023-11-15-preview/SuccessfulConversationPIIExclusionTaskStatusRequest.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2023-11-15-preview/SuccessfulConversationPIIExclusionTaskStatusRequest.json deleted file mode 100644 index 140ac9bc453a..000000000000 --- a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2023-11-15-preview/SuccessfulConversationPIIExclusionTaskStatusRequest.json +++ /dev/null @@ -1,68 +0,0 @@ -{ - "operationId": "AnalyzeConversationsJobStatus", - "title": "SuccessfulConversationPIIExclusionTaskStatusRequest", - "parameters": { - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2023-11-15-preview", - "Endpoint": "{Endpoint}", - "jobId": "c0f2a446-05d9-48fc-ba8f-3ef4af8d0b18" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "createdDateTime": "2020-10-01T15:00:45Z", - "displayName": "Redacting PII from transcribed audio", - "expirationDateTime": "2020-10-03T15:01:03Z", - "jobId": "c0f2a446-05d9-48fc-ba8f-3ef4af8d0b18", - "lastUpdatedDateTime": "2022-01-25T15:01:03Z", - "status": "succeeded", - "tasks": { - "completed": 1, - "failed": 0, - "inProgress": 0, - "total": 1, - "items": [ - { - "kind": "conversationalPIIResults", - "taskName": "Conversation PII", - "lastUpdateDateTime": "2022-01-25T15:01:03Z", - "status": "succeeded", - "results": { - "conversations": [ - { - "id": "1", - "conversationItems": [ - { - "id": "1", - "redactedContent": { - "text": "Good morning *************.", - "itn": "good morning *************", - "maskedItn": "good morning *************", - "lexical": "good morning *************", - "audioTimings": [ - { - "offset": 590000, - "duration": 920000 - } - ] - }, - "entities": [] - } - ], - "warnings": [], - "statistics": { - "transactionsCount": 1 - } - } - ], - "errors": [], - "modelVersion": "2022-05-15-preview" - } - } - ] - } - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2023-11-15-preview/SuccessfulConversationPIIRedactionCharSubmit.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2023-11-15-preview/SuccessfulConversationPIIRedactionCharSubmit.json deleted file mode 100644 index 377aef55f9e3..000000000000 --- a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2023-11-15-preview/SuccessfulConversationPIIRedactionCharSubmit.json +++ /dev/null @@ -1,77 +0,0 @@ -{ - "operationId": "AnalyzeConversationsSubmitJob", - "title": "SuccessfulConversationPIIRedactionCharSubmit", - "parameters": { - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2023-11-15-preview", - "Endpoint": "{Endpoint}", - "jobId": "{Job ID}", - "body": { - "displayName": "Redacting PII data from transcribed audio", - "analysisInput": { - "conversations": [ - { - "id": "1", - "language": "en", - "modality": "transcript", - "domain": "generic", - "conversationItems": [ - { - "participantId": "1", - "id": "1", - "text": "Good morning John Doe.", - "itn": "good morning john doe", - "maskedItn": "good morning john doe", - "lexical": "good morning john doe", - "wordLevelTimings": [ - { - "word": "good", - "offset": 390000, - "duration": 2700000 - }, - { - "word": "morning", - "offset": 4500000, - "duration": 920000 - }, - { - "word": "john", - "offset": 590000, - "duration": 2700000 - }, - { - "word": "doe", - "offset": 6300000, - "duration": 920000 - } - ] - } - ] - } - ] - }, - "tasks": [ - { - "taskName": "Conversation PII", - "kind": "ConversationalPIITask", - "parameters": { - "modelVersion": "latest", - "piiCategories": [ - "All" - ], - "redactionCharacter": "-", - "redactionSource": "lexical", - "redactAudioTiming": true - } - } - ] - } - }, - "responses": { - "202": { - "headers": { - "Operation-Location": "{Endpoint}/language/analyze-conversation/jobs/{jobId}?api-version=2023-11-15-preview" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2023-11-15-preview/SuccessfulConversationPIISubmit.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2023-11-15-preview/SuccessfulConversationPIISubmit.json deleted file mode 100644 index d94e207ea7c9..000000000000 --- a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2023-11-15-preview/SuccessfulConversationPIISubmit.json +++ /dev/null @@ -1,76 +0,0 @@ -{ - "operationId": "AnalyzeConversationsSubmitJob", - "title": "SuccessfulConversationPIISubmit", - "parameters": { - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2023-11-15-preview", - "Endpoint": "{Endpoint}", - "jobId": "{Job ID}", - "body": { - "displayName": "Redacting PII data from transcribed audio", - "analysisInput": { - "conversations": [ - { - "id": "1", - "language": "en", - "modality": "transcript", - "domain": "generic", - "conversationItems": [ - { - "participantId": "1", - "id": "1", - "text": "Good morning John Doe.", - "itn": "good morning john doe", - "maskedItn": "good morning john doe", - "lexical": "good morning john doe", - "wordLevelTimings": [ - { - "word": "good", - "offset": 390000, - "duration": 2700000 - }, - { - "word": "morning", - "offset": 4500000, - "duration": 920000 - }, - { - "word": "john", - "offset": 590000, - "duration": 2700000 - }, - { - "word": "doe", - "offset": 6300000, - "duration": 920000 - } - ] - } - ] - } - ] - }, - "tasks": [ - { - "taskName": "Conversation PII", - "kind": "ConversationalPIITask", - "parameters": { - "modelVersion": "latest", - "piiCategories": [ - "All" - ], - "redactionSource": "lexical", - "redactAudioTiming": true - } - } - ] - } - }, - "responses": { - "202": { - "headers": { - "Operation-Location": "{Endpoint}/language/analyze-conversation/jobs/{jobId}?api-version=2023-11-15-preview" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2023-11-15-preview/SuccessfulConversationPIITaskStatusRequest.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2023-11-15-preview/SuccessfulConversationPIITaskStatusRequest.json deleted file mode 100644 index e379a775a24a..000000000000 --- a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2023-11-15-preview/SuccessfulConversationPIITaskStatusRequest.json +++ /dev/null @@ -1,76 +0,0 @@ -{ - "operationId": "AnalyzeConversationsJobStatus", - "title": "SuccessfulConversationPIITaskStatusRequest", - "parameters": { - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2023-11-15-preview", - "Endpoint": "{Endpoint}", - "jobId": "c0f2a446-05d9-48fc-ba8f-3ef4af8d0b18" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "createdDateTime": "2020-10-01T15:00:45Z", - "displayName": "Redacting PII from transcribed audio", - "expirationDateTime": "2020-10-03T15:01:03Z", - "jobId": "c0f2a446-05d9-48fc-ba8f-3ef4af8d0b18", - "lastUpdatedDateTime": "2022-01-25T15:01:03Z", - "status": "succeeded", - "tasks": { - "completed": 1, - "failed": 0, - "inProgress": 0, - "total": 1, - "items": [ - { - "kind": "conversationalPIIResults", - "taskName": "Conversation PII", - "lastUpdateDateTime": "2022-01-25T15:01:03Z", - "status": "succeeded", - "results": { - "conversations": [ - { - "id": "1", - "conversationItems": [ - { - "id": "1", - "redactedContent": { - "text": "Good morning *************.", - "itn": "good morning *************", - "maskedItn": "good morning *************", - "lexical": "good morning *************", - "audioTimings": [ - { - "offset": 590000, - "duration": 920000 - } - ] - }, - "entities": [ - { - "category": "Person", - "confidenceScore": 0.91, - "length": 8, - "offset": 13, - "text": "john doe" - } - ] - } - ], - "warnings": [], - "statistics": { - "transactionsCount": 1 - } - } - ], - "errors": [], - "modelVersion": "2022-05-15-preview" - } - } - ] - } - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2023-11-15-preview/SuccessfulConversationSentimentSubmit.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2023-11-15-preview/SuccessfulConversationSentimentSubmit.json deleted file mode 100644 index cd06fcaf794c..000000000000 --- a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2023-11-15-preview/SuccessfulConversationSentimentSubmit.json +++ /dev/null @@ -1,49 +0,0 @@ -{ - "operationId": "AnalyzeConversationsSubmitJob", - "title": "SuccessfulConversationSentimentSubmit", - "parameters": { - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2023-11-15-preview", - "Endpoint": "{Endpoint}", - "jobId": "{Job ID}", - "body": { - "displayName": "Sentiment Analysis from a call center conversation", - "analysisInput": { - "conversations": [ - { - "id": "1", - "language": "en", - "modality": "transcript", - "conversationItems": [ - { - "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", - "itn": "", - "maskedItn": "" - } - ] - } - ] - }, - "tasks": [ - { - "taskName": "Conversation Sentiment Analysis", - "kind": "ConversationalSentimentTask", - "parameters": { - "modelVersion": "latest", - "predictionSource": "text" - } - } - ] - } - }, - "responses": { - "202": { - "headers": { - "Operation-Location": "{Endpoint}/language/analyze-conversation/jobs/{jobId}?api-version=2023-11-15-preview" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2023-11-15-preview/SuccessfulConversationSentimentTaskStatusRequest.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2023-11-15-preview/SuccessfulConversationSentimentTaskStatusRequest.json deleted file mode 100644 index 33bfb6c2f6bb..000000000000 --- a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2023-11-15-preview/SuccessfulConversationSentimentTaskStatusRequest.json +++ /dev/null @@ -1,62 +0,0 @@ -{ - "operationId": "AnalyzeConversationsJobStatus", - "title": "SuccessfulConversationSentimentTaskStatusRequest", - "parameters": { - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2023-11-15-preview", - "Endpoint": "{Endpoint}", - "jobId": "c0f2a446-05d9-48fc-ba8f-3ef4af8d0b18" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "createdDateTime": "2022-04-01T15:00:45Z", - "displayName": "Sentiment Analysis from a call center conversation", - "expirationDateTime": "2022-04-01T15:00:45Z", - "jobId": "c0f2a446-05d9-48fc-ba8f-3ef4af8d0b18", - "lastUpdatedDateTime": "2022-04-01T15:00:45Z", - "status": "succeeded", - "tasks": { - "completed": 1, - "failed": 0, - "inProgress": 0, - "total": 1, - "items": [ - { - "kind": "conversationalSentimentResults", - "taskName": "Conversation Sentiment", - "lastUpdateDateTime": "2022-04-01T15:00:45Z", - "status": "succeeded", - "results": { - "conversations": [ - { - "id": "1", - "conversationItems": [ - { - "id": "1", - "participantId": "agent_1", - "sentiment": "mixed", - "confidenceScores": { - "positive": 0.5, - "neutral": 0.01, - "negative": 0.49 - } - } - ], - "warnings": [], - "statistics": { - "transactionsCount": 1 - } - } - ], - "errors": [], - "modelVersion": "2023-11-15-preview" - } - } - ] - } - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2023-11-15-preview/SuccessfulConversationSummarizationTaskResult.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2023-11-15-preview/SuccessfulConversationSummarizationTaskResult.json deleted file mode 100644 index 73d39d18dd18..000000000000 --- a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2023-11-15-preview/SuccessfulConversationSummarizationTaskResult.json +++ /dev/null @@ -1,77 +0,0 @@ -{ - "operationId": "AnalyzeConversationsJobStatus", - "title": "SuccessfulConversationSummarizationTaskResult", - "parameters": { - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2023-11-15-preview", - "Endpoint": "{Endpoint}", - "jobId": "3e9e8518-492f-47f9-abd1-9a7468231086" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "displayName": "Conversation Summarization Example", - "createdDateTime": "2022-04-01T15:00:45Z", - "expirationDateTime": "2022-04-02T15:00:45Z", - "jobId": "3e9e8518-492f-47f9-abd1-9a7468231086", - "lastUpdatedDateTime": "2022-04-01T15:00:49Z", - "status": "succeeded", - "tasks": { - "completed": 1, - "failed": 0, - "inProgress": 0, - "total": 1, - "items": [ - { - "kind": "ConversationalSummarizationResults", - "lastUpdateDateTime": "2022-04-01T15:00:49Z", - "taskName": "Conversation Summarization Task 1", - "status": "succeeded", - "results": { - "conversations": [ - { - "id": "1", - "summaries": [ - { - "aspect": "chapterTitle", - "text": "Bug Triage", - "contexts": [ - { - "conversationItemId": "2", - "offset": 4, - "length": 39 - } - ] - }, - { - "aspect": "narrative", - "text": "Speaker 3 believes there are 3 remaining bugs.", - "contexts": [ - { - "conversationItemId": "2", - "offset": 4, - "length": 39 - }, - { - "conversationItemId": "3", - "offset": 0, - "length": 7 - } - ] - } - ], - "warnings": [] - } - ], - "errors": [], - "modelVersion": "latest" - } - } - ] - }, - "nextLink": "/language/analyze-conversation/jobs/3e9e8518-492f-47f9-abd1-9a7468231086?$skip=10&$top=10" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2023-11-15-preview/SuccessfulConversationSummarizationTaskStatusRequest.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2023-11-15-preview/SuccessfulConversationSummarizationTaskStatusRequest.json deleted file mode 100644 index 07718a8f8779..000000000000 --- a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2023-11-15-preview/SuccessfulConversationSummarizationTaskStatusRequest.json +++ /dev/null @@ -1,61 +0,0 @@ -{ - "operationId": "AnalyzeConversationsJobStatus", - "title": "SuccessfulConversationSummarizationTaskStatusRequest", - "parameters": { - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2023-11-15-preview", - "Endpoint": "{Endpoint}", - "jobId": "c0f2a446-05d9-48fc-ba8f-3ef4af8d0b18" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "displayName": "Analyze chat", - "createdDateTime": "2022-04-01T15:00:45Z", - "expirationDateTime": "2022-04-02T15:00:45Z", - "jobId": "3e9e8518-492f-47f9-abd1-9a7468231086", - "lastUpdatedDateTime": "2022-04-01T15:00:49Z", - "status": "succeeded", - "tasks": { - "completed": 1, - "failed": 0, - "inProgress": 0, - "total": 1, - "items": [ - { - "kind": "conversationalSummarizationResults", - "lastUpdateDateTime": "2022-04-01T15:00:49Z", - "taskName": "analyze 1", - "status": "succeeded", - "results": { - "conversations": [ - { - "id": "20220101meeting", - "summaries": [ - { - "aspect": "issue", - "text": "Customer wants to cancel his subscription. Customer doesn't know how" - }, - { - "aspect": "resolution", - "text": "pii Auto-Fortify. \npii Gamertag.\npii E-mail.\nCanceled customer's subscription" - } - ], - "warnings": [], - "statistics": { - "transactionsCount": 1 - } - } - ], - "errors": [], - "modelVersion": "latest" - } - } - ] - }, - "nextLink": "/language/analyze-conversation/jobs/3e9e8518-492f-47f9-abd1-9a7468231086?$skip=10&$top=10" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2023-11-15-preview/SuccessfulConversationSummarizationTaskSubmit.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2023-11-15-preview/SuccessfulConversationSummarizationTaskSubmit.json deleted file mode 100644 index fb8d74f4917b..000000000000 --- a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2023-11-15-preview/SuccessfulConversationSummarizationTaskSubmit.json +++ /dev/null @@ -1,79 +0,0 @@ -{ - "operationId": "AnalyzeConversationsSubmitJob", - "title": "SuccessfulConversationSummarizationTaskSubmit", - "parameters": { - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2023-11-15-preview", - "Endpoint": "{Endpoint}", - "jobId": "{Job ID}", - "body": { - "displayName": "Conversation Summarization Example", - "analysisInput": { - "conversations": [ - { - "id": "1", - "language": "en", - "modality": "transcript", - "conversationItems": [ - { - "participantId": "speaker 1", - "id": "1", - "text": "Let's get started.", - "lexical": "", - "itn": "", - "maskedItn": "", - "conversationItemLevelTiming": { - "offset": 0, - "duration": 20000000 - } - }, - { - "participantId": "speaker 2", - "id": "2", - "text": "OK. How many remaining bugs do we have now?", - "lexical": "", - "itn": "", - "maskedItn": "", - "conversationItemLevelTiming": { - "offset": 20000000, - "duration": 50000000 - } - }, - { - "participantId": "speaker 3", - "id": "3", - "text": "Only 3.", - "lexical": "", - "itn": "", - "maskedItn": "", - "conversationItemLevelTiming": { - "offset": 50000000, - "duration": 60000000 - } - } - ] - } - ] - }, - "tasks": [ - { - "taskName": "Conversation Summarization Task 1", - "kind": "ConversationalSummarizationTask", - "parameters": { - "summaryAspects": [ - "chapterTitle", - "narrative" - ] - } - } - ] - } - }, - "responses": { - "202": { - "headers": { - "Operation-Location": "{Endpoint}/language/analyze-conversation/jobs/{jobId}?api-version=2023-11-15-preview" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2023-11-15-preview/SuccessfulConversationSummarySubmit.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2023-11-15-preview/SuccessfulConversationSummarySubmit.json deleted file mode 100644 index 1d06f87a2bed..000000000000 --- a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2023-11-15-preview/SuccessfulConversationSummarySubmit.json +++ /dev/null @@ -1,63 +0,0 @@ -{ - "operationId": "AnalyzeConversationsSubmitJob", - "title": "SuccessfulConversationSummarySubmit", - "parameters": { - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2023-11-15-preview", - "Endpoint": "{Endpoint}", - "jobId": "{Job ID}", - "body": { - "displayName": "Analyze conversations from Contoso meeting", - "analysisInput": { - "conversations": [ - { - "id": "20220101meeting", - "language": "en", - "modality": "text", - "domain": "generic", - "conversationItems": [ - { - "participantId": "user", - "role": "customer", - "id": "1", - "text": "Hi!" - }, - { - "participantId": "agent", - "role": "agent", - "id": "2", - "text": "Hello, how can I help you?" - }, - { - "participantId": "user", - "role": "customer", - "id": "3", - "text": "I am having trouble issuing a return of a game on my xbox: call of duty" - } - ] - } - ] - }, - "tasks": [ - { - "taskName": "analyze 1", - "kind": "ConversationalSummarizationTask", - "parameters": { - "modelVersion": "latest", - "summaryAspects": [ - "issue", - "resolution" - ] - } - } - ] - } - }, - "responses": { - "202": { - "headers": { - "Operation-Location": "{Endpoint}/language/analyze-conversation/jobs/{jobId}?api-version=2023-11-15-preview" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2023-11-15-preview/SuccessfulCustomConversationSummarizationTaskResult.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2023-11-15-preview/SuccessfulCustomConversationSummarizationTaskResult.json deleted file mode 100644 index 5ce4948fe18d..000000000000 --- a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2023-11-15-preview/SuccessfulCustomConversationSummarizationTaskResult.json +++ /dev/null @@ -1,66 +0,0 @@ -{ - "operationId": "AnalyzeConversationsJobStatus", - "title": "SuccessfulCustomConversationSummarizationTaskResult", - "parameters": { - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2023-11-15-preview", - "Endpoint": "{Endpoint}", - "jobId": "3e9e8518-492f-47f9-abd1-9a7468231086" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "displayName": "Custom Conversation Summarization Example", - "createdDateTime": "2022-04-01T15:00:45Z", - "expirationDateTime": "2022-04-02T15:00:45Z", - "jobId": "3e9e8518-492f-47f9-abd1-9a7468231086", - "lastUpdatedDateTime": "2022-04-01T15:00:49Z", - "status": "succeeded", - "tasks": { - "completed": 1, - "failed": 0, - "inProgress": 0, - "total": 1, - "items": [ - { - "kind": "CustomConversationalSummarizationResults", - "lastUpdateDateTime": "2022-04-01T15:00:49Z", - "taskName": "Custom Conversation Summarization Task 1", - "status": "succeeded", - "results": { - "conversations": [ - { - "id": "1", - "summaries": [ - { - "aspect": "narrative", - "text": "Speaker 3 believes there are 3 remaining bugs.", - "contexts": [ - { - "conversationItemId": "2", - "offset": 4, - "length": 39 - }, - { - "conversationItemId": "3", - "offset": 0, - "length": 7 - } - ] - } - ], - "warnings": [] - } - ], - "errors": [], - "projectName": "my_project", - "deploymentName": "my_deployment" - } - } - ] - } - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2023-11-15-preview/SuccessfulCustomConversationSummarizationTaskSubmit.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2023-11-15-preview/SuccessfulCustomConversationSummarizationTaskSubmit.json deleted file mode 100644 index d68630c0ab7e..000000000000 --- a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2023-11-15-preview/SuccessfulCustomConversationSummarizationTaskSubmit.json +++ /dev/null @@ -1,80 +0,0 @@ -{ - "operationId": "AnalyzeConversationsSubmitJob", - "title": "SuccessfulCustomConversationSummarizationTaskSubmit", - "parameters": { - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2023-11-15-preview", - "Endpoint": "{Endpoint}", - "jobId": "{Job ID}", - "body": { - "displayName": "Custom Conversation Summarization Example", - "analysisInput": { - "conversations": [ - { - "id": "1", - "language": "en", - "modality": "transcript", - "conversationItems": [ - { - "participantId": "speaker 1", - "id": "1", - "text": "Let's get started.", - "lexical": "", - "itn": "", - "maskedItn": "", - "conversationItemLevelTiming": { - "offset": 0, - "duration": 20000000 - } - }, - { - "participantId": "speaker 2", - "id": "2", - "text": "OK. How many remaining bugs do we have now?", - "lexical": "", - "itn": "", - "maskedItn": "", - "conversationItemLevelTiming": { - "offset": 20000000, - "duration": 50000000 - } - }, - { - "participantId": "speaker 3", - "id": "3", - "text": "Only 3.", - "lexical": "", - "itn": "", - "maskedItn": "", - "conversationItemLevelTiming": { - "offset": 50000000, - "duration": 60000000 - } - } - ] - } - ] - }, - "tasks": [ - { - "taskName": "Custom Conversation Summarization Task 1", - "kind": "CustomConversationalSummarizationTask", - "parameters": { - "summaryAspects": [ - "narrative" - ], - "projectName": "my_project", - "deploymentName": "my_deployment" - } - } - ] - } - }, - "responses": { - "202": { - "headers": { - "Operation-Location": "{Endpoint}/language/analyze-conversation/jobs/{jobId}?api-version=2023-11-15-preview" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2024-05-15-preview/SuccessfulAnalyzeConversationsArbitration.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2024-05-15-preview/SuccessfulAnalyzeConversationsArbitration.json deleted file mode 100644 index 33018615d1b3..000000000000 --- a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2024-05-15-preview/SuccessfulAnalyzeConversationsArbitration.json +++ /dev/null @@ -1,76 +0,0 @@ -{ - "operationId": "AnalyzeConversations", - "title": "SuccessfulAnalyzeConversationsArbitration", - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "Content-Type": "application/json", - "api-version": "2024-05-15-preview", - "body": { - "kind": "Conversation", - "analysisInput": { - "conversationItem": { - "participantId": "1", - "id": "1", - "modality": "text", - "language": "en-GB", - "text": "How do I integrate QnA Maker and LUIS?" - } - }, - "parameters": { - "projectName": "{project-name}", - "deploymentName": "{deployment-name}", - "verbose": true, - "isLoggingEnabled": false, - "stringIndexType": "TextElement_V8" - } - } - }, - "responses": { - "200": { - "headers": {}, - "body": { - "kind": "ConversationResult", - "result": { - "query": "trains from London", - "prediction": { - "topIntent": "Rail", - "projectKind": "Orchestration", - "intents": { - "Rail": { - "confidenceScore": 1, - "targetProjectKind": "Conversation", - "result": { - "query": "trains from London", - "prediction": { - "topIntent": "Timetable", - "projectKind": "Conversation", - "intents": [ - { - "category": "Timetable", - "confidenceScore": 0.99968535 - }, - { - "category": "Locomotive", - "confidenceScore": 0.000314623 - } - ], - "entities": [] - } - } - }, - "Tree": { - "confidenceScore": 0.2641529, - "targetProjectKind": "QuestionAnswering" - }, - "None": { - "confidenceScore": 0, - "targetProjectKind": "NonLinked" - } - } - } - } - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2024-05-15-preview/SuccessfulConversationPIIExclusionTaskStatusRequest.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2024-05-15-preview/SuccessfulConversationPIIExclusionTaskStatusRequest.json deleted file mode 100644 index 9e7801933ebc..000000000000 --- a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2024-05-15-preview/SuccessfulConversationPIIExclusionTaskStatusRequest.json +++ /dev/null @@ -1,68 +0,0 @@ -{ - "operationId": "AnalyzeConversationsJobStatus", - "title": "SuccessfulConversationPIIExclusionTaskStatusRequest", - "parameters": { - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2024-05-15-preview", - "Endpoint": "{Endpoint}", - "jobId": "c0f2a446-05d9-48fc-ba8f-3ef4af8d0b18" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "createdDateTime": "2020-10-01T15:00:45Z", - "displayName": "Redacting PII from transcribed audio", - "expirationDateTime": "2020-10-03T15:01:03Z", - "jobId": "c0f2a446-05d9-48fc-ba8f-3ef4af8d0b18", - "lastUpdatedDateTime": "2022-01-25T15:01:03Z", - "status": "succeeded", - "tasks": { - "completed": 1, - "failed": 0, - "inProgress": 0, - "total": 1, - "items": [ - { - "kind": "conversationalPIIResults", - "taskName": "Conversation PII", - "lastUpdateDateTime": "2022-01-25T15:01:03Z", - "status": "succeeded", - "results": { - "conversations": [ - { - "id": "1", - "conversationItems": [ - { - "id": "1", - "redactedContent": { - "text": "Good morning *************.", - "itn": "good morning *************", - "maskedItn": "good morning *************", - "lexical": "good morning *************", - "audioTimings": [ - { - "offset": 590000, - "duration": 920000 - } - ] - }, - "entities": [] - } - ], - "warnings": [], - "statistics": { - "transactionsCount": 1 - } - } - ], - "errors": [], - "modelVersion": "2022-05-15-preview" - } - } - ] - } - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2024-05-15-preview/SuccessfulConversationPIIRedactionCharTaskStatusRequest.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2024-05-15-preview/SuccessfulConversationPIIRedactionCharTaskStatusRequest.json deleted file mode 100644 index e2b3ea2499ad..000000000000 --- a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2024-05-15-preview/SuccessfulConversationPIIRedactionCharTaskStatusRequest.json +++ /dev/null @@ -1,76 +0,0 @@ -{ - "operationId": "AnalyzeConversationsJobStatus", - "title": "SuccessfulConversationPIIRedactionCharTaskStatusRequest", - "parameters": { - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2024-05-15-preview", - "Endpoint": "{Endpoint}", - "jobId": "c0f2a446-05d9-48fc-ba8f-3ef4af8d0b18" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "createdDateTime": "2020-10-01T15:00:45Z", - "displayName": "Redacting PII from transcribed audio", - "expirationDateTime": "2020-10-03T15:01:03Z", - "jobId": "c0f2a446-05d9-48fc-ba8f-3ef4af8d0b18", - "lastUpdatedDateTime": "2022-01-25T15:01:03Z", - "status": "succeeded", - "tasks": { - "completed": 1, - "failed": 0, - "inProgress": 0, - "total": 1, - "items": [ - { - "kind": "conversationalPIIResults", - "taskName": "Conversation PII", - "lastUpdateDateTime": "2022-01-25T15:01:03Z", - "status": "succeeded", - "results": { - "conversations": [ - { - "id": "1", - "conversationItems": [ - { - "id": "1", - "redactedContent": { - "text": "Good morning -------------.", - "itn": "good morning -------------", - "maskedItn": "good morning -------------", - "lexical": "good morning -------------", - "audioTimings": [ - { - "offset": 590000, - "duration": 920000 - } - ] - }, - "entities": [ - { - "category": "Person", - "confidenceScore": 0.91, - "length": 8, - "offset": 13, - "text": "john doe" - } - ] - } - ], - "warnings": [], - "statistics": { - "transactionsCount": 1 - } - } - ], - "errors": [], - "modelVersion": "2022-05-15-preview" - } - } - ] - } - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2024-05-15-preview/SuccessfulConversationPIISubmit.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2024-05-15-preview/SuccessfulConversationPIISubmit.json deleted file mode 100644 index 56c12df8d8b5..000000000000 --- a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2024-05-15-preview/SuccessfulConversationPIISubmit.json +++ /dev/null @@ -1,76 +0,0 @@ -{ - "operationId": "AnalyzeConversationsSubmitJob", - "title": "SuccessfulConversationPIISubmit", - "parameters": { - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2024-05-15-preview", - "Endpoint": "{Endpoint}", - "jobId": "{Job ID}", - "body": { - "displayName": "Redacting PII data from transcribed audio", - "analysisInput": { - "conversations": [ - { - "id": "1", - "language": "en", - "modality": "transcript", - "domain": "generic", - "conversationItems": [ - { - "participantId": "1", - "id": "1", - "text": "Good morning John Doe.", - "itn": "good morning john doe", - "maskedItn": "good morning john doe", - "lexical": "good morning john doe", - "wordLevelTimings": [ - { - "word": "good", - "offset": 390000, - "duration": 2700000 - }, - { - "word": "morning", - "offset": 4500000, - "duration": 920000 - }, - { - "word": "john", - "offset": 590000, - "duration": 2700000 - }, - { - "word": "doe", - "offset": 6300000, - "duration": 920000 - } - ] - } - ] - } - ] - }, - "tasks": [ - { - "taskName": "Conversation PII", - "kind": "ConversationalPIITask", - "parameters": { - "modelVersion": "latest", - "piiCategories": [ - "All" - ], - "redactionSource": "lexical", - "redactAudioTiming": true - } - } - ] - } - }, - "responses": { - "202": { - "headers": { - "Operation-Location": "{Endpoint}/language/analyze-conversation/jobs/{jobId}?api-version=2024-05-15-preview" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2024-05-15-preview/SuccessfulConversationPIITaskStatusRequest.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2024-05-15-preview/SuccessfulConversationPIITaskStatusRequest.json deleted file mode 100644 index c9c0ce430777..000000000000 --- a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2024-05-15-preview/SuccessfulConversationPIITaskStatusRequest.json +++ /dev/null @@ -1,76 +0,0 @@ -{ - "operationId": "AnalyzeConversationsJobStatus", - "title": "SuccessfulConversationPIITaskStatusRequest", - "parameters": { - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2024-05-15-preview", - "Endpoint": "{Endpoint}", - "jobId": "c0f2a446-05d9-48fc-ba8f-3ef4af8d0b18" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "createdDateTime": "2020-10-01T15:00:45Z", - "displayName": "Redacting PII from transcribed audio", - "expirationDateTime": "2020-10-03T15:01:03Z", - "jobId": "c0f2a446-05d9-48fc-ba8f-3ef4af8d0b18", - "lastUpdatedDateTime": "2022-01-25T15:01:03Z", - "status": "succeeded", - "tasks": { - "completed": 1, - "failed": 0, - "inProgress": 0, - "total": 1, - "items": [ - { - "kind": "conversationalPIIResults", - "taskName": "Conversation PII", - "lastUpdateDateTime": "2022-01-25T15:01:03Z", - "status": "succeeded", - "results": { - "conversations": [ - { - "id": "1", - "conversationItems": [ - { - "id": "1", - "redactedContent": { - "text": "Good morning *************.", - "itn": "good morning *************", - "maskedItn": "good morning *************", - "lexical": "good morning *************", - "audioTimings": [ - { - "offset": 590000, - "duration": 920000 - } - ] - }, - "entities": [ - { - "category": "Person", - "confidenceScore": 0.91, - "length": 8, - "offset": 13, - "text": "john doe" - } - ] - } - ], - "warnings": [], - "statistics": { - "transactionsCount": 1 - } - } - ], - "errors": [], - "modelVersion": "2022-05-15-preview" - } - } - ] - } - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2024-05-15-preview/SuccessfulConversationSummarizationTaskResult.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2024-05-15-preview/SuccessfulConversationSummarizationTaskResult.json deleted file mode 100644 index eca89232337e..000000000000 --- a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2024-05-15-preview/SuccessfulConversationSummarizationTaskResult.json +++ /dev/null @@ -1,77 +0,0 @@ -{ - "operationId": "AnalyzeConversationsJobStatus", - "title": "SuccessfulConversationSummarizationTaskResult", - "parameters": { - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2024-05-15-preview", - "Endpoint": "{Endpoint}", - "jobId": "3e9e8518-492f-47f9-abd1-9a7468231086" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "displayName": "Conversation Summarization Example", - "createdDateTime": "2022-04-01T15:00:45Z", - "expirationDateTime": "2022-04-02T15:00:45Z", - "jobId": "3e9e8518-492f-47f9-abd1-9a7468231086", - "lastUpdatedDateTime": "2022-04-01T15:00:49Z", - "status": "succeeded", - "tasks": { - "completed": 1, - "failed": 0, - "inProgress": 0, - "total": 1, - "items": [ - { - "kind": "conversationalSummarizationResults", - "lastUpdateDateTime": "2022-04-01T15:00:49Z", - "taskName": "Conversation Summarization Task 1", - "status": "succeeded", - "results": { - "conversations": [ - { - "id": "1", - "summaries": [ - { - "aspect": "chapterTitle", - "text": "Bug Triage", - "contexts": [ - { - "conversationItemId": "2", - "offset": 4, - "length": 39 - } - ] - }, - { - "aspect": "narrative", - "text": "Speaker 3 believes there are 3 remaining bugs.", - "contexts": [ - { - "conversationItemId": "2", - "offset": 4, - "length": 39 - }, - { - "conversationItemId": "3", - "offset": 0, - "length": 7 - } - ] - } - ], - "warnings": [] - } - ], - "errors": [], - "modelVersion": "latest" - } - } - ] - }, - "nextLink": "/language/analyze-conversation/jobs/3e9e8518-492f-47f9-abd1-9a7468231086?$skip=10&$top=10" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2024-05-15-preview/SuccessfulConversationSummarizationTaskStatusRequest.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2024-05-15-preview/SuccessfulConversationSummarizationTaskStatusRequest.json deleted file mode 100644 index 2cb92a853eda..000000000000 --- a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2024-05-15-preview/SuccessfulConversationSummarizationTaskStatusRequest.json +++ /dev/null @@ -1,61 +0,0 @@ -{ - "operationId": "AnalyzeConversationsJobStatus", - "title": "SuccessfulConversationSummarizationTaskStatusRequest", - "parameters": { - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2024-05-15-preview", - "Endpoint": "{Endpoint}", - "jobId": "c0f2a446-05d9-48fc-ba8f-3ef4af8d0b18" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "displayName": "Analyze chat", - "createdDateTime": "2022-04-01T15:00:45Z", - "expirationDateTime": "2022-04-02T15:00:45Z", - "jobId": "3e9e8518-492f-47f9-abd1-9a7468231086", - "lastUpdatedDateTime": "2022-04-01T15:00:49Z", - "status": "succeeded", - "tasks": { - "completed": 1, - "failed": 0, - "inProgress": 0, - "total": 1, - "items": [ - { - "kind": "conversationalSummarizationResults", - "lastUpdateDateTime": "2022-04-01T15:00:49Z", - "taskName": "analyze 1", - "status": "succeeded", - "results": { - "conversations": [ - { - "id": "20220101meeting", - "summaries": [ - { - "aspect": "issue", - "text": "Customer wants to cancel his subscription. Customer doesn't know how" - }, - { - "aspect": "resolution", - "text": "pii Auto-Fortify. \npii Gamertag.\npii E-mail.\nCanceled customer's subscription" - } - ], - "warnings": [], - "statistics": { - "transactionsCount": 1 - } - } - ], - "errors": [], - "modelVersion": "latest" - } - } - ] - }, - "nextLink": "/language/analyze-conversation/jobs/3e9e8518-492f-47f9-abd1-9a7468231086?$skip=10&$top=10" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2024-05-15-preview/SuccessfulCustomConversationSummarizationTaskResult.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2024-05-15-preview/SuccessfulCustomConversationSummarizationTaskResult.json deleted file mode 100644 index bd961e99ed76..000000000000 --- a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2024-05-15-preview/SuccessfulCustomConversationSummarizationTaskResult.json +++ /dev/null @@ -1,66 +0,0 @@ -{ - "operationId": "AnalyzeConversationsJobStatus", - "title": "SuccessfulCustomConversationSummarizationTaskResult", - "parameters": { - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2024-05-15-preview", - "Endpoint": "{Endpoint}", - "jobId": "3e9e8518-492f-47f9-abd1-9a7468231086" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "displayName": "Custom Conversation Summarization Example", - "createdDateTime": "2022-04-01T15:00:45Z", - "expirationDateTime": "2022-04-02T15:00:45Z", - "jobId": "3e9e8518-492f-47f9-abd1-9a7468231086", - "lastUpdatedDateTime": "2022-04-01T15:00:49Z", - "status": "succeeded", - "tasks": { - "completed": 1, - "failed": 0, - "inProgress": 0, - "total": 1, - "items": [ - { - "kind": "customConversationalSummarizationResults", - "lastUpdateDateTime": "2022-04-01T15:00:49Z", - "taskName": "Custom Conversation Summarization Task 1", - "status": "succeeded", - "results": { - "conversations": [ - { - "id": "1", - "summaries": [ - { - "aspect": "narrative", - "text": "Speaker 3 believes there are 3 remaining bugs.", - "contexts": [ - { - "conversationItemId": "2", - "offset": 4, - "length": 39 - }, - { - "conversationItemId": "3", - "offset": 0, - "length": 7 - } - ] - } - ], - "warnings": [] - } - ], - "errors": [], - "projectName": "my_project", - "deploymentName": "my_deployment" - } - } - ] - } - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2024-05-15-preview/SuccessfulCustomConversationSummarizationTaskSubmit.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2024-05-15-preview/SuccessfulCustomConversationSummarizationTaskSubmit.json deleted file mode 100644 index e8110f83f168..000000000000 --- a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2024-05-15-preview/SuccessfulCustomConversationSummarizationTaskSubmit.json +++ /dev/null @@ -1,80 +0,0 @@ -{ - "operationId": "AnalyzeConversationsSubmitJob", - "title": "SuccessfulCustomConversationSummarizationTaskSubmit", - "parameters": { - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2024-05-15-preview", - "Endpoint": "{Endpoint}", - "jobId": "{Job ID}", - "body": { - "displayName": "Custom Conversation Summarization Example", - "analysisInput": { - "conversations": [ - { - "id": "1", - "language": "en", - "modality": "transcript", - "conversationItems": [ - { - "participantId": "speaker 1", - "id": "1", - "text": "Let's get started.", - "lexical": "", - "itn": "", - "maskedItn": "", - "conversationItemLevelTiming": { - "offset": 0, - "duration": 20000000 - } - }, - { - "participantId": "speaker 2", - "id": "2", - "text": "OK. How many remaining bugs do we have now?", - "lexical": "", - "itn": "", - "maskedItn": "", - "conversationItemLevelTiming": { - "offset": 20000000, - "duration": 50000000 - } - }, - { - "participantId": "speaker 3", - "id": "3", - "text": "Only 3.", - "lexical": "", - "itn": "", - "maskedItn": "", - "conversationItemLevelTiming": { - "offset": 50000000, - "duration": 60000000 - } - } - ] - } - ] - }, - "tasks": [ - { - "taskName": "Custom Conversation Summarization Task 1", - "kind": "CustomConversationalSummarizationTask", - "parameters": { - "summaryAspects": [ - "narrative" - ], - "projectName": "my_project", - "deploymentName": "my_deployment" - } - } - ] - } - }, - "responses": { - "202": { - "headers": { - "Operation-Location": "{Endpoint}/language/analyze-conversation/jobs/{jobId}?api-version=2024-05-15-preview" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2024-11-15-preview/SuccessfulAnalyzeConversations.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2024-11-15-preview/SuccessfulAnalyzeConversations.json deleted file mode 100644 index 8616101b455b..000000000000 --- a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2024-11-15-preview/SuccessfulAnalyzeConversations.json +++ /dev/null @@ -1,120 +0,0 @@ -{ - "operationId": "AnalyzeConversations", - "title": "SuccessfulAnalyzeConversations", - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "Content-Type": "application/json", - "api-version": "2024-11-15-preview", - "body": { - "kind": "Conversation", - "analysisInput": { - "conversationItem": { - "id": "1", - "participantId": "1", - "text": "Book a flight to Seattle on Oct 10th" - } - }, - "parameters": { - "projectName": "{project-name}", - "deploymentName": "{deployment-name}", - "stringIndexType": "TextElement_V8" - } - } - }, - "responses": { - "200": { - "headers": {}, - "body": { - "kind": "ConversationResult", - "result": { - "query": "Book a flight to Seattle on Oct 10th", - "prediction": { - "topIntent": "BookFlight", - "projectKind": "Conversation", - "intents": [ - { - "category": "None", - "confidenceScore": 1 - }, - { - "category": "BookTrain", - "confidenceScore": 0 - }, - { - "category": "BookFlight", - "confidenceScore": 0 - } - ], - "entities": [ - { - "category": "Geography.Location", - "text": "seattle", - "offset": 17, - "length": 7, - "confidenceScore": 1, - "extraInformation": [ - { - "extraInformationKind": "EntitySubtype", - "value": "geography.location", - "tags": [ - { - "name": "City", - "confidenceScore": 1 - }, - { - "name": "GPE", - "confidenceScore": 1 - }, - { - "name": "Location", - "confidenceScore": 1 - } - ] - } - ] - }, - { - "category": "DateTime", - "text": "oct 10th", - "offset": 28, - "length": 8, - "confidenceScore": 1, - "resolutions": [ - { - "resolutionKind": "DateTimeResolution", - "dateTimeSubKind": "Date", - "timex": "XXXX-10-10", - "value": "2023-10-10" - }, - { - "resolutionKind": "DateTimeResolution", - "dateTimeSubKind": "Date", - "timex": "XXXX-10-10", - "value": "2024-10-10" - } - ], - "extraInformation": [ - { - "extraInformationKind": "EntitySubtype", - "value": "datetime.date", - "tags": [ - { - "name": "Date", - "confidenceScore": 1 - }, - { - "name": "Temporal", - "confidenceScore": 1 - } - ] - } - ] - } - ] - } - } - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2024-11-15-preview/SuccessfulAnalyzeConversationsArbitration.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2024-11-15-preview/SuccessfulAnalyzeConversationsArbitration.json deleted file mode 100644 index e53d1e73b0df..000000000000 --- a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2024-11-15-preview/SuccessfulAnalyzeConversationsArbitration.json +++ /dev/null @@ -1,76 +0,0 @@ -{ - "operationId": "AnalyzeConversations", - "title": "SuccessfulAnalyzeConversationsArbitration", - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "Content-Type": "application/json", - "api-version": "2024-11-15-preview", - "body": { - "kind": "Conversation", - "analysisInput": { - "conversationItem": { - "participantId": "1", - "id": "1", - "modality": "text", - "language": "en-GB", - "text": "How do I integrate QnA Maker and LUIS?" - } - }, - "parameters": { - "projectName": "{project-name}", - "deploymentName": "{deployment-name}", - "verbose": true, - "isLoggingEnabled": false, - "stringIndexType": "TextElement_V8" - } - } - }, - "responses": { - "200": { - "headers": {}, - "body": { - "kind": "ConversationResult", - "result": { - "query": "trains from London", - "prediction": { - "topIntent": "Rail", - "projectKind": "Orchestration", - "intents": { - "Rail": { - "confidenceScore": 1, - "targetProjectKind": "Conversation", - "result": { - "query": "trains from London", - "prediction": { - "topIntent": "Timetable", - "projectKind": "Conversation", - "intents": [ - { - "category": "Timetable", - "confidenceScore": 0.99968535 - }, - { - "category": "Locomotive", - "confidenceScore": 0.000314623 - } - ], - "entities": [] - } - } - }, - "Tree": { - "confidenceScore": 0.2641529, - "targetProjectKind": "QuestionAnswering" - }, - "None": { - "confidenceScore": 0, - "targetProjectKind": "NonLinked" - } - } - } - } - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2024-11-15-preview/SuccessfulAnalyzeConversationsArbitrationDirectTarget.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2024-11-15-preview/SuccessfulAnalyzeConversationsArbitrationDirectTarget.json deleted file mode 100644 index c7fa63683056..000000000000 --- a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2024-11-15-preview/SuccessfulAnalyzeConversationsArbitrationDirectTarget.json +++ /dev/null @@ -1,77 +0,0 @@ -{ - "operationId": "AnalyzeConversations", - "title": "SuccessfulAnalyzeConversationsArbitrationDirectTarget", - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "Content-Type": "application/json", - "api-version": "2024-11-15-preview", - "body": { - "kind": "Conversation", - "analysisInput": { - "conversationItem": { - "text": "Ports and connectors", - "participantId": "1", - "id": "1" - } - }, - "parameters": { - "projectName": "prj1", - "deploymentName": "dep1", - "directTarget": "qnaProject", - "targetProjectParameters": { - "qnaProject": { - "targetProjectKind": "QuestionAnswering", - "callingOptions": { - "context": { - "previousUserQuery": "Meet Surface Pro 4", - "previousQnaId": 4 - }, - "top": 1, - "question": "App Service overview" - } - } - } - } - } - }, - "responses": { - "200": { - "headers": {}, - "body": { - "kind": "ConversationResult", - "result": { - "query": "Ports and connectors", - "prediction": { - "projectKind": "Orchestration", - "topIntent": "qnaTargetApp", - "intents": { - "qnaTargetApp": { - "targetProjectKind": "QuestionAnswering", - "confidenceScore": 1, - "result": { - "answers": [ - { - "questions": [ - "App Service overview" - ], - "answer": "The compute resources you use are determined by the *App Service plan* that you run your apps on.", - "confidenceScore": 0.7384000000000001, - "id": 1, - "source": "https://docs.microsoft.com/en-us/azure/app-service/overview", - "metadata": {}, - "dialog": { - "isContextOnly": false, - "prompts": [] - } - } - ] - } - } - } - } - } - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2024-11-15-preview/SuccessfulAnalyzeConversationsJobsCancelRequest.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2024-11-15-preview/SuccessfulAnalyzeConversationsJobsCancelRequest.json deleted file mode 100644 index 0ba9180e8ccb..000000000000 --- a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2024-11-15-preview/SuccessfulAnalyzeConversationsJobsCancelRequest.json +++ /dev/null @@ -1,17 +0,0 @@ -{ - "operationId": "AnalyzeConversationsCancelJob", - "title": "SuccessfulAnalyzeConversationsJobsCancelRequest", - "parameters": { - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2024-11-15-preview", - "Endpoint": "{Endpoint}", - "jobId": "c0f2a446-05d9-48fc-ba8f-3ef4af8d0b18" - }, - "responses": { - "202": { - "headers": { - "Operation-Location": "{Endpoint}/language/analyze-conversations/jobs/{jobId}?api-version=2024-11-15-preview" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2024-11-15-preview/SuccessfulConversationPIIExclusionSubmit.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2024-11-15-preview/SuccessfulConversationPIIExclusionSubmit.json deleted file mode 100644 index c97624b9d472..000000000000 --- a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2024-11-15-preview/SuccessfulConversationPIIExclusionSubmit.json +++ /dev/null @@ -1,76 +0,0 @@ -{ - "operationId": "AnalyzeConversationsSubmitJob", - "title": "SuccessfulConversationPIIExclusionSubmit", - "parameters": { - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2024-11-15-preview", - "Endpoint": "{Endpoint}", - "jobId": "{Job ID}", - "body": { - "displayName": "Redacting PII data from transcribed audio", - "analysisInput": { - "conversations": [ - { - "id": "1", - "language": "en", - "modality": "transcript", - "domain": "generic", - "conversationItems": [ - { - "participantId": "1", - "id": "1", - "text": "Good morning John Doe.", - "itn": "good morning john doe", - "maskedItn": "good morning john doe", - "lexical": "good morning john doe", - "wordLevelTimings": [ - { - "word": "good", - "offset": 390000, - "duration": 2700000 - }, - { - "word": "morning", - "offset": 4500000, - "duration": 920000 - }, - { - "word": "john", - "offset": 590000, - "duration": 2700000 - }, - { - "word": "doe", - "offset": 6300000, - "duration": 920000 - } - ] - } - ] - } - ] - }, - "tasks": [ - { - "taskName": "Conversation PII", - "kind": "ConversationalPIITask", - "parameters": { - "modelVersion": "latest", - "excludePiiCategories": [ - "Person" - ], - "redactionSource": "lexical", - "redactAudioTiming": true - } - } - ] - } - }, - "responses": { - "202": { - "headers": { - "Operation-Location": "{Endpoint}/language/analyze-conversation/jobs/{jobId}?api-version=2023-05-15-preview" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2024-11-15-preview/SuccessfulConversationPIIRedactionCharSubmit.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2024-11-15-preview/SuccessfulConversationPIIRedactionCharSubmit.json deleted file mode 100644 index b3c7e4333661..000000000000 --- a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2024-11-15-preview/SuccessfulConversationPIIRedactionCharSubmit.json +++ /dev/null @@ -1,77 +0,0 @@ -{ - "operationId": "AnalyzeConversationsSubmitJob", - "title": "SuccessfulConversationPIIRedactionCharSubmit", - "parameters": { - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2024-11-15-preview", - "Endpoint": "{Endpoint}", - "jobId": "{Job ID}", - "body": { - "displayName": "Redacting PII data from transcribed audio", - "analysisInput": { - "conversations": [ - { - "id": "1", - "language": "en", - "modality": "transcript", - "domain": "generic", - "conversationItems": [ - { - "participantId": "1", - "id": "1", - "text": "Good morning John Doe.", - "itn": "good morning john doe", - "maskedItn": "good morning john doe", - "lexical": "good morning john doe", - "wordLevelTimings": [ - { - "word": "good", - "offset": 390000, - "duration": 2700000 - }, - { - "word": "morning", - "offset": 4500000, - "duration": 920000 - }, - { - "word": "john", - "offset": 590000, - "duration": 2700000 - }, - { - "word": "doe", - "offset": 6300000, - "duration": 920000 - } - ] - } - ] - } - ] - }, - "tasks": [ - { - "taskName": "Conversation PII", - "kind": "ConversationalPIITask", - "parameters": { - "modelVersion": "latest", - "piiCategories": [ - "All" - ], - "redactionCharacter": "-", - "redactionSource": "lexical", - "redactAudioTiming": true - } - } - ] - } - }, - "responses": { - "202": { - "headers": { - "Operation-Location": "{Endpoint}/language/analyze-conversation/jobs/{jobId}?api-version=2024-11-15-preview" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2024-11-15-preview/SuccessfulConversationPIIRedactionCharTaskStatusRequest.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2024-11-15-preview/SuccessfulConversationPIIRedactionCharTaskStatusRequest.json deleted file mode 100644 index 5ad8363d2a85..000000000000 --- a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2024-11-15-preview/SuccessfulConversationPIIRedactionCharTaskStatusRequest.json +++ /dev/null @@ -1,76 +0,0 @@ -{ - "operationId": "AnalyzeConversationsJobStatus", - "title": "SuccessfulConversationPIIRedactionCharTaskStatusRequest", - "parameters": { - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2024-11-15-preview", - "Endpoint": "{Endpoint}", - "jobId": "c0f2a446-05d9-48fc-ba8f-3ef4af8d0b18" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "createdDateTime": "2020-10-01T15:00:45Z", - "displayName": "Redacting PII from transcribed audio", - "expirationDateTime": "2020-10-03T15:01:03Z", - "jobId": "c0f2a446-05d9-48fc-ba8f-3ef4af8d0b18", - "lastUpdatedDateTime": "2022-01-25T15:01:03Z", - "status": "succeeded", - "tasks": { - "completed": 1, - "failed": 0, - "inProgress": 0, - "total": 1, - "items": [ - { - "kind": "conversationalPIIResults", - "taskName": "Conversation PII", - "lastUpdateDateTime": "2022-01-25T15:01:03Z", - "status": "succeeded", - "results": { - "conversations": [ - { - "id": "1", - "conversationItems": [ - { - "id": "1", - "redactedContent": { - "text": "Good morning -------------.", - "itn": "good morning -------------", - "maskedItn": "good morning -------------", - "lexical": "good morning -------------", - "audioTimings": [ - { - "offset": 590000, - "duration": 920000 - } - ] - }, - "entities": [ - { - "category": "Person", - "confidenceScore": 0.91, - "length": 8, - "offset": 13, - "text": "john doe" - } - ] - } - ], - "warnings": [], - "statistics": { - "transactionsCount": 1 - } - } - ], - "errors": [], - "modelVersion": "2022-05-15-preview" - } - } - ] - } - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2024-11-15-preview/SuccessfulConversationSummarizationTaskSubmit.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2024-11-15-preview/SuccessfulConversationSummarizationTaskSubmit.json deleted file mode 100644 index a3b23cc611c1..000000000000 --- a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2024-11-15-preview/SuccessfulConversationSummarizationTaskSubmit.json +++ /dev/null @@ -1,79 +0,0 @@ -{ - "operationId": "AnalyzeConversationsSubmitJob", - "title": "SuccessfulConversationSummarizationTaskSubmit", - "parameters": { - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2024-11-15-preview", - "Endpoint": "{Endpoint}", - "jobId": "{Job ID}", - "body": { - "displayName": "Conversation Summarization Example", - "analysisInput": { - "conversations": [ - { - "id": "1", - "language": "en", - "modality": "transcript", - "conversationItems": [ - { - "participantId": "speaker 1", - "id": "1", - "text": "Let's get started.", - "lexical": "", - "itn": "", - "maskedItn": "", - "conversationItemLevelTiming": { - "offset": 0, - "duration": 20000000 - } - }, - { - "participantId": "speaker 2", - "id": "2", - "text": "OK. How many remaining bugs do we have now?", - "lexical": "", - "itn": "", - "maskedItn": "", - "conversationItemLevelTiming": { - "offset": 20000000, - "duration": 50000000 - } - }, - { - "participantId": "speaker 3", - "id": "3", - "text": "Only 3.", - "lexical": "", - "itn": "", - "maskedItn": "", - "conversationItemLevelTiming": { - "offset": 50000000, - "duration": 60000000 - } - } - ] - } - ] - }, - "tasks": [ - { - "taskName": "Conversation Summarization Task 1", - "kind": "ConversationalSummarizationTask", - "parameters": { - "summaryAspects": [ - "chapterTitle", - "narrative" - ] - } - } - ] - } - }, - "responses": { - "202": { - "headers": { - "Operation-Location": "{Endpoint}/language/analyze-conversation/jobs/{jobId}?api-version=2024-11-15-preview" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2024-11-15-preview/SuccessfulConversationSummarySubmit.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2024-11-15-preview/SuccessfulConversationSummarySubmit.json deleted file mode 100644 index 6b868c22497d..000000000000 --- a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2024-11-15-preview/SuccessfulConversationSummarySubmit.json +++ /dev/null @@ -1,63 +0,0 @@ -{ - "operationId": "AnalyzeConversationsSubmitJob", - "title": "SuccessfulConversationSummarySubmit", - "parameters": { - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2024-11-15-preview", - "Endpoint": "{Endpoint}", - "jobId": "{Job ID}", - "body": { - "displayName": "Analyze conversations from Contoso meeting", - "analysisInput": { - "conversations": [ - { - "id": "20220101meeting", - "language": "en", - "modality": "text", - "domain": "generic", - "conversationItems": [ - { - "participantId": "user", - "role": "customer", - "id": "1", - "text": "Hi!" - }, - { - "participantId": "agent", - "role": "agent", - "id": "2", - "text": "Hello, how can I help you?" - }, - { - "participantId": "user", - "role": "customer", - "id": "3", - "text": "I am having trouble issuing a return of a game on my xbox: call of duty" - } - ] - } - ] - }, - "tasks": [ - { - "taskName": "analyze 1", - "kind": "ConversationalSummarizationTask", - "parameters": { - "modelVersion": "latest", - "summaryAspects": [ - "issue", - "resolution" - ] - } - } - ] - } - }, - "responses": { - "202": { - "headers": { - "Operation-Location": "{Endpoint}/language/analyze-conversation/jobs/{jobId}?api-version=2024-11-15-preview" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/main.tsp b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/main.tsp index d7d83474cdd5..b47c5ee68734 100644 --- a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/main.tsp +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/main.tsp @@ -53,6 +53,9 @@ enum Versions { /** Version 2024-11-01 */ v2024_11_01: "2024-11-01", + /** Version 2025-05-15 */ + v2025_05_15_preview: "2025-05-15-preview", + /** Version 2025-11-15-preview */ v2025_11_15_preview: "2025-11-15-preview", } diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/models/common.tsp b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/models/common.tsp index 2d86b4162baa..487c260b8e40 100644 --- a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/models/common.tsp +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/models/common.tsp @@ -401,7 +401,7 @@ model AnalyzeConversationTaskResult { /** A conversational AI task. */ #suppress "@azure-tools/typespec-azure-core/casing-style" -@added(Versions.v2025_11_15_preview) +@added(Versions.v2025_05_15_preview) model ConversationalAITask extends AnalyzeConversationTask { /** Task kind. */ kind: AnalyzeConversationTaskKind.ConversationalAI; @@ -415,7 +415,7 @@ model ConversationalAITask extends AnalyzeConversationTask { /** The input ConversationItem and its optional parameters */ #suppress "@azure-tools/typespec-azure-core/casing-style" -@added(Versions.v2025_11_15_preview) +@added(Versions.v2025_05_15_preview) model ConversationalAIAnalysisInput { /** List of multiple conversations */ conversations: TextConversation[]; @@ -604,7 +604,7 @@ model EntitySubtype extends BaseExtraInformation { value?: string; @doc("List of entity tags. Tags express similarities between entity categories for the extracted entity type.") - @added(Versions.v2025_11_15_preview) + @added(Versions.v2025_05_15_preview) tags?: Array; } @@ -632,7 +632,7 @@ model RegexKey extends BaseExtraInformation { /** The abstract base class for entity resolutions. */ @doc("Tags express similarities between entity categories for the extracted entity type.") -@added(Versions.v2025_11_15_preview) +@added(Versions.v2025_05_15_preview) model EntityTag { @doc("The name of the tag.") name: string; @@ -864,7 +864,7 @@ model AnalyzeConversationJobsInput { tasks: Array; /** Optional duration in seconds after which the job will be canceled if not completed. */ - @added(Versions.v2025_11_15_preview) + @added(Versions.v2025_05_15_preview) cancelAfter?: float32; } @@ -1072,7 +1072,7 @@ model ConversationItemLevelTiming is AudioTiming; /** Input parameters base for a Conversation task. */ #suppress "@azure-tools/typespec-azure-core/casing-style" -@added(Versions.v2025_11_15_preview) +@added(Versions.v2025_05_15_preview) model ConversationalAIInputParameters { /** The name of the project to use. */ projectName: string; @@ -1110,7 +1110,7 @@ model ConversationTaskParameters { /** The results of a ConversationalAI task. */ #suppress "@azure-tools/typespec-azure-core/casing-style" -@added(Versions.v2025_11_15_preview) +@added(Versions.v2025_05_15_preview) model ConversationalAITaskResult extends AnalyzeConversationTaskResult { /** The results of a Conversational AI task. */ kind: AnalyzeConversationTaskResultsKind.ConversationalAIResult; @@ -1121,7 +1121,7 @@ model ConversationalAITaskResult extends AnalyzeConversationTaskResult { /** Represents the conversational analysis response. */ #suppress "@azure-tools/typespec-azure-core/casing-style" -@added(Versions.v2025_11_15_preview) +@added(Versions.v2025_05_15_preview) model ConversationalAIResult { /** Multiple multi-turn conversations analyzed. */ conversations: ConversationalAIAnalysis[]; @@ -1132,7 +1132,7 @@ model ConversationalAIResult { /** Multiple multi-turn conversations analyzed. */ #suppress "@azure-tools/typespec-azure-core/casing-style" -@added(Versions.v2025_11_15_preview) +@added(Versions.v2025_05_15_preview) model ConversationalAIAnalysis { /** The ID of the conversation. */ id: string; @@ -1146,7 +1146,7 @@ model ConversationalAIAnalysis { /** The intent classification result for this conversation. */ #suppress "@azure-tools/typespec-azure-core/casing-style" -@added(Versions.v2025_11_15_preview) +@added(Versions.v2025_05_15_preview) model ConversationalAIIntent { /** The name of the detected intent. */ name: string; @@ -1162,7 +1162,7 @@ model ConversationalAIIntent { } /** The ranges of conversation items where this intent was identified. */ -@added(Versions.v2025_11_15_preview) +@added(Versions.v2025_05_15_preview) model ConversationItemRange { /** The starting index of the intent occurrence within the conversation. */ offset: int32; @@ -1173,7 +1173,7 @@ model ConversationItemRange { /** The entity associated with this intent. */ #suppress "@azure-tools/typespec-azure-core/casing-style" -@added(Versions.v2025_11_15_preview) +@added(Versions.v2025_05_15_preview) model ConversationalAIEntity { /** The entity name or category. */ name: string; diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/models/common.union.tsp b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/models/common.union.tsp index 0ebd94d2b50f..e70a5218434a 100644 --- a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/models/common.union.tsp +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/models/common.union.tsp @@ -21,7 +21,7 @@ union AnalyzeConversationTaskKind { Conversation: "Conversation", /** Conversation task kind */ - @added(Versions.v2025_11_15_preview) + @added(Versions.v2025_05_15_preview) ConversationalAI: "ConversationalAI", } @@ -33,7 +33,7 @@ union AnalyzeConversationTaskResultsKind { ConversationResult: "ConversationResult", /** Conversation result task kind */ - @added(Versions.v2025_11_15_preview) + @added(Versions.v2025_05_15_preview) ConversationalAIResult: "ConversationalAIResult", } @@ -246,7 +246,7 @@ union projectKind { Orchestration: "Orchestration", /** Conversation type */ - @added(Versions.v2025_11_15_preview) + @added(Versions.v2025_05_15_preview) ConversationalAI: "ConversationalAI", } @@ -682,7 +682,7 @@ union AnalyzeConversationLROTaskKind { ConversationalPIITask: "ConversationalPIITask", /** Custom Conversational Summarization Task */ - @added(Versions.v2025_11_15_preview) + @added(Versions.v2025_05_15_preview) CustomConversationalSummarizationTask: "CustomConversationalSummarizationTask", } @@ -700,7 +700,7 @@ union AnalyzeConversationResultsKind { ConversationalPIIResults: "conversationalPIIResults", /** Custom Conversational Summarization Results */ - @added(Versions.v2025_11_15_preview) + @added(Versions.v2025_05_15_preview) CustomConversationalSummarizationResults: "customConversationalSummarizationResults", } diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/models/pii.tsp b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/models/pii.tsp index f19d973e7fa8..b436cad0afad 100644 --- a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/models/pii.tsp +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/models/pii.tsp @@ -35,15 +35,15 @@ model Entity { confidenceScore: float64; /** Exact mask text to mask the PII entity */ - @added(Versions.v2025_11_15_preview) + @added(Versions.v2025_05_15_preview) mask?: string; /** Offset of the mask text */ - @added(Versions.v2025_11_15_preview) + @added(Versions.v2025_05_15_preview) maskOffset?: int32; /** Length of the mask text */ - @added(Versions.v2025_11_15_preview) + @added(Versions.v2025_05_15_preview) maskLength?: int32; } @@ -125,12 +125,12 @@ model ConversationPiiTaskParameters is PreBuiltTaskParameters { excludePiiCategories?: Array; /** Optional parameter determine what type of redaction to use. */ - @added(Versions.v2025_11_15_preview) + @added(Versions.v2025_05_15_preview) redactionPolicy?: BaseRedactionPolicy; } /** Kinds of redaction policies supported. */ -@added(Versions.v2025_11_15_preview) +@added(Versions.v2025_05_15_preview) union RedactionPolicyKind { string, @@ -145,7 +145,7 @@ union RedactionPolicyKind { } /** The abstract base class for RedactionPolicy. */ -@added(Versions.v2025_11_15_preview) +@added(Versions.v2025_05_15_preview) @discriminator("policyKind") model BaseRedactionPolicy { /** The entity RedactionPolicy object kind. */ @@ -153,7 +153,7 @@ model BaseRedactionPolicy { } /** Represents the policy of masking with a redaction character */ -@added(Versions.v2025_11_15_preview) +@added(Versions.v2025_05_15_preview) model CharacterMaskPolicyType extends BaseRedactionPolicy { /** The entity RedactionPolicy object kind. */ policyKind: RedactionPolicyKind.characterMask; @@ -163,14 +163,14 @@ model CharacterMaskPolicyType extends BaseRedactionPolicy { } /** Represents the policy of not masking found PII. */ -@added(Versions.v2025_11_15_preview) +@added(Versions.v2025_05_15_preview) model NoMaskPolicyType extends BaseRedactionPolicy { /** The entity RedactionPolicy object kind. */ policyKind: RedactionPolicyKind.noMask; } /** Represents the policy of masking PII with the entity type. */ -@added(Versions.v2025_11_15_preview) +@added(Versions.v2025_05_15_preview) model EntityMaskTypePolicyType extends BaseRedactionPolicy { /** The entity OverlapPolicy object kind. */ policyKind: RedactionPolicyKind.entityMask; diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/models/summarization.tsp b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/models/summarization.tsp index 95aae0cd7070..b93153bff5e3 100644 --- a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/models/summarization.tsp +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/models/summarization.tsp @@ -14,7 +14,7 @@ using Azure.Core.Traits; namespace Language.Conversations; /** Task definition for custom conversational summarization. */ -@added(Versions.v2025_11_15_preview) +@added(Versions.v2025_05_15_preview) model AnalyzeCustomConversationSummarizationTask extends AnalyzeConversationLROTask { /** discriminator kind */ @@ -42,7 +42,7 @@ model ConversationSummarizationTaskParametersBase summaryAspects: Array; /** a text field to allow customers to use natural language to describe their needs for summarization. */ - @added(Versions.v2025_11_15_preview) + @added(Versions.v2025_05_15_preview) instruction?: string; } @@ -53,7 +53,7 @@ model ConversationSummarizationTaskParameters is PreBuiltTaskParameters { } /** Supported parameters for a custom conversation summarization task. */ -@added(Versions.v2025_11_15_preview) +@added(Versions.v2025_05_15_preview) model CustomConversationSummarizationTaskParameters is CustomTaskParameters { /** It controls the approximate number of sentences in the output summaries. */ sentenceCount?: int32; @@ -90,7 +90,7 @@ union SummaryAspect { recap: "recap", /** Action items and tasks that arose during a meeting. */ - @added(Versions.v2025_11_15_preview) + @added(Versions.v2025_05_15_preview) followUpTasks: "follow-up tasks", } @@ -106,7 +106,7 @@ model AnalyzeConversationSummarizationResult } /** Result for the custom summarization task on the conversation. */ -@added(Versions.v2025_11_15_preview) +@added(Versions.v2025_05_15_preview) model AnalyzeCustomConversationSummarizationResult extends AnalyzeConversationJobResult { /** discriminator kind */ @@ -131,7 +131,7 @@ model SummaryResult { } /** Custom Summary Results */ -@added(Versions.v2025_11_15_preview) +@added(Versions.v2025_05_15_preview) model CustomSummaryResult { ...SummaryResultBase; ...CustomResult; diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/preview/2025-05-15-preview/analyzeconversations.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/preview/2025-05-15-preview/analyzeconversations.json new file mode 100644 index 000000000000..62589fd4a25c --- /dev/null +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/preview/2025-05-15-preview/analyzeconversations.json @@ -0,0 +1,5501 @@ +{ + "swagger": "2.0", + "info": { + "title": "Microsoft Cognitive Language Service - Analyze Conversations", + "version": "2025-05-15-preview", + "description": "The language service conversations API is a suite of natural language processing (NLP) skills that can be used to analyze structured conversations (textual or spoken). The synchronous API in this suite accepts a request and mediates among multiple language projects, such as LUIS Generally Available, Question Answering, Conversational Language Understanding, and then calls the best candidate service to handle the request. At last, it returns a response with the candidate service's response as a payload.\\n\\n In some cases, this API needs to forward requests and responses between the caller and an upstream service. The asynchronous APIs in this suite enable tasks like Conversation Summarization and Conversational PII detection.", + "x-typespec-generated": [ + { + "emitter": "@azure-tools/typespec-autorest" + } + ] + }, + "schemes": [ + "https" + ], + "x-ms-parameterized-host": { + "hostTemplate": "{Endpoint}/language", + "useSchemePrefix": false, + "parameters": [ + { + "name": "Endpoint", + "in": "path", + "description": "Supported Cognitive Services endpoint (e.g., https://.api.cognitiveservices.azure.com).", + "required": true, + "type": "string", + "format": "uri", + "x-ms-skip-url-encoding": true + } + ] + }, + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "security": [ + { + "ApiKeyAuth": [] + }, + { + "OAuth2Auth": [ + "https://cognitiveservices.azure.com/.default" + ] + } + ], + "securityDefinitions": { + "ApiKeyAuth": { + "type": "apiKey", + "name": "Ocp-Apim-Subscription-Key", + "in": "header" + }, + "OAuth2Auth": { + "type": "oauth2", + "flow": "accessCode", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "https://cognitiveservices.azure.com/.default": "" + }, + "tokenUrl": "https://login.microsoftonline.com/common/oauth2/token" + } + }, + "tags": [], + "paths": { + "/:analyze-conversations": { + "post": { + "operationId": "AnalyzeConversations", + "description": "Analyzes the input conversation utterance.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "body", + "in": "body", + "description": "The input for the analyze conversations operation.", + "required": true, + "schema": { + "$ref": "#/definitions/AnalyzeConversationTask" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/AnalyzeConversationTaskResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "SuccessfulAnalyzeConversationalAITask": { + "$ref": "./examples/SuccessfulAnalyzeConversationalAITask.json" + }, + "SuccessfulAnalyzeConversations": { + "$ref": "./examples/SuccessfulAnalyzeConversations.json" + }, + "SuccessfulAnalyzeConversationsArbitration": { + "$ref": "./examples/SuccessfulAnalyzeConversationsArbitration.json" + }, + "SuccessfulAnalyzeConversationsArbitrationDirectTarget": { + "$ref": "./examples/SuccessfulAnalyzeConversationsArbitrationDirectTarget.json" + } + } + } + }, + "/analyze-conversations/jobs": { + "post": { + "operationId": "AnalyzeConversationsSubmitJob", + "description": "Analyzes the input conversation utterance.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "body", + "in": "body", + "description": "The input for the analyze conversations operation.", + "required": true, + "schema": { + "$ref": "#/definitions/AnalyzeConversationJobsInput" + } + } + ], + "responses": { + "202": { + "description": "The request has been accepted for processing, but processing has not yet completed.", + "headers": { + "Operation-Location": { + "type": "string", + "format": "uri", + "description": "The location for monitoring the operation state." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "SuccessfulConversationPIICharacterMask": { + "$ref": "./examples/SuccessfulConversationPIICharacterMask.json" + }, + "SuccessfulConversationPIIEntityMask": { + "$ref": "./examples/SuccessfulConversationPIIEntityMask.json" + }, + "SuccessfulConversationPIIExclusionSubmit": { + "$ref": "./examples/SuccessfulConversationPIIExclusionSubmit.json" + }, + "SuccessfulConversationPIINoMask": { + "$ref": "./examples/SuccessfulConversationPIINoMask.json" + }, + "SuccessfulConversationPIIRedactionCharSubmit": { + "$ref": "./examples/SuccessfulConversationPIIRedactionCharSubmit.json" + }, + "SuccessfulConversationPIISubmit": { + "$ref": "./examples/SuccessfulConversationPIISubmit.json" + }, + "SuccessfulConversationSummarizationTaskSubmit": { + "$ref": "./examples/SuccessfulConversationSummarizationTaskSubmit.json" + }, + "SuccessfulConversationSummarySubmit": { + "$ref": "./examples/SuccessfulConversationSummarySubmit.json" + }, + "SuccessfulCustomConversationSummarizationTaskSubmit": { + "$ref": "./examples/SuccessfulCustomConversationSummarizationTaskSubmit.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/analyze-conversations/jobs/{jobId}": { + "get": { + "operationId": "AnalyzeConversationsJobStatus", + "summary": "Get analysis status and results", + "description": "Get the status of an analysis job. A job can consist of one or more tasks. After all tasks succeed, the job transitions to the succeeded state and results are available for each task.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "jobId", + "in": "path", + "description": "job ID", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "name": "showStats", + "in": "query", + "description": "(Optional) if set to true, response will contain request and document level statistics.", + "required": false, + "type": "boolean" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/AnalyzeConversationJobState" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "SuccessfulConversationPIICharacterMaskTaskStatusRequest": { + "$ref": "./examples/SuccessfulConversationPIICharacterMaskTaskStatusRequest.json" + }, + "SuccessfulConversationPIIEntityMaskTaskStatusRequest": { + "$ref": "./examples/SuccessfulConversationPIIEntityMaskTaskStatusRequest.json" + }, + "SuccessfulConversationPIIExclusionTaskStatusRequest": { + "$ref": "./examples/SuccessfulConversationPIIExclusionTaskStatusRequest.json" + }, + "SuccessfulConversationPIINoMaskTaskStatusRequest": { + "$ref": "./examples/SuccessfulConversationPIINoMaskTaskStatusRequest.json" + }, + "SuccessfulConversationPIIRedactionCharTaskStatusRequest": { + "$ref": "./examples/SuccessfulConversationPIIRedactionCharTaskStatusRequest.json" + }, + "SuccessfulConversationPIITaskStatusRequest": { + "$ref": "./examples/SuccessfulConversationPIITaskStatusRequest.json" + }, + "SuccessfulConversationSummarizationTaskResult": { + "$ref": "./examples/SuccessfulConversationSummarizationTaskResult.json" + }, + "SuccessfulConversationSummarizationTaskStatusRequest": { + "$ref": "./examples/SuccessfulConversationSummarizationTaskStatusRequest.json" + }, + "SuccessfulCustomConversationSummarizationTaskResult": { + "$ref": "./examples/SuccessfulCustomConversationSummarizationTaskResult.json" + } + } + } + }, + "/analyze-conversations/jobs/{jobId}:cancel": { + "post": { + "operationId": "AnalyzeConversationsCancelJob", + "summary": "Cancel a long-running Text Analysis conversations job.", + "description": "Cancel a long-running job for text analysis of conversations.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "jobId", + "in": "path", + "description": "The job ID to cancel.", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "202": { + "description": "The request has been accepted for processing, but processing has not yet completed.", + "headers": { + "Operation-Location": { + "type": "string", + "format": "uri", + "description": "The location for monitoring the operation state." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "SuccessfulAnalyzeConversationsJobsCancelRequest": { + "$ref": "./examples/SuccessfulAnalyzeConversationsJobsCancelRequest.json" + } + }, + "x-ms-long-running-operation": true + } + } + }, + "definitions": { + "AgeResolution": { + "type": "object", + "description": "Represents the Age entity resolution model.", + "properties": { + "value": { + "type": "number", + "format": "double", + "description": "The numeric value that the extracted text denotes." + }, + "unit": { + "$ref": "#/definitions/AgeUnit", + "description": "The Age Unit of measurement" + } + }, + "required": [ + "value", + "unit" + ], + "allOf": [ + { + "$ref": "#/definitions/BaseResolution" + } + ], + "x-ms-discriminator-value": "AgeResolution" + }, + "AgeUnit": { + "type": "string", + "description": "The Age Unit of measurement", + "enum": [ + "Unspecified", + "Year", + "Month", + "Week", + "Day" + ], + "x-ms-enum": { + "name": "AgeUnit", + "modelAsString": true, + "values": [ + { + "name": "Unspecified", + "value": "Unspecified", + "description": "Unspecified age unit" + }, + { + "name": "Year", + "value": "Year", + "description": "Year age unit" + }, + { + "name": "Month", + "value": "Month", + "description": "Month age unit" + }, + { + "name": "Week", + "value": "Week", + "description": "Week age unit" + }, + { + "name": "Day", + "value": "Day", + "description": "Day age unit" + } + ] + } + }, + "AnalysisParameters": { + "type": "object", + "description": "This is the parameter set of either the Orchestration project itself or one of the target services.", + "properties": { + "targetProjectKind": { + "$ref": "#/definitions/targetProjectKind", + "description": "The type of a target service" + }, + "apiVersion": { + "type": "string", + "description": "The API version to use when call a specific target service." + } + }, + "discriminator": "targetProjectKind", + "required": [ + "targetProjectKind" + ] + }, + "AnalyzeConversationConversationPiiResult": { + "type": "object", + "description": "Result from the personally identifiable information detection and redaction operation performed on a list of conversations.", + "properties": { + "results": { + "$ref": "#/definitions/ConversationPiiResults", + "description": "results" + } + }, + "required": [ + "results" + ], + "allOf": [ + { + "$ref": "#/definitions/AnalyzeConversationJobResult" + } + ], + "x-ms-discriminator-value": "conversationalPIIResults" + }, + "AnalyzeConversationJobResult": { + "type": "object", + "description": "Container for results of all tasks in the conversation job.", + "properties": { + "lastUpdateDateTime": { + "type": "string", + "format": "date-time", + "description": "The last updated time in UTC for the task." + }, + "status": { + "$ref": "#/definitions/State", + "description": "The status of the task at the mentioned last update time." + }, + "taskName": { + "type": "string", + "description": "task name" + }, + "kind": { + "$ref": "#/definitions/AnalyzeConversationResultsKind", + "description": "discriminator kind" + } + }, + "discriminator": "kind", + "required": [ + "lastUpdateDateTime", + "status", + "kind" + ] + }, + "AnalyzeConversationJobState": { + "type": "object", + "description": "Contains the status of the submitted job for analyzing a conversation, along with related statistics.", + "properties": { + "displayName": { + "type": "string", + "description": "display name" + }, + "createdDateTime": { + "type": "string", + "format": "date-time", + "description": "Date and time job created" + }, + "expirationDateTime": { + "type": "string", + "format": "date-time", + "description": "Date and time job expires" + }, + "jobId": { + "$ref": "#/definitions/Azure.Core.uuid", + "description": "job ID", + "readOnly": true + }, + "lastUpdatedDateTime": { + "type": "string", + "format": "date-time", + "description": "last updated date and time" + }, + "status": { + "$ref": "#/definitions/State", + "description": "status" + }, + "errors": { + "type": "array", + "description": "errors", + "items": { + "$ref": "#/definitions/Error" + } + }, + "nextLink": { + "type": "string", + "description": "next link" + }, + "tasks": { + "$ref": "#/definitions/Tasks", + "description": "Contains the state for the tasks that are being executed as part of the submitted job for analyzing a conversation." + }, + "statistics": { + "$ref": "#/definitions/ConversationRequestStatistics", + "description": "Contains the statistics for the submitted job." + } + }, + "required": [ + "createdDateTime", + "jobId", + "lastUpdatedDateTime", + "status", + "tasks" + ] + }, + "AnalyzeConversationJobsInput": { + "type": "object", + "description": "It is a wrap up a Question Answering KB response.", + "properties": { + "displayName": { + "type": "string", + "description": "Display name for the analysis job." + }, + "analysisInput": { + "$ref": "#/definitions/MultiLanguageConversationAnalysisInput", + "description": "Analysis Input", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "tasks": { + "type": "array", + "description": "Set of tasks to execute on the input conversation.", + "items": { + "$ref": "#/definitions/AnalyzeConversationLROTask" + } + }, + "cancelAfter": { + "type": "number", + "format": "float", + "description": "Optional duration in seconds after which the job will be canceled if not completed." + } + }, + "required": [ + "analysisInput", + "tasks" + ] + }, + "AnalyzeConversationLROTask": { + "type": "object", + "description": "Base class for a long-running conversation input task.", + "properties": { + "taskName": { + "type": "string", + "description": "task name" + }, + "kind": { + "$ref": "#/definitions/AnalyzeConversationLROTaskKind", + "description": "Enumeration of supported analysis tasks on a collection of conversations." + } + }, + "discriminator": "kind", + "required": [ + "kind" + ] + }, + "AnalyzeConversationLROTaskKind": { + "type": "string", + "description": "Enumeration of supported analysis tasks on a collection of conversations.", + "enum": [ + "ConversationalSummarizationTask", + "ConversationalPIITask", + "CustomConversationalSummarizationTask" + ], + "x-ms-enum": { + "name": "AnalyzeConversationLROTaskKind", + "modelAsString": true, + "values": [ + { + "name": "ConversationalSummarizationTask", + "value": "ConversationalSummarizationTask", + "description": "Conversational Summarization Task" + }, + { + "name": "ConversationalPIITask", + "value": "ConversationalPIITask", + "description": "Conversational PII Task" + }, + { + "name": "CustomConversationalSummarizationTask", + "value": "CustomConversationalSummarizationTask", + "description": "Custom Conversational Summarization Task" + } + ] + } + }, + "AnalyzeConversationPiiTask": { + "type": "object", + "description": "Task definition for a PII redaction in conversations.", + "properties": { + "parameters": { + "$ref": "#/definitions/ConversationPiiTaskParameters", + "description": "parameters" + } + }, + "allOf": [ + { + "$ref": "#/definitions/AnalyzeConversationLROTask" + } + ], + "x-ms-discriminator-value": "ConversationalPIITask" + }, + "AnalyzeConversationResult": { + "type": "object", + "description": "Represents a conversation analysis response.", + "properties": { + "query": { + "type": "string", + "description": "The conversation utterance given by the caller." + }, + "detectedLanguage": { + "type": "string", + "description": "The system detected language for the query in BCP 47 language representation.." + }, + "prediction": { + "$ref": "#/definitions/BasePrediction", + "description": "The prediction result of a conversation project." + } + }, + "required": [ + "query", + "prediction" + ] + }, + "AnalyzeConversationResultsKind": { + "type": "string", + "description": "Enumeration of results for supported conversation analysis Results.", + "enum": [ + "conversationalSummarizationResults", + "conversationalPIIResults", + "customConversationalSummarizationResults" + ], + "x-ms-enum": { + "name": "AnalyzeConversationResultsKind", + "modelAsString": true, + "values": [ + { + "name": "ConversationalSummarizationResults", + "value": "conversationalSummarizationResults", + "description": "Conversational Summarization Results" + }, + { + "name": "ConversationalPIIResults", + "value": "conversationalPIIResults", + "description": "Conversational PII Results" + }, + { + "name": "CustomConversationalSummarizationResults", + "value": "customConversationalSummarizationResults", + "description": "Custom Conversational Summarization Results" + } + ] + } + }, + "AnalyzeConversationSummarizationResult": { + "type": "object", + "description": "Result for the summarization task on the conversation.", + "properties": { + "results": { + "$ref": "#/definitions/SummaryResult", + "description": "results" + } + }, + "required": [ + "results" + ], + "allOf": [ + { + "$ref": "#/definitions/AnalyzeConversationJobResult" + } + ], + "x-ms-discriminator-value": "conversationalSummarizationResults" + }, + "AnalyzeConversationSummarizationTask": { + "type": "object", + "description": "Task definition for conversational summarization.", + "properties": { + "parameters": { + "$ref": "#/definitions/ConversationSummarizationTaskParameters", + "description": "parameters" + } + }, + "allOf": [ + { + "$ref": "#/definitions/AnalyzeConversationLROTask" + } + ], + "x-ms-discriminator-value": "ConversationalSummarizationTask" + }, + "AnalyzeConversationTask": { + "type": "object", + "description": "The base class of a conversation input task.", + "properties": { + "kind": { + "$ref": "#/definitions/AnalyzeConversationTaskKind", + "description": "The base class of a conversation input task.", + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "discriminator": "kind", + "required": [ + "kind" + ] + }, + "AnalyzeConversationTaskKind": { + "type": "string", + "description": "Enumeration of supported Conversation tasks.", + "enum": [ + "Conversation", + "ConversationalAI" + ], + "x-ms-enum": { + "name": "AnalyzeConversationTaskKind", + "modelAsString": true, + "values": [ + { + "name": "Conversation", + "value": "Conversation", + "description": "Conversation task kind" + }, + { + "name": "ConversationalAI", + "value": "ConversationalAI", + "description": "Conversation task kind" + } + ] + } + }, + "AnalyzeConversationTaskResult": { + "type": "object", + "description": "The base class of a conversation input task result.", + "properties": { + "kind": { + "$ref": "#/definitions/AnalyzeConversationTaskResultsKind", + "description": "The base class of a conversation input task result." + } + }, + "discriminator": "kind", + "required": [ + "kind" + ] + }, + "AnalyzeConversationTaskResultsKind": { + "type": "string", + "description": "Enumeration of supported conversational task results.", + "enum": [ + "ConversationResult", + "ConversationalAIResult" + ], + "x-ms-enum": { + "name": "AnalyzeConversationTaskResultsKind", + "modelAsString": true, + "values": [ + { + "name": "ConversationResult", + "value": "ConversationResult", + "description": "Conversation result task kind" + }, + { + "name": "ConversationalAIResult", + "value": "ConversationalAIResult", + "description": "Conversation result task kind" + } + ] + } + }, + "AnalyzeCustomConversationSummarizationResult": { + "type": "object", + "description": "Result for the custom summarization task on the conversation.", + "properties": { + "results": { + "$ref": "#/definitions/CustomSummaryResult", + "description": "Custom Summary Result" + } + }, + "required": [ + "results" + ], + "allOf": [ + { + "$ref": "#/definitions/AnalyzeConversationJobResult" + } + ], + "x-ms-discriminator-value": "customConversationalSummarizationResults" + }, + "AnalyzeCustomConversationSummarizationTask": { + "type": "object", + "description": "Task definition for custom conversational summarization.", + "properties": { + "parameters": { + "$ref": "#/definitions/CustomConversationSummarizationTaskParameters", + "description": "parameters" + } + }, + "allOf": [ + { + "$ref": "#/definitions/AnalyzeConversationLROTask" + } + ], + "x-ms-discriminator-value": "CustomConversationalSummarizationTask" + }, + "AnswerSpan": { + "type": "object", + "description": "Answer span object of QnA.", + "properties": { + "text": { + "type": "string", + "description": "Predicted text of answer span." + }, + "confidenceScore": { + "type": "number", + "format": "double", + "description": "Predicted score of answer span, value ranges from 0 to 1.", + "minimum": 0, + "maximum": 1 + }, + "offset": { + "type": "integer", + "format": "int32", + "description": "The answer span offset from the start of answer." + }, + "length": { + "type": "integer", + "format": "int32", + "description": "The length of the answer span." + } + } + }, + "AnswersOptions": { + "type": "object", + "description": "Parameters to query a knowledge base.", + "properties": { + "qnaId": { + "type": "integer", + "format": "int32", + "description": "Exact QnA ID to fetch from the knowledge base, this field takes priority over question." + }, + "question": { + "type": "string", + "description": "User question to query against the knowledge base." + }, + "top": { + "type": "integer", + "format": "int32", + "description": "Max number of answers to be returned for the question." + }, + "userId": { + "type": "string", + "description": "Unique identifier for the user." + }, + "confidenceScoreThreshold": { + "type": "number", + "format": "double", + "description": "Minimum threshold score for answers, value ranges from 0 to 1.", + "minimum": 0, + "maximum": 1 + }, + "context": { + "$ref": "#/definitions/KnowledgeBaseAnswerContext", + "description": "Context object with previous QnA's information." + }, + "rankerType": { + "$ref": "#/definitions/RankerKind", + "description": "Type of ranker to be used." + }, + "filters": { + "$ref": "#/definitions/QueryFilters", + "description": "Filter QnAs based on given metadata list and knowledge base sources." + }, + "answerSpanRequest": { + "$ref": "#/definitions/ShortAnswerOptions", + "description": "To configure Answer span prediction feature." + }, + "includeUnstructuredSources": { + "type": "boolean", + "description": "(Optional) Flag to enable Query over Unstructured Sources." + } + } + }, + "AnswersResult": { + "type": "object", + "description": "Represents List of Question Answers.", + "properties": { + "answers": { + "type": "array", + "description": "Represents Answer Result list.", + "items": { + "$ref": "#/definitions/KnowledgeBaseAnswer" + } + } + } + }, + "AreaResolution": { + "type": "object", + "description": "Represents the area entity resolution model.", + "properties": { + "value": { + "type": "number", + "format": "double", + "description": "The numeric value that the extracted text denotes." + }, + "unit": { + "$ref": "#/definitions/AreaUnit", + "description": "The area Unit of measurement" + } + }, + "required": [ + "value", + "unit" + ], + "allOf": [ + { + "$ref": "#/definitions/BaseResolution" + } + ], + "x-ms-discriminator-value": "AreaResolution" + }, + "AreaUnit": { + "type": "string", + "description": "The area unit of measurement.", + "enum": [ + "Unspecified", + "SquareKilometer", + "SquareHectometer", + "SquareDecameter", + "SquareDecimeter", + "SquareMeter", + "SquareCentimeter", + "SquareMillimeter", + "SquareInch", + "SquareFoot", + "SquareMile", + "SquareYard", + "Acre" + ], + "x-ms-enum": { + "name": "AreaUnit", + "modelAsString": true, + "values": [ + { + "name": "Unspecified", + "value": "Unspecified", + "description": "Unspecified area unit" + }, + { + "name": "SquareKilometer", + "value": "SquareKilometer", + "description": "Square kilometer area unit" + }, + { + "name": "SquareHectometer", + "value": "SquareHectometer", + "description": "Square hectometer area unit" + }, + { + "name": "SquareDecameter", + "value": "SquareDecameter", + "description": "Square decameter area unit" + }, + { + "name": "SquareDecimeter", + "value": "SquareDecimeter", + "description": "Square decimeter area unit" + }, + { + "name": "SquareMeter", + "value": "SquareMeter", + "description": "Square meter area unit" + }, + { + "name": "SquareCentimeter", + "value": "SquareCentimeter", + "description": "Square centimeter area unit" + }, + { + "name": "SquareMillimeter", + "value": "SquareMillimeter", + "description": "Square millimeter area unit" + }, + { + "name": "SquareInch", + "value": "SquareInch", + "description": "Square inch area unit" + }, + { + "name": "SquareFoot", + "value": "SquareFoot", + "description": "Square foot area unit" + }, + { + "name": "SquareMile", + "value": "SquareMile", + "description": "Square mile area unit" + }, + { + "name": "SquareYard", + "value": "SquareYard", + "description": "Square yard area unit" + }, + { + "name": "Acre", + "value": "Acre", + "description": "Acre area unit" + } + ] + } + }, + "AudioTiming": { + "type": "object", + "description": "Audio timing information.", + "properties": { + "offset": { + "type": "integer", + "format": "int64", + "description": "Offset from the start of speech audio, in ticks. 1 tick = 100 nanoseconds." + }, + "duration": { + "type": "integer", + "format": "int64", + "description": "Duration of word articulation, in ticks. 1 tick = 100 nanoseconds." + } + } + }, + "Azure.Core.uuid": { + "type": "string", + "format": "uuid", + "description": "Universally Unique Identifier" + }, + "BaseExtraInformation": { + "type": "object", + "description": "The abstract base object for entity extra information.", + "properties": { + "extraInformationKind": { + "$ref": "#/definitions/ExtraInformationKind", + "description": "The extra information object kind." + } + }, + "discriminator": "extraInformationKind", + "required": [ + "extraInformationKind" + ] + }, + "BasePrediction": { + "type": "object", + "description": "This is the base class of prediction", + "properties": { + "projectKind": { + "$ref": "#/definitions/projectKind", + "description": "The type of the project." + }, + "topIntent": { + "type": "string", + "description": "The intent with the highest score." + } + }, + "discriminator": "projectKind", + "required": [ + "projectKind" + ] + }, + "BaseRedactionPolicy": { + "type": "object", + "description": "The abstract base class for RedactionPolicy.", + "properties": { + "policyKind": { + "type": "string", + "description": "The entity RedactionPolicy object kind.", + "default": "characterMask", + "enum": [ + "noMask", + "characterMask", + "entityMask" + ], + "x-ms-enum": { + "name": "RedactionPolicyKind", + "modelAsString": true, + "values": [ + { + "name": "noMask", + "value": "noMask", + "description": "Do not mask detected entities" + }, + { + "name": "characterMask", + "value": "characterMask", + "description": "Mask detected entities with redaction character" + }, + { + "name": "entityMask", + "value": "entityMask", + "description": "Mask detected entities with entity type" + } + ] + } + } + }, + "discriminator": "policyKind", + "required": [ + "policyKind" + ] + }, + "BaseResolution": { + "type": "object", + "description": "The abstract base class for entity resolutions.", + "properties": { + "resolutionKind": { + "$ref": "#/definitions/ResolutionKind", + "description": "The entity resolution object kind." + } + }, + "discriminator": "resolutionKind", + "required": [ + "resolutionKind" + ] + }, + "BooleanResolution": { + "type": "object", + "description": "A resolution for boolean expressions", + "properties": { + "value": { + "type": "boolean", + "description": "A resolution for boolean expressions" + } + }, + "required": [ + "value" + ], + "allOf": [ + { + "$ref": "#/definitions/BaseResolution" + } + ], + "x-ms-discriminator-value": "BooleanResolution" + }, + "CharacterMaskPolicyType": { + "type": "object", + "description": "Represents the policy of masking with a redaction character", + "properties": { + "redactionCharacter": { + "type": "string", + "description": "Optional parameter to use a Custom Character to be used for redaction in PII responses. Default character will be * as before. We allow specific ascii characters for redaction.", + "default": "*", + "enum": [ + "!", + "#", + "$", + "%", + "&", + "*", + "+", + "-", + "=", + "?", + "@", + "^", + "_", + "~" + ], + "x-ms-enum": { + "name": "redactionCharacter", + "modelAsString": true, + "values": [ + { + "name": "exclamationPoint", + "value": "!", + "description": "Exclamation point character" + }, + { + "name": "numberSign", + "value": "#", + "description": "Number sign character" + }, + { + "name": "dollar", + "value": "$", + "description": "Dollar sign character" + }, + { + "name": "perCent", + "value": "%", + "description": "Percent sign character" + }, + { + "name": "ampersand", + "value": "&", + "description": "Ampersand character" + }, + { + "name": "asterisk", + "value": "*", + "description": "Asterisk character" + }, + { + "name": "plus", + "value": "+", + "description": "Plus sign character" + }, + { + "name": "minus", + "value": "-", + "description": "Minus sign character" + }, + { + "name": "equals", + "value": "=", + "description": "Equals sign character" + }, + { + "name": "questionMark", + "value": "?", + "description": "Question mark character" + }, + { + "name": "atSign", + "value": "@", + "description": "At sign character" + }, + { + "name": "caret", + "value": "^", + "description": "Caret character" + }, + { + "name": "underscore", + "value": "_", + "description": "Underscore character" + }, + { + "name": "tilde", + "value": "~", + "description": "Tilde character" + } + ] + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/BaseRedactionPolicy" + } + ], + "x-ms-discriminator-value": "characterMask" + }, + "Conversation": { + "type": "object", + "description": "Complete ordered set of utterances (spoken or written) by one or more speakers to be used for analysis.", + "properties": { + "id": { + "type": "string", + "description": "Unique identifier for the conversation." + }, + "language": { + "type": "string", + "description": "Language of the conversation item in BCP-47 format." + }, + "modality": { + "$ref": "#/definitions/InputModality", + "description": "modality" + }, + "domain": { + "$ref": "#/definitions/ConversationDomain", + "description": "domain" + } + }, + "discriminator": "modality", + "required": [ + "id", + "language", + "modality" + ] + }, + "ConversationAnalysisOptions": { + "type": "object", + "description": "The input ConversationItem and its optional parameters", + "properties": { + "conversationItem": { + "$ref": "#/definitions/TextConversationItem", + "description": "The abstract base for a user input formatted conversation (e.g., Text, Transcript)." + } + }, + "required": [ + "conversationItem" + ] + }, + "ConversationCallingOptions": { + "type": "object", + "description": "The option to set to call a Conversation project.", + "properties": { + "language": { + "type": "string", + "description": "The language of the query in BCP 47 language representation." + }, + "verbose": { + "type": "boolean", + "description": "If true, the service will return more detailed information." + }, + "isLoggingEnabled": { + "type": "boolean", + "description": "If true, the query will be saved for customers to further review in authoring, to improve the model quality." + } + } + }, + "ConversationDomain": { + "type": "string", + "description": "Enumeration of supported conversational domains.", + "enum": [ + "finance", + "healthcare", + "generic" + ], + "x-ms-enum": { + "name": "ConversationDomain", + "modelAsString": true, + "values": [ + { + "name": "finance", + "value": "finance", + "description": "Enumeration of supported conversational domains." + }, + { + "name": "healthcare", + "value": "healthcare", + "description": "Enumeration of supported conversational domains." + }, + { + "name": "generic", + "value": "generic", + "description": "Enumeration of supported conversational domains." + } + ] + } + }, + "ConversationEntity": { + "type": "object", + "description": "The entity extraction result of a Conversation project.", + "properties": { + "category": { + "type": "string", + "description": "The entity category." + }, + "text": { + "type": "string", + "description": "The predicted entity text." + }, + "offset": { + "type": "integer", + "format": "int32", + "description": "The starting index of this entity in the query." + }, + "length": { + "type": "integer", + "format": "int32", + "description": "The length of the text." + }, + "confidenceScore": { + "type": "number", + "format": "float", + "description": "The entity confidence score." + }, + "resolutions": { + "type": "array", + "description": "The collection of entity resolution objects.", + "items": { + "$ref": "#/definitions/BaseResolution" + } + }, + "extraInformation": { + "type": "array", + "description": "The collection of entity extra information objects.", + "items": { + "$ref": "#/definitions/BaseExtraInformation" + } + } + }, + "required": [ + "category", + "text", + "offset", + "length", + "confidenceScore" + ] + }, + "ConversationIntent": { + "type": "object", + "description": "The intent classification result of a Conversation project.", + "properties": { + "category": { + "type": "string", + "description": "A predicted class." + }, + "confidenceScore": { + "type": "number", + "format": "float", + "description": "The confidence score of the class from 0.0 to 1.0.", + "minimum": 0, + "maximum": 1 + } + }, + "required": [ + "category", + "confidenceScore" + ] + }, + "ConversationItemLevelTiming": { + "type": "object", + "description": "Audio timing at the conversation item level.", + "properties": { + "offset": { + "type": "integer", + "format": "int64", + "description": "Offset from the start of speech audio, in ticks. 1 tick = 100 nanoseconds." + }, + "duration": { + "type": "integer", + "format": "int64", + "description": "Duration of word articulation, in ticks. 1 tick = 100 nanoseconds." + } + } + }, + "ConversationItemRange": { + "type": "object", + "description": "The ranges of conversation items where this intent was identified.", + "properties": { + "offset": { + "type": "integer", + "format": "int32", + "description": "The starting index of the intent occurrence within the conversation." + }, + "count": { + "type": "integer", + "format": "int32", + "description": "The number of continuous conversation items for this intent." + } + }, + "required": [ + "offset", + "count" + ] + }, + "ConversationParameters": { + "type": "object", + "description": "This is a set of request parameters for Customized Conversation projects.", + "properties": { + "callingOptions": { + "$ref": "#/definitions/ConversationCallingOptions", + "description": "The option to set to call a Conversation project." + } + }, + "allOf": [ + { + "$ref": "#/definitions/AnalysisParameters" + } + ], + "x-ms-discriminator-value": "Conversation" + }, + "ConversationPiiCategories": { + "type": "string", + "description": "Describes the PII categories to return for detection. If not provided, 'default' categories will be returned which will vary with the language.", + "enum": [ + "Address", + "CreditCard", + "Email", + "Person", + "NumericIdentifier", + "Phone", + "USSocialSecurityNumber", + "All", + "Default" + ], + "x-ms-enum": { + "name": "ConversationPiiCategories", + "modelAsString": true, + "values": [ + { + "name": "Address", + "value": "Address", + "description": "Address category" + }, + { + "name": "CreditCard", + "value": "CreditCard", + "description": "Credit card category" + }, + { + "name": "Email", + "value": "Email", + "description": "Email category" + }, + { + "name": "Person", + "value": "Person", + "description": "Person category" + }, + { + "name": "NumericIdentifier", + "value": "NumericIdentifier", + "description": "Numeric identifier category" + }, + { + "name": "Phone", + "value": "Phone", + "description": "Phone category" + }, + { + "name": "USSocialSecurityNumber", + "value": "USSocialSecurityNumber", + "description": "US social security number category" + }, + { + "name": "All", + "value": "All", + "description": "All categories" + }, + { + "name": "Default", + "value": "Default", + "description": "Default categories" + } + ] + } + }, + "ConversationPiiCategoriesExclude": { + "type": "string", + "description": "Describes the PII categories to exclude for detection. If not provided, 'default' categories will be returned which will vary with the language.", + "enum": [ + "Address", + "CreditCard", + "Email", + "Person", + "NumericIdentifier", + "Phone", + "USSocialSecurityNumber" + ], + "x-ms-enum": { + "name": "ConversationPiiCategoriesExclude", + "modelAsString": true, + "values": [ + { + "name": "Address", + "value": "Address", + "description": "Address category" + }, + { + "name": "CreditCard", + "value": "CreditCard", + "description": "Credit card category" + }, + { + "name": "Email", + "value": "Email", + "description": "Email category" + }, + { + "name": "Person", + "value": "Person", + "description": "Person category" + }, + { + "name": "NumericIdentifier", + "value": "NumericIdentifier", + "description": "Numeric identifier category" + }, + { + "name": "Phone", + "value": "Phone", + "description": "Phone category" + }, + { + "name": "USSocialSecurityNumber", + "value": "USSocialSecurityNumber", + "description": "US social security number category" + } + ] + } + }, + "ConversationPiiItemResult": { + "type": "object", + "description": "The result from PII detection and redaction operation for each conversation.", + "properties": { + "id": { + "type": "string", + "description": "Id of the result" + }, + "redactedContent": { + "$ref": "#/definitions/RedactedTranscriptContent", + "description": "Transcript content response that the service generates, with all necessary personally identifiable information redacted." + }, + "entities": { + "type": "array", + "description": "Array of Entities", + "items": { + "$ref": "#/definitions/Entity" + } + } + }, + "required": [ + "id", + "redactedContent", + "entities" + ] + }, + "ConversationPiiResults": { + "type": "object", + "description": "The result from PII detection and redaction operation for each conversation.", + "properties": { + "errors": { + "type": "array", + "description": "Errors by document id.", + "items": { + "$ref": "#/definitions/DocumentError" + } + }, + "statistics": { + "$ref": "#/definitions/RequestStatistics", + "description": "statistics" + }, + "modelVersion": { + "type": "string", + "description": "This field indicates which model is used for scoring." + }, + "conversations": { + "type": "array", + "description": "array of conversations", + "items": { + "$ref": "#/definitions/ConversationalPiiResultWithResultBase" + } + } + }, + "required": [ + "errors", + "modelVersion", + "conversations" + ] + }, + "ConversationPiiTaskParameters": { + "type": "object", + "description": "Supported parameters for a conversational pii task.", + "properties": { + "loggingOptOut": { + "type": "boolean", + "description": "logging opt out", + "default": false + }, + "modelVersion": { + "type": "string", + "description": "model version", + "default": "latest" + }, + "piiCategories": { + "type": "array", + "description": "Array of ConversationPIICategories", + "items": { + "$ref": "#/definitions/ConversationPiiCategories" + } + }, + "redactAudioTiming": { + "type": "boolean", + "description": "Flag to indicate if response should include audio stream offset and duration for any detected entities to be redacted. By default, audio timing of redacted entities are not included." + }, + "redactionSource": { + "$ref": "#/definitions/TranscriptContentType", + "description": "For transcript conversations, this parameter provides information regarding which content type (ITN, Text, Lexical, Masked ITN) should be used for entity detection. The details of the entities detected - like the offset, length and the text itself - will correspond to the text type selected here." + }, + "redactionCharacter": { + "type": "string", + "description": "Optional parameter to use a Custom Character to be used for redaction in PII responses. Default character will be * as before. We allow specific ascii characters for redaction.", + "default": "*", + "enum": [ + "!", + "#", + "$", + "%", + "&", + "*", + "+", + "-", + "=", + "?", + "@", + "^", + "_", + "~" + ], + "x-ms-enum": { + "name": "redactionCharacter", + "modelAsString": true, + "values": [ + { + "name": "exclamationPoint", + "value": "!", + "description": "Exclamation point character" + }, + { + "name": "numberSign", + "value": "#", + "description": "Number sign character" + }, + { + "name": "dollar", + "value": "$", + "description": "Dollar sign character" + }, + { + "name": "perCent", + "value": "%", + "description": "Percent sign character" + }, + { + "name": "ampersand", + "value": "&", + "description": "Ampersand character" + }, + { + "name": "asterisk", + "value": "*", + "description": "Asterisk character" + }, + { + "name": "plus", + "value": "+", + "description": "Plus sign character" + }, + { + "name": "minus", + "value": "-", + "description": "Minus sign character" + }, + { + "name": "equals", + "value": "=", + "description": "Equals sign character" + }, + { + "name": "questionMark", + "value": "?", + "description": "Question mark character" + }, + { + "name": "atSign", + "value": "@", + "description": "At sign character" + }, + { + "name": "caret", + "value": "^", + "description": "Caret character" + }, + { + "name": "underscore", + "value": "_", + "description": "Underscore character" + }, + { + "name": "tilde", + "value": "~", + "description": "Tilde character" + } + ] + } + }, + "excludePiiCategories": { + "type": "array", + "description": "List of categories that need to be excluded instead of included.", + "items": { + "$ref": "#/definitions/ConversationPiiCategoriesExclude" + } + }, + "redactionPolicy": { + "$ref": "#/definitions/BaseRedactionPolicy", + "description": "Optional parameter determine what type of redaction to use." + } + } + }, + "ConversationPrediction": { + "type": "object", + "description": "Represents the prediction section of a Conversation project.", + "properties": { + "intents": { + "type": "array", + "description": "The intent classification results.", + "items": { + "$ref": "#/definitions/ConversationIntent" + } + }, + "entities": { + "type": "array", + "description": "The entity extraction results.", + "items": { + "$ref": "#/definitions/ConversationEntity" + } + } + }, + "required": [ + "intents", + "entities" + ], + "allOf": [ + { + "$ref": "#/definitions/BasePrediction" + } + ], + "x-ms-discriminator-value": "Conversation" + }, + "ConversationRequestStatistics": { + "type": "object", + "description": "if showStats=true was specified in the request, this field contains information about the request payload.", + "properties": { + "documentsCount": { + "type": "integer", + "format": "int32", + "description": "Number of documents submitted in the request." + }, + "validDocumentsCount": { + "type": "integer", + "format": "int32", + "description": "Number of valid documents. This excludes empty, over-size limit or non-supported languages documents." + }, + "erroneousDocumentsCount": { + "type": "integer", + "format": "int32", + "description": "Number of invalid documents. This includes empty, over-size limit or non-supported languages documents." + }, + "transactionsCount": { + "type": "integer", + "format": "int64", + "description": "Number of transactions for the request." + }, + "conversationsCount": { + "type": "integer", + "format": "int32", + "description": "Number of conversations submitted in the request." + }, + "validConversationsCount": { + "type": "integer", + "format": "int32", + "description": "Number of conversation documents. This excludes documents that are empty, over the size limit, or in unsupported languages." + }, + "erroneousConversationsCount": { + "type": "integer", + "format": "int32", + "description": "Number of invalid documents. This includes documents that are empty, over the size limit, or in unsupported languages." + } + }, + "required": [ + "documentsCount", + "validDocumentsCount", + "erroneousDocumentsCount", + "transactionsCount", + "conversationsCount", + "validConversationsCount", + "erroneousConversationsCount" + ] + }, + "ConversationResult": { + "type": "object", + "description": "The response returned by a Conversation project.", + "properties": { + "query": { + "type": "string", + "description": "The same query given in request." + }, + "detectedLanguage": { + "type": "string", + "description": "The detected language from the query in BCP 47 language representation." + }, + "prediction": { + "$ref": "#/definitions/ConversationPrediction", + "description": "The predicted result for the query." + } + }, + "required": [ + "query" + ] + }, + "ConversationStatistics": { + "type": "object", + "description": "If showStats=true was specified in the request, this field contains information about the conversation payload.", + "properties": { + "transactionsCount": { + "type": "integer", + "format": "int32", + "description": "Number of text units for the request." + } + }, + "required": [ + "transactionsCount" + ] + }, + "ConversationSummarizationTaskParameters": { + "type": "object", + "description": "Supported parameters for pre-build conversational summarization task.", + "properties": { + "loggingOptOut": { + "type": "boolean", + "description": "logging opt out", + "default": false + }, + "modelVersion": { + "type": "string", + "description": "model version", + "default": "latest" + }, + "sentenceCount": { + "type": "integer", + "format": "int32", + "description": "It controls the approximate number of sentences in the output summaries." + }, + "stringIndexType": { + "type": "string", + "description": "String index type", + "default": "TextElements_v8", + "enum": [ + "TextElements_v8", + "UnicodeCodePoint", + "Utf16CodeUnit" + ], + "x-ms-enum": { + "name": "StringIndexType", + "modelAsString": true, + "values": [ + { + "name": "TextElements_v8", + "value": "TextElements_v8", + "description": "Returned offset and length values will correspond to TextElements (Graphemes and Grapheme clusters) confirming to the Unicode 8.0.0 standard. Use this option if your application is written in .Net Framework or .Net Core and you will be using StringInfo." + }, + { + "name": "UnicodeCodePoint", + "value": "UnicodeCodePoint", + "description": "Returned offset and length values will correspond to Unicode code points. Use this option if your application is written in a language that support Unicode, for example Python." + }, + { + "name": "Utf16CodeUnit", + "value": "Utf16CodeUnit", + "description": "Returned offset and length values will correspond to UTF-16 code units. Use this option if your application is written in a language that support Unicode, for example Java, JavaScript." + } + ] + } + }, + "summaryLength": { + "$ref": "#/definitions/SummaryLengthBucket", + "description": "(NOTE: Recommended to use summaryLength over sentenceCount) Controls the approximate length of the output summaries." + }, + "summaryAspects": { + "type": "array", + "description": "Array of Summary Aspects", + "items": { + "$ref": "#/definitions/SummaryAspect" + } + }, + "instruction": { + "type": "string", + "description": "a text field to allow customers to use natural language to describe their needs for summarization." + } + }, + "required": [ + "summaryAspects" + ] + }, + "ConversationTargetIntentResult": { + "type": "object", + "description": "A wrap up of Conversation project response.", + "properties": { + "result": { + "$ref": "#/definitions/ConversationResult", + "description": "The actual response from a Conversation project." + } + }, + "allOf": [ + { + "$ref": "#/definitions/TargetIntentResult" + } + ], + "x-ms-discriminator-value": "Conversation" + }, + "ConversationTaskParameters": { + "type": "object", + "description": "Input parameters necessary for a Conversation task.", + "properties": { + "projectName": { + "type": "string", + "description": "The name of the project to use." + }, + "deploymentName": { + "type": "string", + "description": "The name of the deployment to use." + }, + "verbose": { + "type": "boolean", + "description": "If true, the service will return more detailed information in the response." + }, + "isLoggingEnabled": { + "type": "boolean", + "description": "If true, the service will keep the query for further review." + }, + "stringIndexType": { + "type": "string", + "description": "Specifies the method used to interpret string offsets. Defaults to Text Elements (Graphemes) according to Unicode v8.0.0. For additional information see https://aka.ms/text-analytics-offsets.", + "default": "TextElements_v8", + "enum": [ + "TextElements_v8", + "UnicodeCodePoint", + "Utf16CodeUnit" + ], + "x-ms-enum": { + "name": "StringIndexType", + "modelAsString": true, + "values": [ + { + "name": "TextElements_v8", + "value": "TextElements_v8", + "description": "Returned offset and length values will correspond to TextElements (Graphemes and Grapheme clusters) confirming to the Unicode 8.0.0 standard. Use this option if your application is written in .Net Framework or .Net Core and you will be using StringInfo." + }, + { + "name": "UnicodeCodePoint", + "value": "UnicodeCodePoint", + "description": "Returned offset and length values will correspond to Unicode code points. Use this option if your application is written in a language that support Unicode, for example Python." + }, + { + "name": "Utf16CodeUnit", + "value": "Utf16CodeUnit", + "description": "Returned offset and length values will correspond to UTF-16 code units. Use this option if your application is written in a language that support Unicode, for example Java, JavaScript." + } + ] + } + }, + "directTarget": { + "type": "string", + "description": "The name of a target project to forward the request to." + }, + "targetProjectParameters": { + "type": "object", + "description": "A dictionary representing the parameters for each target project.", + "additionalProperties": { + "$ref": "#/definitions/AnalysisParameters" + } + } + }, + "required": [ + "projectName", + "deploymentName" + ] + }, + "ConversationalAIAnalysis": { + "type": "object", + "description": "Multiple multi-turn conversations analyzed.", + "properties": { + "id": { + "type": "string", + "description": "The ID of the conversation." + }, + "intents": { + "type": "array", + "description": "The intent classification results for this conversation.", + "items": { + "$ref": "#/definitions/ConversationalAIIntent" + } + }, + "entities": { + "type": "array", + "description": "Global entities that are matched but not associated with any specific intent.", + "items": { + "$ref": "#/definitions/ConversationalAIEntity" + } + } + }, + "required": [ + "id", + "intents" + ] + }, + "ConversationalAIAnalysisInput": { + "type": "object", + "description": "The input ConversationItem and its optional parameters", + "properties": { + "conversations": { + "type": "array", + "description": "List of multiple conversations", + "items": { + "$ref": "#/definitions/TextConversation" + } + } + }, + "required": [ + "conversations" + ] + }, + "ConversationalAIEntity": { + "type": "object", + "description": "The entity associated with this intent.", + "properties": { + "name": { + "type": "string", + "description": "The entity name or category." + }, + "text": { + "type": "string", + "description": "The detected text of the entity." + }, + "confidenceScore": { + "type": "number", + "format": "float", + "description": "The confidence score of the entity detection (0.0 to 1.0)." + }, + "offset": { + "type": "integer", + "format": "int32", + "description": "The starting index of the entity in the query." + }, + "length": { + "type": "integer", + "format": "int32", + "description": "The length of the detected entity text." + }, + "conversationItemId": { + "type": "string", + "description": "The ID of the conversation item where the entity appears." + }, + "conversationItemIndex": { + "type": "integer", + "format": "int32", + "description": "The index of the conversation item where the entity appears." + }, + "resolutions": { + "type": "array", + "description": "Entity resolution details, if available.", + "items": { + "$ref": "#/definitions/BaseResolution" + } + }, + "extraInformation": { + "type": "array", + "description": "Additional entity metadata.", + "items": { + "$ref": "#/definitions/BaseExtraInformation" + } + } + }, + "required": [ + "name", + "text", + "confidenceScore", + "offset", + "length", + "conversationItemId" + ] + }, + "ConversationalAIInputParameters": { + "type": "object", + "description": "Input parameters base for a Conversation task.", + "properties": { + "projectName": { + "type": "string", + "description": "The name of the project to use." + }, + "deploymentName": { + "type": "string", + "description": "The name of the deployment to use." + }, + "stringIndexType": { + "type": "string", + "description": "Specifies the method used to interpret string offsets. Defaults to Text Elements (Graphemes) according to Unicode v8.0.0. For additional information see https://aka.ms/text-analytics-offsets.", + "default": "TextElements_v8", + "enum": [ + "TextElements_v8", + "UnicodeCodePoint", + "Utf16CodeUnit" + ], + "x-ms-enum": { + "name": "StringIndexType", + "modelAsString": true, + "values": [ + { + "name": "TextElements_v8", + "value": "TextElements_v8", + "description": "Returned offset and length values will correspond to TextElements (Graphemes and Grapheme clusters) confirming to the Unicode 8.0.0 standard. Use this option if your application is written in .Net Framework or .Net Core and you will be using StringInfo." + }, + { + "name": "UnicodeCodePoint", + "value": "UnicodeCodePoint", + "description": "Returned offset and length values will correspond to Unicode code points. Use this option if your application is written in a language that support Unicode, for example Python." + }, + { + "name": "Utf16CodeUnit", + "value": "Utf16CodeUnit", + "description": "Returned offset and length values will correspond to UTF-16 code units. Use this option if your application is written in a language that support Unicode, for example Java, JavaScript." + } + ] + } + } + }, + "required": [ + "projectName", + "deploymentName" + ] + }, + "ConversationalAIIntent": { + "type": "object", + "description": "The intent classification result for this conversation.", + "properties": { + "name": { + "type": "string", + "description": "The name of the detected intent." + }, + "type": { + "type": "string", + "description": "The type of intent, either \"action\" or \"question\"." + }, + "conversationItemRanges": { + "type": "array", + "description": "The ranges of conversation items where this intent was identified.", + "items": { + "$ref": "#/definitions/ConversationItemRange" + } + }, + "entities": { + "type": "array", + "description": "The entities associated with this intent.", + "items": { + "$ref": "#/definitions/ConversationalAIEntity" + } + } + }, + "required": [ + "name", + "type", + "conversationItemRanges", + "entities" + ] + }, + "ConversationalAIResult": { + "type": "object", + "description": "Represents the conversational analysis response.", + "properties": { + "conversations": { + "type": "array", + "description": "Multiple multi-turn conversations analyzed.", + "items": { + "$ref": "#/definitions/ConversationalAIAnalysis" + } + }, + "warnings": { + "type": "array", + "description": "Any warnings encountered during processing.", + "items": { + "type": "string" + } + } + }, + "required": [ + "conversations" + ] + }, + "ConversationalAITask": { + "type": "object", + "description": "A conversational AI task.", + "properties": { + "analysisInput": { + "$ref": "#/definitions/ConversationalAIAnalysisInput", + "description": "The input ConversationItem and its optional parameters" + }, + "parameters": { + "$ref": "#/definitions/ConversationalAIInputParameters", + "description": "Input parameters necessary for a Conversation language understanding task." + } + }, + "required": [ + "analysisInput", + "parameters" + ], + "allOf": [ + { + "$ref": "#/definitions/AnalyzeConversationTask" + } + ], + "x-ms-discriminator-value": "ConversationalAI" + }, + "ConversationalAITaskResult": { + "type": "object", + "description": "The results of a ConversationalAI task.", + "properties": { + "result": { + "$ref": "#/definitions/ConversationalAIResult", + "description": "Represents the conversational analysis response." + } + }, + "required": [ + "result" + ], + "allOf": [ + { + "$ref": "#/definitions/AnalyzeConversationTaskResult" + } + ], + "x-ms-discriminator-value": "ConversationalAIResult" + }, + "ConversationalPiiResultWithResultBase": { + "type": "object", + "description": "Conversation PII result item", + "properties": { + "id": { + "type": "string", + "description": "Unique, non-empty conversation identifier." + }, + "warnings": { + "type": "array", + "description": "Warnings encountered in processing the document.", + "items": { + "$ref": "#/definitions/InputWarning" + } + }, + "statistics": { + "$ref": "#/definitions/ConversationStatistics", + "description": "If showStats=true was specified in the request this field will contain information about the conversation payload." + }, + "conversationItems": { + "type": "array", + "description": "List of conversationItems", + "items": { + "$ref": "#/definitions/ConversationPiiItemResult" + } + } + }, + "required": [ + "id", + "warnings", + "conversationItems" + ] + }, + "ConversationalTask": { + "type": "object", + "description": "The input for a conversation language understanding task.", + "properties": { + "analysisInput": { + "$ref": "#/definitions/ConversationAnalysisOptions", + "description": "The input ConversationItem and its optional parameters" + }, + "parameters": { + "$ref": "#/definitions/ConversationTaskParameters", + "description": "Input parameters necessary for a Conversation language understanding task." + } + }, + "required": [ + "analysisInput", + "parameters" + ], + "allOf": [ + { + "$ref": "#/definitions/AnalyzeConversationTask" + } + ], + "x-ms-discriminator-value": "Conversation" + }, + "ConversationalTaskResult": { + "type": "object", + "description": "The results of a Conversation task.", + "properties": { + "result": { + "$ref": "#/definitions/AnalyzeConversationResult", + "description": "Represents a conversation analysis response." + } + }, + "required": [ + "result" + ], + "allOf": [ + { + "$ref": "#/definitions/AnalyzeConversationTaskResult" + } + ], + "x-ms-discriminator-value": "ConversationResult" + }, + "ConversationsSummaryResult": { + "type": "object", + "description": "Conversations Summary Result", + "properties": { + "id": { + "type": "string", + "description": "Unique, non-empty conversation identifier." + }, + "warnings": { + "type": "array", + "description": "Warnings encountered in processing the document.", + "items": { + "$ref": "#/definitions/InputWarning" + } + }, + "statistics": { + "$ref": "#/definitions/ConversationStatistics", + "description": "If showStats=true was specified in the request this field will contain information about the conversation payload." + }, + "summaries": { + "type": "array", + "description": "array of summaries", + "items": { + "$ref": "#/definitions/SummaryResultItem" + } + } + }, + "required": [ + "id", + "warnings", + "summaries" + ] + }, + "CurrencyResolution": { + "type": "object", + "description": "Represents the currency entity resolution model.", + "properties": { + "ISO4217": { + "type": "string", + "description": "The alphabetic code based on another ISO standard, ISO 3166, which lists the codes for country names. The first two letters of the ISO 4217 three-letter code are the same as the code for the country name, and, where possible, the third letter corresponds to the first letter of the currency name.", + "x-ms-client-name": "iso4217" + }, + "value": { + "type": "number", + "format": "double", + "description": "The money amount captured in the extracted entity" + }, + "unit": { + "type": "string", + "description": "The unit of the amount captured in the extracted entity" + } + }, + "required": [ + "value", + "unit" + ], + "allOf": [ + { + "$ref": "#/definitions/BaseResolution" + } + ], + "x-ms-discriminator-value": "CurrencyResolution" + }, + "CustomConversationSummarizationTaskParameters": { + "type": "object", + "description": "Supported parameters for a custom conversation summarization task.", + "properties": { + "loggingOptOut": { + "type": "boolean", + "description": "logging opt out", + "default": false + }, + "projectName": { + "type": "string", + "description": "This field indicates the project name for the model." + }, + "deploymentName": { + "type": "string", + "description": "This field indicates the deployment name for the model." + }, + "sentenceCount": { + "type": "integer", + "format": "int32", + "description": "It controls the approximate number of sentences in the output summaries." + }, + "stringIndexType": { + "type": "string", + "description": "String index type", + "default": "TextElements_v8", + "enum": [ + "TextElements_v8", + "UnicodeCodePoint", + "Utf16CodeUnit" + ], + "x-ms-enum": { + "name": "StringIndexType", + "modelAsString": true, + "values": [ + { + "name": "TextElements_v8", + "value": "TextElements_v8", + "description": "Returned offset and length values will correspond to TextElements (Graphemes and Grapheme clusters) confirming to the Unicode 8.0.0 standard. Use this option if your application is written in .Net Framework or .Net Core and you will be using StringInfo." + }, + { + "name": "UnicodeCodePoint", + "value": "UnicodeCodePoint", + "description": "Returned offset and length values will correspond to Unicode code points. Use this option if your application is written in a language that support Unicode, for example Python." + }, + { + "name": "Utf16CodeUnit", + "value": "Utf16CodeUnit", + "description": "Returned offset and length values will correspond to UTF-16 code units. Use this option if your application is written in a language that support Unicode, for example Java, JavaScript." + } + ] + } + }, + "summaryLength": { + "$ref": "#/definitions/SummaryLengthBucket", + "description": "Controls the approximate length of the output summaries. Recommended to use summaryLength over sentenceCount" + }, + "summaryAspects": { + "type": "array", + "description": "Array of Summary Aspects", + "items": { + "$ref": "#/definitions/SummaryAspect" + } + } + }, + "required": [ + "projectName", + "deploymentName", + "summaryAspects" + ] + }, + "CustomSummaryResult": { + "type": "object", + "description": "Custom Summary Results", + "properties": { + "conversations": { + "type": "array", + "description": "array of conversations", + "items": { + "$ref": "#/definitions/ConversationsSummaryResult" + } + }, + "errors": { + "type": "array", + "description": "Errors by document id.", + "items": { + "$ref": "#/definitions/DocumentError" + } + }, + "statistics": { + "$ref": "#/definitions/RequestStatistics", + "description": "if showStats=true was specified in the request this field will contain information about the request payload." + }, + "projectName": { + "type": "string", + "description": "This field indicates the project name for the model." + }, + "deploymentName": { + "type": "string", + "description": "This field indicates the deployment name for the model." + } + }, + "required": [ + "conversations", + "errors", + "projectName", + "deploymentName" + ] + }, + "DateTimeResolution": { + "type": "object", + "description": "A resolution for datetime entity instances.", + "properties": { + "timex": { + "type": "string", + "description": "An extended ISO 8601 date/time representation as described in (https://github.com/Microsoft/Recognizers-Text/blob/master/Patterns/English/English-DateTime.yaml)" + }, + "dateTimeSubKind": { + "$ref": "#/definitions/DateTimeSubKind", + "description": "The DateTime SubKind" + }, + "value": { + "type": "string", + "description": "The actual time that the extracted text denote." + }, + "modifier": { + "$ref": "#/definitions/TemporalModifier", + "description": "An optional modifier of a date/time instance." + } + }, + "required": [ + "timex", + "dateTimeSubKind", + "value" + ], + "allOf": [ + { + "$ref": "#/definitions/BaseResolution" + } + ], + "x-ms-discriminator-value": "DateTimeResolution" + }, + "DateTimeSubKind": { + "type": "string", + "description": "The Datetime SubKind.", + "enum": [ + "Time", + "Date", + "DateTime", + "Duration", + "Set" + ], + "x-ms-enum": { + "name": "DateTimeSubKind", + "modelAsString": true, + "values": [ + { + "name": "Time", + "value": "Time", + "description": "Time subkind" + }, + { + "name": "Date", + "value": "Date", + "description": "Date subkind" + }, + { + "name": "DateTime", + "value": "DateTime", + "description": "DateTime subkind" + }, + { + "name": "Duration", + "value": "Duration", + "description": "Duration subkind" + }, + { + "name": "Set", + "value": "Set", + "description": "Set subkind" + } + ] + } + }, + "DocumentError": { + "type": "object", + "description": "Contains details of errors encountered during a job execution.", + "properties": { + "id": { + "type": "string", + "description": "The ID of the input document." + }, + "error": { + "$ref": "#/definitions/Error", + "description": "Error encountered." + } + }, + "required": [ + "id", + "error" + ] + }, + "Entity": { + "type": "object", + "description": "Text that has been categorized into pre-defined classes or types such as: person, location, event, product, and organization.", + "properties": { + "text": { + "type": "string", + "description": "Entity text as appears in the request." + }, + "category": { + "type": "string", + "description": "Entity type." + }, + "subcategory": { + "type": "string", + "description": "(Optional) Entity sub type." + }, + "offset": { + "type": "integer", + "format": "int32", + "description": "Start position for the entity text. Use of different 'stringIndexType' values can affect the offset returned." + }, + "length": { + "type": "integer", + "format": "int32", + "description": "Length for the entity text. Use of different 'stringIndexType' values can affect the length returned." + }, + "confidenceScore": { + "type": "number", + "format": "double", + "description": "Confidence score between 0 and 1 of the extracted entity." + }, + "mask": { + "type": "string", + "description": "Exact mask text to mask the PII entity" + }, + "maskOffset": { + "type": "integer", + "format": "int32", + "description": "Offset of the mask text" + }, + "maskLength": { + "type": "integer", + "format": "int32", + "description": "Length of the mask text" + } + }, + "required": [ + "text", + "category", + "offset", + "length", + "confidenceScore" + ] + }, + "EntityMaskTypePolicyType": { + "type": "object", + "description": "Represents the policy of masking PII with the entity type.", + "allOf": [ + { + "$ref": "#/definitions/BaseRedactionPolicy" + } + ], + "x-ms-discriminator-value": "entityMask" + }, + "EntitySubtype": { + "type": "object", + "description": "The concrete entity Subtype model of extra information.", + "properties": { + "value": { + "type": "string", + "description": "The Subtype of an extracted entity type." + }, + "tags": { + "type": "array", + "description": "List of entity tags. Tags express similarities between entity categories for the extracted entity type.", + "items": { + "$ref": "#/definitions/EntityTag" + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/BaseExtraInformation" + } + ], + "x-ms-discriminator-value": "EntitySubtype" + }, + "EntityTag": { + "type": "object", + "description": "Tags express similarities between entity categories for the extracted entity type.", + "properties": { + "name": { + "type": "string", + "description": "The name of the tag." + }, + "confidenceScore": { + "type": "number", + "format": "double", + "description": "The confidence score of the tag for the extracted entity between 0.0 and 1.0." + } + }, + "required": [ + "name" + ] + }, + "Error": { + "type": "object", + "description": "The error object.", + "properties": { + "code": { + "$ref": "#/definitions/ErrorCode", + "description": "One of a server-defined set of error codes." + }, + "message": { + "type": "string", + "description": "A human-readable representation of the error." + }, + "target": { + "type": "string", + "description": "The target of the error." + }, + "details": { + "type": "array", + "description": "An array of details about specific errors that led to this reported error.", + "items": { + "$ref": "#/definitions/Error" + } + }, + "innererror": { + "$ref": "#/definitions/InnerErrorModel", + "description": "An object containing more specific information than the current object about the error." + } + }, + "required": [ + "code", + "message" + ] + }, + "ErrorCode": { + "type": "string", + "description": "Human-readable error code.", + "enum": [ + "InvalidRequest", + "InvalidArgument", + "Unauthorized", + "Forbidden", + "NotFound", + "ProjectNotFound", + "OperationNotFound", + "AzureCognitiveSearchNotFound", + "AzureCognitiveSearchIndexNotFound", + "TooManyRequests", + "AzureCognitiveSearchThrottling", + "AzureCognitiveSearchIndexLimitReached", + "InternalServerError", + "ServiceUnavailable", + "Timeout", + "QuotaExceeded", + "Conflict", + "Warning" + ], + "x-ms-enum": { + "name": "ErrorCode", + "modelAsString": true, + "values": [ + { + "name": "InvalidRequest", + "value": "InvalidRequest", + "description": "Invalid request error" + }, + { + "name": "InvalidArgument", + "value": "InvalidArgument", + "description": "Invalid argument error" + }, + { + "name": "Unauthorized", + "value": "Unauthorized", + "description": "Unauthorized access error" + }, + { + "name": "Forbidden", + "value": "Forbidden", + "description": "Forbidden access error" + }, + { + "name": "NotFound", + "value": "NotFound", + "description": "Not found error" + }, + { + "name": "ProjectNotFound", + "value": "ProjectNotFound", + "description": "Project not found error" + }, + { + "name": "OperationNotFound", + "value": "OperationNotFound", + "description": "Operation not found error" + }, + { + "name": "AzureCognitiveSearchNotFound", + "value": "AzureCognitiveSearchNotFound", + "description": "Azure Cognitive Search not found error" + }, + { + "name": "AzureCognitiveSearchIndexNotFound", + "value": "AzureCognitiveSearchIndexNotFound", + "description": "Azure Cognitive Search index not found error" + }, + { + "name": "TooManyRequests", + "value": "TooManyRequests", + "description": "Too many requests error" + }, + { + "name": "AzureCognitiveSearchThrottling", + "value": "AzureCognitiveSearchThrottling", + "description": "Azure Cognitive Search throttling error" + }, + { + "name": "AzureCognitiveSearchIndexLimitReached", + "value": "AzureCognitiveSearchIndexLimitReached", + "description": "Azure Cognitive Search index limit reached error" + }, + { + "name": "InternalServerError", + "value": "InternalServerError", + "description": "Internal server error" + }, + { + "name": "ServiceUnavailable", + "value": "ServiceUnavailable", + "description": "Service unavailable error" + }, + { + "name": "Timeout", + "value": "Timeout", + "description": "Timeout error" + }, + { + "name": "QuotaExceeded", + "value": "QuotaExceeded", + "description": "Quota exceeded error" + }, + { + "name": "Conflict", + "value": "Conflict", + "description": "Conflict error" + }, + { + "name": "Warning", + "value": "Warning", + "description": "Warning error" + } + ] + } + }, + "ErrorResponse": { + "type": "object", + "description": "Error response.", + "properties": { + "error": { + "$ref": "#/definitions/Error", + "description": "The error object." + } + }, + "required": [ + "error" + ] + }, + "ExtraInformationKind": { + "type": "string", + "description": "The extra information object kind.", + "enum": [ + "EntitySubtype", + "ListKey", + "RegexKey" + ], + "x-ms-enum": { + "name": "ExtraInformationKind", + "modelAsString": true, + "values": [ + { + "name": "EntitySubtype", + "value": "EntitySubtype", + "description": "Entity subtype extra information kind" + }, + { + "name": "ListKey", + "value": "ListKey", + "description": "List key extra information kind" + }, + { + "name": "RegexKey", + "value": "RegexKey", + "description": "Regex key extra information kind" + } + ] + } + }, + "InformationResolution": { + "type": "object", + "description": "Represents the information (data) entity resolution model.", + "properties": { + "value": { + "type": "number", + "format": "double", + "description": "The numeric value that the extracted text denotes." + }, + "unit": { + "$ref": "#/definitions/InformationUnit", + "description": "The information (data) Unit of measurement." + } + }, + "required": [ + "value", + "unit" + ], + "allOf": [ + { + "$ref": "#/definitions/BaseResolution" + } + ], + "x-ms-discriminator-value": "InformationResolution" + }, + "InformationUnit": { + "type": "string", + "description": "The information (data) Unit of measurement.", + "enum": [ + "Unspecified", + "Bit", + "Kilobit", + "Megabit", + "Gigabit", + "Terabit", + "Petabit", + "Byte", + "Kilobyte", + "Megabyte", + "Gigabyte", + "Terabyte", + "Petabyte" + ], + "x-ms-enum": { + "name": "InformationUnit", + "modelAsString": true, + "values": [ + { + "name": "Unspecified", + "value": "Unspecified", + "description": "Unspecified information unit" + }, + { + "name": "Bit", + "value": "Bit", + "description": "Bit information unit" + }, + { + "name": "Kilobit", + "value": "Kilobit", + "description": "Kilobit information unit" + }, + { + "name": "Megabit", + "value": "Megabit", + "description": "Megabit information unit" + }, + { + "name": "Gigabit", + "value": "Gigabit", + "description": "Gigabit information unit" + }, + { + "name": "Terabit", + "value": "Terabit", + "description": "Terabit information unit" + }, + { + "name": "Petabit", + "value": "Petabit", + "description": "Petabit information unit" + }, + { + "name": "Byte", + "value": "Byte", + "description": "Byte information unit" + }, + { + "name": "Kilobyte", + "value": "Kilobyte", + "description": "Kilobyte information unit" + }, + { + "name": "Megabyte", + "value": "Megabyte", + "description": "Megabyte information unit" + }, + { + "name": "Gigabyte", + "value": "Gigabyte", + "description": "Gigabyte information unit" + }, + { + "name": "Terabyte", + "value": "Terabyte", + "description": "Terabyte information unit" + }, + { + "name": "Petabyte", + "value": "Petabyte", + "description": "Petabyte information unit" + } + ] + } + }, + "InnerErrorCode": { + "type": "string", + "description": "Human-readable error code.", + "enum": [ + "InvalidRequest", + "InvalidParameterValue", + "KnowledgeBaseNotFound", + "AzureCognitiveSearchNotFound", + "AzureCognitiveSearchThrottling", + "ExtractionFailure", + "InvalidRequestBodyFormat", + "EmptyRequest", + "MissingInputDocuments", + "InvalidDocument", + "ModelVersionIncorrect", + "InvalidDocumentBatch", + "UnsupportedLanguageCode", + "InvalidCountryHint" + ], + "x-ms-enum": { + "name": "InnerErrorCode", + "modelAsString": true, + "values": [ + { + "name": "InvalidRequest", + "value": "InvalidRequest", + "description": "Invalid request error" + }, + { + "name": "InvalidParameterValue", + "value": "InvalidParameterValue", + "description": "Invalid parameter value error" + }, + { + "name": "KnowledgeBaseNotFound", + "value": "KnowledgeBaseNotFound", + "description": "Knowledge base not found error" + }, + { + "name": "AzureCognitiveSearchNotFound", + "value": "AzureCognitiveSearchNotFound", + "description": "Azure Cognitive Search not found error" + }, + { + "name": "AzureCognitiveSearchThrottling", + "value": "AzureCognitiveSearchThrottling", + "description": "Azure Cognitive Search throttling error" + }, + { + "name": "ExtractionFailure", + "value": "ExtractionFailure", + "description": "Extraction failure error" + }, + { + "name": "InvalidRequestBodyFormat", + "value": "InvalidRequestBodyFormat", + "description": "Invalid request body format error" + }, + { + "name": "EmptyRequest", + "value": "EmptyRequest", + "description": "Empty request error" + }, + { + "name": "MissingInputDocuments", + "value": "MissingInputDocuments", + "description": "Missing input documents error" + }, + { + "name": "InvalidDocument", + "value": "InvalidDocument", + "description": "Invalid document error" + }, + { + "name": "ModelVersionIncorrect", + "value": "ModelVersionIncorrect", + "description": "Model version incorrect error" + }, + { + "name": "InvalidDocumentBatch", + "value": "InvalidDocumentBatch", + "description": "Invalid document batch error" + }, + { + "name": "UnsupportedLanguageCode", + "value": "UnsupportedLanguageCode", + "description": "Unsupported language code error" + }, + { + "name": "InvalidCountryHint", + "value": "InvalidCountryHint", + "description": "Invalid country hint error" + } + ] + } + }, + "InnerErrorModel": { + "type": "object", + "description": "An object containing more specific information about the error. As per Microsoft One API guidelines - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.", + "properties": { + "code": { + "$ref": "#/definitions/InnerErrorCode", + "description": "One of a server-defined set of error codes." + }, + "message": { + "type": "string", + "description": "Error message." + }, + "details": { + "type": "object", + "description": "Error details.", + "additionalProperties": { + "type": "string" + } + }, + "target": { + "type": "string", + "description": "Error target." + }, + "innererror": { + "$ref": "#/definitions/InnerErrorModel", + "description": "An object containing more specific information than the current object about the error." + } + }, + "required": [ + "code", + "message" + ] + }, + "InputModality": { + "type": "string", + "description": "Enumeration of supported conversational modalities.", + "enum": [ + "transcript", + "text" + ], + "x-ms-enum": { + "name": "InputModality", + "modelAsString": true, + "values": [ + { + "name": "transcript", + "value": "transcript", + "description": "Transcript input modality" + }, + { + "name": "text", + "value": "text", + "description": "Text input modality" + } + ] + } + }, + "InputWarning": { + "type": "object", + "description": "Contains details of warnings encountered during a job execution.", + "properties": { + "code": { + "type": "string", + "description": "Warning code." + }, + "message": { + "type": "string", + "description": "Warning message." + }, + "targetRef": { + "type": "string", + "description": "A JSON pointer reference indicating the target object." + } + }, + "required": [ + "code", + "message" + ] + }, + "ItemizedSummaryContext": { + "type": "object", + "description": "Context of the summary with a conversation item ID.", + "properties": { + "offset": { + "type": "integer", + "format": "int32", + "description": "Start position for the context. Use of different 'stringIndexType' values can affect the offset returned." + }, + "length": { + "type": "integer", + "format": "int32", + "description": "The length of the context. Use of different 'stringIndexType' values can affect the length returned." + }, + "conversationItemId": { + "type": "string", + "description": "Reference to the ID of ConversationItem." + } + }, + "required": [ + "offset", + "length", + "conversationItemId" + ] + }, + "KnowledgeBaseAnswer": { + "type": "object", + "description": "Represents knowledge base answer.", + "properties": { + "questions": { + "type": "array", + "description": "List of questions associated with the answer.", + "items": { + "type": "string" + } + }, + "answer": { + "type": "string", + "description": "Answer text." + }, + "confidenceScore": { + "type": "number", + "format": "double", + "description": "Answer confidence score, value ranges from 0 to 1.", + "minimum": 0, + "maximum": 1 + }, + "id": { + "type": "integer", + "format": "int32", + "description": "ID of the QnA result." + }, + "source": { + "type": "string", + "description": "Source of QnA result." + }, + "metadata": { + "type": "object", + "description": "Metadata associated with the answer, useful to categorize or filter question answers.", + "additionalProperties": { + "type": "string" + } + }, + "dialog": { + "$ref": "#/definitions/KnowledgeBaseAnswerDialog", + "description": "Dialog associated with Answer." + }, + "answerSpan": { + "$ref": "#/definitions/AnswerSpan", + "description": "Answer span object of QnA with respect to user's question." + } + } + }, + "KnowledgeBaseAnswerContext": { + "type": "object", + "description": "Context object with previous QnA's information.", + "properties": { + "previousQnaId": { + "type": "integer", + "format": "int32", + "description": "Previous turn top answer result QnA ID." + }, + "previousUserQuery": { + "type": "string", + "description": "Previous user query." + } + }, + "required": [ + "previousQnaId" + ] + }, + "KnowledgeBaseAnswerDialog": { + "type": "object", + "description": "Dialog associated with Answer.", + "properties": { + "isContextOnly": { + "type": "boolean", + "description": "To mark if a prompt is relevant only with a previous question or not. If true, do not include this QnA as search result for queries without context; otherwise, if false, ignores context and includes this QnA in search result." + }, + "prompts": { + "type": "array", + "description": "List of prompts associated with the answer.", + "maxItems": 20, + "items": { + "$ref": "#/definitions/KnowledgeBaseAnswerPrompt" + } + } + } + }, + "KnowledgeBaseAnswerPrompt": { + "type": "object", + "description": "Prompt for an answer.", + "properties": { + "displayOrder": { + "type": "integer", + "format": "int32", + "description": "Index of the prompt - used in ordering of the prompts." + }, + "qnaId": { + "type": "integer", + "format": "int32", + "description": "QnA ID corresponding to the prompt." + }, + "displayText": { + "type": "string", + "description": "Text displayed to represent a follow up question prompt.", + "maxLength": 200 + } + } + }, + "LengthResolution": { + "type": "object", + "description": "Represents the length entity resolution model.", + "properties": { + "value": { + "type": "number", + "format": "double", + "description": "The numeric value that the extracted text denotes." + }, + "unit": { + "$ref": "#/definitions/LengthUnit", + "description": "The length Unit of measurement" + } + }, + "required": [ + "value", + "unit" + ], + "allOf": [ + { + "$ref": "#/definitions/BaseResolution" + } + ], + "x-ms-discriminator-value": "LengthResolution" + }, + "LengthUnit": { + "type": "string", + "description": "The length unit of measurement.", + "enum": [ + "Unspecified", + "Kilometer", + "Hectometer", + "Decameter", + "Meter", + "Decimeter", + "Centimeter", + "Millimeter", + "Micrometer", + "Nanometer", + "Picometer", + "Mile", + "Yard", + "Inch", + "Foot", + "LightYear", + "Pt" + ], + "x-ms-enum": { + "name": "LengthUnit", + "modelAsString": true, + "values": [ + { + "name": "Unspecified", + "value": "Unspecified", + "description": "Unspecified length unit" + }, + { + "name": "Kilometer", + "value": "Kilometer", + "description": "Kilometer length unit" + }, + { + "name": "Hectometer", + "value": "Hectometer", + "description": "Hectometer length unit" + }, + { + "name": "Decameter", + "value": "Decameter", + "description": "Decameter length unit" + }, + { + "name": "Meter", + "value": "Meter", + "description": "Meter length unit" + }, + { + "name": "Decimeter", + "value": "Decimeter", + "description": "Decimeter length unit" + }, + { + "name": "Centimeter", + "value": "Centimeter", + "description": "Centimeter length unit" + }, + { + "name": "Millimeter", + "value": "Millimeter", + "description": "Millimeter length unit" + }, + { + "name": "Micrometer", + "value": "Micrometer", + "description": "Micrometer length unit" + }, + { + "name": "Nanometer", + "value": "Nanometer", + "description": "Nanometer length unit" + }, + { + "name": "Picometer", + "value": "Picometer", + "description": "Picometer length unit" + }, + { + "name": "Mile", + "value": "Mile", + "description": "Mile length unit" + }, + { + "name": "Yard", + "value": "Yard", + "description": "Yard length unit" + }, + { + "name": "Inch", + "value": "Inch", + "description": "Inch length unit" + }, + { + "name": "Foot", + "value": "Foot", + "description": "Foot length unit" + }, + { + "name": "LightYear", + "value": "LightYear", + "description": "Light year length unit" + }, + { + "name": "Pt", + "value": "Pt", + "description": "Point length unit" + } + ] + } + }, + "ListKey": { + "type": "object", + "description": "The list key extra data kind.", + "properties": { + "key": { + "type": "string", + "description": "The canonical form of the extracted entity." + } + }, + "allOf": [ + { + "$ref": "#/definitions/BaseExtraInformation" + } + ], + "x-ms-discriminator-value": "ListKey" + }, + "LuisCallingOptions": { + "type": "object", + "description": "This customizes how the service calls LUIS Generally Available projects.", + "properties": { + "verbose": { + "type": "boolean", + "description": "Enable verbose response." + }, + "log": { + "type": "boolean", + "description": "Save log to add in training utterances later." + }, + "show-all-intents": { + "type": "boolean", + "description": "Set true to show all intents." + }, + "timezoneOffset": { + "type": "integer", + "format": "int32", + "description": "The timezone offset for the location of the request." + }, + "spellCheck": { + "type": "boolean", + "description": "Enable spell checking." + }, + "bing-spell-check-subscription-key": { + "type": "string", + "description": "The subscription key to use when enabling Bing spell check" + } + } + }, + "LuisParameters": { + "type": "object", + "description": "This is a set of request parameters for LUIS Generally Available projects.", + "properties": { + "query": { + "type": "string", + "description": "The utterance to predict.", + "maxLength": 500 + }, + "callingOptions": { + "$ref": "#/definitions/LuisCallingOptions", + "description": "This customizes how the service calls LUIS Generally Available projects." + } + }, + "allOf": [ + { + "$ref": "#/definitions/AnalysisParameters" + } + ], + "x-ms-discriminator-value": "Luis" + }, + "LuisResult": { + "type": "object", + "description": "It is the response from a LUIS Generally Available application.", + "additionalProperties": {} + }, + "LuisTargetIntentResult": { + "type": "object", + "description": "It is a wrap up of LUIS Generally Available response.", + "properties": { + "result": { + "$ref": "#/definitions/LuisResult", + "description": "The actual response from a LUIS Generally Available application." + } + }, + "allOf": [ + { + "$ref": "#/definitions/TargetIntentResult" + } + ], + "x-ms-discriminator-value": "Luis" + }, + "MetadataFilter": { + "type": "object", + "description": "Find QnAs that are associated with the given list of metadata.", + "properties": { + "metadata": { + "type": "array", + "description": "List of metadata.", + "items": { + "$ref": "#/definitions/MetadataRecord" + } + }, + "logicalOperation": { + "type": "string", + "description": "Operation used to join metadata filters.", + "default": "AND", + "enum": [ + "AND", + "OR" + ], + "x-ms-enum": { + "name": "LogicalOperationKind", + "modelAsString": true, + "values": [ + { + "name": "AND", + "value": "AND", + "description": "Logical AND" + }, + { + "name": "OR", + "value": "OR", + "description": "Logical OR" + } + ] + } + } + } + }, + "MetadataRecord": { + "type": "object", + "description": "Object to provide the key value pair for each metadata.", + "properties": { + "key": { + "type": "string", + "description": "Metadata Key from Metadata dictionary used in the QnA." + }, + "value": { + "type": "string", + "description": "Metadata Value from Metadata dictionary used in the QnA." + } + }, + "required": [ + "key", + "value" + ] + }, + "MultiLanguageConversationAnalysisInput": { + "type": "object", + "description": "Multi Language Conversation Analysis Input", + "properties": { + "conversations": { + "type": "array", + "description": "Array of conversation items", + "items": { + "$ref": "#/definitions/Conversation" + } + } + }, + "required": [ + "conversations" + ] + }, + "NoMaskPolicyType": { + "type": "object", + "description": "Represents the policy of not masking found PII.", + "allOf": [ + { + "$ref": "#/definitions/BaseRedactionPolicy" + } + ], + "x-ms-discriminator-value": "noMask" + }, + "NoneLinkedTargetIntentResult": { + "type": "object", + "description": "A wrap up of non-linked intent response.", + "properties": { + "result": { + "$ref": "#/definitions/ConversationResult", + "description": "The actual response from a Conversation project." + } + }, + "allOf": [ + { + "$ref": "#/definitions/TargetIntentResult" + } + ], + "x-ms-discriminator-value": "NonLinked" + }, + "NumberKind": { + "type": "string", + "description": "The type of the extracted number entity.", + "enum": [ + "Integer", + "Decimal", + "Power", + "Fraction", + "Percent", + "Unspecified" + ], + "x-ms-enum": { + "name": "NumberKind", + "modelAsString": true, + "values": [ + { + "name": "Integer", + "value": "Integer", + "description": "Integer number" + }, + { + "name": "Decimal", + "value": "Decimal", + "description": "Decimal number" + }, + { + "name": "Power", + "value": "Power", + "description": "Power number" + }, + { + "name": "Fraction", + "value": "Fraction", + "description": "Fraction number" + }, + { + "name": "Percent", + "value": "Percent", + "description": "Percent number" + }, + { + "name": "Unspecified", + "value": "Unspecified", + "description": "Unspecified number kind" + } + ] + } + }, + "NumberResolution": { + "type": "object", + "description": "A resolution for numeric entity instances.", + "properties": { + "numberKind": { + "$ref": "#/definitions/NumberKind", + "description": "The type of the extracted number entity." + }, + "value": { + "type": "number", + "format": "double", + "description": "A numeric representation of what the extracted text denotes." + } + }, + "required": [ + "numberKind", + "value" + ], + "allOf": [ + { + "$ref": "#/definitions/BaseResolution" + } + ], + "x-ms-discriminator-value": "NumberResolution" + }, + "NumericRangeResolution": { + "type": "object", + "description": "represents the resolution of numeric intervals.", + "properties": { + "rangeKind": { + "$ref": "#/definitions/RangeKind", + "description": "The kind of range that the resolution object represents." + }, + "minimum": { + "type": "number", + "format": "double", + "description": "The beginning value of the interval." + }, + "maximum": { + "type": "number", + "format": "double", + "description": "The ending value of the interval." + } + }, + "required": [ + "rangeKind", + "minimum", + "maximum" + ], + "allOf": [ + { + "$ref": "#/definitions/BaseResolution" + } + ], + "x-ms-discriminator-value": "NumericRangeResolution" + }, + "OrchestrationPrediction": { + "type": "object", + "description": "This represents the prediction result of an Orchestration project.", + "properties": { + "intents": { + "type": "object", + "description": "A dictionary that contains all intents. A key is an intent name and a value is its confidence score and target type. The top intent's value also contains the actual response from the target project.", + "additionalProperties": { + "$ref": "#/definitions/TargetIntentResult" + } + } + }, + "required": [ + "intents" + ], + "allOf": [ + { + "$ref": "#/definitions/BasePrediction" + } + ], + "x-ms-discriminator-value": "Orchestration" + }, + "OrdinalResolution": { + "type": "object", + "description": "A resolution for ordinal numbers entity instances.", + "properties": { + "offset": { + "type": "string", + "description": "The offset with respect to the reference (e.g., offset = -1 indicates the second to last)" + }, + "relativeTo": { + "$ref": "#/definitions/RelativeTo", + "description": "The reference point that the ordinal number denotes." + }, + "value": { + "type": "string", + "description": "A simple arithmetic expression that the ordinal denotes." + } + }, + "required": [ + "offset", + "relativeTo", + "value" + ], + "allOf": [ + { + "$ref": "#/definitions/BaseResolution" + } + ], + "x-ms-discriminator-value": "OrdinalResolution" + }, + "QueryFilters": { + "type": "object", + "description": "filters over knowledge base.", + "properties": { + "metadataFilter": { + "$ref": "#/definitions/MetadataFilter", + "description": "filters over knowledge base." + }, + "sourceFilter": { + "$ref": "#/definitions/SourceFilter", + "description": "filters over knowledge base." + }, + "logicalOperation": { + "type": "string", + "description": "Logical operation used to join metadata filter with source filter.", + "default": "AND", + "enum": [ + "AND", + "OR" + ], + "x-ms-enum": { + "name": "LogicalOperationKind", + "modelAsString": true, + "values": [ + { + "name": "AND", + "value": "AND", + "description": "Logical AND" + }, + { + "name": "OR", + "value": "OR", + "description": "Logical OR" + } + ] + } + } + } + }, + "QuestionAnsweringParameters": { + "type": "object", + "description": "This is a set of request parameters for Question Answering knowledge bases.", + "properties": { + "callingOptions": { + "$ref": "#/definitions/AnswersOptions", + "description": "The options sent to a Question Answering KB." + } + }, + "allOf": [ + { + "$ref": "#/definitions/AnalysisParameters" + } + ], + "x-ms-discriminator-value": "QuestionAnswering" + }, + "QuestionAnsweringTargetIntentResult": { + "type": "object", + "description": "It is a wrap up a Question Answering KB response.", + "properties": { + "result": { + "$ref": "#/definitions/AnswersResult", + "description": "The generated answer by a Question Answering KB." + } + }, + "allOf": [ + { + "$ref": "#/definitions/TargetIntentResult" + } + ], + "x-ms-discriminator-value": "QuestionAnswering" + }, + "RangeKind": { + "type": "string", + "description": "The kind of range that the resolution object represents.", + "enum": [ + "Number", + "Speed", + "Weight", + "Length", + "Volume", + "Area", + "Age", + "Information", + "Temperature", + "Currency" + ], + "x-ms-enum": { + "name": "RangeKind", + "modelAsString": true, + "values": [ + { + "name": "Number", + "value": "Number", + "description": "Number range" + }, + { + "name": "Speed", + "value": "Speed", + "description": "Speed range" + }, + { + "name": "Weight", + "value": "Weight", + "description": "Weight range" + }, + { + "name": "Length", + "value": "Length", + "description": "Length range" + }, + { + "name": "Volume", + "value": "Volume", + "description": "Volume range" + }, + { + "name": "Area", + "value": "Area", + "description": "Area range" + }, + { + "name": "Age", + "value": "Age", + "description": "Age range" + }, + { + "name": "Information", + "value": "Information", + "description": "Information range" + }, + { + "name": "Temperature", + "value": "Temperature", + "description": "Temperature range" + }, + { + "name": "Currency", + "value": "Currency", + "description": "Currency range" + } + ] + } + }, + "RankerKind": { + "type": "string", + "description": "Type of ranker to be used", + "enum": [ + "Default", + "QuestionOnly" + ], + "x-ms-enum": { + "name": "RankerKind", + "modelAsString": true, + "values": [ + { + "name": "Default", + "value": "Default", + "description": "Default ranker." + }, + { + "name": "QuestionOnly", + "value": "QuestionOnly", + "description": "Question only ranker." + } + ] + } + }, + "RedactedTranscriptContent": { + "type": "object", + "description": "Transcript content response that the service generates, with all necessary personally identifiable information redacted.", + "properties": { + "itn": { + "type": "string", + "description": "Redacted output for input in inverse-text-normalized format." + }, + "maskedItn": { + "type": "string", + "description": "Redacted output for input in masked inverse-text-normalized format." + }, + "text": { + "type": "string", + "description": "Redacted output for input in text (Microsoft's speech-to-text 'display') format." + }, + "lexical": { + "type": "string", + "description": "Redacted output for input in lexical format." + }, + "audioTimings": { + "type": "array", + "description": "List of redacted audio segments.", + "items": { + "$ref": "#/definitions/AudioTiming" + } + } + } + }, + "RegexKey": { + "type": "object", + "description": "The regex key extra data kind.", + "properties": { + "key": { + "type": "string", + "description": "The key of the regex pattern used in extracting the entity." + }, + "regexPattern": { + "type": "string", + "description": "The .NET regex pattern used in extracting the entity. Please visit https://learn.microsoft.com/dotnet/standard/base-types/regular-expressions for more information about .NET regular expressions." + } + }, + "allOf": [ + { + "$ref": "#/definitions/BaseExtraInformation" + } + ], + "x-ms-discriminator-value": "RegexKey" + }, + "RelativeTo": { + "type": "string", + "description": "The reference point that the ordinal number denotes.", + "enum": [ + "Current", + "End", + "Start" + ], + "x-ms-enum": { + "name": "RelativeTo", + "modelAsString": true, + "values": [ + { + "name": "Current", + "value": "Current", + "description": "Current state" + }, + { + "name": "End", + "value": "End", + "description": "End state" + }, + { + "name": "Start", + "value": "Start", + "description": "Start state" + } + ] + } + }, + "RequestStatistics": { + "type": "object", + "description": "if showStats=true was specified in the request this field will contain information about the request payload.", + "properties": { + "documentsCount": { + "type": "integer", + "format": "int32", + "description": "Number of documents submitted in the request." + }, + "validDocumentsCount": { + "type": "integer", + "format": "int32", + "description": "Number of valid documents. This excludes empty, over-size limit or non-supported languages documents." + }, + "erroneousDocumentsCount": { + "type": "integer", + "format": "int32", + "description": "Number of invalid documents. This includes empty, over-size limit or non-supported languages documents." + }, + "transactionsCount": { + "type": "integer", + "format": "int64", + "description": "Number of transactions for the request." + } + }, + "required": [ + "documentsCount", + "validDocumentsCount", + "erroneousDocumentsCount", + "transactionsCount" + ] + }, + "ResolutionKind": { + "type": "string", + "description": "The entity resolution object kind.", + "enum": [ + "BooleanResolution", + "DateTimeResolution", + "NumberResolution", + "OrdinalResolution", + "SpeedResolution", + "WeightResolution", + "LengthResolution", + "VolumeResolution", + "AreaResolution", + "AgeResolution", + "InformationResolution", + "TemperatureResolution", + "CurrencyResolution", + "NumericRangeResolution", + "TemporalSpanResolution" + ], + "x-ms-enum": { + "name": "ResolutionKind", + "modelAsString": true, + "values": [ + { + "name": "BooleanResolution", + "value": "BooleanResolution", + "description": "Resolution of a boolean entity" + }, + { + "name": "DateTimeResolution", + "value": "DateTimeResolution", + "description": "Resolution of a date/time entity" + }, + { + "name": "NumberResolution", + "value": "NumberResolution", + "description": "Resolution of a number entity" + }, + { + "name": "OrdinalResolution", + "value": "OrdinalResolution", + "description": "Resolution of an ordinal entity" + }, + { + "name": "SpeedResolution", + "value": "SpeedResolution", + "description": "Resolution of a speed entity" + }, + { + "name": "WeightResolution", + "value": "WeightResolution", + "description": "Resolution of a weight entity" + }, + { + "name": "LengthResolution", + "value": "LengthResolution", + "description": "Resolution of a length entity" + }, + { + "name": "VolumeResolution", + "value": "VolumeResolution", + "description": "Resolution of a volume entity" + }, + { + "name": "AreaResolution", + "value": "AreaResolution", + "description": "Resolution of an area entity" + }, + { + "name": "AgeResolution", + "value": "AgeResolution", + "description": "Resolution of an age entity" + }, + { + "name": "InformationResolution", + "value": "InformationResolution", + "description": "Resolution of an information entity" + }, + { + "name": "TemperatureResolution", + "value": "TemperatureResolution", + "description": "Resolution of a temperature entity" + }, + { + "name": "CurrencyResolution", + "value": "CurrencyResolution", + "description": "Resolution of a currency entity" + }, + { + "name": "NumericRangeResolution", + "value": "NumericRangeResolution", + "description": "Resolution of a numeric range entity" + }, + { + "name": "TemporalSpanResolution", + "value": "TemporalSpanResolution", + "description": "Resolution of a temporal span entity" + } + ] + } + }, + "ShortAnswerOptions": { + "type": "object", + "description": "To configure Answer span prediction feature.", + "properties": { + "enable": { + "type": "boolean", + "description": "Enable or disable Answer Span prediction.", + "default": true + }, + "confidenceScoreThreshold": { + "type": "number", + "format": "double", + "description": "Minimum threshold score required to include an answer span, value ranges from 0 to 1.", + "minimum": 0, + "maximum": 1 + }, + "topAnswersWithSpan": { + "type": "integer", + "format": "int32", + "description": "Number of Top answers to be considered for span prediction from 1 to 10.", + "minimum": 1, + "maximum": 10 + } + } + }, + "SourceFilter": { + "type": "array", + "description": "Find QnAs that are associated with any of the given list of sources in knowledge base.", + "items": { + "type": "string" + } + }, + "SpeedResolution": { + "type": "object", + "description": "Represents the speed entity resolution model.", + "properties": { + "value": { + "type": "number", + "format": "double", + "description": "The numeric value that the extracted text denotes." + }, + "unit": { + "$ref": "#/definitions/SpeedUnit", + "description": "The speed Unit of measurement" + } + }, + "required": [ + "value", + "unit" + ], + "allOf": [ + { + "$ref": "#/definitions/BaseResolution" + } + ], + "x-ms-discriminator-value": "SpeedResolution" + }, + "SpeedUnit": { + "type": "string", + "description": "The speed Unit of measurement", + "enum": [ + "Unspecified", + "MetersPerSecond", + "KilometersPerHour", + "KilometersPerMinute", + "KilometersPerSecond", + "MilesPerHour", + "Knot", + "FootPerSecond", + "FootPerMinute", + "YardsPerMinute", + "YardsPerSecond", + "MetersPerMillisecond", + "CentimetersPerMillisecond", + "KilometersPerMillisecond" + ], + "x-ms-enum": { + "name": "SpeedUnit", + "modelAsString": true, + "values": [ + { + "name": "Unspecified", + "value": "Unspecified", + "description": "Unspecified speed unit" + }, + { + "name": "MetersPerSecond", + "value": "MetersPerSecond", + "description": "Meters per second speed unit" + }, + { + "name": "KilometersPerHour", + "value": "KilometersPerHour", + "description": "Kilometers per hour speed unit" + }, + { + "name": "KilometersPerMinute", + "value": "KilometersPerMinute", + "description": "Kilometers per minute speed unit" + }, + { + "name": "KilometersPerSecond", + "value": "KilometersPerSecond", + "description": "Kilometers per second speed unit" + }, + { + "name": "MilesPerHour", + "value": "MilesPerHour", + "description": "Miles per hour speed unit" + }, + { + "name": "Knot", + "value": "Knot", + "description": "Knot speed unit" + }, + { + "name": "FootPerSecond", + "value": "FootPerSecond", + "description": "Foot per second speed unit" + }, + { + "name": "FootPerMinute", + "value": "FootPerMinute", + "description": "Foot per minute speed unit" + }, + { + "name": "YardsPerMinute", + "value": "YardsPerMinute", + "description": "Yards per minute speed unit" + }, + { + "name": "YardsPerSecond", + "value": "YardsPerSecond", + "description": "Yards per second speed unit" + }, + { + "name": "MetersPerMillisecond", + "value": "MetersPerMillisecond", + "description": "Meters per millisecond speed unit" + }, + { + "name": "CentimetersPerMillisecond", + "value": "CentimetersPerMillisecond", + "description": "Centimeters per millisecond speed unit" + }, + { + "name": "KilometersPerMillisecond", + "value": "KilometersPerMillisecond", + "description": "Kilometers per millisecond speed unit" + } + ] + } + }, + "State": { + "type": "string", + "description": "The status of the task at the mentioned last update time.", + "enum": [ + "notStarted", + "running", + "succeeded", + "partiallyCompleted", + "failed", + "cancelled", + "cancelling" + ], + "x-ms-enum": { + "name": "State", + "modelAsString": true, + "values": [ + { + "name": "notStarted", + "value": "notStarted", + "description": "Not started state" + }, + { + "name": "running", + "value": "running", + "description": "Running state" + }, + { + "name": "succeeded", + "value": "succeeded", + "description": "Succeeded state" + }, + { + "name": "partiallyCompleted", + "value": "partiallyCompleted", + "description": "Partially completed state" + }, + { + "name": "failed", + "value": "failed", + "description": "Failed state" + }, + { + "name": "cancelled", + "value": "cancelled", + "description": "Cancelled state" + }, + { + "name": "cancelling", + "value": "cancelling", + "description": "Cancelling state" + } + ] + } + }, + "SummaryAspect": { + "type": "string", + "description": "Supported parameters for a conversational summarization task.", + "enum": [ + "issue", + "resolution", + "chapterTitle", + "narrative", + "recap", + "follow-up tasks" + ], + "x-ms-enum": { + "name": "SummaryAspect", + "modelAsString": true, + "values": [ + { + "name": "issue", + "value": "issue", + "description": "Summary of issues in transcripts of web chats and service calls between customer-service agents and customers." + }, + { + "name": "resolution", + "value": "resolution", + "description": "Summary of resolutions in transcripts of web chats and service calls between customer-service agents and customers." + }, + { + "name": "chapterTitle", + "value": "chapterTitle", + "description": "Chapter title of any conversation. It's usually one phrase or several phrases naturally combined. Long conversations tend to have more chapters. You can find the chapter boundary from the summary context." + }, + { + "name": "narrative", + "value": "narrative", + "description": "Generic narrative summary of any conversation. It generally converts the conversational language into formal written language, compresses the text length, and keeps the salient information." + }, + { + "name": "recap", + "value": "recap", + "description": "A concise one-paragraph summary to provide a quick overview." + }, + { + "name": "followUpTasks", + "value": "follow-up tasks", + "description": "Action items and tasks that arose during a meeting." + } + ] + } + }, + "SummaryLengthBucket": { + "type": "string", + "description": "Enum that defines the length of the output summaries.", + "enum": [ + "short", + "medium", + "long" + ], + "x-ms-enum": { + "name": "SummaryLengthBucket", + "modelAsString": true, + "values": [ + { + "name": "short", + "value": "short", + "description": "Instructs model to generate shorter length summaries." + }, + { + "name": "medium", + "value": "medium", + "description": "Instructs model to generate medium length summaries." + }, + { + "name": "long", + "value": "long", + "description": "Instructs model to generate longer length summaries." + } + ] + } + }, + "SummaryResult": { + "type": "object", + "description": "Summary Results", + "properties": { + "conversations": { + "type": "array", + "description": "array of conversations", + "items": { + "$ref": "#/definitions/ConversationsSummaryResult" + } + }, + "errors": { + "type": "array", + "description": "Errors by document id.", + "items": { + "$ref": "#/definitions/DocumentError" + } + }, + "statistics": { + "$ref": "#/definitions/RequestStatistics", + "description": "statistics" + }, + "modelVersion": { + "type": "string", + "description": "This field indicates which model is used for scoring." + } + }, + "required": [ + "conversations", + "errors", + "modelVersion" + ] + }, + "SummaryResultItem": { + "type": "object", + "description": "Summary Result Item", + "properties": { + "aspect": { + "type": "string", + "description": "aspect" + }, + "text": { + "type": "string", + "description": "text" + }, + "contexts": { + "type": "array", + "description": "Context list of the summary.", + "items": { + "$ref": "#/definitions/ItemizedSummaryContext" + } + } + }, + "required": [ + "aspect", + "text" + ] + }, + "TargetIntentResult": { + "type": "object", + "description": "This is the base class of an intent prediction", + "properties": { + "targetProjectKind": { + "$ref": "#/definitions/targetProjectKind", + "description": "This is the base class of an intent prediction" + }, + "apiVersion": { + "type": "string", + "description": "The API version used to call a target service." + }, + "confidenceScore": { + "type": "number", + "format": "double", + "description": "The prediction score and it ranges from 0.0 to 1.0.", + "minimum": 0, + "maximum": 1 + } + }, + "discriminator": "targetProjectKind", + "required": [ + "targetProjectKind", + "confidenceScore" + ] + }, + "Tasks": { + "type": "object", + "description": "Contains the state for the tasks that are being executed as part of the submitted job for analyzing a conversation.", + "properties": { + "completed": { + "type": "integer", + "format": "int32", + "description": "Count of tasks that finished successfully." + }, + "failed": { + "type": "integer", + "format": "int32", + "description": "Count of tasks that failed." + }, + "inProgress": { + "type": "integer", + "format": "int32", + "description": "Count of tasks that are currently in progress." + }, + "total": { + "type": "integer", + "format": "int32", + "description": "Total count of tasks submitted as part of the job." + }, + "items": { + "type": "array", + "description": "List of results from tasks (if available).", + "items": { + "$ref": "#/definitions/AnalyzeConversationJobResult" + } + } + }, + "required": [ + "completed", + "failed", + "inProgress", + "total" + ] + }, + "TemperatureResolution": { + "type": "object", + "description": "Represents the temperature entity resolution model.", + "properties": { + "value": { + "type": "number", + "format": "double", + "description": "The numeric value that the extracted text denotes." + }, + "unit": { + "$ref": "#/definitions/TemperatureUnit", + "description": "The temperature Unit of measurement." + } + }, + "required": [ + "value", + "unit" + ], + "allOf": [ + { + "$ref": "#/definitions/BaseResolution" + } + ], + "x-ms-discriminator-value": "TemperatureResolution" + }, + "TemperatureUnit": { + "type": "string", + "description": "The temperature Unit of measurement.", + "enum": [ + "Unspecified", + "Fahrenheit", + "Kelvin", + "Rankine", + "Celsius" + ], + "x-ms-enum": { + "name": "TemperatureUnit", + "modelAsString": true, + "values": [ + { + "name": "Unspecified", + "value": "Unspecified", + "description": "Unspecified temperature unit" + }, + { + "name": "Fahrenheit", + "value": "Fahrenheit", + "description": "Fahrenheit temperature unit" + }, + { + "name": "Kelvin", + "value": "Kelvin", + "description": "Kelvin temperature unit" + }, + { + "name": "Rankine", + "value": "Rankine", + "description": "Rankine temperature unit" + }, + { + "name": "Celsius", + "value": "Celsius", + "description": "Celsius temperature unit" + } + ] + } + }, + "TemporalModifier": { + "type": "string", + "description": "An optional modifier of a date/time instance.", + "enum": [ + "AfterApprox", + "Before", + "BeforeStart", + "Approx", + "ReferenceUndefined", + "SinceEnd", + "AfterMid", + "Start", + "After", + "BeforeEnd", + "Until", + "End", + "Less", + "Since", + "AfterStart", + "BeforeApprox", + "Mid", + "More" + ], + "x-ms-enum": { + "name": "TemporalModifier", + "modelAsString": true, + "values": [ + { + "name": "AfterApprox", + "value": "AfterApprox", + "description": "AfterApprox temporal modifier" + }, + { + "name": "Before", + "value": "Before", + "description": "Before temporal modifier" + }, + { + "name": "BeforeStart", + "value": "BeforeStart", + "description": "BeforeStart temporal modifier" + }, + { + "name": "Approx", + "value": "Approx", + "description": "Approx temporal modifier" + }, + { + "name": "ReferenceUndefined", + "value": "ReferenceUndefined", + "description": "ReferenceUndefined temporal modifier" + }, + { + "name": "SinceEnd", + "value": "SinceEnd", + "description": "SinceEnd temporal modifier" + }, + { + "name": "AfterMid", + "value": "AfterMid", + "description": "AfterMid temporal modifier" + }, + { + "name": "Start", + "value": "Start", + "description": "Start temporal modifier" + }, + { + "name": "After", + "value": "After", + "description": "After temporal modifier" + }, + { + "name": "BeforeEnd", + "value": "BeforeEnd", + "description": "BeforeEnd temporal modifier" + }, + { + "name": "Until", + "value": "Until", + "description": "Until temporal modifier" + }, + { + "name": "End", + "value": "End", + "description": "End temporal modifier" + }, + { + "name": "Less", + "value": "Less", + "description": "Less temporal modifier" + }, + { + "name": "Since", + "value": "Since", + "description": "Since temporal modifier" + }, + { + "name": "AfterStart", + "value": "AfterStart", + "description": "AfterStart temporal modifier" + }, + { + "name": "BeforeApprox", + "value": "BeforeApprox", + "description": "BeforeApprox temporal modifier" + }, + { + "name": "Mid", + "value": "Mid", + "description": "Mid temporal modifier" + }, + { + "name": "More", + "value": "More", + "description": "More temporal modifier" + } + ] + } + }, + "TemporalSpanResolution": { + "type": "object", + "description": "represents the resolution of a date and/or time span.", + "properties": { + "begin": { + "type": "string", + "description": "represents the resolution of a date and/or time span. An extended ISO 8601 date/time representation as described in (https://github.com/Microsoft/Recognizers-Text/blob/master/Patterns/English/English-DateTime.yaml)" + }, + "end": { + "type": "string", + "description": "represents the resolution of a date and/or time span. An extended ISO 8601 date/time representation as described in (https://github.com/Microsoft/Recognizers-Text/blob/master/Patterns/English/English-DateTime.yaml)" + }, + "duration": { + "type": "string", + "description": "An optional duration value formatted based on the ISO 8601 (https://en.wikipedia.org/wiki/ISO_8601#Durations)" + }, + "modifier": { + "$ref": "#/definitions/TemporalModifier", + "description": "An optional modifier of a date/time instance." + }, + "timex": { + "type": "string", + "description": "An optional triplet containing the beginning, the end, and the duration all stated as ISO 8601 formatted strings." + } + }, + "allOf": [ + { + "$ref": "#/definitions/BaseResolution" + } + ], + "x-ms-discriminator-value": "TemporalSpanResolution" + }, + "TextConversation": { + "type": "object", + "description": "model for text conversation", + "properties": { + "conversationItems": { + "type": "array", + "description": "Ordered list of text conversation items in the conversation.", + "items": { + "$ref": "#/definitions/TextConversationItem" + } + } + }, + "required": [ + "conversationItems" + ], + "allOf": [ + { + "$ref": "#/definitions/Conversation" + } + ], + "x-ms-discriminator-value": "text" + }, + "TextConversationItem": { + "type": "object", + "description": "The text modality of an input conversation.", + "properties": { + "id": { + "type": "string", + "description": "The ID of a conversation item." + }, + "participantId": { + "type": "string", + "description": "The participant ID of a conversation item." + }, + "language": { + "type": "string", + "description": "The override language of a conversation item in BCP 47 language representation." + }, + "modality": { + "$ref": "#/definitions/InputModality", + "description": "Enumeration of supported conversational modalities." + }, + "role": { + "$ref": "#/definitions/role", + "description": "Role of the participant." + }, + "text": { + "type": "string", + "description": "The text input" + } + }, + "required": [ + "id", + "participantId", + "text" + ] + }, + "TranscriptContentType": { + "type": "string", + "description": "Enumeration of supported transcript content types.", + "enum": [ + "lexical", + "itn", + "maskedItn", + "text" + ], + "x-ms-enum": { + "name": "TranscriptContentType", + "modelAsString": true, + "values": [ + { + "name": "lexical", + "value": "lexical", + "description": "Lexical content type" + }, + { + "name": "itn", + "value": "itn", + "description": "ITN content type" + }, + { + "name": "maskedItn", + "value": "maskedItn", + "description": "Masked ITN content type" + }, + { + "name": "text", + "value": "text", + "description": "Text content type" + } + ] + } + }, + "TranscriptConversation": { + "type": "object", + "description": "model for transcript conversation", + "properties": { + "conversationItems": { + "type": "array", + "description": "Ordered list of transcript conversation items in the conversation.", + "items": { + "$ref": "#/definitions/TranscriptConversationItem" + } + } + }, + "required": [ + "conversationItems" + ], + "allOf": [ + { + "$ref": "#/definitions/Conversation" + } + ], + "x-ms-discriminator-value": "transcript" + }, + "TranscriptConversationItem": { + "type": "object", + "description": "Additional properties for supporting transcript conversation.", + "properties": { + "id": { + "type": "string", + "description": "The ID of a conversation item." + }, + "participantId": { + "type": "string", + "description": "The participant ID of a conversation item." + }, + "language": { + "type": "string", + "description": "The override language of a conversation item in BCP 47 language representation." + }, + "modality": { + "$ref": "#/definitions/InputModality", + "description": "Enumeration of supported conversational modalities." + }, + "role": { + "$ref": "#/definitions/role", + "description": "Role of the participant." + }, + "itn": { + "type": "string", + "description": "Inverse text normalization (ITN) representation of input. The inverse-text-normalized form is the recognized text from Microsoft's speech-to-text API, with phone numbers, numbers, abbreviations, and other transformations applied." + }, + "maskedItn": { + "type": "string", + "description": "Inverse-text-normalized format with profanity masking applied." + }, + "text": { + "type": "string", + "description": "Display form of the recognized text from the speech-to-text API, with punctuation and capitalization added." + }, + "lexical": { + "type": "string", + "description": "Lexical form of the recognized text from the speech-to-text API, with the actual words recognized." + }, + "wordLevelTimings": { + "type": "array", + "description": "List of word-level audio timing information.", + "items": { + "$ref": "#/definitions/WordLevelTiming" + } + }, + "conversationItemLevelTiming": { + "$ref": "#/definitions/ConversationItemLevelTiming", + "description": "Audio timing at the conversation item level. This still can help with AI quality if word-level audio timings are not available." + } + }, + "required": [ + "id", + "participantId", + "itn", + "maskedItn", + "text", + "lexical" + ] + }, + "VolumeResolution": { + "type": "object", + "description": "Represents the volume entity resolution model.", + "properties": { + "value": { + "type": "number", + "format": "double", + "description": "The numeric value that the extracted text denotes." + }, + "unit": { + "$ref": "#/definitions/VolumeUnit", + "description": "The Volume Unit of measurement" + } + }, + "required": [ + "value", + "unit" + ], + "allOf": [ + { + "$ref": "#/definitions/BaseResolution" + } + ], + "x-ms-discriminator-value": "VolumeResolution" + }, + "VolumeUnit": { + "type": "string", + "description": "The Volume Unit of measurement", + "enum": [ + "Unspecified", + "CubicMeter", + "CubicCentimeter", + "CubicMillimeter", + "Hectoliter", + "Decaliter", + "Liter", + "Centiliter", + "Milliliter", + "CubicYard", + "CubicInch", + "CubicFoot", + "CubicMile", + "FluidOunce", + "Teaspoon", + "Tablespoon", + "Pint", + "Quart", + "Cup", + "Gill", + "Pinch", + "FluidDram", + "Barrel", + "Minim", + "Cord", + "Peck", + "Bushel", + "Hogshead" + ], + "x-ms-enum": { + "name": "VolumeUnit", + "modelAsString": true, + "values": [ + { + "name": "Unspecified", + "value": "Unspecified", + "description": "Unspecified volume unit." + }, + { + "name": "CubicMeter", + "value": "CubicMeter", + "description": "Volume unit in cubic meters." + }, + { + "name": "CubicCentimeter", + "value": "CubicCentimeter", + "description": "Volume unit in cubic centimeters." + }, + { + "name": "CubicMillimeter", + "value": "CubicMillimeter", + "description": "Volume unit in cubic millimeters." + }, + { + "name": "Hectoliter", + "value": "Hectoliter", + "description": "Volume unit in hectoliters." + }, + { + "name": "Decaliter", + "value": "Decaliter", + "description": "Volume unit in decaliters." + }, + { + "name": "Liter", + "value": "Liter", + "description": "Volume unit in liters." + }, + { + "name": "Centiliter", + "value": "Centiliter", + "description": "Volume unit in centiliters." + }, + { + "name": "Milliliter", + "value": "Milliliter", + "description": "Volume unit in milliliters." + }, + { + "name": "CubicYard", + "value": "CubicYard", + "description": "Volume unit in cubic yards." + }, + { + "name": "CubicInch", + "value": "CubicInch", + "description": "Volume unit in cubic inches." + }, + { + "name": "CubicFoot", + "value": "CubicFoot", + "description": "Volume unit in cubic feet." + }, + { + "name": "CubicMile", + "value": "CubicMile", + "description": "Volume unit in cubic miles." + }, + { + "name": "FluidOunce", + "value": "FluidOunce", + "description": "Volume unit in fluid ounces." + }, + { + "name": "Teaspoon", + "value": "Teaspoon", + "description": "Volume unit in teaspoons." + }, + { + "name": "Tablespoon", + "value": "Tablespoon", + "description": "Volume unit in tablespoons." + }, + { + "name": "Pint", + "value": "Pint", + "description": "Volume unit in pints." + }, + { + "name": "Quart", + "value": "Quart", + "description": "Volume unit in quarts." + }, + { + "name": "Cup", + "value": "Cup", + "description": "Volume unit in cups." + }, + { + "name": "Gill", + "value": "Gill", + "description": "Volume unit in gills." + }, + { + "name": "Pinch", + "value": "Pinch", + "description": "Volume unit in pinches." + }, + { + "name": "FluidDram", + "value": "FluidDram", + "description": "Volume unit in fluid drams." + }, + { + "name": "Barrel", + "value": "Barrel", + "description": "Volume unit in barrels." + }, + { + "name": "Minim", + "value": "Minim", + "description": "Volume unit in minims." + }, + { + "name": "Cord", + "value": "Cord", + "description": "Volume unit in cords." + }, + { + "name": "Peck", + "value": "Peck", + "description": "Volume unit in pecks." + }, + { + "name": "Bushel", + "value": "Bushel", + "description": "Volume unit in bushels." + }, + { + "name": "Hogshead", + "value": "Hogshead", + "description": "Volume unit in hogsheads." + } + ] + } + }, + "WeightResolution": { + "type": "object", + "description": "Represents the weight entity resolution model.", + "properties": { + "value": { + "type": "number", + "format": "double", + "description": "The numeric value that the extracted text denotes." + }, + "unit": { + "$ref": "#/definitions/WeightUnit", + "description": "The weight Unit of measurement." + } + }, + "required": [ + "value", + "unit" + ], + "allOf": [ + { + "$ref": "#/definitions/BaseResolution" + } + ], + "x-ms-discriminator-value": "WeightResolution" + }, + "WeightUnit": { + "type": "string", + "description": "The weight Unit of measurement.", + "enum": [ + "Unspecified", + "Kilogram", + "Gram", + "Milligram", + "Gallon", + "MetricTon", + "Ton", + "Pound", + "Ounce", + "Grain", + "PennyWeight", + "LongTonBritish", + "ShortTonUS", + "ShortHundredWeightUS", + "Stone", + "Dram" + ], + "x-ms-enum": { + "name": "WeightUnit", + "modelAsString": true, + "values": [ + { + "name": "Unspecified", + "value": "Unspecified", + "description": "Unspecified weight unit" + }, + { + "name": "Kilogram", + "value": "Kilogram", + "description": "Weight unit in kilograms" + }, + { + "name": "Gram", + "value": "Gram", + "description": "Weight unit in grams" + }, + { + "name": "Milligram", + "value": "Milligram", + "description": "Weight unit in milligrams" + }, + { + "name": "Gallon", + "value": "Gallon", + "description": "Volume unit in gallons" + }, + { + "name": "MetricTon", + "value": "MetricTon", + "description": "Weight unit in metric tons" + }, + { + "name": "Ton", + "value": "Ton", + "description": "Weight unit in tons" + }, + { + "name": "Pound", + "value": "Pound", + "description": "Weight unit in pounds" + }, + { + "name": "Ounce", + "value": "Ounce", + "description": "Weight unit in ounces" + }, + { + "name": "Grain", + "value": "Grain", + "description": "Weight unit in grains" + }, + { + "name": "PennyWeight", + "value": "PennyWeight", + "description": "Weight unit in pennyweights" + }, + { + "name": "LongTonBritish", + "value": "LongTonBritish", + "description": "Weight unit in long tons (British)" + }, + { + "name": "ShortTonUS", + "value": "ShortTonUS", + "description": "Weight unit in short tons (US)" + }, + { + "name": "ShortHundredWeightUS", + "value": "ShortHundredWeightUS", + "description": "Weight unit in short hundredweights (US)" + }, + { + "name": "Stone", + "value": "Stone", + "description": "Weight unit in stones" + }, + { + "name": "Dram", + "value": "Dram", + "description": "Weight unit in drams" + } + ] + } + }, + "WordLevelTiming": { + "type": "object", + "description": "Word-level timing information that the speech-to-text API generates. The words in this object should have 1:1 correspondence with the lexical input to allow for audio redaction.", + "properties": { + "offset": { + "type": "integer", + "format": "int64", + "description": "Offset from the start of speech audio, in ticks. 1 tick = 100 nanoseconds." + }, + "duration": { + "type": "integer", + "format": "int64", + "description": "Duration of word articulation, in ticks. 1 tick = 100 nanoseconds." + }, + "word": { + "type": "string", + "description": "Recognized word." + } + } + }, + "projectKind": { + "type": "string", + "description": "The type of the project.", + "enum": [ + "Conversation", + "Orchestration", + "ConversationalAI" + ], + "x-ms-enum": { + "name": "projectKind", + "modelAsString": true, + "values": [ + { + "name": "Conversation", + "value": "Conversation", + "description": "Conversation type" + }, + { + "name": "Orchestration", + "value": "Orchestration", + "description": "Orchestration type" + }, + { + "name": "ConversationalAI", + "value": "ConversationalAI", + "description": "Conversation type" + } + ] + } + }, + "role": { + "type": "string", + "description": "Role of the participant.", + "enum": [ + "customer", + "agent", + "generic" + ], + "x-ms-enum": { + "name": "role", + "modelAsString": true, + "values": [ + { + "name": "customer", + "value": "customer", + "description": "The participant is a customer." + }, + { + "name": "agent", + "value": "agent", + "description": "The participant is an agent." + }, + { + "name": "generic", + "value": "generic", + "description": "The is a generic participant." + } + ] + } + }, + "targetProjectKind": { + "type": "string", + "description": "The type of a target service.", + "enum": [ + "Luis", + "Conversation", + "QuestionAnswering", + "NonLinked" + ], + "x-ms-enum": { + "name": "targetProjectKind", + "modelAsString": true, + "values": [ + { + "name": "Luis", + "value": "Luis", + "description": "Luis target service type" + }, + { + "name": "Conversation", + "value": "Conversation", + "description": "Conversation target service type" + }, + { + "name": "QuestionAnswering", + "value": "QuestionAnswering", + "description": "QuestionAnswering target service type" + }, + { + "name": "NonLinked", + "value": "NonLinked", + "description": "NonLinked target service type" + } + ] + } + } + }, + "parameters": { + "Azure.Core.Foundations.ApiVersionParameter": { + "name": "api-version", + "in": "query", + "description": "The API version to use for this operation.", + "required": true, + "type": "string", + "minLength": 1, + "x-ms-parameter-location": "method", + "x-ms-client-name": "apiVersion" + } + } +} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/preview/2025-05-15-preview/examples/SuccessfulAnalyzeConversationalAITask.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/preview/2025-05-15-preview/examples/SuccessfulAnalyzeConversationalAITask.json new file mode 100644 index 000000000000..4dc47676d868 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/preview/2025-05-15-preview/examples/SuccessfulAnalyzeConversationalAITask.json @@ -0,0 +1,228 @@ +{ + "operationId": "AnalyzeConversations", + "title": "SuccessfulAnalyzeConversationalAITask", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "Content-Type": "application/json", + "api-version": "2025-05-15-preview", + "body": { + "kind": "ConversationalAI", + "parameters": { + "projectName": "project1", + "deploymentName": "deployment1", + "stringIndexType": "Utf16CodeUnit" + }, + "analysisInput": { + "conversations": [ + { + "id": "order", + "language": "en", + "modality": "text", + "conversationItems": [ + { + "participantId": "user", + "id": "1", + "text": "Hi!" + }, + { + "participantId": "bot", + "id": "2", + "text": "Hello, how can I help you?" + }, + { + "participantId": "user", + "id": "3", + "text": "I would like to book a flight from Paris to Berlin on Oct 10th." + }, + { + "participantId": "bot", + "id": "4", + "text": "Do you have any airline preference?" + }, + { + "participantId": "user", + "id": "5", + "text": "No." + }, + { + "participantId": "user", + "id": "6", + "text": "I like New York and Boston." + }, + { + "participantId": "user", + "id": "7", + "text": "Actualy, change the destination to New York." + }, + { + "participantId": "user", + "id": "8", + "text": "Wait, I do not like the food in New York." + }, + { + "participantId": "user", + "id": "9", + "text": "Ok, change the destination back to Berlin." + } + ] + } + ] + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "kind": "ConversationalAIResult", + "result": { + "conversations": [ + { + "id": "OrderAndQuestion", + "intents": [ + { + "type": "action", + "name": "BookFlight", + "conversationItemRanges": [ + { + "offset": 2, + "count": 3 + }, + { + "offset": 6, + "count": 1 + }, + { + "offset": 8, + "count": 1 + } + ], + "entities": [ + { + "name": "Source", + "text": "Paris", + "confidenceScore": 0.8, + "offset": 35, + "length": 5, + "conversationItemIndex": 2, + "conversationItemId": "3" + }, + { + "name": "Geography.Location", + "text": "Berlin", + "confidenceScore": 0.8, + "offset": 35, + "length": 6, + "conversationItemIndex": 8, + "conversationItemId": "9", + "extraInformation": [ + { + "extraInformationKind": "EntitySubtype", + "value": "geography.location", + "tags": [ + { + "name": "City", + "confidenceScore": 1 + }, + { + "name": "GPE", + "confidenceScore": 1 + }, + { + "name": "Location", + "confidenceScore": 1 + } + ] + } + ] + }, + { + "name": "Geography.Location", + "text": "New York", + "confidenceScore": 0.8, + "offset": 32, + "length": 8, + "conversationItemIndex": 6, + "conversationItemId": "7", + "extraInformation": [ + { + "extraInformationKind": "EntitySubtype", + "value": "geography.location", + "tags": [ + { + "name": "City", + "confidenceScore": 1 + }, + { + "name": "GPE", + "confidenceScore": 1 + }, + { + "name": "Location", + "confidenceScore": 1 + } + ] + } + ] + }, + { + "name": "DateTime", + "text": "Oct 10th", + "confidenceScore": 0.8, + "offset": 54, + "length": 8, + "conversationItemIndex": 2, + "conversationItemId": "3", + "resolutions": [ + { + "resolutionKind": "DateTimeResolution", + "dateTimeSubKind": "Date", + "timex": "XXXX-10-10", + "value": "2024-10-10" + }, + { + "resolutionKind": "DateTimeResolution", + "dateTimeSubKind": "Date", + "timex": "XXXX-10-10", + "value": "2025-10-10" + } + ], + "extraInformation": [ + { + "extraInformationKind": "EntitySubtype", + "value": "datetime.date", + "tags": [ + { + "name": "Date", + "confidenceScore": 1 + }, + { + "name": "Temporal", + "confidenceScore": 1 + } + ] + } + ] + } + ] + } + ], + "entities": [ + { + "name": "Geography.Location", + "text": "Boston", + "confidenceScore": 0.8, + "offset": 20, + "length": 8, + "conversationItemId": "6" + } + ] + } + ], + "warnings": [] + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2024-05-15-preview/SuccessfulAnalyzeConversations.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/preview/2025-05-15-preview/examples/SuccessfulAnalyzeConversations.json similarity index 98% rename from specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2024-05-15-preview/SuccessfulAnalyzeConversations.json rename to specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/preview/2025-05-15-preview/examples/SuccessfulAnalyzeConversations.json index b4dd75203aff..ec8f107f4282 100644 --- a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2024-05-15-preview/SuccessfulAnalyzeConversations.json +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/preview/2025-05-15-preview/examples/SuccessfulAnalyzeConversations.json @@ -5,7 +5,7 @@ "Endpoint": "{Endpoint}", "Ocp-Apim-Subscription-Key": "{API key}", "Content-Type": "application/json", - "api-version": "2024-05-15-preview", + "api-version": "2025-05-15-preview", "body": { "kind": "Conversation", "analysisInput": { diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2023-11-15-preview/SuccessfulAnalyzeConversationsArbitration.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/preview/2025-05-15-preview/examples/SuccessfulAnalyzeConversationsArbitration.json similarity index 98% rename from specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2023-11-15-preview/SuccessfulAnalyzeConversationsArbitration.json rename to specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/preview/2025-05-15-preview/examples/SuccessfulAnalyzeConversationsArbitration.json index 63886997c41e..b9fb0b63a9eb 100644 --- a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2023-11-15-preview/SuccessfulAnalyzeConversationsArbitration.json +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/preview/2025-05-15-preview/examples/SuccessfulAnalyzeConversationsArbitration.json @@ -5,7 +5,7 @@ "Endpoint": "{Endpoint}", "Ocp-Apim-Subscription-Key": "{API key}", "Content-Type": "application/json", - "api-version": "2023-11-15-preview", + "api-version": "2025-05-15-preview", "body": { "kind": "Conversation", "analysisInput": { diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2024-05-15-preview/SuccessfulAnalyzeConversationsArbitrationDirectTarget.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/preview/2025-05-15-preview/examples/SuccessfulAnalyzeConversationsArbitrationDirectTarget.json similarity index 98% rename from specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2024-05-15-preview/SuccessfulAnalyzeConversationsArbitrationDirectTarget.json rename to specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/preview/2025-05-15-preview/examples/SuccessfulAnalyzeConversationsArbitrationDirectTarget.json index b0897595ecb7..9e30bda0712e 100644 --- a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2024-05-15-preview/SuccessfulAnalyzeConversationsArbitrationDirectTarget.json +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/preview/2025-05-15-preview/examples/SuccessfulAnalyzeConversationsArbitrationDirectTarget.json @@ -5,7 +5,7 @@ "Endpoint": "{Endpoint}", "Ocp-Apim-Subscription-Key": "{API key}", "Content-Type": "application/json", - "api-version": "2024-05-15-preview", + "api-version": "2025-05-15-preview", "body": { "kind": "Conversation", "analysisInput": { diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2024-05-15-preview/SuccessfulAnalyzeConversationsJobsCancelRequest.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/preview/2025-05-15-preview/examples/SuccessfulAnalyzeConversationsJobsCancelRequest.json similarity index 80% rename from specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2024-05-15-preview/SuccessfulAnalyzeConversationsJobsCancelRequest.json rename to specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/preview/2025-05-15-preview/examples/SuccessfulAnalyzeConversationsJobsCancelRequest.json index ab8a77b27c0b..034f13022014 100644 --- a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2024-05-15-preview/SuccessfulAnalyzeConversationsJobsCancelRequest.json +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/preview/2025-05-15-preview/examples/SuccessfulAnalyzeConversationsJobsCancelRequest.json @@ -3,14 +3,14 @@ "title": "SuccessfulAnalyzeConversationsJobsCancelRequest", "parameters": { "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2024-05-15-preview", + "api-version": "2025-05-15-preview", "Endpoint": "{Endpoint}", "jobId": "c0f2a446-05d9-48fc-ba8f-3ef4af8d0b18" }, "responses": { "202": { "headers": { - "Operation-Location": "{Endpoint}/language/analyze-conversations/jobs/{jobId}?api-version=2024-05-15-preview" + "Operation-Location": "{Endpoint}/language/analyze-conversations/jobs/{jobId}?api-version=2025-05-15-preview" } } } diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2024-11-15-preview/SuccessfulConversationPIICharacterMask.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/preview/2025-05-15-preview/examples/SuccessfulConversationPIICharacterMask.json similarity index 95% rename from specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2024-11-15-preview/SuccessfulConversationPIICharacterMask.json rename to specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/preview/2025-05-15-preview/examples/SuccessfulConversationPIICharacterMask.json index d7cb037984ad..af9a1c6b1257 100644 --- a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2024-11-15-preview/SuccessfulConversationPIICharacterMask.json +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/preview/2025-05-15-preview/examples/SuccessfulConversationPIICharacterMask.json @@ -3,7 +3,7 @@ "title": "SuccessfulConversationPIICharacterMask", "parameters": { "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2024-11-15-preview", + "api-version": "2025-05-15-preview", "Endpoint": "{Endpoint}", "jobId": "{Job ID}", "body": { @@ -73,7 +73,7 @@ "responses": { "202": { "headers": { - "Operation-Location": "{Endpoint}/language/analyze-conversation/jobs/{jobId}?api-version=2024-11-15-preview" + "Operation-Location": "{Endpoint}/language/analyze-conversation/jobs/{jobId}?api-version=2025-05-15-preview" } } } diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2024-11-15-preview/SuccessfulConversationPIICharacterMaskTaskStatusRequest.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/preview/2025-05-15-preview/examples/SuccessfulConversationPIICharacterMaskTaskStatusRequest.json similarity index 98% rename from specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2024-11-15-preview/SuccessfulConversationPIICharacterMaskTaskStatusRequest.json rename to specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/preview/2025-05-15-preview/examples/SuccessfulConversationPIICharacterMaskTaskStatusRequest.json index 14ac4c6fb1d3..78aa5de34778 100644 --- a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2024-11-15-preview/SuccessfulConversationPIICharacterMaskTaskStatusRequest.json +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/preview/2025-05-15-preview/examples/SuccessfulConversationPIICharacterMaskTaskStatusRequest.json @@ -3,7 +3,7 @@ "title": "SuccessfulConversationPIICharacterMaskTaskStatusRequest", "parameters": { "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2024-11-15-preview", + "api-version": "2025-05-15-preview", "Endpoint": "{Endpoint}", "jobId": "c0f2a446-05d9-48fc-ba8f-3ef4af8d0b18" }, diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2024-11-15-preview/SuccessfulConversationPIIEntityMask.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/preview/2025-05-15-preview/examples/SuccessfulConversationPIIEntityMask.json similarity index 95% rename from specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2024-11-15-preview/SuccessfulConversationPIIEntityMask.json rename to specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/preview/2025-05-15-preview/examples/SuccessfulConversationPIIEntityMask.json index 8089b3ad3d5c..da90a5955322 100644 --- a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2024-11-15-preview/SuccessfulConversationPIIEntityMask.json +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/preview/2025-05-15-preview/examples/SuccessfulConversationPIIEntityMask.json @@ -3,7 +3,7 @@ "title": "SuccessfulConversationPIIEntityMask", "parameters": { "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2024-11-15-preview", + "api-version": "2025-05-15-preview", "Endpoint": "{Endpoint}", "jobId": "{Job ID}", "body": { @@ -72,7 +72,7 @@ "responses": { "202": { "headers": { - "Operation-Location": "{Endpoint}/language/analyze-conversation/jobs/{jobId}?api-version=2024-11-15-preview" + "Operation-Location": "{Endpoint}/language/analyze-conversation/jobs/{jobId}?api-version=2025-05-15-preview" } } } diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2024-11-15-preview/SuccessfulConversationPIIEntityMaskTaskStatusRequest.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/preview/2025-05-15-preview/examples/SuccessfulConversationPIIEntityMaskTaskStatusRequest.json similarity index 98% rename from specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2024-11-15-preview/SuccessfulConversationPIIEntityMaskTaskStatusRequest.json rename to specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/preview/2025-05-15-preview/examples/SuccessfulConversationPIIEntityMaskTaskStatusRequest.json index 273289f3b259..6fd2102512ac 100644 --- a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2024-11-15-preview/SuccessfulConversationPIIEntityMaskTaskStatusRequest.json +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/preview/2025-05-15-preview/examples/SuccessfulConversationPIIEntityMaskTaskStatusRequest.json @@ -3,7 +3,7 @@ "title": "SuccessfulConversationPIIEntityMaskTaskStatusRequest", "parameters": { "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2024-11-15-preview", + "api-version": "2025-05-15-preview", "Endpoint": "{Endpoint}", "jobId": "c0f2a446-05d9-48fc-ba8f-3ef4af8d0b18" }, diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2024-05-15-preview/SuccessfulConversationPIIExclusionSubmit.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/preview/2025-05-15-preview/examples/SuccessfulConversationPIIExclusionSubmit.json similarity index 98% rename from specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2024-05-15-preview/SuccessfulConversationPIIExclusionSubmit.json rename to specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/preview/2025-05-15-preview/examples/SuccessfulConversationPIIExclusionSubmit.json index 1236a317bdf2..a6b20a7f8e66 100644 --- a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2024-05-15-preview/SuccessfulConversationPIIExclusionSubmit.json +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/preview/2025-05-15-preview/examples/SuccessfulConversationPIIExclusionSubmit.json @@ -3,7 +3,7 @@ "title": "SuccessfulConversationPIIExclusionSubmit", "parameters": { "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2024-05-15-preview", + "api-version": "2025-05-15-preview", "Endpoint": "{Endpoint}", "jobId": "{Job ID}", "body": { diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2024-11-15-preview/SuccessfulConversationPIIExclusionTaskStatusRequest.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/preview/2025-05-15-preview/examples/SuccessfulConversationPIIExclusionTaskStatusRequest.json similarity index 98% rename from specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2024-11-15-preview/SuccessfulConversationPIIExclusionTaskStatusRequest.json rename to specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/preview/2025-05-15-preview/examples/SuccessfulConversationPIIExclusionTaskStatusRequest.json index 03866576d9b7..81405c0d194d 100644 --- a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2024-11-15-preview/SuccessfulConversationPIIExclusionTaskStatusRequest.json +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/preview/2025-05-15-preview/examples/SuccessfulConversationPIIExclusionTaskStatusRequest.json @@ -3,7 +3,7 @@ "title": "SuccessfulConversationPIIExclusionTaskStatusRequest", "parameters": { "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2024-11-15-preview", + "api-version": "2025-05-15-preview", "Endpoint": "{Endpoint}", "jobId": "c0f2a446-05d9-48fc-ba8f-3ef4af8d0b18" }, diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2024-11-15-preview/SuccessfulConversationPIINoMask.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/preview/2025-05-15-preview/examples/SuccessfulConversationPIINoMask.json similarity index 95% rename from specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2024-11-15-preview/SuccessfulConversationPIINoMask.json rename to specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/preview/2025-05-15-preview/examples/SuccessfulConversationPIINoMask.json index 427d6196183d..6c30cd64723d 100644 --- a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2024-11-15-preview/SuccessfulConversationPIINoMask.json +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/preview/2025-05-15-preview/examples/SuccessfulConversationPIINoMask.json @@ -3,7 +3,7 @@ "title": "SuccessfulConversationPIINoMask", "parameters": { "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2024-11-15-preview", + "api-version": "2025-05-15-preview", "Endpoint": "{Endpoint}", "jobId": "{Job ID}", "body": { @@ -72,7 +72,7 @@ "responses": { "202": { "headers": { - "Operation-Location": "{Endpoint}/language/analyze-conversation/jobs/{jobId}?api-version=2024-11-15-preview" + "Operation-Location": "{Endpoint}/language/analyze-conversation/jobs/{jobId}?api-version=2025-05-15-preview" } } } diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2024-11-15-preview/SuccessfulConversationPIINoMaskTaskStatusRequest.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/preview/2025-05-15-preview/examples/SuccessfulConversationPIINoMaskTaskStatusRequest.json similarity index 98% rename from specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2024-11-15-preview/SuccessfulConversationPIINoMaskTaskStatusRequest.json rename to specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/preview/2025-05-15-preview/examples/SuccessfulConversationPIINoMaskTaskStatusRequest.json index fe157ff95d5a..3581d0fc989c 100644 --- a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2024-11-15-preview/SuccessfulConversationPIINoMaskTaskStatusRequest.json +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/preview/2025-05-15-preview/examples/SuccessfulConversationPIINoMaskTaskStatusRequest.json @@ -3,7 +3,7 @@ "title": "SuccessfulConversationPIINoMaskTaskStatusRequest", "parameters": { "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2024-11-15-preview", + "api-version": "2025-05-15-preview", "Endpoint": "{Endpoint}", "jobId": "c0f2a446-05d9-48fc-ba8f-3ef4af8d0b18" }, diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2024-05-15-preview/SuccessfulConversationPIIRedactionCharSubmit.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/preview/2025-05-15-preview/examples/SuccessfulConversationPIIRedactionCharSubmit.json similarity index 95% rename from specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2024-05-15-preview/SuccessfulConversationPIIRedactionCharSubmit.json rename to specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/preview/2025-05-15-preview/examples/SuccessfulConversationPIIRedactionCharSubmit.json index 72097e81061c..0e2d09c1806c 100644 --- a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2024-05-15-preview/SuccessfulConversationPIIRedactionCharSubmit.json +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/preview/2025-05-15-preview/examples/SuccessfulConversationPIIRedactionCharSubmit.json @@ -3,7 +3,7 @@ "title": "SuccessfulConversationPIIRedactionCharSubmit", "parameters": { "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2024-05-15-preview", + "api-version": "2025-05-15-preview", "Endpoint": "{Endpoint}", "jobId": "{Job ID}", "body": { @@ -70,7 +70,7 @@ "responses": { "202": { "headers": { - "Operation-Location": "{Endpoint}/language/analyze-conversation/jobs/{jobId}?api-version=2024-05-15-preview" + "Operation-Location": "{Endpoint}/language/analyze-conversation/jobs/{jobId}?api-version=2025-05-15-preview" } } } diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2023-11-15-preview/SuccessfulConversationPIIRedactionCharTaskStatusRequest.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/preview/2025-05-15-preview/examples/SuccessfulConversationPIIRedactionCharTaskStatusRequest.json similarity index 98% rename from specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2023-11-15-preview/SuccessfulConversationPIIRedactionCharTaskStatusRequest.json rename to specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/preview/2025-05-15-preview/examples/SuccessfulConversationPIIRedactionCharTaskStatusRequest.json index 083a82355920..b54fa42c2e94 100644 --- a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2023-11-15-preview/SuccessfulConversationPIIRedactionCharTaskStatusRequest.json +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/preview/2025-05-15-preview/examples/SuccessfulConversationPIIRedactionCharTaskStatusRequest.json @@ -3,7 +3,7 @@ "title": "SuccessfulConversationPIIRedactionCharTaskStatusRequest", "parameters": { "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2023-11-15-preview", + "api-version": "2025-05-15-preview", "Endpoint": "{Endpoint}", "jobId": "c0f2a446-05d9-48fc-ba8f-3ef4af8d0b18" }, diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2024-11-15-preview/SuccessfulConversationPIISubmit.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/preview/2025-05-15-preview/examples/SuccessfulConversationPIISubmit.json similarity index 95% rename from specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2024-11-15-preview/SuccessfulConversationPIISubmit.json rename to specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/preview/2025-05-15-preview/examples/SuccessfulConversationPIISubmit.json index a71e74da84a5..947e9ead2b75 100644 --- a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2024-11-15-preview/SuccessfulConversationPIISubmit.json +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/preview/2025-05-15-preview/examples/SuccessfulConversationPIISubmit.json @@ -3,7 +3,7 @@ "title": "SuccessfulConversationPIISubmit", "parameters": { "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2024-11-15-preview", + "api-version": "2025-05-15-preview", "Endpoint": "{Endpoint}", "jobId": "{Job ID}", "body": { @@ -69,7 +69,7 @@ "responses": { "202": { "headers": { - "Operation-Location": "{Endpoint}/language/analyze-conversation/jobs/{jobId}?api-version=2024-11-15-preview" + "Operation-Location": "{Endpoint}/language/analyze-conversation/jobs/{jobId}?api-version=2025-05-15-preview" } } } diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2024-11-15-preview/SuccessfulConversationPIITaskStatusRequest.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/preview/2025-05-15-preview/examples/SuccessfulConversationPIITaskStatusRequest.json similarity index 98% rename from specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2024-11-15-preview/SuccessfulConversationPIITaskStatusRequest.json rename to specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/preview/2025-05-15-preview/examples/SuccessfulConversationPIITaskStatusRequest.json index 6de863d126a7..fe7c7edbe67f 100644 --- a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2024-11-15-preview/SuccessfulConversationPIITaskStatusRequest.json +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/preview/2025-05-15-preview/examples/SuccessfulConversationPIITaskStatusRequest.json @@ -3,7 +3,7 @@ "title": "SuccessfulConversationPIITaskStatusRequest", "parameters": { "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2024-11-15-preview", + "api-version": "2025-05-15-preview", "Endpoint": "{Endpoint}", "jobId": "c0f2a446-05d9-48fc-ba8f-3ef4af8d0b18" }, diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2024-11-15-preview/SuccessfulConversationSummarizationTaskResult.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/preview/2025-05-15-preview/examples/SuccessfulConversationSummarizationTaskResult.json similarity index 98% rename from specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2024-11-15-preview/SuccessfulConversationSummarizationTaskResult.json rename to specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/preview/2025-05-15-preview/examples/SuccessfulConversationSummarizationTaskResult.json index 80f4c585efc8..e610d0537b33 100644 --- a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2024-11-15-preview/SuccessfulConversationSummarizationTaskResult.json +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/preview/2025-05-15-preview/examples/SuccessfulConversationSummarizationTaskResult.json @@ -3,7 +3,7 @@ "title": "SuccessfulConversationSummarizationTaskResult", "parameters": { "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2024-11-15-preview", + "api-version": "2025-05-15-preview", "Endpoint": "{Endpoint}", "jobId": "3e9e8518-492f-47f9-abd1-9a7468231086" }, diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2024-11-15-preview/SuccessfulConversationSummarizationTaskStatusRequest.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/preview/2025-05-15-preview/examples/SuccessfulConversationSummarizationTaskStatusRequest.json similarity index 98% rename from specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2024-11-15-preview/SuccessfulConversationSummarizationTaskStatusRequest.json rename to specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/preview/2025-05-15-preview/examples/SuccessfulConversationSummarizationTaskStatusRequest.json index 4319fab4524a..b4480b5b1723 100644 --- a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2024-11-15-preview/SuccessfulConversationSummarizationTaskStatusRequest.json +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/preview/2025-05-15-preview/examples/SuccessfulConversationSummarizationTaskStatusRequest.json @@ -3,7 +3,7 @@ "title": "SuccessfulConversationSummarizationTaskStatusRequest", "parameters": { "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2024-11-15-preview", + "api-version": "2025-05-15-preview", "Endpoint": "{Endpoint}", "jobId": "c0f2a446-05d9-48fc-ba8f-3ef4af8d0b18" }, diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2024-05-15-preview/SuccessfulConversationSummarizationTaskSubmit.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/preview/2025-05-15-preview/examples/SuccessfulConversationSummarizationTaskSubmit.json similarity index 95% rename from specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2024-05-15-preview/SuccessfulConversationSummarizationTaskSubmit.json rename to specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/preview/2025-05-15-preview/examples/SuccessfulConversationSummarizationTaskSubmit.json index a9ae7d4dc2a4..248cfb670b10 100644 --- a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2024-05-15-preview/SuccessfulConversationSummarizationTaskSubmit.json +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/preview/2025-05-15-preview/examples/SuccessfulConversationSummarizationTaskSubmit.json @@ -3,7 +3,7 @@ "title": "SuccessfulConversationSummarizationTaskSubmit", "parameters": { "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2024-05-15-preview", + "api-version": "2025-05-15-preview", "Endpoint": "{Endpoint}", "jobId": "{Job ID}", "body": { @@ -72,7 +72,7 @@ "responses": { "202": { "headers": { - "Operation-Location": "{Endpoint}/language/analyze-conversation/jobs/{jobId}?api-version=2024-05-15-preview" + "Operation-Location": "{Endpoint}/language/analyze-conversation/jobs/{jobId}?api-version=2025-05-15-preview" } } } diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2024-05-15-preview/SuccessfulConversationSummarySubmit.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/preview/2025-05-15-preview/examples/SuccessfulConversationSummarySubmit.json similarity index 94% rename from specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2024-05-15-preview/SuccessfulConversationSummarySubmit.json rename to specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/preview/2025-05-15-preview/examples/SuccessfulConversationSummarySubmit.json index f7f06e6dcc67..edd8c4d31423 100644 --- a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2024-05-15-preview/SuccessfulConversationSummarySubmit.json +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/preview/2025-05-15-preview/examples/SuccessfulConversationSummarySubmit.json @@ -3,7 +3,7 @@ "title": "SuccessfulConversationSummarySubmit", "parameters": { "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2024-05-15-preview", + "api-version": "2025-05-15-preview", "Endpoint": "{Endpoint}", "jobId": "{Job ID}", "body": { @@ -56,7 +56,7 @@ "responses": { "202": { "headers": { - "Operation-Location": "{Endpoint}/language/analyze-conversation/jobs/{jobId}?api-version=2024-05-15-preview" + "Operation-Location": "{Endpoint}/language/analyze-conversation/jobs/{jobId}?api-version=2025-05-15-preview" } } } diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2024-11-15-preview/SuccessfulCustomConversationSummarizationTaskResult.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/preview/2025-05-15-preview/examples/SuccessfulCustomConversationSummarizationTaskResult.json similarity index 98% rename from specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2024-11-15-preview/SuccessfulCustomConversationSummarizationTaskResult.json rename to specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/preview/2025-05-15-preview/examples/SuccessfulCustomConversationSummarizationTaskResult.json index ce81f6994e94..0364df663456 100644 --- a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2024-11-15-preview/SuccessfulCustomConversationSummarizationTaskResult.json +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/preview/2025-05-15-preview/examples/SuccessfulCustomConversationSummarizationTaskResult.json @@ -3,7 +3,7 @@ "title": "SuccessfulCustomConversationSummarizationTaskResult", "parameters": { "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2024-11-15-preview", + "api-version": "2025-05-15-preview", "Endpoint": "{Endpoint}", "jobId": "3e9e8518-492f-47f9-abd1-9a7468231086" }, diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2024-11-15-preview/SuccessfulCustomConversationSummarizationTaskSubmit.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/preview/2025-05-15-preview/examples/SuccessfulCustomConversationSummarizationTaskSubmit.json similarity index 95% rename from specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2024-11-15-preview/SuccessfulCustomConversationSummarizationTaskSubmit.json rename to specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/preview/2025-05-15-preview/examples/SuccessfulCustomConversationSummarizationTaskSubmit.json index 22fa3666bb1b..23d62289ed19 100644 --- a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2024-11-15-preview/SuccessfulCustomConversationSummarizationTaskSubmit.json +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/preview/2025-05-15-preview/examples/SuccessfulCustomConversationSummarizationTaskSubmit.json @@ -3,7 +3,7 @@ "title": "SuccessfulCustomConversationSummarizationTaskSubmit", "parameters": { "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2024-11-15-preview", + "api-version": "2025-05-15-preview", "Endpoint": "{Endpoint}", "jobId": "{Job ID}", "body": { @@ -73,7 +73,7 @@ "responses": { "202": { "headers": { - "Operation-Location": "{Endpoint}/language/analyze-conversation/jobs/{jobId}?api-version=2024-11-15-preview" + "Operation-Location": "{Endpoint}/language/analyze-conversation/jobs/{jobId}?api-version=2025-05-15-preview" } } } diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/readme.md b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/readme.md index ef30b75c8bab..00eed55235c4 100644 --- a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/readme.md +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/readme.md @@ -38,6 +38,19 @@ modelerfour: lenient-model-deduplication: true ``` +### Release 2025-05-15-preview + +These settings apply only when `--tag=release_2025-05-15-preview` is specified on the command line. + +``` yaml $(tag) == 'release_2025-05-15-preview' +input-file: + - preview/2025-05-15-preview/analyzeconversations.json +title: + Microsoft Cognitive Language Service - Conversations +modelerfour: + lenient-model-deduplication: true +``` + ### Release 2024-11-01 These settings apply only when `--tag=release_2024-11-01` is specified on the command line. diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/SuccessfulAssignDeploymentResources.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/analyzeconversations-authoring/SuccessfulAssignDeploymentResources.json similarity index 100% rename from specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/SuccessfulAssignDeploymentResources.json rename to specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/analyzeconversations-authoring/SuccessfulAssignDeploymentResources.json diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/SuccessfulCancelTrainingJob.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/analyzeconversations-authoring/SuccessfulCancelTrainingJob.json similarity index 100% rename from specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/SuccessfulCancelTrainingJob.json rename to specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/analyzeconversations-authoring/SuccessfulCancelTrainingJob.json diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/SuccessfulCopyProject.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/analyzeconversations-authoring/SuccessfulCopyProject.json similarity index 100% rename from specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/SuccessfulCopyProject.json rename to specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/analyzeconversations-authoring/SuccessfulCopyProject.json diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/SuccessfulCopyProjectAuthorization.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/analyzeconversations-authoring/SuccessfulCopyProjectAuthorization.json similarity index 100% rename from specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/SuccessfulCopyProjectAuthorization.json rename to specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/analyzeconversations-authoring/SuccessfulCopyProjectAuthorization.json diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/SuccessfulCreateExportedModel.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/analyzeconversations-authoring/SuccessfulCreateExportedModel.json similarity index 100% rename from specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/SuccessfulCreateExportedModel.json rename to specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/analyzeconversations-authoring/SuccessfulCreateExportedModel.json diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/SuccessfulCreateProject.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/analyzeconversations-authoring/SuccessfulCreateProject.json similarity index 100% rename from specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/SuccessfulCreateProject.json rename to specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/analyzeconversations-authoring/SuccessfulCreateProject.json diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/SuccessfulDeleteDeployment.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/analyzeconversations-authoring/SuccessfulDeleteDeployment.json similarity index 100% rename from specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/SuccessfulDeleteDeployment.json rename to specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/analyzeconversations-authoring/SuccessfulDeleteDeployment.json diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/SuccessfulDeleteDeploymentFromResources.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/analyzeconversations-authoring/SuccessfulDeleteDeploymentFromResources.json similarity index 100% rename from specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/SuccessfulDeleteDeploymentFromResources.json rename to specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/analyzeconversations-authoring/SuccessfulDeleteDeploymentFromResources.json diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/SuccessfulDeleteExportedModel.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/analyzeconversations-authoring/SuccessfulDeleteExportedModel.json similarity index 100% rename from specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/SuccessfulDeleteExportedModel.json rename to specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/analyzeconversations-authoring/SuccessfulDeleteExportedModel.json diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/SuccessfulDeleteModel.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/analyzeconversations-authoring/SuccessfulDeleteModel.json similarity index 100% rename from specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/SuccessfulDeleteModel.json rename to specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/analyzeconversations-authoring/SuccessfulDeleteModel.json diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/SuccessfulDeleteProject.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/analyzeconversations-authoring/SuccessfulDeleteProject.json similarity index 100% rename from specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/SuccessfulDeleteProject.json rename to specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/analyzeconversations-authoring/SuccessfulDeleteProject.json diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/SuccessfulDeployProject.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/analyzeconversations-authoring/SuccessfulDeployProject.json similarity index 100% rename from specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/SuccessfulDeployProject.json rename to specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/analyzeconversations-authoring/SuccessfulDeployProject.json diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/SuccessfulEvaluationProject.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/analyzeconversations-authoring/SuccessfulEvaluationProject.json similarity index 100% rename from specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/SuccessfulEvaluationProject.json rename to specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/analyzeconversations-authoring/SuccessfulEvaluationProject.json diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/SuccessfulExportProject.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/analyzeconversations-authoring/SuccessfulExportProject.json similarity index 100% rename from specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/SuccessfulExportProject.json rename to specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/analyzeconversations-authoring/SuccessfulExportProject.json diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/SuccessfulGetAssignDeploymentResourcesStatus.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/analyzeconversations-authoring/SuccessfulGetAssignDeploymentResourcesStatus.json similarity index 100% rename from specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/SuccessfulGetAssignDeploymentResourcesStatus.json rename to specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/analyzeconversations-authoring/SuccessfulGetAssignDeploymentResourcesStatus.json diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/SuccessfulGetCopyProjectStatus.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/analyzeconversations-authoring/SuccessfulGetCopyProjectStatus.json similarity index 100% rename from specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/SuccessfulGetCopyProjectStatus.json rename to specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/analyzeconversations-authoring/SuccessfulGetCopyProjectStatus.json diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/SuccessfulGetDeployment.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/analyzeconversations-authoring/SuccessfulGetDeployment.json similarity index 100% rename from specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/SuccessfulGetDeployment.json rename to specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/analyzeconversations-authoring/SuccessfulGetDeployment.json diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/SuccessfulGetDeploymentDeleteFromResourcesStatus.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/analyzeconversations-authoring/SuccessfulGetDeploymentDeleteFromResourcesStatus.json similarity index 100% rename from specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/SuccessfulGetDeploymentDeleteFromResourcesStatus.json rename to specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/analyzeconversations-authoring/SuccessfulGetDeploymentDeleteFromResourcesStatus.json diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/SuccessfulGetDeploymentStatus.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/analyzeconversations-authoring/SuccessfulGetDeploymentStatus.json similarity index 100% rename from specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/SuccessfulGetDeploymentStatus.json rename to specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/analyzeconversations-authoring/SuccessfulGetDeploymentStatus.json diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/SuccessfulGetEvaluationStatus.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/analyzeconversations-authoring/SuccessfulGetEvaluationStatus.json similarity index 100% rename from specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/SuccessfulGetEvaluationStatus.json rename to specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/analyzeconversations-authoring/SuccessfulGetEvaluationStatus.json diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/SuccessfulGetExportStatus.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/analyzeconversations-authoring/SuccessfulGetExportStatus.json similarity index 100% rename from specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/SuccessfulGetExportStatus.json rename to specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/analyzeconversations-authoring/SuccessfulGetExportStatus.json diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/SuccessfulGetExportedModel.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/analyzeconversations-authoring/SuccessfulGetExportedModel.json similarity index 100% rename from specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/SuccessfulGetExportedModel.json rename to specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/analyzeconversations-authoring/SuccessfulGetExportedModel.json diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/SuccessfulGetExportedModelStatus.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/analyzeconversations-authoring/SuccessfulGetExportedModelStatus.json similarity index 100% rename from specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/SuccessfulGetExportedModelStatus.json rename to specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/analyzeconversations-authoring/SuccessfulGetExportedModelStatus.json diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/SuccessfulGetImportStatus.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/analyzeconversations-authoring/SuccessfulGetImportStatus.json similarity index 100% rename from specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/SuccessfulGetImportStatus.json rename to specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/analyzeconversations-authoring/SuccessfulGetImportStatus.json diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/SuccessfulGetLoadSnapshotStatus.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/analyzeconversations-authoring/SuccessfulGetLoadSnapshotStatus.json similarity index 100% rename from specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/SuccessfulGetLoadSnapshotStatus.json rename to specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/analyzeconversations-authoring/SuccessfulGetLoadSnapshotStatus.json diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/SuccessfulGetModel.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/analyzeconversations-authoring/SuccessfulGetModel.json similarity index 100% rename from specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/SuccessfulGetModel.json rename to specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/analyzeconversations-authoring/SuccessfulGetModel.json diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/SuccessfulGetModelEvaluation.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/analyzeconversations-authoring/SuccessfulGetModelEvaluation.json similarity index 100% rename from specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/SuccessfulGetModelEvaluation.json rename to specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/analyzeconversations-authoring/SuccessfulGetModelEvaluation.json diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/SuccessfulGetModelEvaluationSummary.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/analyzeconversations-authoring/SuccessfulGetModelEvaluationSummary.json similarity index 100% rename from specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/SuccessfulGetModelEvaluationSummary.json rename to specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/analyzeconversations-authoring/SuccessfulGetModelEvaluationSummary.json diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/SuccessfulGetProject.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/analyzeconversations-authoring/SuccessfulGetProject.json similarity index 100% rename from specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/SuccessfulGetProject.json rename to specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/analyzeconversations-authoring/SuccessfulGetProject.json diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/SuccessfulGetProjectDeletionStatus.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/analyzeconversations-authoring/SuccessfulGetProjectDeletionStatus.json similarity index 100% rename from specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/SuccessfulGetProjectDeletionStatus.json rename to specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/analyzeconversations-authoring/SuccessfulGetProjectDeletionStatus.json diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/SuccessfulGetSupportedLanguages.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/analyzeconversations-authoring/SuccessfulGetSupportedLanguages.json similarity index 100% rename from specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/SuccessfulGetSupportedLanguages.json rename to specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/analyzeconversations-authoring/SuccessfulGetSupportedLanguages.json diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/SuccessfulGetSupportedPrebuiltEntities.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/analyzeconversations-authoring/SuccessfulGetSupportedPrebuiltEntities.json similarity index 100% rename from specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/SuccessfulGetSupportedPrebuiltEntities.json rename to specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/analyzeconversations-authoring/SuccessfulGetSupportedPrebuiltEntities.json diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/SuccessfulGetSupportedTrainingConfigVersions.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/analyzeconversations-authoring/SuccessfulGetSupportedTrainingConfigVersions.json similarity index 100% rename from specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/SuccessfulGetSupportedTrainingConfigVersions.json rename to specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/analyzeconversations-authoring/SuccessfulGetSupportedTrainingConfigVersions.json diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/SuccessfulGetSwapDeploymentsStatus.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/analyzeconversations-authoring/SuccessfulGetSwapDeploymentsStatus.json similarity index 100% rename from specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/SuccessfulGetSwapDeploymentsStatus.json rename to specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/analyzeconversations-authoring/SuccessfulGetSwapDeploymentsStatus.json diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/SuccessfulGetTrainStatus.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/analyzeconversations-authoring/SuccessfulGetTrainStatus.json similarity index 100% rename from specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/SuccessfulGetTrainStatus.json rename to specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/analyzeconversations-authoring/SuccessfulGetTrainStatus.json diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/SuccessfulGetUnassignDeploymentResourcesStatus.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/analyzeconversations-authoring/SuccessfulGetUnassignDeploymentResourcesStatus.json similarity index 100% rename from specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/SuccessfulGetUnassignDeploymentResourcesStatus.json rename to specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/analyzeconversations-authoring/SuccessfulGetUnassignDeploymentResourcesStatus.json diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/SuccessfulImportProject.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/analyzeconversations-authoring/SuccessfulImportProject.json similarity index 100% rename from specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/SuccessfulImportProject.json rename to specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/analyzeconversations-authoring/SuccessfulImportProject.json diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/SuccessfulListAssignedResourceDeployments.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/analyzeconversations-authoring/SuccessfulListAssignedResourceDeployments.json similarity index 100% rename from specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/SuccessfulListAssignedResourceDeployments.json rename to specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/analyzeconversations-authoring/SuccessfulListAssignedResourceDeployments.json diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/SuccessfulListDeploymentResources.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/analyzeconversations-authoring/SuccessfulListDeploymentResources.json similarity index 100% rename from specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/SuccessfulListDeploymentResources.json rename to specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/analyzeconversations-authoring/SuccessfulListDeploymentResources.json diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/SuccessfulListDeployments.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/analyzeconversations-authoring/SuccessfulListDeployments.json similarity index 100% rename from specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/SuccessfulListDeployments.json rename to specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/analyzeconversations-authoring/SuccessfulListDeployments.json diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/SuccessfulListExportedModels.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/analyzeconversations-authoring/SuccessfulListExportedModels.json similarity index 100% rename from specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/SuccessfulListExportedModels.json rename to specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/analyzeconversations-authoring/SuccessfulListExportedModels.json diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/SuccessfulListModels.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/analyzeconversations-authoring/SuccessfulListModels.json similarity index 100% rename from specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/SuccessfulListModels.json rename to specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/analyzeconversations-authoring/SuccessfulListModels.json diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/SuccessfulListProjects.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/analyzeconversations-authoring/SuccessfulListProjects.json similarity index 100% rename from specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/SuccessfulListProjects.json rename to specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/analyzeconversations-authoring/SuccessfulListProjects.json diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/SuccessfulListTrainingJobs.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/analyzeconversations-authoring/SuccessfulListTrainingJobs.json similarity index 100% rename from specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/SuccessfulListTrainingJobs.json rename to specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/analyzeconversations-authoring/SuccessfulListTrainingJobs.json diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/SuccessfulLoadSnapshot.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/analyzeconversations-authoring/SuccessfulLoadSnapshot.json similarity index 100% rename from specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/SuccessfulLoadSnapshot.json rename to specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/analyzeconversations-authoring/SuccessfulLoadSnapshot.json diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/SuccessfulSwapDeployments.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/analyzeconversations-authoring/SuccessfulSwapDeployments.json similarity index 100% rename from specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/SuccessfulSwapDeployments.json rename to specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/analyzeconversations-authoring/SuccessfulSwapDeployments.json diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/SuccessfulTrainProject.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/analyzeconversations-authoring/SuccessfulTrainProject.json similarity index 100% rename from specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/SuccessfulTrainProject.json rename to specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/analyzeconversations-authoring/SuccessfulTrainProject.json diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/SuccessfulUnassignDeploymentResources.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/analyzeconversations-authoring/SuccessfulUnassignDeploymentResources.json similarity index 100% rename from specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/SuccessfulUnassignDeploymentResources.json rename to specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/analyzeconversations-authoring/SuccessfulUnassignDeploymentResources.json diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/main.tsp b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/main.tsp index 186ac0e30467..cb0268ce61f7 100644 --- a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/main.tsp +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/main.tsp @@ -49,6 +49,11 @@ enum Versions { /** Version 2025-11-01 */ v2025_11_01: "2025-11-01", + /** + * The 2025-05-15-preview API version. + */ + v2025_05_15_preview: "2025-05-15-preview", + /** * The 2025-11-15-preview API version. */ diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/models/common.tsp b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/models/common.tsp index 0156a5817f15..2354b76c5e7f 100644 --- a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/models/common.tsp +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/models/common.tsp @@ -30,7 +30,7 @@ union ProjectKind { /** * A project to build conversation summarization models which are able to summarize long conversations. */ - @added(Versions.v2025_11_15_preview) + @added(Versions.v2025_05_15_preview) CustomConversationSummarization: "CustomConversationSummarization", } diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/models/project.tsp b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/models/project.tsp index 0f065f1007a6..3b0f8df3933f 100644 --- a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/models/project.tsp +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/models/project.tsp @@ -69,7 +69,7 @@ model AnalyzeConversationAuthoringProjectMetadata { * The storage container name in case of conversation summarization. */ @visibility(Lifecycle.Create, Lifecycle.Read) - @added(Versions.v2025_11_15_preview) + @added(Versions.v2025_05_15_preview) storageInputContainerName?: string; /** @@ -156,7 +156,7 @@ model AnalyzeConversationAuthoringCreateProjectOptions { /** * The storage container name in case of conversation summarization. */ - @added(Versions.v2025_11_15_preview) + @added(Versions.v2025_05_15_preview) storageInputContainerName?: string; /** @@ -183,7 +183,7 @@ model AnalyzeConversationAuthoringCreateProjectOptions { /** * Represents the options for authorizing a project copy to the current Azure resource. */ -@added(Versions.v2025_11_15_preview) +@added(Versions.v2025_05_15_preview) model AnalyzeConversationAuthoringCopyAuthorizationOptions { /** * Represents the project kind. @@ -204,7 +204,7 @@ model AnalyzeConversationAuthoringCopyAuthorizationOptions { /** * Represents the options for copying an existing project to another Azure resource. */ -@added(Versions.v2025_11_15_preview) +@added(Versions.v2025_05_15_preview) model AnalyzeConversationAuthoringCopiedProjectOptions { /** * Represents the project kind. @@ -300,7 +300,7 @@ model AnalyzeConversationAuthoringTrainingJobOptions { /** * For customers to populate if they wish to use data generation for their model training job. */ - @added(Versions.v2025_11_15_preview) + @added(Versions.v2025_05_15_preview) dataGenerationSettings?: AnalyzeConversationAuthoringDataGenerationSettings; } @@ -327,7 +327,7 @@ model AnalyzeConversationAuthoringEvaluationOptions { /** * Represents the state of a copy job. */ -@added(Versions.v2025_11_15_preview) +@added(Versions.v2025_05_15_preview) @resource("copy/jobs") @parentResource(AnalyzeConversationAuthoringProjectMetadata) model AnalyzeConversationAuthoringCopiedProjectJobState { @@ -433,13 +433,20 @@ model AnalyzeConversationAuthoringProjectDeployment { * Represents the metadata of the assigned Azure resources. */ @added(Versions.v2025_11_01) + @typeChangedFrom( + Versions.v2025_05_15_preview, + AnalyzeConversationAuthoringProjectResourceInfo[] + ) + @typeChangedFrom( + Versions.v2025_11_15_preview, + AnalyzeConversationAuthoringDeploymentResource[] + ) assignedResources: AnalyzeConversationAuthoringProjectResourceInfo[]; } /** * Represents an Azure resource assigned to a deployment. */ -@added(Versions.v2025_11_15_preview) model AnalyzeConversationAuthoringDeploymentResource { /** * Represents the Azure resource Id. @@ -454,7 +461,7 @@ model AnalyzeConversationAuthoringDeploymentResource { /** * Represents the AOAI resource assigned for data generation. */ - @added(Versions.v2025_11_15_preview) + @added(Versions.v2025_05_15_preview) assignedAoaiResource?: AnalyzeConversationAuthoringDataGenerationConnectionInfo; } @@ -471,13 +478,13 @@ model AnalyzeConversationAuthoringCreateDeploymentOptions { * Represents the Language or AIService resource IDs that if provided,\n the deployment will be rolled out to the resources provided here as well as the original resource in which the project is created. */ @added(Versions.v2025_11_01) - @removed(Versions.v2025_11_15_preview) + @removed(Versions.v2025_05_15_preview) assignedResourceIds?: string[]; /** * Represents the resources to be assigned to the deployment. If provided, the deployment will be rolled out to the resources provided here as well as the original resource in which the project is created. */ - @added(Versions.v2025_11_15_preview) + @added(Versions.v2025_05_15_preview) assignedResources?: AnalyzeConversationAuthoringDeploymentResource[]; } @@ -485,8 +492,12 @@ model AnalyzeConversationAuthoringCreateDeploymentOptions { * Represents the payload for deleting a project deployment. */ @renamedFrom( - Versions.v2025_11_01, - "AnalyzeConversationAuthoringDeleteDeploymentOptions" + Versions.v2025_05_15_preview, + "AnalyzeConversationAuthoringProjectAzureResourceIds" +) +@renamedFrom( + Versions.v2025_11_15_preview, + "AnalyzeConversationAuthoringAssignedDeploymentResources" ) model AnalyzeConversationAuthoringProjectAzureResourceIds { /** @@ -495,6 +506,16 @@ model AnalyzeConversationAuthoringProjectAzureResourceIds { assignedResourceIds?: string[]; } +/** + * Represents the options for deleting a project deployment. + */ +model AnalyzeConversationAuthoringDeleteDeploymentOptions { + /** + * Represents the resource IDs to delete the deployment from. If not provided, the deployment will be rolled out from all the resources it is deployed to. If provided, it will delete the deployment only from the specified assigned resources, and leave it for the rest. + */ + assignedResourceIds?: string[]; +} + /** * Represents the state of a deployment job. */ @@ -1006,6 +1027,14 @@ model AnalyzeConversationAuthoringLoadSnapshotJobState { * Represents the assigned deployment resources. */ @added(Versions.v2025_11_01) +@renamedFrom( + Versions.v2025_05_15_preview, + "AnalyzeConversationAuthoringDeploymentResourcesInfoList" +) +@renamedFrom( + Versions.v2025_11_15_preview, + "AnalyzeConversationAuthoringAssignedDeploymentResources" +) model AnalyzeConversationAuthoringDeploymentResourcesInfoList { /** * The list of assigned deployment resources. @@ -1024,6 +1053,14 @@ model AnalyzeConversationAuthoringDeploymentResourcesInfoList { @added(Versions.v2025_11_01) @resource("resources") @parentResource(AnalyzeConversationAuthoringProjectMetadata) +@renamedFrom( + Versions.v2025_05_15_preview, + "AnalyzeConversationAuthoringProjectResourceInfo" +) +@renamedFrom( + Versions.v2025_11_15_preview, + "AnalyzeConversationAuthoringAssignedDeploymentResource" +) model AnalyzeConversationAuthoringProjectResourceInfo { /** * The Azure resource ID of the language or AI resource. @@ -1042,10 +1079,20 @@ model AnalyzeConversationAuthoringProjectResourceInfo { * Represents the payload for assigning Azure resources to a project. */ @added(Versions.v2025_11_01) +@renamedFrom( + Versions.v2025_05_15_preview, + "AnalyzeConversationAuthoringProjectResourceAssignments" +) +@renamedFrom( + Versions.v2025_11_15_preview, + "AnalyzeConversationAuthoringAssignDeploymentResourcesOptions" +) model AnalyzeConversationAuthoringProjectResourceAssignments { /** * Represents the metadata for the project resources to be assigned. */ + @renamedFrom(Versions.v2025_05_15_preview, "projectResources") + @renamedFrom(Versions.v2025_11_15_preview, "resourcesMetadata") projectResources: AnalyzeConversationAuthoringProjectResourceAssignmentInfo[]; } @@ -1053,7 +1100,11 @@ model AnalyzeConversationAuthoringProjectResourceAssignments { * Represents metadata for the Azure resource.. */ @renamedFrom( - Versions.v2025_11_01, + Versions.v2025_05_15_preview, + "AnalyzeConversationAuthoringProjectResourceAssignmentInfo" +) +@renamedFrom( + Versions.v2025_11_15_preview, "AnalyzeConversationAuthoringResourceMetadata" ) model AnalyzeConversationAuthoringProjectResourceAssignmentInfo { @@ -1076,7 +1127,7 @@ model AnalyzeConversationAuthoringProjectResourceAssignmentInfo { /** * Represents the options to unassign Azure resources from a project. */ -@added(Versions.v2025_11_15_preview) +@added(Versions.v2025_05_15_preview) model AnalyzeConversationAuthoringUnassignDeploymentResourcesOptions { /** * Represents the assigned resource IDs to be unassigned. @@ -1090,6 +1141,14 @@ model AnalyzeConversationAuthoringUnassignDeploymentResourcesOptions { @added(Versions.v2025_11_01) @resource("resources/assign/jobs") @parentResource(AnalyzeConversationAuthoringProjectMetadata) +@renamedFrom( + Versions.v2025_05_15_preview, + "AnalyzeConversationAuthoringProjectResourcesJobState" +) +@renamedFrom( + Versions.v2025_11_15_preview, + "AnalyzeConversationAuthoringDeploymentResourcesJobState" +) model AnalyzeConversationAuthoringProjectResourcesJobState { ...AnalyzeConversationAuthoringJobState; } @@ -1150,7 +1209,7 @@ model AnalyzeConversationAuthoringTrainingJobResult { /** * Represents the model data generation status. */ - @added(Versions.v2025_11_15_preview) + @added(Versions.v2025_05_15_preview) dataGenerationStatus: AnalyzeConversationAuthoringSubTrainingJobState; /** @@ -1368,7 +1427,7 @@ model AnalyzeConversationAuthoringConversationExportedEntity { /** * The entity description. */ - @added(Versions.v2025_11_15_preview) + @added(Versions.v2025_05_15_preview) description?: string; /** @@ -1489,20 +1548,20 @@ model AnalyzeConversationAuthoringConversationExportedIntent { /** * The intent description. */ - @added(Versions.v2025_11_15_preview) + @added(Versions.v2025_05_15_preview) description?: string; /** * The list of associated entities. */ - @added(Versions.v2025_11_15_preview) + @added(Versions.v2025_05_15_preview) associatedEntities?: AnalyzeConversationExportedAssociatedEntityLabel[]; } /** * Represents an associated entity label for an intent. */ -@added(Versions.v2025_11_15_preview) +@added(Versions.v2025_05_15_preview) model AnalyzeConversationExportedAssociatedEntityLabel { /** * The category of the entity label. @@ -1752,7 +1811,7 @@ model AnalyzeConversationAuthoringOrchestrationExportedIntent { /** * The intent description. */ - @added(Versions.v2025_11_15_preview) + @added(Versions.v2025_05_15_preview) description?: string; } @@ -1843,7 +1902,7 @@ model AnalyzeConversationAuthoringExportedTrainedModel { /** * Represents the state of a job to create or updated an exported model. */ -@added(Versions.v2025_11_15_preview) +@added(Versions.v2025_05_15_preview) @resource("jobs") @parentResource(AnalyzeConversationAuthoringExportedTrainedModel) model AnalyzeConversationAuthoringExportedModelJobState { @@ -1852,7 +1911,7 @@ model AnalyzeConversationAuthoringExportedModelJobState { /** * Represents the properties for the model file. */ -@added(Versions.v2025_11_15_preview) +@added(Versions.v2025_05_15_preview) model AnalyzeConversationAuthoringModelFile { /** * The name of the file. @@ -1867,7 +1926,7 @@ model AnalyzeConversationAuthoringModelFile { /** * Represents the options for creating or replacing an exported model. */ -@added(Versions.v2025_11_15_preview) +@added(Versions.v2025_05_15_preview) model ExportedModelOptions { /** * The trained model label. @@ -1879,7 +1938,7 @@ model ExportedModelOptions { * Represents the connection kind for Azure OpenAI deployment. */ #suppress "@azure-tools/typespec-azure-core/documentation-required" -@added(Versions.v2025_11_15_preview) +@added(Versions.v2025_05_15_preview) union AnalyzeConversationAuthoringDataGenerationConnectionKind { string, AzureOpenAI: "AzureOpenAI", @@ -1888,7 +1947,7 @@ union AnalyzeConversationAuthoringDataGenerationConnectionKind { /** * Represents the connection info for the Azure resource to use during data generation. */ -@added(Versions.v2025_11_15_preview) +@added(Versions.v2025_05_15_preview) model AnalyzeConversationAuthoringDataGenerationConnectionInfo { /** * Connection type for data generation settings. Currently only supports Azure OpenAI. @@ -1910,7 +1969,7 @@ model AnalyzeConversationAuthoringDataGenerationConnectionInfo { /** * Settings to enable data generation for training augmentation. */ -@added(Versions.v2025_11_15_preview) +@added(Versions.v2025_05_15_preview) model AnalyzeConversationAuthoringDataGenerationSettings { /** * Must be explicitly set to True to enable data generation to augment training data. diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/analyzeconversations-authoring.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/analyzeconversations-authoring.json new file mode 100644 index 000000000000..0ccdd406b56d --- /dev/null +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/analyzeconversations-authoring.json @@ -0,0 +1,5726 @@ +{ + "swagger": "2.0", + "info": { + "title": "Microsoft Cognitive Language Service - Analyze Conversations Authoring", + "version": "2025-05-15-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 https://learn.microsoft.com/en-us/azure/cognitive-services/language-service/overview.", + "x-typespec-generated": [ + { + "emitter": "@azure-tools/typespec-autorest" + } + ] + }, + "schemes": [ + "https" + ], + "x-ms-parameterized-host": { + "hostTemplate": "{Endpoint}/language", + "useSchemePrefix": false, + "parameters": [ + { + "name": "Endpoint", + "in": "path", + "description": "Supported Cognitive Services endpoint e.g., https://.api.cognitiveservices.azure.com.", + "required": true, + "type": "string", + "format": "uri", + "x-ms-skip-url-encoding": true + } + ] + }, + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "security": [ + { + "ApiKeyAuth": [] + }, + { + "OAuth2Auth": [ + "https://cognitiveservices.azure.com/.default" + ] + } + ], + "securityDefinitions": { + "ApiKeyAuth": { + "type": "apiKey", + "name": "Ocp-Apim-Subscription-Key", + "in": "header" + }, + "OAuth2Auth": { + "type": "oauth2", + "flow": "accessCode", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "https://cognitiveservices.azure.com/.default": "" + }, + "tokenUrl": "https://login.microsoftonline.com/common/oauth2/token" + } + }, + "tags": [], + "paths": { + "/authoring/analyze-conversations/projects": { + "get": { + "operationId": "ConversationAuthoringListProjects", + "description": "Lists the existing projects.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "$ref": "#/parameters/Azure.Core.TopQueryParameter" + }, + { + "$ref": "#/parameters/Azure.Core.SkipQueryParameter" + }, + { + "$ref": "#/parameters/Azure.Core.MaxPageSizeQueryParameter" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/PagedAnalyzeConversationAuthoringProjectMetadata" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Successful List Projects": { + "$ref": "./examples/analyzeconversations-authoring/SuccessfulListProjects.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/authoring/analyze-conversations/projects/{projectName}": { + "get": { + "operationId": "ConversationAuthoringProject_GetProject", + "description": "Gets the details of a project.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "The new project name.", + "required": true, + "type": "string", + "maxLength": 100 + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/AnalyzeConversationAuthoringProjectMetadata" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Successful Get Project": { + "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetProject.json" + } + } + }, + "patch": { + "operationId": "ConversationAuthoringProject_CreateProject", + "description": "Creates a new project or updates an existing one.", + "consumes": [ + "application/merge-patch+json" + ], + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "The new project name.", + "required": true, + "type": "string", + "maxLength": 100 + }, + { + "name": "body", + "in": "body", + "description": "The request body", + "required": true, + "schema": { + "$ref": "#/definitions/AnalyzeConversationAuthoringCreateProjectOptions" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/AnalyzeConversationAuthoringProjectMetadata" + } + }, + "201": { + "description": "The request has succeeded and a new resource has been created as a result.", + "schema": { + "$ref": "#/definitions/AnalyzeConversationAuthoringProjectMetadata" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Successful Create Project": { + "$ref": "./examples/analyzeconversations-authoring/SuccessfulCreateProject.json" + } + } + }, + "delete": { + "operationId": "ConversationAuthoringProject_DeleteProject", + "description": "Deletes a project.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "The name of the project to use.", + "required": true, + "type": "string", + "maxLength": 100 + } + ], + "responses": { + "202": { + "description": "The request has been accepted for processing, but processing has not yet completed.", + "headers": { + "Operation-Location": { + "type": "string", + "format": "uri", + "description": "The location for monitoring the operation state." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Successful Delete Project": { + "$ref": "./examples/analyzeconversations-authoring/SuccessfulDeleteProject.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/authoring/analyze-conversations/projects/{projectName}/:authorize-copy": { + "post": { + "operationId": "ConversationAuthoringProject_CopyProjectAuthorization", + "description": "Generates a copy project operation authorization to the current target Azure resource.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "The new project name.", + "required": true, + "type": "string", + "maxLength": 100 + }, + { + "name": "body", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/AnalyzeConversationAuthoringCopyAuthorizationOptions" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/AnalyzeConversationAuthoringCopiedProjectOptions" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Successful Copy Project Authorization": { + "$ref": "./examples/analyzeconversations-authoring/SuccessfulCopyProjectAuthorization.json" + } + } + } + }, + "/authoring/analyze-conversations/projects/{projectName}/:copy": { + "post": { + "operationId": "ConversationAuthoringProject_CopyProject", + "description": "Copies an existing project to another Azure resource.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "The name of the project to use.", + "required": true, + "type": "string", + "maxLength": 100 + }, + { + "name": "body", + "in": "body", + "description": "The copy project info.", + "required": true, + "schema": { + "$ref": "#/definitions/AnalyzeConversationAuthoringCopiedProjectOptions" + } + } + ], + "responses": { + "202": { + "description": "The request has been accepted for processing, but processing has not yet completed.", + "headers": { + "Operation-Location": { + "type": "string", + "format": "uri", + "description": "The location for monitoring the operation state." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Successful Copy Project": { + "$ref": "./examples/analyzeconversations-authoring/SuccessfulCopyProject.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/authoring/analyze-conversations/projects/{projectName}/:export": { + "post": { + "operationId": "ConversationAuthoringProject_Export", + "description": "Triggers a job to export a project's data.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "The name of the project to use.", + "required": true, + "type": "string", + "maxLength": 100 + }, + { + "name": "format", + "in": "query", + "description": "The format of the exported project file to use.", + "required": false, + "type": "string", + "enum": [ + "Conversation", + "Luis" + ], + "x-ms-enum": { + "name": "ExportedProjectFormat", + "modelAsString": true, + "values": [ + { + "name": "Conversation", + "value": "Conversation", + "description": "Specifies the format for a conversational project." + }, + { + "name": "Luis", + "value": "Luis", + "description": "Specifies the format for an application that was exported from LUIS." + } + ] + }, + "x-ms-client-name": "ExportedProjectFormat" + }, + { + "name": "stringIndexType", + "in": "query", + "description": "Specifies the method used to interpret string offsets. For additional information see https://aka.ms/text-analytics-offsets.", + "required": true, + "type": "string", + "enum": [ + "Utf16CodeUnit", + "Utf8CodeUnit", + "Utf32CodeUnit" + ], + "x-ms-enum": { + "name": "StringIndexType", + "modelAsString": true, + "values": [ + { + "name": "Utf16CodeUnit", + "value": "Utf16CodeUnit", + "description": "The offset and length values will correspond to UTF-16 code units. Use this option if your application is written in a language that support Unicode, for example Java, JavaScript." + }, + { + "name": "Utf8CodeUnit", + "value": "Utf8CodeUnit" + }, + { + "name": "Utf32CodeUnit", + "value": "Utf32CodeUnit" + } + ] + } + }, + { + "name": "assetKind", + "in": "query", + "description": "Kind of asset to export.", + "required": false, + "type": "string" + }, + { + "name": "trainedModelLabel", + "in": "query", + "description": "Trained model label to export. If the trainedModelLabel is null, the default behavior is to export the current working copy.", + "required": false, + "type": "string" + } + ], + "responses": { + "202": { + "description": "The request has been accepted for processing, but processing has not yet completed.", + "headers": { + "Operation-Location": { + "type": "string", + "format": "uri", + "description": "The location for monitoring the operation state." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Successful Export Project": { + "$ref": "./examples/analyzeconversations-authoring/SuccessfulExportProject.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/authoring/analyze-conversations/projects/{projectName}/:import": { + "post": { + "operationId": "ConversationAuthoringProject_Import", + "description": "Triggers a job to import a project. If a project with the same name already exists, the data of that project is replaced.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "The name of the project to use.", + "required": true, + "type": "string", + "maxLength": 100 + }, + { + "name": "format", + "in": "query", + "description": "The format of the exported project file to use.", + "required": false, + "type": "string", + "enum": [ + "Conversation", + "Luis" + ], + "x-ms-enum": { + "name": "ExportedProjectFormat", + "modelAsString": true, + "values": [ + { + "name": "Conversation", + "value": "Conversation", + "description": "Specifies the format for a conversational project." + }, + { + "name": "Luis", + "value": "Luis", + "description": "Specifies the format for an application that was exported from LUIS." + } + ] + }, + "x-ms-client-name": "ExportedProjectFormat" + }, + { + "name": "body", + "in": "body", + "description": "The project data to import.", + "required": true, + "schema": { + "$ref": "#/definitions/AnalyzeConversationAuthoringExportedProject" + } + } + ], + "responses": { + "202": { + "description": "The request has been accepted for processing, but processing has not yet completed.", + "headers": { + "Operation-Location": { + "type": "string", + "format": "uri", + "description": "The location for monitoring the operation state." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Successful Import Project": { + "$ref": "./examples/analyzeconversations-authoring/SuccessfulImportProject.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/authoring/analyze-conversations/projects/{projectName}/:train": { + "post": { + "operationId": "ConversationAuthoringProject_Train", + "description": "Triggers a training job for a project.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "The name of the project to use.", + "required": true, + "type": "string", + "maxLength": 100 + }, + { + "name": "body", + "in": "body", + "description": "The training input parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/AnalyzeConversationAuthoringTrainingJobOptions" + } + } + ], + "responses": { + "202": { + "description": "The request has been accepted for processing, but processing has not yet completed.", + "headers": { + "Operation-Location": { + "type": "string", + "format": "uri", + "description": "The location for monitoring the operation state." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Successful Train Project": { + "$ref": "./examples/analyzeconversations-authoring/SuccessfulTrainProject.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/authoring/analyze-conversations/projects/{projectName}/copy/jobs/{jobId}": { + "get": { + "operationId": "ConversationAuthoringProject_GetCopyProjectStatus", + "description": "Gets the status of an existing copy project job.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "The new project name.", + "required": true, + "type": "string", + "maxLength": 100 + }, + { + "name": "jobId", + "in": "path", + "description": "The job ID.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/AnalyzeConversationAuthoringCopiedProjectJobState" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Successful Get Copy Project Status": { + "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetCopyProjectStatus.json" + } + } + } + }, + "/authoring/analyze-conversations/projects/{projectName}/deployments": { + "get": { + "operationId": "ConversationAuthoringListDeployments", + "description": "Lists the deployments belonging to a project.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "The new project name.", + "required": true, + "type": "string", + "maxLength": 100 + }, + { + "$ref": "#/parameters/Azure.Core.TopQueryParameter" + }, + { + "$ref": "#/parameters/Azure.Core.SkipQueryParameter" + }, + { + "$ref": "#/parameters/Azure.Core.MaxPageSizeQueryParameter" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/PagedAnalyzeConversationAuthoringProjectDeployment" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Successful List Deployments": { + "$ref": "./examples/analyzeconversations-authoring/SuccessfulListDeployments.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/authoring/analyze-conversations/projects/{projectName}/deployments/{deploymentName}": { + "get": { + "operationId": "ConversationAuthoringDeployment_GetDeployment", + "description": "Gets the details of a deployment.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "The new project name.", + "required": true, + "type": "string", + "maxLength": 100 + }, + { + "name": "deploymentName", + "in": "path", + "description": "Represents deployment name.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/AnalyzeConversationAuthoringProjectDeployment" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Successful Get Deployment": { + "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetDeployment.json" + } + } + }, + "put": { + "operationId": "ConversationAuthoringDeployment_DeployProject", + "description": "Creates a new deployment or replaces an existing one.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "The name of the project to use.", + "required": true, + "type": "string", + "maxLength": 100 + }, + { + "name": "deploymentName", + "in": "path", + "description": "The name of the specific deployment of the project to use.", + "required": true, + "type": "string" + }, + { + "name": "body", + "in": "body", + "description": "The new deployment info.", + "required": true, + "schema": { + "$ref": "#/definitions/AnalyzeConversationAuthoringCreateDeploymentOptions" + } + } + ], + "responses": { + "202": { + "description": "The request has been accepted for processing, but processing has not yet completed.", + "headers": { + "Operation-Location": { + "type": "string", + "format": "uri", + "description": "The location for monitoring the operation state." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Successful Deploy Project": { + "$ref": "./examples/analyzeconversations-authoring/SuccessfulDeployProject.json" + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "ConversationAuthoringDeployment_DeleteDeployment", + "description": "Deletes a project deployment.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "The name of the project to use.", + "required": true, + "type": "string", + "maxLength": 100 + }, + { + "name": "deploymentName", + "in": "path", + "description": "The name of the specific deployment of the project to use.", + "required": true, + "type": "string" + } + ], + "responses": { + "202": { + "description": "The request has been accepted for processing, but processing has not yet completed.", + "headers": { + "Operation-Location": { + "type": "string", + "format": "uri", + "description": "The location for monitoring the operation state." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Successful Delete Deployment": { + "$ref": "./examples/analyzeconversations-authoring/SuccessfulDeleteDeployment.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/authoring/analyze-conversations/projects/{projectName}/deployments/{deploymentName}/:delete-from-resources": { + "post": { + "operationId": "ConversationAuthoringDeployment_DeleteDeploymentFromResources", + "description": "Deletes a deployment from the specified project-assigned resources.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "The name of the project to use.", + "required": true, + "type": "string", + "maxLength": 100 + }, + { + "name": "deploymentName", + "in": "path", + "description": "The name of the specific deployment of the project to use.", + "required": true, + "type": "string" + }, + { + "name": "body", + "in": "body", + "description": "The Language or AIService resource list for deleting the deployment.\\r\\n The deployment will only be deleted from the specified resources, and will remain for the rest.", + "required": true, + "schema": { + "$ref": "#/definitions/AnalyzeConversationAuthoringDeleteDeploymentOptions" + } + } + ], + "responses": { + "202": { + "description": "The request has been accepted for processing, but processing has not yet completed.", + "headers": { + "Operation-Location": { + "type": "string", + "format": "uri", + "description": "The location for monitoring the operation state." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Successful Delete Deployment From Resources": { + "$ref": "./examples/analyzeconversations-authoring/SuccessfulDeleteDeploymentFromResources.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/authoring/analyze-conversations/projects/{projectName}/deployments/{deploymentName}/delete-from-resources/jobs/{jobId}": { + "get": { + "operationId": "ConversationAuthoringDeployment_GetDeploymentDeleteFromResourcesStatus", + "description": "Gets the status of an existing delete deployment from specific resources job.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "The new project name.", + "required": true, + "type": "string", + "maxLength": 100 + }, + { + "name": "deploymentName", + "in": "path", + "description": "Represents deployment name.", + "required": true, + "type": "string" + }, + { + "name": "jobId", + "in": "path", + "description": "The job ID.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/AnalyzeConversationAuthoringDeploymentDeleteFromResourcesJobState" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Successful Get Deployment Status": { + "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetDeploymentDeleteFromResourcesStatus.json" + } + } + } + }, + "/authoring/analyze-conversations/projects/{projectName}/deployments/{deploymentName}/jobs/{jobId}": { + "get": { + "operationId": "ConversationAuthoringDeployment_GetDeploymentStatus", + "description": "Gets the status of an existing deployment job.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "The new project name.", + "required": true, + "type": "string", + "maxLength": 100 + }, + { + "name": "deploymentName", + "in": "path", + "description": "Represents deployment name.", + "required": true, + "type": "string" + }, + { + "name": "jobId", + "in": "path", + "description": "The job ID.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/AnalyzeConversationAuthoringDeploymentJobState" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Successful Get Deployment Status": { + "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetDeploymentStatus.json" + } + } + } + }, + "/authoring/analyze-conversations/projects/{projectName}/deployments/:swap": { + "post": { + "operationId": "ConversationAuthoringProject_SwapDeployments", + "description": "Swaps two existing deployments with each other.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "The name of the project to use.", + "required": true, + "type": "string", + "maxLength": 100 + }, + { + "name": "body", + "in": "body", + "description": "The job object to swap two deployments.", + "required": true, + "schema": { + "$ref": "#/definitions/AnalyzeConversationAuthoringSwapDeploymentsOptions" + } + } + ], + "responses": { + "202": { + "description": "The request has been accepted for processing, but processing has not yet completed.", + "headers": { + "Operation-Location": { + "type": "string", + "format": "uri", + "description": "The location for monitoring the operation state." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Successful Swap Deployments": { + "$ref": "./examples/analyzeconversations-authoring/SuccessfulSwapDeployments.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/authoring/analyze-conversations/projects/{projectName}/deployments/swap/jobs/{jobId}": { + "get": { + "operationId": "ConversationAuthoringProject_GetSwapDeploymentsStatus", + "description": "Gets the status of an existing swap deployment job.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "The new project name.", + "required": true, + "type": "string", + "maxLength": 100 + }, + { + "name": "jobId", + "in": "path", + "description": "The job ID.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/AnalyzeConversationAuthoringSwapDeploymentsJobState" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Successful Get Swap Deployments Status": { + "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetSwapDeploymentsStatus.json" + } + } + } + }, + "/authoring/analyze-conversations/projects/{projectName}/export/jobs/{jobId}": { + "get": { + "operationId": "ConversationAuthoringProject_GetExportStatus", + "description": "Gets the status of an export job. Once job completes, returns the project metadata, and assets.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "The new project name.", + "required": true, + "type": "string", + "maxLength": 100 + }, + { + "name": "jobId", + "in": "path", + "description": "The job ID.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/AnalyzeConversationAuthoringExportProjectJobState" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Successful Get Export Status": { + "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetExportStatus.json" + } + } + } + }, + "/authoring/analyze-conversations/projects/{projectName}/exported-models": { + "get": { + "operationId": "ConversationAuthoringListExportedModels", + "description": "Lists the exported models belonging to a project.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "The new project name.", + "required": true, + "type": "string", + "maxLength": 100 + }, + { + "$ref": "#/parameters/Azure.Core.TopQueryParameter" + }, + { + "$ref": "#/parameters/Azure.Core.SkipQueryParameter" + }, + { + "$ref": "#/parameters/Azure.Core.MaxPageSizeQueryParameter" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/PagedAnalyzeConversationAuthoringExportedTrainedModel" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Successful List Exported Models": { + "$ref": "./examples/analyzeconversations-authoring/SuccessfulListExportedModels.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/authoring/analyze-conversations/projects/{projectName}/exported-models/{exportedModelName}": { + "get": { + "operationId": "ConversationAuthoringExportedModel_GetExportedModel", + "description": "Gets the details of an exported model.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "The new project name.", + "required": true, + "type": "string", + "maxLength": 100 + }, + { + "name": "exportedModelName", + "in": "path", + "description": "The exported model name.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/AnalyzeConversationAuthoringExportedTrainedModel" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Successful Get Exported Model": { + "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetExportedModel.json" + } + } + }, + "put": { + "operationId": "ConversationAuthoringExportedModel_CreateOrUpdateExportedModel", + "description": "Creates a new exported model or replaces an existing one.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "The name of the project to use.", + "required": true, + "type": "string" + }, + { + "name": "exportedModelName", + "in": "path", + "description": "The exported model name.", + "required": true, + "type": "string" + }, + { + "name": "body", + "in": "body", + "description": "The exported model info.", + "required": true, + "schema": { + "$ref": "#/definitions/ExportedModelOptions" + } + } + ], + "responses": { + "202": { + "description": "The request has been accepted for processing, but processing has not yet completed.", + "headers": { + "Operation-Location": { + "type": "string", + "format": "uri", + "description": "The location for monitoring the operation state." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Successful Create Exported Model": { + "$ref": "./examples/analyzeconversations-authoring/SuccessfulCreateExportedModel.json" + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "ConversationAuthoringExportedModel_DeleteExportedModel", + "description": "Deletes an existing exported model.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "The name of the project to use.", + "required": true, + "type": "string" + }, + { + "name": "exportedModelName", + "in": "path", + "description": "The exported model name.", + "required": true, + "type": "string" + } + ], + "responses": { + "202": { + "description": "The request has been accepted for processing, but processing has not yet completed.", + "headers": { + "Operation-Location": { + "type": "string", + "format": "uri", + "description": "The location for monitoring the operation state." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Successful Delete Exported Model": { + "$ref": "./examples/analyzeconversations-authoring/SuccessfulDeleteExportedModel.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/authoring/analyze-conversations/projects/{projectName}/exported-models/{exportedModelName}/jobs/{jobId}": { + "get": { + "operationId": "ConversationAuthoringExportedModel_GetExportedModelJobStatus", + "description": "Gets the status for an existing job to create or update an exported model.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "The new project name.", + "required": true, + "type": "string", + "maxLength": 100 + }, + { + "name": "exportedModelName", + "in": "path", + "description": "The exported model name.", + "required": true, + "type": "string" + }, + { + "name": "jobId", + "in": "path", + "description": "The job ID.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/AnalyzeConversationAuthoringExportedModelJobState" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Successful Get Exported Model Status": { + "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetExportedModelStatus.json" + } + } + } + }, + "/authoring/analyze-conversations/projects/{projectName}/import/jobs/{jobId}": { + "get": { + "operationId": "ConversationAuthoringProject_GetImportStatus", + "description": "Gets the status for an import.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "The new project name.", + "required": true, + "type": "string", + "maxLength": 100 + }, + { + "name": "jobId", + "in": "path", + "description": "The job ID.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/AnalyzeConversationAuthoringImportProjectJobState" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Successful Get Import Status": { + "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetImportStatus.json" + } + } + } + }, + "/authoring/analyze-conversations/projects/{projectName}/models": { + "get": { + "operationId": "ConversationAuthoringListTrainedModels", + "description": "Lists the trained models belonging to a project.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "The new project name.", + "required": true, + "type": "string", + "maxLength": 100 + }, + { + "$ref": "#/parameters/Azure.Core.TopQueryParameter" + }, + { + "$ref": "#/parameters/Azure.Core.SkipQueryParameter" + }, + { + "$ref": "#/parameters/Azure.Core.MaxPageSizeQueryParameter" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/PagedAnalyzeConversationAuthoringProjectTrainedModel" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Successful List Models": { + "$ref": "./examples/analyzeconversations-authoring/SuccessfulListModels.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/authoring/analyze-conversations/projects/{projectName}/models/{trainedModelLabel}": { + "get": { + "operationId": "ConversationAuthoringTrainedModel_GetTrainedModel", + "description": "Gets the details of a trained model.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "The new project name.", + "required": true, + "type": "string", + "maxLength": 100 + }, + { + "name": "trainedModelLabel", + "in": "path", + "description": "The trained model label.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/AnalyzeConversationAuthoringProjectTrainedModel" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Successful Get Model": { + "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetModel.json" + } + } + }, + "delete": { + "operationId": "ConversationAuthoringTrainedModel_DeleteTrainedModel", + "description": "Deletes an existing trained model.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "The new project name.", + "required": true, + "type": "string", + "maxLength": 100 + }, + { + "name": "trainedModelLabel", + "in": "path", + "description": "The trained model label.", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "There is no content to send for this request, but the headers may be useful. " + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Successful Delete Model": { + "$ref": "./examples/analyzeconversations-authoring/SuccessfulDeleteModel.json" + } + } + } + }, + "/authoring/analyze-conversations/projects/{projectName}/models/{trainedModelLabel}/:evaluate": { + "post": { + "operationId": "ConversationAuthoringTrainedModel_EvaluateModel", + "description": "Triggers evaluation operation on a trained model.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "The name of the project to use.", + "required": true, + "type": "string", + "maxLength": 100 + }, + { + "name": "trainedModelLabel", + "in": "path", + "description": "The trained model label.", + "required": true, + "type": "string" + }, + { + "name": "body", + "in": "body", + "description": "The training input parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/AnalyzeConversationAuthoringEvaluationOptions" + } + } + ], + "responses": { + "202": { + "description": "The request has been accepted for processing, but processing has not yet completed.", + "headers": { + "Operation-Location": { + "type": "string", + "format": "uri", + "description": "The location for monitoring the operation state." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Successful Evaluation Project": { + "$ref": "./examples/analyzeconversations-authoring/SuccessfulEvaluationProject.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/authoring/analyze-conversations/projects/{projectName}/models/{trainedModelLabel}/:load-snapshot": { + "post": { + "operationId": "ConversationAuthoringTrainedModel_LoadSnapshot", + "description": "Restores the snapshot of this trained model to be the current working directory of the project.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "The name of the project to use.", + "required": true, + "type": "string", + "maxLength": 100 + }, + { + "name": "trainedModelLabel", + "in": "path", + "description": "The trained model label.", + "required": true, + "type": "string" + } + ], + "responses": { + "202": { + "description": "The request has been accepted for processing, but processing has not yet completed.", + "headers": { + "Operation-Location": { + "type": "string", + "format": "uri", + "description": "The location for monitoring the operation state." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Successful Load Snapshot": { + "$ref": "./examples/analyzeconversations-authoring/SuccessfulLoadSnapshot.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/authoring/analyze-conversations/projects/{projectName}/models/{trainedModelLabel}/evaluate/jobs/{jobId}": { + "get": { + "operationId": "ConversationAuthoringTrainedModel_GetEvaluationStatus", + "description": "Gets the status for an evaluation job.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "The new project name.", + "required": true, + "type": "string", + "maxLength": 100 + }, + { + "name": "trainedModelLabel", + "in": "path", + "description": "The trained model label.", + "required": true, + "type": "string" + }, + { + "name": "jobId", + "in": "path", + "description": "The job ID.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/AnalyzeConversationAuthoringEvaluationJobState" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Successful Get Evaluation Status": { + "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetEvaluationStatus.json" + } + } + } + }, + "/authoring/analyze-conversations/projects/{projectName}/models/{trainedModelLabel}/evaluation/result": { + "get": { + "operationId": "ConversationAuthoringTrainedModel_GetModelEvaluationResults", + "description": "Gets the detailed results of the evaluation for a trained model. This includes the raw inference results for the data included in the evaluation process.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "The new project name.", + "required": true, + "type": "string", + "maxLength": 100 + }, + { + "name": "trainedModelLabel", + "in": "path", + "description": "The trained model label.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/Azure.Core.TopQueryParameter" + }, + { + "$ref": "#/parameters/Azure.Core.SkipQueryParameter" + }, + { + "$ref": "#/parameters/Azure.Core.MaxPageSizeQueryParameter" + }, + { + "$ref": "#/parameters/StringIndexTypeQueryParameter" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/PagedAnalyzeConversationAuthoringUtteranceEvaluationResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Successful Get Model Evaluation": { + "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetModelEvaluation.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/authoring/analyze-conversations/projects/{projectName}/models/{trainedModelLabel}/evaluation/summary-result": { + "get": { + "operationId": "ConversationAuthoringTrainedModel_GetModelEvaluationSummary", + "description": "Gets the evaluation summary of a trained model. The summary includes high level performance measurements of the model e.g., F1, Precision, Recall, etc.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "The name of the project to use.", + "required": true, + "type": "string", + "maxLength": 100 + }, + { + "name": "trainedModelLabel", + "in": "path", + "description": "The trained model label.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/AnalyzeConversationAuthoringEvaluationSummary" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Successful Get Model Evaluation Summary": { + "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetModelEvaluationSummary.json" + } + } + } + }, + "/authoring/analyze-conversations/projects/{projectName}/models/{trainedModelLabel}/load-snapshot/jobs/{jobId}": { + "get": { + "operationId": "ConversationAuthoringTrainedModel_GetLoadSnapshotStatus", + "description": "Gets the status for loading a snapshot.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "The new project name.", + "required": true, + "type": "string", + "maxLength": 100 + }, + { + "name": "trainedModelLabel", + "in": "path", + "description": "The trained model label.", + "required": true, + "type": "string" + }, + { + "name": "jobId", + "in": "path", + "description": "The job ID.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/AnalyzeConversationAuthoringLoadSnapshotJobState" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Successful Get Load Snapshot Status": { + "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetLoadSnapshotStatus.json" + } + } + } + }, + "/authoring/analyze-conversations/projects/{projectName}/resources": { + "get": { + "operationId": "ConversationAuthoringListDeploymentResources", + "description": "Lists the Language or AIService resources assigned to the project.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "The new project name.", + "required": true, + "type": "string", + "maxLength": 100 + }, + { + "$ref": "#/parameters/Azure.Core.TopQueryParameter" + }, + { + "$ref": "#/parameters/Azure.Core.SkipQueryParameter" + }, + { + "$ref": "#/parameters/Azure.Core.MaxPageSizeQueryParameter" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/PagedAnalyzeConversationAuthoringAssignedDeploymentResource" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Successful List Deployment Resources": { + "$ref": "./examples/analyzeconversations-authoring/SuccessfulListDeploymentResources.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/authoring/analyze-conversations/projects/{projectName}/resources/:assign": { + "post": { + "operationId": "ConversationAuthoringProject_AssignDeploymentResources", + "description": "Assign new Language or AIService Azure resources to a project to allowing deployment to them. This API is available only via AAD authentication and not supported via subscription key authentication. For more details about AAD authentication, check here: https://learn.microsoft.com/en-us/azure/cognitive-services/authentication?tabs=powershell#authenticate-with-azure-active-directory", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "The name of the project to use.", + "required": true, + "type": "string", + "maxLength": 100 + }, + { + "name": "body", + "in": "body", + "description": "The new project resources to be assigned.", + "required": true, + "schema": { + "$ref": "#/definitions/AnalyzeConversationAuthoringAssignDeploymentResourcesOptions" + } + } + ], + "responses": { + "202": { + "description": "The request has been accepted for processing, but processing has not yet completed.", + "headers": { + "Operation-Location": { + "type": "string", + "format": "uri", + "description": "The location for monitoring the operation state." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Successful Assign Deployment Resources": { + "$ref": "./examples/analyzeconversations-authoring/SuccessfulAssignDeploymentResources.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/authoring/analyze-conversations/projects/{projectName}/resources/:unassign": { + "post": { + "operationId": "ConversationAuthoringProject_UnassignDeploymentResources", + "description": "Unassign resources from a project. This disallows deployment to these resources.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "The name of the project to use.", + "required": true, + "type": "string", + "maxLength": 100 + }, + { + "name": "body", + "in": "body", + "description": "The list of Language or AIService Azure resource IDs to be unassigned.", + "required": true, + "schema": { + "$ref": "#/definitions/AnalyzeConversationAuthoringUnassignDeploymentResourcesOptions" + } + } + ], + "responses": { + "202": { + "description": "The request has been accepted for processing, but processing has not yet completed.", + "headers": { + "Operation-Location": { + "type": "string", + "format": "uri", + "description": "The location for monitoring the operation state." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Successful Unassign Deployment Resources": { + "$ref": "./examples/analyzeconversations-authoring/SuccessfulUnassignDeploymentResources.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/authoring/analyze-conversations/projects/{projectName}/resources/assign/jobs/{jobId}": { + "get": { + "operationId": "ConversationAuthoringProject_GetAssignDeploymentResourcesStatus", + "description": "Gets the status of an existing assign project resources job.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "The new project name.", + "required": true, + "type": "string", + "maxLength": 100 + }, + { + "name": "jobId", + "in": "path", + "description": "The job ID.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/AnalyzeConversationAuthoringDeploymentResourcesJobState" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Successful Get Assign Deployment Resources Status": { + "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetAssignDeploymentResourcesStatus.json" + } + } + } + }, + "/authoring/analyze-conversations/projects/{projectName}/resources/unassign/jobs/{jobId}": { + "get": { + "operationId": "ConversationAuthoringProject_GetUnassignDeploymentResourcesStatus", + "description": "Gets the status of an existing unassign project resources job.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "The name of the project to use.", + "required": true, + "type": "string", + "maxLength": 100 + }, + { + "name": "jobId", + "in": "path", + "description": "The job ID.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/AnalyzeConversationAuthoringDeploymentResourcesJobState" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Successful Get Unassign Deployment Resources Status": { + "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetUnassignDeploymentResourcesStatus.json" + } + } + } + }, + "/authoring/analyze-conversations/projects/{projectName}/train/jobs": { + "get": { + "operationId": "ConversationAuthoringListTrainingJobs", + "description": "Lists the non-expired training jobs created for a project.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "The new project name.", + "required": true, + "type": "string", + "maxLength": 100 + }, + { + "$ref": "#/parameters/Azure.Core.TopQueryParameter" + }, + { + "$ref": "#/parameters/Azure.Core.SkipQueryParameter" + }, + { + "$ref": "#/parameters/Azure.Core.MaxPageSizeQueryParameter" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/PagedAnalyzeConversationAuthoringTrainingJobState" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Successful List Training Jobs": { + "$ref": "./examples/analyzeconversations-authoring/SuccessfulListTrainingJobs.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/authoring/analyze-conversations/projects/{projectName}/train/jobs/{jobId}": { + "get": { + "operationId": "ConversationAuthoringProject_GetTrainingStatus", + "description": "Gets the status for a training job.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "The new project name.", + "required": true, + "type": "string", + "maxLength": 100 + }, + { + "name": "jobId", + "in": "path", + "description": "The job ID.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/AnalyzeConversationAuthoringTrainingJobState" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Successful Get Train Status": { + "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetTrainStatus.json" + } + } + } + }, + "/authoring/analyze-conversations/projects/{projectName}/train/jobs/{jobId}/:cancel": { + "post": { + "operationId": "ConversationAuthoringProject_CancelTrainingJob", + "description": "Triggers a cancellation for a running training job.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "The name of the project to use.", + "required": true, + "type": "string", + "maxLength": 100 + }, + { + "name": "jobId", + "in": "path", + "description": "The job ID.", + "required": true, + "type": "string" + } + ], + "responses": { + "202": { + "description": "The request has been accepted for processing, but processing has not yet completed.", + "headers": { + "Operation-Location": { + "type": "string", + "format": "uri", + "description": "The location for monitoring the operation state." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Successful Cancel Training Job": { + "$ref": "./examples/analyzeconversations-authoring/SuccessfulCancelTrainingJob.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/authoring/analyze-conversations/projects/global/deletion-jobs/{jobId}": { + "get": { + "operationId": "ConversationAuthoringProject_GetProjectDeletionStatus", + "description": "Gets the status for a project deletion job.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "jobId", + "in": "path", + "description": "The job ID.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/AnalyzeConversationAuthoringProjectDeletionJobState" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Successful Get Project Deletion Status": { + "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetProjectDeletionStatus.json" + } + } + } + }, + "/authoring/analyze-conversations/projects/global/deployments/resources": { + "get": { + "operationId": "ConversationAuthoringListAssignedResourceDeployments", + "description": "Lists the deployments to which an Azure resource is assigned. This doesn't return deployments belonging to projects owned by this resource. It only returns deployments belonging to projects owned by other resources.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "$ref": "#/parameters/Azure.Core.TopQueryParameter" + }, + { + "$ref": "#/parameters/Azure.Core.SkipQueryParameter" + }, + { + "$ref": "#/parameters/Azure.Core.MaxPageSizeQueryParameter" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/PagedAnalyzeConversationAuthoringAssignedProjectDeploymentsMetadata" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Successful List Assigned Resource Deployments": { + "$ref": "./examples/analyzeconversations-authoring/SuccessfulListAssignedResourceDeployments.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/authoring/analyze-conversations/projects/global/languages": { + "get": { + "operationId": "ConversationAuthoringListSupportedLanguages", + "description": "Lists the supported languages for the given project type.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "$ref": "#/parameters/Azure.Core.TopQueryParameter" + }, + { + "$ref": "#/parameters/Azure.Core.SkipQueryParameter" + }, + { + "$ref": "#/parameters/Azure.Core.MaxPageSizeQueryParameter" + }, + { + "$ref": "#/parameters/ProjectKindQueryParameter" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/PagedAnalyzeConversationAuthoringSupportedLanguage" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Successful Get Supported Languages": { + "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetSupportedLanguages.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/authoring/analyze-conversations/projects/global/prebuilt-entities": { + "get": { + "operationId": "ConversationAuthoringListSupportedPrebuiltEntities", + "description": "Lists the supported prebuilt entities that can be used while creating composed entities.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "$ref": "#/parameters/Azure.Core.TopQueryParameter" + }, + { + "$ref": "#/parameters/Azure.Core.SkipQueryParameter" + }, + { + "$ref": "#/parameters/Azure.Core.MaxPageSizeQueryParameter" + }, + { + "$ref": "#/parameters/SupportedPrebuiltEntitiesQueryParameter.language" + }, + { + "$ref": "#/parameters/SupportedPrebuiltEntitiesQueryParameter.multilingual" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/PagedAnalyzeConversationAuthoringPrebuiltEntity" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Successful Get Supported Prebuilt Entities": { + "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetSupportedPrebuiltEntities.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/authoring/analyze-conversations/projects/global/training-config-versions": { + "get": { + "operationId": "ConversationAuthoringListTrainingConfigVersions", + "description": "Lists the support training config version for a given project type.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "$ref": "#/parameters/Azure.Core.TopQueryParameter" + }, + { + "$ref": "#/parameters/Azure.Core.SkipQueryParameter" + }, + { + "$ref": "#/parameters/Azure.Core.MaxPageSizeQueryParameter" + }, + { + "$ref": "#/parameters/ProjectKindQueryParameter" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/PagedAnalyzeConversationAuthoringTrainingConfigVersion" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Successful Get Supported Training Config Versions": { + "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetSupportedTrainingConfigVersions.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "AnalyzeConversationAuthoringAssignDeploymentResourcesOptions": { + "type": "object", + "description": "Represents the payload for assigning Azure resources to a project.", + "properties": { + "resourcesMetadata": { + "type": "array", + "description": "Represents the metadata for the project resources to be assigned.", + "items": { + "$ref": "#/definitions/AnalyzeConversationAuthoringResourceMetadata" + } + } + }, + "required": [ + "resourcesMetadata" + ] + }, + "AnalyzeConversationAuthoringAssignedDeploymentResource": { + "type": "object", + "description": "Represents the assigned project resource.", + "properties": { + "azureResourceId": { + "type": "string", + "description": "The Azure resource ID of the language or AI resource.", + "readOnly": true + }, + "region": { + "type": "string", + "description": "The Azure resource region." + } + }, + "required": [ + "azureResourceId", + "region" + ] + }, + "AnalyzeConversationAuthoringAssignedProjectDeploymentMetadata": { + "type": "object", + "description": "Represents the metadata for an assigned deployment", + "properties": { + "deploymentName": { + "type": "string", + "description": "Represents the deployment name." + }, + "lastDeployedDateTime": { + "type": "string", + "format": "date-time", + "description": "Represents deployment last deployed time." + }, + "deploymentExpirationDate": { + "type": "string", + "format": "date", + "description": "Represents deployment expiration date in the runtime." + } + }, + "required": [ + "deploymentName", + "lastDeployedDateTime", + "deploymentExpirationDate" + ] + }, + "AnalyzeConversationAuthoringAssignedProjectDeploymentsMetadata": { + "type": "object", + "description": "Represents the metadata for assigned deployments for a project.", + "properties": { + "projectName": { + "type": "string", + "description": "Represents the project name.", + "readOnly": true + }, + "deploymentsMetadata": { + "type": "array", + "description": "Represents the resource region.", + "items": { + "$ref": "#/definitions/AnalyzeConversationAuthoringAssignedProjectDeploymentMetadata" + } + } + }, + "required": [ + "projectName", + "deploymentsMetadata" + ] + }, + "AnalyzeConversationAuthoringConfusionMatrixCell": { + "type": "object", + "description": "Represents a cell in a confusion matrix.", + "properties": { + "normalizedValue": { + "type": "number", + "format": "float", + "description": "Represents normalized value in percentages." + }, + "rawValue": { + "type": "number", + "format": "float", + "description": "Represents raw value." + } + }, + "required": [ + "normalizedValue", + "rawValue" + ] + }, + "AnalyzeConversationAuthoringConfusionMatrixRow": { + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/AnalyzeConversationAuthoringConfusionMatrixCell" + } + }, + "AnalyzeConversationAuthoringConversationExportedEntity": { + "type": "object", + "description": "Represents an entity with its components.", + "properties": { + "category": { + "type": "string", + "description": "The category of the entity." + }, + "description": { + "type": "string", + "description": "The entity description." + }, + "compositionSetting": { + "$ref": "#/definitions/CompositionSetting", + "description": "The behavior to follow when the entity's components overlap with each other." + }, + "entities": { + "$ref": "#/definitions/AnalyzeConversationAuthoringExportedEntityList", + "description": "The list component of the entity." + }, + "prebuilts": { + "type": "array", + "description": "The prebuilt entities components.", + "items": { + "$ref": "#/definitions/AnalyzeConversationAuthoringExportedPrebuiltEntity" + } + }, + "regex": { + "$ref": "#/definitions/AnalyzeConversationAuthoringExportedEntityRegex", + "description": "The regex component of the entity." + }, + "requiredComponents": { + "type": "array", + "description": "The required components. Allowed values are 'learned', 'list', 'prebuilts' and 'regex'.", + "items": { + "type": "string" + } + } + }, + "required": [ + "category" + ] + }, + "AnalyzeConversationAuthoringConversationExportedIntent": { + "type": "object", + "description": "Represents an exported intent of a conversational project.", + "properties": { + "category": { + "type": "string", + "description": "The intent category." + }, + "description": { + "type": "string", + "description": "The intent description." + }, + "associatedEntities": { + "type": "array", + "description": "The list of associated entities.", + "items": { + "$ref": "#/definitions/AnalyzeConversationExportedAssociatedEntityLabel" + } + } + }, + "required": [ + "category" + ] + }, + "AnalyzeConversationAuthoringConversationExportedProjectAsset": { + "type": "object", + "description": "Represents the exported assets of a conversational project.", + "properties": { + "intents": { + "type": "array", + "description": "The intents defined in the project.", + "items": { + "$ref": "#/definitions/AnalyzeConversationAuthoringConversationExportedIntent" + } + }, + "entities": { + "type": "array", + "description": "The entities defined in the project.", + "items": { + "$ref": "#/definitions/AnalyzeConversationAuthoringConversationExportedEntity" + } + }, + "utterances": { + "type": "array", + "description": "The utterances defined in the project.", + "items": { + "$ref": "#/definitions/AnalyzeConversationAuthoringConversationExportedUtterance" + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/AnalyzeConversationAuthoringExportedProjectAssets" + } + ], + "x-ms-discriminator-value": "Conversation" + }, + "AnalyzeConversationAuthoringConversationExportedUtterance": { + "type": "object", + "description": "Represents an exported utterance for a conversational project.", + "properties": { + "entities": { + "type": "array", + "description": "Represents the entity labels of the utterance.", + "items": { + "$ref": "#/definitions/AnalyzeConversationAuthoringExportedUtteranceEntityLabel" + } + }, + "text": { + "type": "string", + "description": "The utterance text." + }, + "language": { + "type": "string", + "description": "Represents the utterance's language. This is BCP-47 representation of a language. For example, use \"en\" for English, \"en-gb\" for English (UK), \"es\" for Spanish etc." + }, + "intent": { + "type": "string", + "description": "The intent of the utterance." + }, + "dataset": { + "$ref": "#/definitions/DatasetType", + "description": "The dataset for this utterance. Allowed values are 'Train' and 'Test'." + } + }, + "required": [ + "text", + "intent" + ] + }, + "AnalyzeConversationAuthoringCopiedProjectJobState": { + "type": "object", + "description": "Represents the state of a copy job.", + "properties": { + "jobId": { + "type": "string", + "description": "The job ID.", + "readOnly": true + }, + "createdDateTime": { + "type": "string", + "format": "date-time", + "description": "The creation date time of the job." + }, + "lastUpdatedDateTime": { + "type": "string", + "format": "date-time", + "description": "The last date time the job was updated." + }, + "expirationDateTime": { + "type": "string", + "format": "date-time", + "description": "The expiration date time of the job." + }, + "status": { + "$ref": "#/definitions/JobStatus", + "description": "The job status." + }, + "warnings": { + "type": "array", + "description": "The warnings that were encountered while executing the job.", + "items": { + "$ref": "#/definitions/Azure.Core.Foundations.Error" + } + }, + "errors": { + "type": "array", + "description": "The errors encountered while executing the job.", + "items": { + "$ref": "#/definitions/Azure.Core.Foundations.Error" + } + } + }, + "required": [ + "jobId", + "createdDateTime", + "lastUpdatedDateTime", + "status" + ] + }, + "AnalyzeConversationAuthoringCopiedProjectOptions": { + "type": "object", + "description": "Represents the options for copying an existing project to another Azure resource.", + "properties": { + "projectKind": { + "$ref": "#/definitions/ProjectKind", + "description": "Represents the project kind." + }, + "targetProjectName": { + "type": "string", + "description": "The project name to be copied-into." + }, + "accessToken": { + "type": "string", + "description": "The access token." + }, + "expiresAt": { + "type": "string", + "format": "date-time", + "description": "The expiration of the access token." + }, + "targetResourceId": { + "type": "string", + "description": "Represents the target Azure resource ID." + }, + "targetResourceRegion": { + "type": "string", + "description": "Represents the target Azure resource region." + } + }, + "required": [ + "projectKind", + "targetProjectName", + "accessToken", + "expiresAt", + "targetResourceId", + "targetResourceRegion" + ] + }, + "AnalyzeConversationAuthoringCopyAuthorizationOptions": { + "type": "object", + "description": "Represents the options for authorizing a project copy to the current Azure resource.", + "properties": { + "projectKind": { + "$ref": "#/definitions/ProjectKind", + "description": "Represents the project kind." + }, + "storageInputContainerName": { + "type": "string", + "description": "The name of the storage container." + }, + "allowOverwrite": { + "type": "boolean", + "description": "Whether to allow an existing project to be overwritten using the resulting copy authorization." + } + }, + "required": [ + "projectKind" + ] + }, + "AnalyzeConversationAuthoringCreateDeploymentOptions": { + "type": "object", + "description": "Represents the options for creating or updating a project deployment.", + "properties": { + "trainedModelLabel": { + "type": "string", + "description": "Represents the trained model label." + }, + "assignedResources": { + "type": "array", + "description": "Represents the resources to be assigned to the deployment. If provided, the deployment will be rolled out to the resources provided here as well as the original resource in which the project is created.", + "items": { + "$ref": "#/definitions/AnalyzeConversationAuthoringDeploymentResource" + } + } + }, + "required": [ + "trainedModelLabel" + ] + }, + "AnalyzeConversationAuthoringCreateProjectOptions": { + "type": "object", + "description": "Represents the options used to create or update a project.", + "properties": { + "projectKind": { + "$ref": "#/definitions/ProjectKind", + "description": "Represents the project kind." + }, + "settings": { + "$ref": "#/definitions/AnalyzeConversationAuthoringProjectSettings", + "description": "The project settings." + }, + "storageInputContainerName": { + "type": "string", + "description": "The storage container name in case of conversation summarization." + }, + "projectName": { + "type": "string", + "description": "The new project name." + }, + "multilingual": { + "type": "boolean", + "description": "Whether the project would be used for multiple languages or not." + }, + "description": { + "type": "string", + "description": "The project description." + }, + "language": { + "type": "string", + "description": "The project language. This is BCP-47 representation of a language. For example, use \"en\" for English, \"en-gb\" for English (UK), \"es\" for Spanish etc." + } + }, + "required": [ + "projectKind", + "projectName", + "language" + ] + }, + "AnalyzeConversationAuthoringDataGenerationConnectionInfo": { + "type": "object", + "description": "Represents the connection info for the Azure resource to use during data generation.", + "properties": { + "kind": { + "$ref": "#/definitions/AnalyzeConversationAuthoringDataGenerationConnectionKind", + "description": "Connection type for data generation settings. Currently only supports Azure OpenAI." + }, + "deploymentName": { + "type": "string", + "description": "Deployment name of model to be used for synthetic data generation." + }, + "resourceId": { + "type": "string", + "description": "Resource ID for the data generation resource. Looks something like\n\"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{resourceName}\"." + } + }, + "required": [ + "kind", + "deploymentName" + ] + }, + "AnalyzeConversationAuthoringDataGenerationConnectionKind": { + "type": "string", + "description": "Represents the connection kind for Azure OpenAI deployment.", + "enum": [ + "AzureOpenAI" + ], + "x-ms-enum": { + "name": "AnalyzeConversationAuthoringDataGenerationConnectionKind", + "modelAsString": true, + "values": [ + { + "name": "AzureOpenAI", + "value": "AzureOpenAI" + } + ] + } + }, + "AnalyzeConversationAuthoringDataGenerationSettings": { + "type": "object", + "description": "Settings to enable data generation for training augmentation.", + "properties": { + "enableDataGeneration": { + "type": "boolean", + "description": "Must be explicitly set to True to enable data generation to augment training data." + }, + "dataGenerationConnectionInfo": { + "$ref": "#/definitions/AnalyzeConversationAuthoringDataGenerationConnectionInfo", + "description": "Must be filled out to enable data generation to augment training data." + } + }, + "required": [ + "enableDataGeneration", + "dataGenerationConnectionInfo" + ] + }, + "AnalyzeConversationAuthoringDeleteDeploymentOptions": { + "type": "object", + "description": "Represents the options for deleting a project deployment.", + "properties": { + "assignedResourceIds": { + "type": "array", + "description": "Represents the resource IDs to delete the deployment from. If not provided, the deployment will be rolled out from all the resources it is deployed to. If provided, it will delete the deployment only from the specified assigned resources, and leave it for the rest.", + "items": { + "type": "string" + } + } + } + }, + "AnalyzeConversationAuthoringDeploymentDeleteFromResourcesJobState": { + "type": "object", + "description": "Represents the state of an existing delete deployment from specific resources job.", + "properties": { + "jobId": { + "type": "string", + "description": "The job ID.", + "readOnly": true + }, + "createdDateTime": { + "type": "string", + "format": "date-time", + "description": "The creation date time of the job." + }, + "lastUpdatedDateTime": { + "type": "string", + "format": "date-time", + "description": "The last date time the job was updated." + }, + "expirationDateTime": { + "type": "string", + "format": "date-time", + "description": "The expiration date time of the job." + }, + "status": { + "$ref": "#/definitions/JobStatus", + "description": "The job status." + }, + "warnings": { + "type": "array", + "description": "The warnings that were encountered while executing the job.", + "items": { + "$ref": "#/definitions/Azure.Core.Foundations.Error" + } + }, + "errors": { + "type": "array", + "description": "The errors encountered while executing the job.", + "items": { + "$ref": "#/definitions/Azure.Core.Foundations.Error" + } + } + }, + "required": [ + "jobId", + "createdDateTime", + "lastUpdatedDateTime", + "status" + ] + }, + "AnalyzeConversationAuthoringDeploymentJobState": { + "type": "object", + "description": "Represents the state of a deployment job.", + "properties": { + "jobId": { + "type": "string", + "description": "The job ID.", + "readOnly": true + }, + "createdDateTime": { + "type": "string", + "format": "date-time", + "description": "The creation date time of the job." + }, + "lastUpdatedDateTime": { + "type": "string", + "format": "date-time", + "description": "The last date time the job was updated." + }, + "expirationDateTime": { + "type": "string", + "format": "date-time", + "description": "The expiration date time of the job." + }, + "status": { + "$ref": "#/definitions/JobStatus", + "description": "The job status." + }, + "warnings": { + "type": "array", + "description": "The warnings that were encountered while executing the job.", + "items": { + "$ref": "#/definitions/Azure.Core.Foundations.Error" + } + }, + "errors": { + "type": "array", + "description": "The errors encountered while executing the job.", + "items": { + "$ref": "#/definitions/Azure.Core.Foundations.Error" + } + } + }, + "required": [ + "jobId", + "createdDateTime", + "lastUpdatedDateTime", + "status" + ] + }, + "AnalyzeConversationAuthoringDeploymentResource": { + "type": "object", + "description": "Represents an Azure resource assigned to a deployment.", + "properties": { + "resourceId": { + "type": "string", + "description": "Represents the Azure resource Id." + }, + "region": { + "type": "string", + "description": "Represents the resource region." + }, + "assignedAoaiResource": { + "$ref": "#/definitions/AnalyzeConversationAuthoringDataGenerationConnectionInfo", + "description": "Represents the AOAI resource assigned for data generation." + } + }, + "required": [ + "resourceId", + "region" + ] + }, + "AnalyzeConversationAuthoringDeploymentResourcesJobState": { + "type": "object", + "description": "Represents the state of a project resources job.", + "properties": { + "jobId": { + "type": "string", + "description": "The job ID.", + "readOnly": true + }, + "createdDateTime": { + "type": "string", + "format": "date-time", + "description": "The creation date time of the job." + }, + "lastUpdatedDateTime": { + "type": "string", + "format": "date-time", + "description": "The last date time the job was updated." + }, + "expirationDateTime": { + "type": "string", + "format": "date-time", + "description": "The expiration date time of the job." + }, + "status": { + "$ref": "#/definitions/JobStatus", + "description": "The job status." + }, + "warnings": { + "type": "array", + "description": "The warnings that were encountered while executing the job.", + "items": { + "$ref": "#/definitions/Azure.Core.Foundations.Error" + } + }, + "errors": { + "type": "array", + "description": "The errors encountered while executing the job.", + "items": { + "$ref": "#/definitions/Azure.Core.Foundations.Error" + } + } + }, + "required": [ + "jobId", + "createdDateTime", + "lastUpdatedDateTime", + "status" + ] + }, + "AnalyzeConversationAuthoringEntitiesEvaluationSummary": { + "type": "object", + "description": "Represents the evaluation result summary for the project's entities.", + "properties": { + "confusionMatrix": { + "type": "object", + "description": "Represents the confusion matrix between two entities (the two entities can be the same). The matrix is between the entity that was labelled and the entity that was predicted.", + "additionalProperties": { + "$ref": "#/definitions/AnalyzeConversationAuthoringConfusionMatrixRow" + } + }, + "entities": { + "type": "object", + "description": "Represents the entities evaluation summary.", + "additionalProperties": { + "$ref": "#/definitions/AnalyzeConversationAuthoringEntityEvaluationSummary" + } + }, + "microF1": { + "type": "number", + "format": "float", + "description": "Represents the micro F1. Expected value is a float between 0 and 1 inclusive." + }, + "microPrecision": { + "type": "number", + "format": "float", + "description": "Represents the micro precision. Expected value is a float between 0 and 1 inclusive." + }, + "microRecall": { + "type": "number", + "format": "float", + "description": "Represents the micro recall. Expected value is a float between 0 and 1 inclusive." + }, + "macroF1": { + "type": "number", + "format": "float", + "description": "Represents the macro F1. Expected value is a float between 0 and 1 inclusive." + }, + "macroPrecision": { + "type": "number", + "format": "float", + "description": "Represents the macro precision. Expected value is a float between 0 and 1 inclusive." + }, + "macroRecall": { + "type": "number", + "format": "float", + "description": "Represents the macro recall. Expected value is a float between 0 and 1 inclusive." + } + }, + "required": [ + "confusionMatrix", + "entities", + "microF1", + "microPrecision", + "microRecall", + "macroF1", + "macroPrecision", + "macroRecall" + ] + }, + "AnalyzeConversationAuthoringEntityEvaluationSummary": { + "type": "object", + "description": "Represents the evaluation result for an entity.", + "properties": { + "f1": { + "type": "number", + "format": "double", + "description": "Represents the model F1 score" + }, + "precision": { + "type": "number", + "format": "double", + "description": "Represents the model precision" + }, + "recall": { + "type": "number", + "format": "double", + "description": "Represents the model precision" + }, + "truePositiveCount": { + "type": "integer", + "format": "int32", + "description": "Represents the count of true positive" + }, + "trueNegativeCount": { + "type": "integer", + "format": "int32", + "description": "Represents the count of true negative" + }, + "falsePositiveCount": { + "type": "integer", + "format": "int32", + "description": "Represents the count of false positive" + }, + "falseNegativeCount": { + "type": "integer", + "format": "int32", + "description": "Represents the count of false negative" + } + }, + "required": [ + "f1", + "precision", + "recall", + "truePositiveCount", + "trueNegativeCount", + "falsePositiveCount", + "falseNegativeCount" + ] + }, + "AnalyzeConversationAuthoringEvaluationJobResult": { + "type": "object", + "properties": { + "evaluationOptions": { + "$ref": "#/definitions/AnalyzeConversationAuthoringEvaluationOptions", + "description": "Represents the options used running the evaluation." + }, + "modelLabel": { + "type": "string", + "description": "Represents trained model label." + }, + "trainingConfigVersion": { + "type": "string", + "description": "Represents training config version." + }, + "percentComplete": { + "type": "integer", + "format": "int32", + "description": "Represents progress percentage." + } + }, + "required": [ + "evaluationOptions", + "modelLabel", + "trainingConfigVersion", + "percentComplete" + ] + }, + "AnalyzeConversationAuthoringEvaluationJobState": { + "type": "object", + "description": "Represents the state of a evaluation job.", + "properties": { + "jobId": { + "type": "string", + "description": "The job ID.", + "readOnly": true + }, + "createdDateTime": { + "type": "string", + "format": "date-time", + "description": "The creation date time of the job." + }, + "lastUpdatedDateTime": { + "type": "string", + "format": "date-time", + "description": "The last date time the job was updated." + }, + "expirationDateTime": { + "type": "string", + "format": "date-time", + "description": "The expiration date time of the job." + }, + "status": { + "$ref": "#/definitions/JobStatus", + "description": "The job status." + }, + "warnings": { + "type": "array", + "description": "The warnings that were encountered while executing the job.", + "items": { + "$ref": "#/definitions/Azure.Core.Foundations.Error" + } + }, + "errors": { + "type": "array", + "description": "The errors encountered while executing the job.", + "items": { + "$ref": "#/definitions/Azure.Core.Foundations.Error" + } + }, + "result": { + "$ref": "#/definitions/AnalyzeConversationAuthoringEvaluationJobResult", + "description": "Represents evaluation task detailed result." + } + }, + "required": [ + "jobId", + "createdDateTime", + "lastUpdatedDateTime", + "status", + "result" + ] + }, + "AnalyzeConversationAuthoringEvaluationOptions": { + "type": "object", + "description": "Represents the options used running the evaluation.", + "properties": { + "kind": { + "$ref": "#/definitions/EvaluationKind", + "description": "Represents the evaluation kind. By default, the evaluation kind is set to percentage." + }, + "trainingSplitPercentage": { + "type": "integer", + "format": "int32", + "description": "Represents the training dataset split percentage. Only needed in case the evaluation kind is percentage." + }, + "testingSplitPercentage": { + "type": "integer", + "format": "int32", + "description": "Represents the testing dataset split percentage. Only needed in case the evaluation kind is percentage." + } + } + }, + "AnalyzeConversationAuthoringEvaluationSummary": { + "type": "object", + "description": "Represents the evaluation result summary.", + "properties": { + "entitiesEvaluation": { + "$ref": "#/definitions/AnalyzeConversationAuthoringEntitiesEvaluationSummary", + "description": "Contains the data related to entities evaluation." + }, + "intentsEvaluation": { + "$ref": "#/definitions/AnalyzeConversationAuthoringIntentsEvaluationSummary", + "description": "Contains the data related to intents evaluation." + }, + "evaluationOptions": { + "$ref": "#/definitions/AnalyzeConversationAuthoringEvaluationOptions", + "description": "The options that were used while running the evaluation." + } + }, + "required": [ + "entitiesEvaluation", + "intentsEvaluation" + ] + }, + "AnalyzeConversationAuthoringExportProjectJobState": { + "type": "object", + "description": "Represents the state of an export job.", + "properties": { + "jobId": { + "type": "string", + "description": "The job ID.", + "readOnly": true + }, + "createdDateTime": { + "type": "string", + "format": "date-time", + "description": "The creation date time of the job." + }, + "lastUpdatedDateTime": { + "type": "string", + "format": "date-time", + "description": "The last date time the job was updated." + }, + "expirationDateTime": { + "type": "string", + "format": "date-time", + "description": "The expiration date time of the job." + }, + "status": { + "$ref": "#/definitions/JobStatus", + "description": "The job status." + }, + "warnings": { + "type": "array", + "description": "The warnings that were encountered while executing the job.", + "items": { + "$ref": "#/definitions/Azure.Core.Foundations.Error" + } + }, + "errors": { + "type": "array", + "description": "The errors encountered while executing the job.", + "items": { + "$ref": "#/definitions/Azure.Core.Foundations.Error" + } + }, + "resultUrl": { + "type": "string", + "description": "The URL to use in order to download the exported project." + } + }, + "required": [ + "jobId", + "createdDateTime", + "lastUpdatedDateTime", + "status" + ] + }, + "AnalyzeConversationAuthoringExportedConversationOrchestration": { + "type": "object", + "description": "Defines the orchestration details for a Conversational project target.", + "properties": { + "projectName": { + "type": "string", + "description": "The name of the targeted project." + }, + "deploymentName": { + "type": "string", + "description": "The name of the targeted deployment." + } + }, + "required": [ + "projectName", + "deploymentName" + ] + }, + "AnalyzeConversationAuthoringExportedConversationOrchestrationOptions": { + "type": "object", + "description": "Represents the orchestration options for a Conversational project target.", + "properties": { + "conversationOrchestration": { + "$ref": "#/definitions/AnalyzeConversationAuthoringExportedConversationOrchestration", + "description": "The Conversational project target details." + } + }, + "required": [ + "conversationOrchestration" + ], + "allOf": [ + { + "$ref": "#/definitions/AnalyzeConversationAuthoringExportedOrchestrationOptions" + } + ], + "x-ms-discriminator-value": "Conversation" + }, + "AnalyzeConversationAuthoringExportedEntityList": { + "type": "object", + "description": "Represents a list component of an entity.", + "properties": { + "sublists": { + "type": "array", + "description": "The sub-lists of the list component.", + "items": { + "$ref": "#/definitions/AnalyzeConversationAuthoringExportedEntitySublist" + } + } + } + }, + "AnalyzeConversationAuthoringExportedEntityListSynonym": { + "type": "object", + "description": "Represents a list of synonyms inside a list component", + "properties": { + "language": { + "type": "string", + "description": "Represents the language of the synonyms. This is BCP-47 representation of a language. For example, use \"en\" for English, \"en-gb\" for English (UK), \"es\" for Spanish etc." + }, + "values": { + "type": "array", + "description": "The list of synonyms.", + "items": { + "type": "string" + } + } + } + }, + "AnalyzeConversationAuthoringExportedEntityRegex": { + "type": "object", + "description": "Represents a regex component of an entity.", + "properties": { + "expressions": { + "type": "array", + "description": "The regex expressions of the regex component. These expressions follow the .NET regex syntax. For reference, check here: https://learn.microsoft.com/dotnet/standard/base-types/regular-expressions", + "items": { + "$ref": "#/definitions/AnalyzeConversationAuthoringExportedEntityRegexExpression" + } + } + } + }, + "AnalyzeConversationAuthoringExportedEntityRegexExpression": { + "type": "object", + "description": "Represents a regex expression inside a regex component. This expression follows the .NET regex syntax. For reference, check here: https://learn.microsoft.com/dotnet/standard/base-types/regular-expressions", + "properties": { + "regexKey": { + "type": "string", + "description": "The key of the regex expression." + }, + "language": { + "type": "string", + "description": "Represents the language of the regex expression. This is BCP-47 representation of a language. For example, use \"en\" for English, \"en-gb\" for English (UK), \"es\" for Spanish etc." + }, + "regexPattern": { + "type": "string", + "description": "The regex pattern." + } + } + }, + "AnalyzeConversationAuthoringExportedEntitySublist": { + "type": "object", + "description": "Represents a sub-list inside a list component.", + "properties": { + "listKey": { + "type": "string", + "description": "The key of the sub-list." + }, + "synonyms": { + "type": "array", + "description": "The phrases of that correspond to the sub-list.", + "items": { + "$ref": "#/definitions/AnalyzeConversationAuthoringExportedEntityListSynonym" + } + } + } + }, + "AnalyzeConversationAuthoringExportedLuisOrchestration": { + "type": "object", + "description": "Defines the orchestration details for a LUIS application target.", + "properties": { + "appId": { + "$ref": "#/definitions/Azure.Core.uuid", + "description": "The LUIS application ID." + }, + "appVersion": { + "type": "string", + "description": "The targeted version Id." + }, + "slotName": { + "type": "string", + "description": "The targeted slot name." + } + }, + "required": [ + "appId" + ] + }, + "AnalyzeConversationAuthoringExportedLuisOrchestrationOptions": { + "type": "object", + "description": "Represents the orchestration options for a LUIS application target.", + "properties": { + "luisOrchestration": { + "$ref": "#/definitions/AnalyzeConversationAuthoringExportedLuisOrchestration", + "description": "The LUIS application target details." + } + }, + "required": [ + "luisOrchestration" + ], + "allOf": [ + { + "$ref": "#/definitions/AnalyzeConversationAuthoringExportedOrchestrationOptions" + } + ], + "x-ms-discriminator-value": "Luis" + }, + "AnalyzeConversationAuthoringExportedModelJobState": { + "type": "object", + "description": "Represents the state of a job to create or updated an exported model.", + "properties": { + "jobId": { + "type": "string", + "description": "The job ID.", + "readOnly": true + }, + "createdDateTime": { + "type": "string", + "format": "date-time", + "description": "The creation date time of the job." + }, + "lastUpdatedDateTime": { + "type": "string", + "format": "date-time", + "description": "The last date time the job was updated." + }, + "expirationDateTime": { + "type": "string", + "format": "date-time", + "description": "The expiration date time of the job." + }, + "status": { + "$ref": "#/definitions/JobStatus", + "description": "The job status." + }, + "warnings": { + "type": "array", + "description": "The warnings that were encountered while executing the job.", + "items": { + "$ref": "#/definitions/Azure.Core.Foundations.Error" + } + }, + "errors": { + "type": "array", + "description": "The errors encountered while executing the job.", + "items": { + "$ref": "#/definitions/Azure.Core.Foundations.Error" + } + } + }, + "required": [ + "jobId", + "createdDateTime", + "lastUpdatedDateTime", + "status" + ] + }, + "AnalyzeConversationAuthoringExportedOrchestrationOptions": { + "type": "object", + "description": "Represents the options used to define the orchestration behavior of an intent.", + "properties": { + "targetProjectKind": { + "$ref": "#/definitions/OrchestrationTargetProjectKind" + } + }, + "discriminator": "targetProjectKind", + "required": [ + "targetProjectKind" + ] + }, + "AnalyzeConversationAuthoringExportedPrebuiltEntity": { + "type": "object", + "description": "Represents an exported prebuilt entity component", + "properties": { + "category": { + "type": "string", + "description": "The prebuilt entity category." + } + }, + "required": [ + "category" + ] + }, + "AnalyzeConversationAuthoringExportedProject": { + "type": "object", + "description": "Represents an exported project.", + "properties": { + "projectFileVersion": { + "type": "string", + "description": "The version of the exported file." + }, + "stringIndexType": { + "$ref": "#/definitions/StringIndexType", + "description": "Specifies the method used to interpret string offsets. For additional information see https://aka.ms/text-analytics-offsets." + }, + "metadata": { + "$ref": "#/definitions/AnalyzeConversationAuthoringCreateProjectOptions", + "description": "Represents the project metadata." + }, + "assets": { + "$ref": "#/definitions/AnalyzeConversationAuthoringExportedProjectAssets", + "description": "Represents the project assets." + } + }, + "required": [ + "projectFileVersion", + "stringIndexType", + "metadata" + ] + }, + "AnalyzeConversationAuthoringExportedProjectAssets": { + "type": "object", + "description": "Represents the assets of an exported project.", + "properties": { + "projectKind": { + "$ref": "#/definitions/ProjectKind", + "description": "The type of project containing the assets." + } + }, + "discriminator": "projectKind", + "required": [ + "projectKind" + ] + }, + "AnalyzeConversationAuthoringExportedQuestionAnsweringOrchestration": { + "type": "object", + "description": "Defines the orchestration details for a Question Answering project target.", + "properties": { + "projectName": { + "type": "string", + "description": "The name of the target project." + } + }, + "required": [ + "projectName" + ] + }, + "AnalyzeConversationAuthoringExportedQuestionAnsweringOrchestrationOptions": { + "type": "object", + "description": "Represents the orchestration options for a Question Answering project target.", + "properties": { + "questionAnsweringOrchestration": { + "$ref": "#/definitions/AnalyzeConversationAuthoringExportedQuestionAnsweringOrchestration", + "description": "The Question Answering project details." + } + }, + "required": [ + "questionAnsweringOrchestration" + ], + "allOf": [ + { + "$ref": "#/definitions/AnalyzeConversationAuthoringExportedOrchestrationOptions" + } + ], + "x-ms-discriminator-value": "QuestionAnswering" + }, + "AnalyzeConversationAuthoringExportedTrainedModel": { + "type": "object", + "description": "Represents an exported trained model.", + "properties": { + "exportedModelName": { + "type": "string", + "description": "The exported model name.", + "readOnly": true + }, + "modelId": { + "type": "string", + "description": "The model ID." + }, + "lastTrainedDateTime": { + "type": "string", + "format": "date-time", + "description": "The last trained date time of the model." + }, + "lastExportedModelDateTime": { + "type": "string", + "format": "date-time", + "description": "The last exported date time of the model." + }, + "modelExpirationDate": { + "type": "string", + "format": "date", + "description": "The model expiration date." + }, + "modelTrainingConfigVersion": { + "type": "string", + "description": "The model training config version." + } + }, + "required": [ + "exportedModelName", + "modelId", + "lastTrainedDateTime", + "lastExportedModelDateTime", + "modelExpirationDate", + "modelTrainingConfigVersion" + ] + }, + "AnalyzeConversationAuthoringExportedUtteranceEntityLabel": { + "type": "object", + "description": "Represents an entity label for an utterance.", + "properties": { + "category": { + "type": "string", + "description": "The category of the entity label." + }, + "offset": { + "type": "integer", + "format": "int32", + "description": "Start position for the entity text." + }, + "length": { + "type": "integer", + "format": "int32", + "description": "Length for the entity text." + } + }, + "required": [ + "category", + "offset", + "length" + ] + }, + "AnalyzeConversationAuthoringImportProjectJobState": { + "type": "object", + "description": "Represents the state of an import job.", + "properties": { + "jobId": { + "type": "string", + "description": "The job ID.", + "readOnly": true + }, + "createdDateTime": { + "type": "string", + "format": "date-time", + "description": "The creation date time of the job." + }, + "lastUpdatedDateTime": { + "type": "string", + "format": "date-time", + "description": "The last date time the job was updated." + }, + "expirationDateTime": { + "type": "string", + "format": "date-time", + "description": "The expiration date time of the job." + }, + "status": { + "$ref": "#/definitions/JobStatus", + "description": "The job status." + }, + "warnings": { + "type": "array", + "description": "The warnings that were encountered while executing the job.", + "items": { + "$ref": "#/definitions/Azure.Core.Foundations.Error" + } + }, + "errors": { + "type": "array", + "description": "The errors encountered while executing the job.", + "items": { + "$ref": "#/definitions/Azure.Core.Foundations.Error" + } + } + }, + "required": [ + "jobId", + "createdDateTime", + "lastUpdatedDateTime", + "status" + ] + }, + "AnalyzeConversationAuthoringIntentEvaluationSummary": { + "type": "object", + "description": "The evaluation summary for an intent.", + "properties": { + "f1": { + "type": "number", + "format": "double", + "description": "Represents the model precision" + }, + "precision": { + "type": "number", + "format": "double", + "description": "Represents the model recall" + }, + "recall": { + "type": "number", + "format": "double", + "description": "Represents the model F1 score" + }, + "truePositiveCount": { + "type": "integer", + "format": "int32", + "description": "Represents the count of true positive" + }, + "trueNegativeCount": { + "type": "integer", + "format": "int32", + "description": "Represents the count of true negative" + }, + "falsePositiveCount": { + "type": "integer", + "format": "int32", + "description": "Represents the count of false positive" + }, + "falseNegativeCount": { + "type": "integer", + "format": "int32", + "description": "Represents the count of false negative" + } + }, + "required": [ + "f1", + "precision", + "recall", + "truePositiveCount", + "trueNegativeCount", + "falsePositiveCount", + "falseNegativeCount" + ] + }, + "AnalyzeConversationAuthoringIntentsEvaluationSummary": { + "type": "object", + "description": "Represents the evaluation summary for the project's intents.", + "properties": { + "confusionMatrix": { + "type": "object", + "description": "Represents the confusion matrix between two intents (the two intents can be the same). The matrix is between the intent that was labelled and the intent that was predicted.", + "additionalProperties": { + "$ref": "#/definitions/AnalyzeConversationAuthoringConfusionMatrixRow" + } + }, + "intents": { + "type": "object", + "description": "Represents the intents evaluation summary.", + "additionalProperties": { + "$ref": "#/definitions/AnalyzeConversationAuthoringIntentEvaluationSummary" + } + }, + "microF1": { + "type": "number", + "format": "float", + "description": "Represents the micro F1. Expected value is a float between 0 and 1 inclusive." + }, + "microPrecision": { + "type": "number", + "format": "float", + "description": "Represents the micro precision. Expected value is a float between 0 and 1 inclusive." + }, + "microRecall": { + "type": "number", + "format": "float", + "description": "Represents the micro recall. Expected value is a float between 0 and 1 inclusive." + }, + "macroF1": { + "type": "number", + "format": "float", + "description": "Represents the macro F1. Expected value is a float between 0 and 1 inclusive." + }, + "macroPrecision": { + "type": "number", + "format": "float", + "description": "Represents the macro precision. Expected value is a float between 0 and 1 inclusive." + }, + "macroRecall": { + "type": "number", + "format": "float", + "description": "Represents the macro recall. Expected value is a float between 0 and 1 inclusive." + } + }, + "required": [ + "confusionMatrix", + "intents", + "microF1", + "microPrecision", + "microRecall", + "macroF1", + "macroPrecision", + "macroRecall" + ] + }, + "AnalyzeConversationAuthoringLoadSnapshotJobState": { + "type": "object", + "description": "Represents the state of loading a snapshot job.", + "properties": { + "jobId": { + "type": "string", + "description": "The job ID.", + "readOnly": true + }, + "createdDateTime": { + "type": "string", + "format": "date-time", + "description": "The creation date time of the job." + }, + "lastUpdatedDateTime": { + "type": "string", + "format": "date-time", + "description": "The last date time the job was updated." + }, + "expirationDateTime": { + "type": "string", + "format": "date-time", + "description": "The expiration date time of the job." + }, + "status": { + "$ref": "#/definitions/JobStatus", + "description": "The job status." + }, + "warnings": { + "type": "array", + "description": "The warnings that were encountered while executing the job.", + "items": { + "$ref": "#/definitions/Azure.Core.Foundations.Error" + } + }, + "errors": { + "type": "array", + "description": "The errors encountered while executing the job.", + "items": { + "$ref": "#/definitions/Azure.Core.Foundations.Error" + } + } + }, + "required": [ + "jobId", + "createdDateTime", + "lastUpdatedDateTime", + "status" + ] + }, + "AnalyzeConversationAuthoringOrchestrationExportedIntent": { + "type": "object", + "description": "Represents an exported intent for an orchestration project.", + "properties": { + "orchestration": { + "$ref": "#/definitions/AnalyzeConversationAuthoringExportedOrchestrationOptions", + "description": "Specifies the behavior of this intent in the orchestration flow." + }, + "category": { + "type": "string", + "description": "The intent category." + }, + "description": { + "type": "string", + "description": "The intent description." + } + }, + "required": [ + "category" + ] + }, + "AnalyzeConversationAuthoringOrchestrationExportedProjectAsset": { + "type": "object", + "description": "Represents the assets of an orchestration project.", + "properties": { + "intents": { + "type": "array", + "description": "Represents the intents of the project.", + "items": { + "$ref": "#/definitions/AnalyzeConversationAuthoringOrchestrationExportedIntent" + } + }, + "utterances": { + "type": "array", + "description": "Represents the utterances of the project.", + "items": { + "$ref": "#/definitions/AnalyzeConversationAuthoringOrchestrationExportedUtterance" + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/AnalyzeConversationAuthoringExportedProjectAssets" + } + ], + "x-ms-discriminator-value": "Orchestration" + }, + "AnalyzeConversationAuthoringOrchestrationExportedUtterance": { + "type": "object", + "description": "Represents an utterance of an orchestration project.", + "properties": { + "text": { + "type": "string", + "description": "The utterance text." + }, + "language": { + "type": "string", + "description": "Represents the utterance's language. This is BCP-47 representation of a language. For example, use \"en\" for English, \"en-gb\" for English (UK), \"es\" for Spanish etc." + }, + "intent": { + "type": "string", + "description": "The intent of the utterance." + }, + "dataset": { + "type": "string", + "description": "The dataset for this utterance. Allowed values are 'Train' and 'Test'." + } + }, + "required": [ + "text", + "intent" + ] + }, + "AnalyzeConversationAuthoringPrebuiltEntity": { + "type": "object", + "description": "Represents a supported prebuilt entity.", + "properties": { + "category": { + "type": "string", + "description": "The prebuilt entity category.", + "readOnly": true + }, + "description": { + "type": "string", + "description": "The description." + }, + "examples": { + "type": "string", + "description": "English examples for the entity." + } + }, + "required": [ + "category", + "description", + "examples" + ] + }, + "AnalyzeConversationAuthoringProjectDeletionJobState": { + "type": "object", + "description": "Represents the state of a project deletion job.", + "properties": { + "jobId": { + "type": "string", + "description": "The job ID.", + "readOnly": true + }, + "createdDateTime": { + "type": "string", + "format": "date-time", + "description": "The creation date time of the job." + }, + "lastUpdatedDateTime": { + "type": "string", + "format": "date-time", + "description": "The last date time the job was updated." + }, + "expirationDateTime": { + "type": "string", + "format": "date-time", + "description": "The expiration date time of the job." + }, + "status": { + "$ref": "#/definitions/JobStatus", + "description": "The job status." + }, + "warnings": { + "type": "array", + "description": "The warnings that were encountered while executing the job.", + "items": { + "$ref": "#/definitions/Azure.Core.Foundations.Error" + } + }, + "errors": { + "type": "array", + "description": "The errors encountered while executing the job.", + "items": { + "$ref": "#/definitions/Azure.Core.Foundations.Error" + } + } + }, + "required": [ + "jobId", + "createdDateTime", + "lastUpdatedDateTime", + "status" + ] + }, + "AnalyzeConversationAuthoringProjectDeployment": { + "type": "object", + "description": "Represents a project deployment.", + "properties": { + "deploymentName": { + "type": "string", + "description": "Represents deployment name.", + "readOnly": true + }, + "modelId": { + "type": "string", + "description": "Represents deployment modelId." + }, + "lastTrainedDateTime": { + "type": "string", + "format": "date-time", + "description": "Represents deployment last trained time." + }, + "lastDeployedDateTime": { + "type": "string", + "format": "date-time", + "description": "Represents deployment last deployed time." + }, + "deploymentExpirationDate": { + "type": "string", + "format": "date", + "description": "Represents deployment expiration date in the runtime." + }, + "modelTrainingConfigVersion": { + "type": "string", + "description": "Represents model training config version." + }, + "assignedResources": { + "type": "array", + "description": "Represents the metadata of the assigned Azure resources.", + "items": { + "$ref": "#/definitions/AnalyzeConversationAuthoringDeploymentResource" + } + } + }, + "required": [ + "deploymentName", + "modelId", + "lastTrainedDateTime", + "lastDeployedDateTime", + "deploymentExpirationDate", + "modelTrainingConfigVersion", + "assignedResources" + ] + }, + "AnalyzeConversationAuthoringProjectMetadata": { + "type": "object", + "description": "Represents the metadata of a project.", + "properties": { + "createdDateTime": { + "type": "string", + "format": "date-time", + "description": "Represents the project creation datetime." + }, + "lastModifiedDateTime": { + "type": "string", + "format": "date-time", + "description": "Represents the project creation datetime." + }, + "lastTrainedDateTime": { + "type": "string", + "format": "date-time", + "description": "Represents the project last trained datetime." + }, + "lastDeployedDateTime": { + "type": "string", + "format": "date-time", + "description": "Represents the project last deployed datetime." + }, + "projectKind": { + "$ref": "#/definitions/ProjectKind", + "description": "Represents the project kind.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "settings": { + "$ref": "#/definitions/AnalyzeConversationAuthoringProjectSettings", + "description": "The project settings.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "storageInputContainerName": { + "type": "string", + "description": "The storage container name in case of conversation summarization.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "projectName": { + "type": "string", + "description": "The new project name.", + "maxLength": 100, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "multilingual": { + "type": "boolean", + "description": "Whether the project would be used for multiple languages or not.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "description": { + "type": "string", + "description": "The project description.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "language": { + "type": "string", + "description": "The project language. This is BCP-47 representation of a language. For example, use \"en\" for English, \"en-gb\" for English (UK), \"es\" for Spanish etc.", + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "required": [ + "createdDateTime", + "lastModifiedDateTime", + "projectKind", + "projectName", + "language" + ] + }, + "AnalyzeConversationAuthoringProjectSettings": { + "type": "object", + "description": "Represents the settings used to define the project behavior.", + "properties": { + "confidenceThreshold": { + "type": "number", + "format": "float", + "description": "The threshold of the intent with the highest confidence, at which the prediction will automatically be changed to \"None\". The value of the threshold should be between 0 and 1 inclusive." + } + }, + "required": [ + "confidenceThreshold" + ] + }, + "AnalyzeConversationAuthoringProjectTrainedModel": { + "type": "object", + "description": "Represents a trained model.", + "properties": { + "label": { + "type": "string", + "description": "The trained model label.", + "readOnly": true + }, + "modelId": { + "type": "string", + "description": "The model ID." + }, + "lastTrainedDateTime": { + "type": "string", + "format": "date-time", + "description": "The last trained date time of the model." + }, + "lastTrainingDurationInSeconds": { + "type": "integer", + "format": "int32", + "description": "The duration of the model's last training request in seconds." + }, + "modelExpirationDate": { + "type": "string", + "format": "date", + "description": "The model expiration date." + }, + "modelTrainingConfigVersion": { + "type": "string", + "description": "The model training config version." + }, + "hasSnapshot": { + "type": "boolean", + "description": "The flag to indicate if the trained model has a snapshot ready." + } + }, + "required": [ + "label", + "modelId", + "lastTrainedDateTime", + "lastTrainingDurationInSeconds", + "modelExpirationDate", + "modelTrainingConfigVersion", + "hasSnapshot" + ] + }, + "AnalyzeConversationAuthoringResourceMetadata": { + "type": "object", + "description": "Represents metadata for the Azure resource..", + "properties": { + "azureResourceId": { + "type": "string", + "description": "Represents the Azure resource ID." + }, + "customDomain": { + "type": "string", + "description": "Represents the Azure resource custom domain." + }, + "region": { + "type": "string", + "description": "Represents the Azure resource region." + } + }, + "required": [ + "azureResourceId", + "customDomain", + "region" + ] + }, + "AnalyzeConversationAuthoringSubTrainingJobState": { + "type": "object", + "description": "Represents the detailed state of a training sub-operation.", + "properties": { + "percentComplete": { + "type": "integer", + "format": "int32", + "description": "Represents progress percentage." + }, + "startDateTime": { + "type": "string", + "format": "date-time", + "description": "Represents the start date time." + }, + "endDateTime": { + "type": "string", + "format": "date-time", + "description": "Represents the end date time." + }, + "status": { + "$ref": "#/definitions/JobStatus", + "description": "Represents the status of the sub-operation." + } + }, + "required": [ + "percentComplete", + "status" + ] + }, + "AnalyzeConversationAuthoringSupportedLanguage": { + "type": "object", + "description": "Represents a supported language.", + "properties": { + "languageName": { + "type": "string", + "description": "The language name.", + "readOnly": true + }, + "languageCode": { + "type": "string", + "description": "The language code. This is BCP-47 representation of a language. For example, \"en\" for English, \"en-gb\" for English (UK), \"es\" for Spanish etc." + } + }, + "required": [ + "languageName", + "languageCode" + ] + }, + "AnalyzeConversationAuthoringSwapDeploymentsJobState": { + "type": "object", + "description": "Represents the state of a deployment job.", + "properties": { + "jobId": { + "type": "string", + "description": "The job ID.", + "readOnly": true + }, + "createdDateTime": { + "type": "string", + "format": "date-time", + "description": "The creation date time of the job." + }, + "lastUpdatedDateTime": { + "type": "string", + "format": "date-time", + "description": "The last date time the job was updated." + }, + "expirationDateTime": { + "type": "string", + "format": "date-time", + "description": "The expiration date time of the job." + }, + "status": { + "$ref": "#/definitions/JobStatus", + "description": "The job status." + }, + "warnings": { + "type": "array", + "description": "The warnings that were encountered while executing the job.", + "items": { + "$ref": "#/definitions/Azure.Core.Foundations.Error" + } + }, + "errors": { + "type": "array", + "description": "The errors encountered while executing the job.", + "items": { + "$ref": "#/definitions/Azure.Core.Foundations.Error" + } + } + }, + "required": [ + "jobId", + "createdDateTime", + "lastUpdatedDateTime", + "status" + ] + }, + "AnalyzeConversationAuthoringSwapDeploymentsOptions": { + "type": "object", + "description": "Represents the options for swapping two deployments together.", + "properties": { + "firstDeploymentName": { + "type": "string", + "description": "Represents the first deployment name." + }, + "secondDeploymentName": { + "type": "string", + "description": "Represents the second deployment name." + } + }, + "required": [ + "firstDeploymentName", + "secondDeploymentName" + ] + }, + "AnalyzeConversationAuthoringTrainingConfigVersion": { + "type": "object", + "description": "Represents a training config version.", + "properties": { + "trainingConfigVersion": { + "type": "string", + "description": "Represents the version of the config.", + "readOnly": true + }, + "modelExpirationDate": { + "type": "string", + "format": "date", + "description": "Represents the training config version expiration date." + } + }, + "required": [ + "trainingConfigVersion", + "modelExpirationDate" + ] + }, + "AnalyzeConversationAuthoringTrainingJobOptions": { + "type": "object", + "description": "Represents the options for starting a new training job.", + "properties": { + "modelLabel": { + "type": "string", + "description": "Represents the output model label." + }, + "trainingConfigVersion": { + "type": "string", + "description": "Represents training config version. By default, \"latest\" value is used which uses the latest released training config version." + }, + "trainingMode": { + "$ref": "#/definitions/TrainingMode", + "description": "Represents the mode of the training operation." + }, + "evaluationOptions": { + "$ref": "#/definitions/AnalyzeConversationAuthoringEvaluationOptions", + "description": "Represents the evaluation options. By default, the evaluation kind is percentage, with training split percentage as 80, and testing split percentage as 20." + }, + "dataGenerationSettings": { + "$ref": "#/definitions/AnalyzeConversationAuthoringDataGenerationSettings", + "description": "For customers to populate if they wish to use data generation for their model training job." + } + }, + "required": [ + "modelLabel", + "trainingMode" + ] + }, + "AnalyzeConversationAuthoringTrainingJobResult": { + "type": "object", + "description": "Represents the output of a training job.", + "properties": { + "modelLabel": { + "type": "string", + "description": "Represents trained model label." + }, + "trainingConfigVersion": { + "type": "string", + "description": "Represents training config version." + }, + "trainingMode": { + "$ref": "#/definitions/TrainingMode", + "description": "Represents the mode of the training operation." + }, + "trainingStatus": { + "$ref": "#/definitions/AnalyzeConversationAuthoringSubTrainingJobState", + "description": "Represents the model training status." + }, + "dataGenerationStatus": { + "$ref": "#/definitions/AnalyzeConversationAuthoringSubTrainingJobState", + "description": "Represents the model data generation status." + }, + "evaluationStatus": { + "$ref": "#/definitions/AnalyzeConversationAuthoringSubTrainingJobState", + "description": "Represents model evaluation status." + }, + "estimatedEndDateTime": { + "type": "string", + "format": "date-time", + "description": "Represents the estimated end date time for training and evaluation." + } + }, + "required": [ + "modelLabel", + "trainingConfigVersion", + "trainingStatus", + "dataGenerationStatus" + ] + }, + "AnalyzeConversationAuthoringTrainingJobState": { + "type": "object", + "description": "Represents the state of a training job.", + "properties": { + "jobId": { + "type": "string", + "description": "The job ID.", + "readOnly": true + }, + "createdDateTime": { + "type": "string", + "format": "date-time", + "description": "The creation date time of the job." + }, + "lastUpdatedDateTime": { + "type": "string", + "format": "date-time", + "description": "The last date time the job was updated." + }, + "expirationDateTime": { + "type": "string", + "format": "date-time", + "description": "The expiration date time of the job." + }, + "status": { + "$ref": "#/definitions/JobStatus", + "description": "The job status." + }, + "warnings": { + "type": "array", + "description": "The warnings that were encountered while executing the job.", + "items": { + "$ref": "#/definitions/Azure.Core.Foundations.Error" + } + }, + "errors": { + "type": "array", + "description": "The errors encountered while executing the job.", + "items": { + "$ref": "#/definitions/Azure.Core.Foundations.Error" + } + }, + "result": { + "$ref": "#/definitions/AnalyzeConversationAuthoringTrainingJobResult", + "description": "Represents training tasks detailed result." + } + }, + "required": [ + "jobId", + "createdDateTime", + "lastUpdatedDateTime", + "status", + "result" + ] + }, + "AnalyzeConversationAuthoringUnassignDeploymentResourcesOptions": { + "type": "object", + "description": "Represents the options to unassign Azure resources from a project.", + "properties": { + "assignedResourceIds": { + "type": "array", + "description": "Represents the assigned resource IDs to be unassigned.", + "items": { + "type": "string" + } + } + }, + "required": [ + "assignedResourceIds" + ] + }, + "AnalyzeConversationAuthoringUtteranceEntitiesEvaluationResult": { + "type": "object", + "description": "Represents the comparison between the expected and predicted entities for an utterance.", + "properties": { + "expectedEntities": { + "type": "array", + "description": "Represents the expected entity labels.", + "items": { + "$ref": "#/definitions/AnalyzeConversationAuthoringUtteranceEntityEvaluationResult" + } + }, + "predictedEntities": { + "type": "array", + "description": "Represents the predicted entity labels.", + "items": { + "$ref": "#/definitions/AnalyzeConversationAuthoringUtteranceEntityEvaluationResult" + } + } + }, + "required": [ + "expectedEntities", + "predictedEntities" + ] + }, + "AnalyzeConversationAuthoringUtteranceEntityEvaluationResult": { + "type": "object", + "description": "Represents the evaluation output of an entity label or prediction.", + "properties": { + "category": { + "type": "string", + "description": "Represents the entity category." + }, + "offset": { + "type": "integer", + "format": "int32", + "description": "Represents the entity offset index relative to the original text." + }, + "length": { + "type": "integer", + "format": "int32", + "description": "Represents the entity length." + } + }, + "required": [ + "category", + "offset", + "length" + ] + }, + "AnalyzeConversationAuthoringUtteranceEvaluationResult": { + "type": "object", + "description": "Represents the evaluation result for an utterance.", + "properties": { + "text": { + "type": "string", + "description": "Represents the utterance text.", + "readOnly": true + }, + "language": { + "type": "string", + "description": "Represents the utterance language. This is BCP-47 representation of a language. For example, use \"en\" for English, \"en-gb\" for English (UK), \"es\" for Spanish etc." + }, + "entitiesResult": { + "$ref": "#/definitions/AnalyzeConversationAuthoringUtteranceEntitiesEvaluationResult", + "description": "Represents the entities results for the utterance." + }, + "intentsResult": { + "$ref": "#/definitions/AnalyzeConversationAuthoringUtteranceIntentsEvaluationResult", + "description": "Represents the intents results for the utterance." + } + }, + "required": [ + "text", + "language", + "entitiesResult", + "intentsResult" + ] + }, + "AnalyzeConversationAuthoringUtteranceIntentsEvaluationResult": { + "type": "object", + "description": "Represents the comparison between the expected and the predicted intent for an utterance.", + "properties": { + "expectedIntent": { + "type": "string", + "description": "Represents the utterance's expected intent." + }, + "predictedIntent": { + "type": "string", + "description": "Represents the utterance's predicted intent." + } + }, + "required": [ + "expectedIntent", + "predictedIntent" + ] + }, + "AnalyzeConversationExportedAssociatedEntityLabel": { + "type": "object", + "description": "Represents an associated entity label for an intent.", + "properties": { + "category": { + "type": "string", + "description": "The category of the entity label." + } + }, + "required": [ + "category" + ] + }, + "Azure.Core.Foundations.Error": { + "type": "object", + "description": "The error object.", + "properties": { + "code": { + "type": "string", + "description": "One of a server-defined set of error codes." + }, + "message": { + "type": "string", + "description": "A human-readable representation of the error." + }, + "target": { + "type": "string", + "description": "The target of the error." + }, + "details": { + "type": "array", + "description": "An array of details about specific errors that led to this reported error.", + "items": { + "$ref": "#/definitions/Azure.Core.Foundations.Error" + } + }, + "innererror": { + "$ref": "#/definitions/Azure.Core.Foundations.InnerError", + "description": "An object containing more specific information than the current object about the error." + } + }, + "required": [ + "code", + "message" + ] + }, + "Azure.Core.Foundations.ErrorResponse": { + "type": "object", + "description": "A response containing error details.", + "properties": { + "error": { + "$ref": "#/definitions/Azure.Core.Foundations.Error", + "description": "The error object." + } + }, + "required": [ + "error" + ] + }, + "Azure.Core.Foundations.InnerError": { + "type": "object", + "description": "An object containing more specific information about the error. As per Azure REST API guidelines - https://aka.ms/AzureRestApiGuidelines#handling-errors.", + "properties": { + "code": { + "type": "string", + "description": "One of a server-defined set of error codes." + }, + "innererror": { + "$ref": "#/definitions/Azure.Core.Foundations.InnerError", + "description": "Inner error." + } + } + }, + "Azure.Core.uuid": { + "type": "string", + "format": "uuid", + "description": "Universally Unique Identifier" + }, + "CompositionSetting": { + "type": "string", + "enum": [ + "returnLongestOverlap", + "requireExactOverlap", + "separateComponents", + "combineComponents" + ], + "x-ms-enum": { + "name": "CompositionSetting", + "modelAsString": true, + "values": [ + { + "name": "returnLongestOverlap", + "value": "returnLongestOverlap", + "description": "When two or more components are found in the text and overlap, the component with the longest set of characters is returned." + }, + { + "name": "requireExactOverlap", + "value": "requireExactOverlap", + "description": "All components must overlap at the exact same characters in the text for the entity to return. If one of the defined components is not matched or predicted, the entity will not return." + }, + { + "name": "separateComponents", + "value": "separateComponents", + "description": "Every component's match or prediction is returned as a separate instance of the entity." + }, + { + "name": "combineComponents", + "value": "combineComponents", + "description": "When two or more components are found in the text and overlap, the components' spans are merged together into one span combining all of them." + } + ] + } + }, + "DatasetType": { + "type": "string", + "description": "The dataset for this utterance. Allowed values are 'Train' and 'Test'.", + "enum": [ + "Train", + "Test" + ], + "x-ms-enum": { + "name": "DatasetType", + "modelAsString": true, + "values": [ + { + "name": "Train", + "value": "Train", + "description": "Split the data into training and test sets according to user-defined percentages." + }, + { + "name": "Test", + "value": "Test", + "description": "Split the data according to the chosen dataset for every example in the data." + } + ] + } + }, + "EvaluationKind": { + "type": "string", + "enum": [ + "percentage", + "manual" + ], + "x-ms-enum": { + "name": "EvaluationKind", + "modelAsString": true, + "values": [ + { + "name": "percentage", + "value": "percentage", + "description": "Split the data into training and test sets according to user-defined percentages." + }, + { + "name": "manual", + "value": "manual", + "description": "Split the data according to the chosen dataset for every example in the data." + } + ] + } + }, + "ExportedModelOptions": { + "type": "object", + "description": "Represents the options for creating or replacing an exported model.", + "properties": { + "trainedModelLabel": { + "type": "string", + "description": "The trained model label." + } + }, + "required": [ + "trainedModelLabel" + ] + }, + "JobStatus": { + "type": "string", + "enum": [ + "notStarted", + "running", + "succeeded", + "failed", + "cancelled", + "cancelling", + "partiallyCompleted" + ], + "x-ms-enum": { + "name": "JobStatus", + "modelAsString": true, + "values": [ + { + "name": "notStarted", + "value": "notStarted" + }, + { + "name": "running", + "value": "running" + }, + { + "name": "succeeded", + "value": "succeeded" + }, + { + "name": "failed", + "value": "failed" + }, + { + "name": "cancelled", + "value": "cancelled" + }, + { + "name": "cancelling", + "value": "cancelling" + }, + { + "name": "partiallyCompleted", + "value": "partiallyCompleted" + } + ] + } + }, + "OrchestrationTargetProjectKind": { + "type": "string", + "enum": [ + "Luis", + "Conversation", + "QuestionAnswering" + ], + "x-ms-enum": { + "name": "OrchestrationTargetProjectKind", + "modelAsString": true, + "values": [ + { + "name": "Luis", + "value": "Luis" + }, + { + "name": "Conversation", + "value": "Conversation" + }, + { + "name": "QuestionAnswering", + "value": "QuestionAnswering" + } + ] + } + }, + "PagedAnalyzeConversationAuthoringAssignedDeploymentResource": { + "type": "object", + "description": "Paged collection of AnalyzeConversationAuthoringAssignedDeploymentResource items", + "properties": { + "value": { + "type": "array", + "description": "The AnalyzeConversationAuthoringAssignedDeploymentResource items on this page", + "items": { + "$ref": "#/definitions/AnalyzeConversationAuthoringAssignedDeploymentResource" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "PagedAnalyzeConversationAuthoringAssignedProjectDeploymentsMetadata": { + "type": "object", + "description": "Paged collection of AnalyzeConversationAuthoringAssignedProjectDeploymentsMetadata items", + "properties": { + "value": { + "type": "array", + "description": "The AnalyzeConversationAuthoringAssignedProjectDeploymentsMetadata items on this page", + "items": { + "$ref": "#/definitions/AnalyzeConversationAuthoringAssignedProjectDeploymentsMetadata" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "PagedAnalyzeConversationAuthoringExportedTrainedModel": { + "type": "object", + "description": "Paged collection of AnalyzeConversationAuthoringExportedTrainedModel items", + "properties": { + "value": { + "type": "array", + "description": "The AnalyzeConversationAuthoringExportedTrainedModel items on this page", + "items": { + "$ref": "#/definitions/AnalyzeConversationAuthoringExportedTrainedModel" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "PagedAnalyzeConversationAuthoringPrebuiltEntity": { + "type": "object", + "description": "Paged collection of AnalyzeConversationAuthoringPrebuiltEntity items", + "properties": { + "value": { + "type": "array", + "description": "The AnalyzeConversationAuthoringPrebuiltEntity items on this page", + "items": { + "$ref": "#/definitions/AnalyzeConversationAuthoringPrebuiltEntity" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "PagedAnalyzeConversationAuthoringProjectDeployment": { + "type": "object", + "description": "Paged collection of AnalyzeConversationAuthoringProjectDeployment items", + "properties": { + "value": { + "type": "array", + "description": "The AnalyzeConversationAuthoringProjectDeployment items on this page", + "items": { + "$ref": "#/definitions/AnalyzeConversationAuthoringProjectDeployment" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "PagedAnalyzeConversationAuthoringProjectMetadata": { + "type": "object", + "description": "Paged collection of AnalyzeConversationAuthoringProjectMetadata items", + "properties": { + "value": { + "type": "array", + "description": "The AnalyzeConversationAuthoringProjectMetadata items on this page", + "items": { + "$ref": "#/definitions/AnalyzeConversationAuthoringProjectMetadata" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "PagedAnalyzeConversationAuthoringProjectTrainedModel": { + "type": "object", + "description": "Paged collection of AnalyzeConversationAuthoringProjectTrainedModel items", + "properties": { + "value": { + "type": "array", + "description": "The AnalyzeConversationAuthoringProjectTrainedModel items on this page", + "items": { + "$ref": "#/definitions/AnalyzeConversationAuthoringProjectTrainedModel" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "PagedAnalyzeConversationAuthoringSupportedLanguage": { + "type": "object", + "description": "Paged collection of AnalyzeConversationAuthoringSupportedLanguage items", + "properties": { + "value": { + "type": "array", + "description": "The AnalyzeConversationAuthoringSupportedLanguage items on this page", + "items": { + "$ref": "#/definitions/AnalyzeConversationAuthoringSupportedLanguage" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "PagedAnalyzeConversationAuthoringTrainingConfigVersion": { + "type": "object", + "description": "Paged collection of AnalyzeConversationAuthoringTrainingConfigVersion items", + "properties": { + "value": { + "type": "array", + "description": "The AnalyzeConversationAuthoringTrainingConfigVersion items on this page", + "items": { + "$ref": "#/definitions/AnalyzeConversationAuthoringTrainingConfigVersion" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "PagedAnalyzeConversationAuthoringTrainingJobState": { + "type": "object", + "description": "Paged collection of AnalyzeConversationAuthoringTrainingJobState items", + "properties": { + "value": { + "type": "array", + "description": "The AnalyzeConversationAuthoringTrainingJobState items on this page", + "items": { + "$ref": "#/definitions/AnalyzeConversationAuthoringTrainingJobState" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "PagedAnalyzeConversationAuthoringUtteranceEvaluationResult": { + "type": "object", + "description": "Paged collection of AnalyzeConversationAuthoringUtteranceEvaluationResult items", + "properties": { + "value": { + "type": "array", + "description": "The AnalyzeConversationAuthoringUtteranceEvaluationResult items on this page", + "items": { + "$ref": "#/definitions/AnalyzeConversationAuthoringUtteranceEvaluationResult" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "ProjectKind": { + "type": "string", + "enum": [ + "Conversation", + "Orchestration", + "CustomConversationSummarization" + ], + "x-ms-enum": { + "name": "ProjectKind", + "modelAsString": true, + "values": [ + { + "name": "Conversation", + "value": "Conversation", + "description": "A project to build natural language into apps, bots, and IoT devices." + }, + { + "name": "Orchestration", + "value": "Orchestration", + "description": "A project to connect and orchestrate Conversation, Custom question answering and LUIS projects together in one single project." + }, + { + "name": "CustomConversationSummarization", + "value": "CustomConversationSummarization", + "description": "A project to build conversation summarization models which are able to summarize long conversations." + } + ] + } + }, + "StringIndexType": { + "type": "string", + "enum": [ + "Utf16CodeUnit", + "Utf8CodeUnit", + "Utf32CodeUnit" + ], + "x-ms-enum": { + "name": "StringIndexType", + "modelAsString": true, + "values": [ + { + "name": "Utf16CodeUnit", + "value": "Utf16CodeUnit", + "description": "The offset and length values will correspond to UTF-16 code units. Use this option if your application is written in a language that support Unicode, for example Java, JavaScript." + }, + { + "name": "Utf8CodeUnit", + "value": "Utf8CodeUnit" + }, + { + "name": "Utf32CodeUnit", + "value": "Utf32CodeUnit" + } + ] + } + }, + "TrainingMode": { + "type": "string", + "enum": [ + "advanced", + "standard" + ], + "x-ms-enum": { + "name": "TrainingMode", + "modelAsString": true, + "values": [ + { + "name": "advanced", + "value": "advanced", + "description": "Trains using fine-tuned neural network transformer models. Can train multilingual projects." + }, + { + "name": "standard", + "value": "standard", + "description": "Faster training times for quicker iterations." + } + ] + } + } + }, + "parameters": { + "Azure.Core.Foundations.ApiVersionParameter": { + "name": "api-version", + "in": "query", + "description": "The API version to use for this operation.", + "required": true, + "type": "string", + "minLength": 1, + "x-ms-parameter-location": "method", + "x-ms-client-name": "apiVersion" + }, + "Azure.Core.MaxPageSizeQueryParameter": { + "name": "maxpagesize", + "in": "query", + "description": "The maximum number of result items per page.", + "required": false, + "type": "integer", + "format": "int32", + "x-ms-parameter-location": "method" + }, + "Azure.Core.SkipQueryParameter": { + "name": "skip", + "in": "query", + "description": "The number of result items to skip.", + "required": false, + "type": "integer", + "format": "int32", + "default": 0, + "x-ms-parameter-location": "method" + }, + "Azure.Core.TopQueryParameter": { + "name": "top", + "in": "query", + "description": "The number of result items to return.", + "required": false, + "type": "integer", + "format": "int32", + "x-ms-parameter-location": "method" + }, + "ProjectKindQueryParameter": { + "name": "projectKind", + "in": "query", + "description": "The project kind.", + "required": true, + "type": "string", + "enum": [ + "Conversation", + "Orchestration", + "CustomConversationSummarization" + ], + "x-ms-enum": { + "name": "ProjectKind", + "modelAsString": true, + "values": [ + { + "name": "Conversation", + "value": "Conversation", + "description": "A project to build natural language into apps, bots, and IoT devices." + }, + { + "name": "Orchestration", + "value": "Orchestration", + "description": "A project to connect and orchestrate Conversation, Custom question answering and LUIS projects together in one single project." + }, + { + "name": "CustomConversationSummarization", + "value": "CustomConversationSummarization", + "description": "A project to build conversation summarization models which are able to summarize long conversations." + } + ] + }, + "x-ms-parameter-location": "method", + "x-ms-client-name": "ProjectKind" + }, + "StringIndexTypeQueryParameter": { + "name": "stringIndexType", + "in": "query", + "description": "Specifies the method used to interpret string offsets. For additional information see https://aka.ms/text-analytics-offsets.", + "required": true, + "type": "string", + "enum": [ + "Utf16CodeUnit", + "Utf8CodeUnit", + "Utf32CodeUnit" + ], + "x-ms-enum": { + "name": "StringIndexType", + "modelAsString": true, + "values": [ + { + "name": "Utf16CodeUnit", + "value": "Utf16CodeUnit", + "description": "The offset and length values will correspond to UTF-16 code units. Use this option if your application is written in a language that support Unicode, for example Java, JavaScript." + }, + { + "name": "Utf8CodeUnit", + "value": "Utf8CodeUnit" + }, + { + "name": "Utf32CodeUnit", + "value": "Utf32CodeUnit" + } + ] + }, + "x-ms-parameter-location": "method" + }, + "SupportedPrebuiltEntitiesQueryParameter.language": { + "name": "language", + "in": "query", + "description": "The language to get supported prebuilt entities for. Required if multilingual is false. This is BCP-47 representation of a language. For example, use \"en\" for English, \"en-gb\" for English (UK), \"es\" for Spanish etc.", + "required": false, + "type": "string", + "x-ms-parameter-location": "method" + }, + "SupportedPrebuiltEntitiesQueryParameter.multilingual": { + "name": "multilingual", + "in": "query", + "description": "Whether to get the support prebuilt entities for multilingual or monolingual projects. If true, the language parameter is ignored.", + "required": false, + "type": "string", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulAssignDeploymentResources.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulAssignDeploymentResources.json new file mode 100644 index 000000000000..a435e5a1c82e --- /dev/null +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulAssignDeploymentResources.json @@ -0,0 +1,31 @@ +{ + "operationId": "ConversationAuthoringProject_AssignDeploymentResources", + "title": "Successful Assign Deployment Resources", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2025-05-15-preview", + "projectName": "EmailApp", + "body": { + "resourcesMetadata": [ + { + "azureResourceId": "/subscriptions/8ff19748-59ed-4e8a-af4b-7ce285849735/resourceGroups/test-rg/providers/Microsoft.CognitiveServices/accounts/LangTestWeu", + "customDomain": "lang-test-weu.cognitiveservices.azure.com", + "region": "westeurope" + }, + { + "azureResourceId": "/subscriptions/8ff19748-59ed-4e8a-af4b-7ce285849735/resourceGroups/test-rg/providers/Microsoft.CognitiveServices/accounts/LangTestEus", + "customDomain": "lang-test-eus.cognitiveservices.azure.com", + "region": "eastus" + } + ] + } + }, + "responses": { + "202": { + "headers": { + "operation-location": "{Endpoint}/language/authoring/analyze-conversations/projects/EmailApp/resources/assign/jobs/66fa9a67-a561-42f1-8a13-f3a879b1a324_637858368000000000?api-version=2025-05-15-preview" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulCancelTrainingJob.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulCancelTrainingJob.json new file mode 100644 index 000000000000..c3bac54d4702 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulCancelTrainingJob.json @@ -0,0 +1,18 @@ +{ + "operationId": "ConversationAuthoringProject_CancelTrainingJob", + "title": "Successful Cancel Training Job", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2025-05-15-preview", + "projectName": "EmailApp", + "jobId": "8ccf2ffe-e758-4d04-a44a-31512918c7e8_637858368000000000" + }, + "responses": { + "202": { + "headers": { + "operation-location": "{Endpoint}/language/authoring/analyze-conversations/projects/EmailApp/train/jobs/4d37982f-fded-4c2c-afe3-15953b5919b6_637858368000000000?api-version=2025-05-15-preview" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulCopyProject.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulCopyProject.json new file mode 100644 index 000000000000..41c577632647 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulCopyProject.json @@ -0,0 +1,25 @@ +{ + "operationId": "ConversationAuthoringProject_CopyProject", + "title": "Successful Copy Project", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2025-05-15-preview", + "projectName": "EmailApp", + "body": { + "projectKind": "Conversation", + "targetProjectName": "EmailApp", + "accessToken": "103fcb47-b095-44c1-aedd-4024a5923275", + "expiresAt": "2023-04-18T13:53:03Z", + "targetResourceId": "/subscriptions/8ff19748-59ed-4e8a-af4b-7ce285849735/resourceGroups/test-rg/providers/Microsoft.CognitiveServices/accounts/LangTestWeu", + "targetResourceRegion": "westeurope" + } + }, + "responses": { + "202": { + "headers": { + "operation-location": "{Endpoint}/language/authoring/analyze-conversations/projects/EmailApp/copy/jobs/4d37982f-fded-4c2c-afe3-15953b5919b6_637858368000000000?api-version=2025-05-15-preview" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulCopyProjectAuthorization.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulCopyProjectAuthorization.json new file mode 100644 index 000000000000..64a202abd0b3 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulCopyProjectAuthorization.json @@ -0,0 +1,27 @@ +{ + "operationId": "ConversationAuthoringProject_CopyProjectAuthorization", + "title": "Successful Copy Project Authorization", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2025-05-15-preview", + "projectName": "EmailApp", + "body": { + "projectKind": "Conversation", + "allowOverwrite": false + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "projectKind": "Conversation", + "targetProjectName": "EmailApp", + "accessToken": "103fcb47-b095-44c1-aedd-4024a5923275", + "expiresAt": "2023-04-18T13:53:03Z", + "targetResourceId": "/subscriptions/8ff19748-59ed-4e8a-af4b-7ce285849735/resourceGroups/test-rg/providers/Microsoft.CognitiveServices/accounts/LangTestWeu", + "targetResourceRegion": "westeurope" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulCreateExportedModel.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulCreateExportedModel.json new file mode 100644 index 000000000000..7632cae53c42 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulCreateExportedModel.json @@ -0,0 +1,21 @@ +{ + "operationId": "ConversationAuthoringExportedModel_CreateOrUpdateExportedModel", + "title": "Successful Create Exported Model", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2025-05-15-preview", + "projectName": "LoanAgreements", + "exportedModelName": "exported-model1", + "body": { + "trainedModelLabel": "model1" + } + }, + "responses": { + "202": { + "headers": { + "operation-location": "{Endpoint}/language/authoring/analyze-conversations/projects/LoanAgreements/exported-models/exported-model1/jobs/4d37982f-fded-4c2c-afe3-15953b5919b6_637858368000000000?api-version=2023-04-15-preview" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulCreateProject.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulCreateProject.json new file mode 100644 index 000000000000..53b4caeddac3 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulCreateProject.json @@ -0,0 +1,46 @@ +{ + "operationId": "ConversationAuthoringProject_CreateProject", + "title": "Successful Create Project", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "Content-Type": "application/merge-patch+json", + "api-version": "2025-05-15-preview", + "projectName": "myproject", + "body": { + "projectName": "myproject", + "language": "en", + "projectKind": "Conversation", + "description": "This is a sample conversation project.", + "multilingual": false + } + }, + "responses": { + "201": { + "headers": {}, + "body": { + "createdDateTime": "2022-04-18T13:53:03Z", + "lastModifiedDateTime": "2022-04-18T13:53:03Z", + "projectKind": "Conversation", + "projectName": "myproject", + "multilingual": false, + "description": "This is a sample conversation project.", + "language": "en" + } + }, + "200": { + "headers": {}, + "body": { + "createdDateTime": "2022-04-18T13:53:03Z", + "lastModifiedDateTime": "2022-04-18T13:53:03Z", + "lastTrainedDateTime": "2022-04-18T14:14:28Z", + "lastDeployedDateTime": "2022-04-18T14:49:01Z", + "projectKind": "Conversation", + "projectName": "myproject", + "multilingual": false, + "description": "This is a sample conversation project.", + "language": "en" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulDeleteDeployment.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulDeleteDeployment.json new file mode 100644 index 000000000000..e7e433aae67a --- /dev/null +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulDeleteDeployment.json @@ -0,0 +1,18 @@ +{ + "operationId": "ConversationAuthoringDeployment_DeleteDeployment", + "title": "Successful Delete Deployment", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2025-05-15-preview", + "projectName": "EmailApp", + "deploymentName": "staging" + }, + "responses": { + "202": { + "headers": { + "operation-location": "{Endpoint}/language/authoring/analyze-conversations/projects/EmailApp/deployments/staging/jobs/61ebb7ef-a207-40d2-82b9-5285440ae579_637858368000000000?api-version=2025-05-15-preview" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulDeleteDeploymentFromResources.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulDeleteDeploymentFromResources.json new file mode 100644 index 000000000000..b60b0dff9781 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulDeleteDeploymentFromResources.json @@ -0,0 +1,23 @@ +{ + "operationId": "ConversationAuthoringDeployment_DeleteDeploymentFromResources", + "title": "Successful Delete Deployment From Resources", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2025-05-15-preview", + "projectName": "EmailApp", + "deploymentName": "staging", + "body": { + "assignedResourceIds": [ + "/subscriptions/8ff19748-59ed-4e8a-af4b-7ce285849735/resourceGroups/test-rg/providers/Microsoft.CognitiveServices/accounts/LangTestWeu" + ] + } + }, + "responses": { + "202": { + "headers": { + "operation-location": "{Endpoint}/language/authoring/analyze-conversations/projects/EmailApp/deployments/staging/delete-from-resources/jobs/61ebb7ef-a207-40d2-82b9-5285440ae579_637858368000000000?api-version=2025-05-15-preview" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulDeleteExportedModel.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulDeleteExportedModel.json new file mode 100644 index 000000000000..d95b78d0cf68 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulDeleteExportedModel.json @@ -0,0 +1,18 @@ +{ + "operationId": "ConversationAuthoringExportedModel_DeleteExportedModel", + "title": "Successful Delete Exported Model", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2025-05-15-preview", + "projectName": "LoanAgreements", + "exportedModelName": "exported-model1" + }, + "responses": { + "202": { + "headers": { + "operation-location": "{Endpoint}/language/authoring/analyze-conversations/projects/LoanAgreements/exported-models/exported-model1/jobs/4d37982f-fded-4c2c-afe3-15953b5919b6_637858368000000000?api-version=2023-04-15-preview" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulDeleteModel.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulDeleteModel.json new file mode 100644 index 000000000000..7db8c7aaa28b --- /dev/null +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulDeleteModel.json @@ -0,0 +1,14 @@ +{ + "operationId": "ConversationAuthoringTrainedModel_DeleteTrainedModel", + "title": "Successful Delete Model", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2025-05-15-preview", + "projectName": "EmailApp", + "trainedModelLabel": "model2" + }, + "responses": { + "204": {} + } +} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulDeleteProject.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulDeleteProject.json new file mode 100644 index 000000000000..c027454cd829 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulDeleteProject.json @@ -0,0 +1,17 @@ +{ + "operationId": "ConversationAuthoringProject_DeleteProject", + "title": "Successful Delete Project", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2025-05-15-preview", + "projectName": "myproject" + }, + "responses": { + "202": { + "headers": { + "operation-location": "{Endpoint}/language/authoring/analyze-conversations/projects/global/deletion-jobs/129d3182-625d-496c-bcf9-43686e85160b_637858368000000000?api-version=2025-05-15-preview" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulDeployProject.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulDeployProject.json new file mode 100644 index 000000000000..558ecfae062c --- /dev/null +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulDeployProject.json @@ -0,0 +1,41 @@ +{ + "operationId": "ConversationAuthoringDeployment_DeployProject", + "title": "Successful Deploy Project", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2025-05-15-preview", + "projectName": "EmailApp", + "deploymentName": "production", + "body": { + "trainedModelLabel": "29886710a2ae49259d62cffca977db66", + "assignedResources": [ + { + "resourceId": "/subscriptions/8ff19748-59ed-4e8a-af4b-7ce285849735/resourceGroups/test-rg/providers/Microsoft.CognitiveServices/accounts/LangTestWeu", + "region": "westeurope", + "assignedAoaiResource": { + "kind": "AzureOpenAI", + "resourceId": "/subscriptions/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/resourceGroups/resource-group-name/providers/Microsoft.CognitiveServices/accounts/aoai-account-name", + "deploymentName": "model-deployment-name" + } + }, + { + "resourceId": "/subscriptions/8ff19748-59ed-4e8a-af4b-7ce285849735/resourceGroups/test-rg/providers/Microsoft.CognitiveServices/accounts/LangTestEus", + "region": "eastus", + "assignedAoaiResource": { + "kind": "AzureOpenAI", + "resourceId": "/subscriptions/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/resourceGroups/resource-group-name/providers/Microsoft.CognitiveServices/accounts/aoai-account-name", + "deploymentName": "model-deployment-name" + } + } + ] + } + }, + "responses": { + "202": { + "headers": { + "operation-location": "{Endpoint}/language/authoring/analyze-conversations/projects/EmailApp/deployments/production/jobs/66fa9a67-a561-42f1-8a13-f3a879b1a324_637858368000000000?api-version=2025-05-15-preview" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulEvaluationProject.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulEvaluationProject.json new file mode 100644 index 000000000000..bf3ba5dd9665 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulEvaluationProject.json @@ -0,0 +1,23 @@ +{ + "operationId": "ConversationAuthoringTrainedModel_EvaluateModel", + "title": "Successful Evaluation Project", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2025-05-15-preview", + "projectName": "EmailApp", + "trainedModelLabel": "model1", + "body": { + "kind": "percentage", + "testingSplitPercentage": 20, + "trainingSplitPercentage": 80 + } + }, + "responses": { + "202": { + "headers": { + "operation-location": "{Endpoint}/language/authoring/analyze-conversations/projects/LoanAgreements/models/model1/evaluate/jobs/4d37982f-fded-4c2c-afe3-15953b5919b6_637858368000000000?api-version=2025-05-15-preview" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulExportProject.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulExportProject.json new file mode 100644 index 000000000000..90cbab3df3c9 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulExportProject.json @@ -0,0 +1,18 @@ +{ + "operationId": "ConversationAuthoringProject_Export", + "title": "Successful Export Project", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2025-05-15-preview", + "projectName": "EmailApp", + "stringIndexType": "Utf16CodeUnit" + }, + "responses": { + "202": { + "headers": { + "operation-location": "{Endpoint}/language/authoring/analyze-conversations/projects/EmailApp/export/jobs/4d37982f-fded-4c2c-afe3-15953b5919b6_637858368000000000?api-version=2025-05-15-preview" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulGetAssignDeploymentResourcesStatus.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulGetAssignDeploymentResourcesStatus.json new file mode 100644 index 000000000000..496d921de59c --- /dev/null +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulGetAssignDeploymentResourcesStatus.json @@ -0,0 +1,23 @@ +{ + "operationId": "ConversationAuthoringProject_GetAssignDeploymentResourcesStatus", + "title": "Successful Get Assign Deployment Resources Status", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2025-05-15-preview", + "projectName": "EmailApp", + "jobId": "66fa9a67-a561-42f1-8a13-f3a879b1a324_637858368000000000" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "jobId": "66fa9a67-a561-42f1-8a13-f3a879b1a324_637858368000000000", + "createdDateTime": "2022-04-18T15:52:48Z", + "lastUpdatedDateTime": "2022-04-18T15:53:04Z", + "expirationDateTime": "2022-04-25T15:52:48Z", + "status": "succeeded" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulGetCopyProjectStatus.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulGetCopyProjectStatus.json new file mode 100644 index 000000000000..6c7c4db33689 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulGetCopyProjectStatus.json @@ -0,0 +1,23 @@ +{ + "operationId": "ConversationAuthoringProject_GetCopyProjectStatus", + "title": "Successful Get Copy Project Status", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2025-05-15-preview", + "projectName": "EmailApp", + "jobId": "66fa9a67-a561-42f1-8a13-f3a879b1a324_637858368000000000" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "jobId": "66fa9a67-a561-42f1-8a13-f3a879b1a324_637858368000000000", + "createdDateTime": "2022-04-18T15:52:48Z", + "lastUpdatedDateTime": "2022-04-18T15:53:04Z", + "expirationDateTime": "2022-04-25T15:52:48Z", + "status": "succeeded" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulGetDeployment.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulGetDeployment.json new file mode 100644 index 000000000000..8d8401adc0c8 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulGetDeployment.json @@ -0,0 +1,44 @@ +{ + "operationId": "ConversationAuthoringDeployment_GetDeployment", + "title": "Successful Get Deployment", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2025-05-15-preview", + "projectName": "EmailApp", + "deploymentName": "staging" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "deploymentName": "staging", + "modelId": "model1-20220418T034749-299f45b8114849538c1a750b21b05a94", + "lastTrainedDateTime": "2022-04-18T15:47:49.4334381Z", + "lastDeployedDateTime": "2022-04-18T15:53:04Z", + "deploymentExpirationDate": "2023-10-28", + "modelTrainingConfigVersion": "2022-05-15-preview", + "assignedResources": [ + { + "resourceId": "/subscriptions/8ff19748-59ed-4e8a-af4b-7ce285849735/resourceGroups/test-rg/providers/Microsoft.CognitiveServices/accounts/LangTestWeu", + "region": "westeurope", + "assignedAoaiResource": { + "kind": "AzureOpenAI", + "resourceId": "/subscriptions/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/resourceGroups/resource-group-name/providers/Microsoft.CognitiveServices/accounts/aoai-account-name", + "deploymentName": "model-deployment-name" + } + }, + { + "resourceId": "/subscriptions/8ff19748-59ed-4e8a-af4b-7ce285849735/resourceGroups/test-rg/providers/Microsoft.CognitiveServices/accounts/LangTestEus", + "region": "eastus", + "assignedAoaiResource": { + "kind": "AzureOpenAI", + "resourceId": "/subscriptions/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/resourceGroups/resource-group-name/providers/Microsoft.CognitiveServices/accounts/aoai-account-name", + "deploymentName": "model-deployment-name" + } + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulGetDeploymentDeleteFromResourcesStatus.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulGetDeploymentDeleteFromResourcesStatus.json new file mode 100644 index 000000000000..3ab793576218 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulGetDeploymentDeleteFromResourcesStatus.json @@ -0,0 +1,24 @@ +{ + "operationId": "ConversationAuthoringDeployment_GetDeploymentDeleteFromResourcesStatus", + "title": "Successful Get Deployment Status", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2025-05-15-preview", + "projectName": "EmailApp", + "deploymentName": "production", + "jobId": "66fa9a67-a561-42f1-8a13-f3a879b1a324_637858368000000000" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "jobId": "66fa9a67-a561-42f1-8a13-f3a879b1a324_637858368000000000", + "createdDateTime": "2022-04-18T15:52:48Z", + "lastUpdatedDateTime": "2022-04-18T15:53:04Z", + "expirationDateTime": "2022-04-25T15:52:48Z", + "status": "succeeded" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulGetDeploymentStatus.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulGetDeploymentStatus.json new file mode 100644 index 000000000000..fa3b907aef41 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulGetDeploymentStatus.json @@ -0,0 +1,24 @@ +{ + "operationId": "ConversationAuthoringDeployment_GetDeploymentStatus", + "title": "Successful Get Deployment Status", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2025-05-15-preview", + "projectName": "EmailApp", + "deploymentName": "production", + "jobId": "66fa9a67-a561-42f1-8a13-f3a879b1a324_637858368000000000" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "jobId": "66fa9a67-a561-42f1-8a13-f3a879b1a324_637858368000000000", + "createdDateTime": "2022-04-18T15:52:48Z", + "lastUpdatedDateTime": "2022-04-18T15:53:04Z", + "expirationDateTime": "2022-04-25T15:52:48Z", + "status": "succeeded" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulGetEvaluationStatus.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulGetEvaluationStatus.json new file mode 100644 index 000000000000..e2db66f43308 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulGetEvaluationStatus.json @@ -0,0 +1,34 @@ +{ + "operationId": "ConversationAuthoringTrainedModel_GetEvaluationStatus", + "title": "Successful Get Evaluation Status", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2025-05-15-preview", + "projectName": "EmailApp", + "trainedModelLabel": "model1", + "jobId": "8ccf2ffe-e758-4d04-a44a-31512918c7e8_637858368000000000" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "result": { + "evaluationOptions": { + "kind": "percentage", + "trainingSplitPercentage": 60, + "testingSplitPercentage": 40 + }, + "modelLabel": "model1", + "trainingConfigVersion": "2022-05-01", + "percentComplete": 30 + }, + "jobId": "8ccf2ffe-e758-4d04-a44a-31512918c7e8_637858368000000000", + "createdDateTime": "2022-04-18T15:44:44Z", + "lastUpdatedDateTime": "2022-04-18T15:45:48Z", + "expirationDateTime": "2022-04-25T15:44:44Z", + "status": "running" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulGetExportStatus.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulGetExportStatus.json new file mode 100644 index 000000000000..c0e08bbdce29 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulGetExportStatus.json @@ -0,0 +1,24 @@ +{ + "operationId": "ConversationAuthoringProject_GetExportStatus", + "title": "Successful Get Export Status", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2025-05-15-preview", + "projectName": "EmailApp", + "jobId": "c95efa2a-44e8-461e-8aa5-04b4677bfa84_637858368000000000" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "resultUrl": "{Endpoint}/language/authoring/analyze-conversations/projects/EmailApp/export/jobs/c4946bfa-4fbf-493b-bfcf-2d232eb9de69_637858368000000000/result?api-version=2025-05-15-preview", + "jobId": "c4946bfa-4fbf-493b-bfcf-2d232eb9de69_637858368000000000", + "createdDateTime": "2022-04-18T15:23:07Z", + "lastUpdatedDateTime": "2022-04-18T15:23:08Z", + "expirationDateTime": "2022-04-25T15:23:07Z", + "status": "succeeded" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulGetExportedModel.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulGetExportedModel.json new file mode 100644 index 000000000000..bee3d7b6f90e --- /dev/null +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulGetExportedModel.json @@ -0,0 +1,24 @@ +{ + "operationId": "ConversationAuthoringExportedModel_GetExportedModel", + "title": "Successful Get Exported Model", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2025-05-15-preview", + "projectName": "LoanAgreements", + "exportedModelName": "exported-model1" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "exportedModelName": "exported-model1", + "modelId": "model1-20220418T034749-299f45b8114849538c1a750b21b05a94", + "lastTrainedDateTime": "2023-04-18T15:47:49Z", + "lastExportedModelDateTime": "2023-04-18T16:03:51Z", + "modelExpirationDate": "2023-10-28", + "modelTrainingConfigVersion": "2022-05-01" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulGetExportedModelStatus.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulGetExportedModelStatus.json new file mode 100644 index 000000000000..146c7095af02 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulGetExportedModelStatus.json @@ -0,0 +1,24 @@ +{ + "operationId": "ConversationAuthoringExportedModel_GetExportedModelJobStatus", + "title": "Successful Get Exported Model Status", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2025-05-15-preview", + "projectName": "LoanAgreements", + "exportedModelName": "exported-model1", + "jobId": "8ccf2ffe-e758-4d04-a44a-31512918c7e8_637858368000000000" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "jobId": "8ccf2ffe-e758-4d04-a44a-31512918c7e8_637858368000000000", + "createdDateTime": "2023-04-18T15:44:44Z", + "lastUpdatedDateTime": "2023-04-18T15:45:48Z", + "expirationDateTime": "2023-04-25T15:44:44Z", + "status": "running" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulGetImportStatus.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulGetImportStatus.json new file mode 100644 index 000000000000..ae448ec3cb84 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulGetImportStatus.json @@ -0,0 +1,23 @@ +{ + "operationId": "ConversationAuthoringProject_GetImportStatus", + "title": "Successful Get Import Status", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2025-05-15-preview", + "projectName": "EmailApp", + "jobId": "c95efa2a-44e8-461e-8aa5-04b4677bfa84_637858368000000000" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "jobId": "c95efa2a-44e8-461e-8aa5-04b4677bfa84_637858368000000000", + "createdDateTime": "2022-04-18T15:17:20Z", + "lastUpdatedDateTime": "2022-04-18T15:17:22Z", + "expirationDateTime": "2022-04-25T15:17:20Z", + "status": "succeeded" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulGetLoadSnapshotStatus.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulGetLoadSnapshotStatus.json new file mode 100644 index 000000000000..fb66a69173f8 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulGetLoadSnapshotStatus.json @@ -0,0 +1,24 @@ +{ + "operationId": "ConversationAuthoringTrainedModel_GetLoadSnapshotStatus", + "title": "Successful Get Load Snapshot Status", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2025-05-15-preview", + "projectName": "EmailApp", + "trainedModelLabel": "model1", + "jobId": "8ccf2ffe-e758-4d04-a44a-31512918c7e8_637858368000000000" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "jobId": "8ccf2ffe-e758-4d04-a44a-31512918c7e8_637858368000000000", + "createdDateTime": "2022-04-18T15:44:44Z", + "lastUpdatedDateTime": "2022-04-18T15:45:48Z", + "expirationDateTime": "2022-04-25T15:44:44Z", + "status": "running" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulGetModel.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulGetModel.json new file mode 100644 index 000000000000..7052d47d9972 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulGetModel.json @@ -0,0 +1,25 @@ +{ + "operationId": "ConversationAuthoringTrainedModel_GetTrainedModel", + "title": "Successful Get Model", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2025-05-15-preview", + "projectName": "EmailApp", + "trainedModelLabel": "model1" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "label": "model1", + "modelId": "model1-20220418T034749-299f45b8114849538c1a750b21b05a94", + "lastTrainedDateTime": "2022-04-18T15:47:49Z", + "lastTrainingDurationInSeconds": 186, + "modelExpirationDate": "2022-10-28", + "modelTrainingConfigVersion": "2022-05-01", + "hasSnapshot": true + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulGetModelEvaluation.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulGetModelEvaluation.json new file mode 100644 index 000000000000..7ab05b79f48f --- /dev/null +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulGetModelEvaluation.json @@ -0,0 +1,286 @@ +{ + "operationId": "ConversationAuthoringTrainedModel_GetModelEvaluationResults", + "title": "Successful Get Model Evaluation", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2025-05-15-preview", + "projectName": "EmailApp", + "trainedModelLabel": "model1", + "stringIndexType": "Utf16CodeUnit", + "maxpagesize": 10 + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "text": "send the email", + "language": "en-us", + "entitiesResult": { + "expectedEntities": [], + "predictedEntities": [] + }, + "intentsResult": { + "expectedIntent": "SendEmail", + "predictedIntent": "SendEmail" + } + }, + { + "text": "send a mail to daniel", + "language": "en-us", + "entitiesResult": { + "expectedEntities": [ + { + "category": "ContactName", + "offset": 15, + "length": 6 + } + ], + "predictedEntities": [ + { + "category": "ContactName", + "offset": 15, + "length": 6 + } + ] + }, + "intentsResult": { + "expectedIntent": "SendEmail", + "predictedIntent": "SendEmail" + } + }, + { + "text": "i forgot to add an important part to that email to james . please set it up to edit", + "language": "en-us", + "entitiesResult": { + "expectedEntities": [ + { + "category": "ContactName", + "offset": 51, + "length": 5 + } + ], + "predictedEntities": [ + { + "category": "Category", + "offset": 19, + "length": 9 + }, + { + "category": "ContactName", + "offset": 51, + "length": 5 + } + ] + }, + "intentsResult": { + "expectedIntent": "AddMore", + "predictedIntent": "AddMore" + } + }, + { + "text": "send email to a and tian", + "language": "en-us", + "entitiesResult": { + "expectedEntities": [ + { + "category": "ContactName", + "offset": 14, + "length": 1 + }, + { + "category": "ContactName", + "offset": 20, + "length": 4 + } + ], + "predictedEntities": [ + { + "category": "ContactName", + "offset": 14, + "length": 1 + }, + { + "category": "ContactName", + "offset": 20, + "length": 4 + } + ] + }, + "intentsResult": { + "expectedIntent": "SendEmail", + "predictedIntent": "SendEmail" + } + }, + { + "text": "send thomas an email", + "language": "en-us", + "entitiesResult": { + "expectedEntities": [ + { + "category": "ContactName", + "offset": 5, + "length": 6 + } + ], + "predictedEntities": [ + { + "category": "ContactName", + "offset": 5, + "length": 6 + } + ] + }, + "intentsResult": { + "expectedIntent": "SendEmail", + "predictedIntent": "SendEmail" + } + }, + { + "text": "i need to add more to the email message i am sending to vincent", + "language": "en-us", + "entitiesResult": { + "expectedEntities": [ + { + "category": "ContactName", + "offset": 56, + "length": 7 + } + ], + "predictedEntities": [ + { + "category": "ContactName", + "offset": 56, + "length": 7 + } + ] + }, + "intentsResult": { + "expectedIntent": "AddMore", + "predictedIntent": "AddMore" + } + }, + { + "text": "send an email to lily roth and abc123@microsoft.com", + "language": "en-us", + "entitiesResult": { + "expectedEntities": [ + { + "category": "ContactName", + "offset": 17, + "length": 9 + } + ], + "predictedEntities": [ + { + "category": "ContactName", + "offset": 17, + "length": 9 + } + ] + }, + "intentsResult": { + "expectedIntent": "SendEmail", + "predictedIntent": "SendEmail" + } + }, + { + "text": "i need to add something else to my email to cheryl", + "language": "en-us", + "entitiesResult": { + "expectedEntities": [ + { + "category": "ContactName", + "offset": 44, + "length": 6 + } + ], + "predictedEntities": [ + { + "category": "ContactName", + "offset": 44, + "length": 6 + } + ] + }, + "intentsResult": { + "expectedIntent": "AddMore", + "predictedIntent": "AddMore" + } + }, + { + "text": "send an email to larry , joseph and billy larkson", + "language": "en-us", + "entitiesResult": { + "expectedEntities": [ + { + "category": "ContactName", + "offset": 17, + "length": 5 + }, + { + "category": "ContactName", + "offset": 25, + "length": 6 + }, + { + "category": "ContactName", + "offset": 36, + "length": 13 + } + ], + "predictedEntities": [ + { + "category": "ContactName", + "offset": 17, + "length": 5 + }, + { + "category": "ContactName", + "offset": 25, + "length": 6 + }, + { + "category": "ContactName", + "offset": 36, + "length": 13 + } + ] + }, + "intentsResult": { + "expectedIntent": "SendEmail", + "predictedIntent": "SendEmail" + } + }, + { + "text": "send mail to dorothy", + "language": "en-us", + "entitiesResult": { + "expectedEntities": [ + { + "category": "ContactName", + "offset": 13, + "length": 7 + } + ], + "predictedEntities": [ + { + "category": "ContactName", + "offset": 13, + "length": 7 + } + ] + }, + "intentsResult": { + "expectedIntent": "SendEmail", + "predictedIntent": "SendEmail" + } + } + ], + "nextLink": "https://api.example.com/language/authoring/analyze-conversations/projects/EmailApp/models/model1/evaluation/result/?api-version=2025-05-15-preview&top=2147483637&skip=100&maxpagesize=100" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulGetModelEvaluationSummary.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulGetModelEvaluationSummary.json new file mode 100644 index 000000000000..38c662c35618 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulGetModelEvaluationSummary.json @@ -0,0 +1,528 @@ +{ + "operationId": "ConversationAuthoringTrainedModel_GetModelEvaluationSummary", + "title": "Successful Get Model Evaluation Summary", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2025-05-15-preview", + "projectName": "EmailApp", + "trainedModelLabel": "model1" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "entitiesEvaluation": { + "confusionMatrix": { + "Attachment": { + "Attachment": { + "normalizedValue": 100.0, + "rawValue": 3.0 + } + }, + "Category": { + "Category": { + "normalizedValue": 91.666664, + "rawValue": 11.0 + }, + "$none": { + "normalizedValue": 8.333333, + "rawValue": 1.0 + } + }, + "ContactName": { + "ContactName": { + "normalizedValue": 91.666664, + "rawValue": 22.0 + }, + "SenderName": { + "normalizedValue": 4.1666665, + "rawValue": 1.0 + }, + "$none": { + "normalizedValue": 4.1666665, + "rawValue": 1.0 + } + }, + "Date": { + "Date": { + "normalizedValue": 100.0, + "rawValue": 2.0 + } + }, + "EmailSubject": { + "EmailSubject": { + "normalizedValue": 93.33333, + "rawValue": 9.333334 + }, + "$none": { + "normalizedValue": 6.6666665, + "rawValue": 0.6666667 + } + }, + "FromRelationshipName": { + "FromRelationshipName": { + "normalizedValue": 100.0, + "rawValue": 1.0 + } + }, + "Line": { + "Line": { + "normalizedValue": 100.0, + "rawValue": 2.0 + } + }, + "Message": { + "Message": { + "normalizedValue": 81.2063, + "rawValue": 6.496504 + }, + "EmailSubject": { + "normalizedValue": 7.43007, + "rawValue": 0.5944056 + }, + "$none": { + "normalizedValue": 9.120047, + "rawValue": 0.7296037 + }, + "Date": { + "normalizedValue": 2.2435899, + "rawValue": 0.17948718 + } + }, + "OrderReference": { + "OrderReference": { + "normalizedValue": 100.0, + "rawValue": 17.0 + } + }, + "PositionReference": { + "$none": { + "normalizedValue": 100.0, + "rawValue": 1.0 + } + }, + "RelationshipName": { + "RelationshipName": { + "normalizedValue": 66.666664, + "rawValue": 2.0 + }, + "$none": { + "normalizedValue": 33.333332, + "rawValue": 1.0 + } + }, + "SearchTexts": { + "SearchTexts": { + "normalizedValue": 100.0, + "rawValue": 4.0 + } + }, + "SenderName": { + "SenderName": { + "normalizedValue": 88.888885, + "rawValue": 8.0 + }, + "ContactName": { + "normalizedValue": 11.111111, + "rawValue": 1.0 + } + }, + "Time": { + "$none": { + "normalizedValue": 100.0, + "rawValue": 2.0 + } + }, + "$none": { + "$none": { + "normalizedValue": 99.739265, + "rawValue": 162.575 + }, + "Category": { + "normalizedValue": 0.2607362, + "rawValue": 0.425 + } + } + }, + "entities": { + "ContactName": { + "f1": 0.9361702799797058, + "precision": 0.95652174949646, + "recall": 0.9166666865348816, + "truePositiveCount": 22, + "trueNegativeCount": 0, + "falsePositiveCount": 1, + "falseNegativeCount": 2 + }, + "Category": { + "f1": 0.8799999952316284, + "precision": 0.8461538553237915, + "recall": 0.9166666865348816, + "truePositiveCount": 11, + "trueNegativeCount": 0, + "falsePositiveCount": 2, + "falseNegativeCount": 1 + }, + "SenderName": { + "f1": 0.8888888955116272, + "precision": 0.8888888955116272, + "recall": 0.8888888955116272, + "truePositiveCount": 8, + "trueNegativeCount": 0, + "falsePositiveCount": 1, + "falseNegativeCount": 1 + }, + "EmailSubject": { + "f1": 0.8181817531585693, + "precision": 0.75, + "recall": 0.8999999761581421, + "truePositiveCount": 9, + "trueNegativeCount": 0, + "falsePositiveCount": 3, + "falseNegativeCount": 1 + }, + "Message": { + "f1": 0.75, + "precision": 0.75, + "recall": 0.75, + "truePositiveCount": 6, + "trueNegativeCount": 0, + "falsePositiveCount": 2, + "falseNegativeCount": 2 + }, + "Date": { + "f1": 0.800000011920929, + "precision": 0.6666666865348816, + "recall": 1.0, + "truePositiveCount": 2, + "trueNegativeCount": 0, + "falsePositiveCount": 1, + "falseNegativeCount": 0 + }, + "OrderReference": { + "f1": 1.0, + "precision": 1.0, + "recall": 1.0, + "truePositiveCount": 17, + "trueNegativeCount": 0, + "falsePositiveCount": 0, + "falseNegativeCount": 0 + }, + "SearchTexts": { + "f1": 1.0, + "precision": 1.0, + "recall": 1.0, + "truePositiveCount": 4, + "trueNegativeCount": 0, + "falsePositiveCount": 0, + "falseNegativeCount": 0 + }, + "Attachment": { + "f1": 1.0, + "precision": 1.0, + "recall": 1.0, + "truePositiveCount": 3, + "trueNegativeCount": 0, + "falsePositiveCount": 0, + "falseNegativeCount": 0 + }, + "RelationshipName": { + "f1": 0.800000011920929, + "precision": 1.0, + "recall": 0.6666666865348816, + "truePositiveCount": 2, + "trueNegativeCount": 0, + "falsePositiveCount": 0, + "falseNegativeCount": 1 + }, + "Line": { + "f1": 1.0, + "precision": 1.0, + "recall": 1.0, + "truePositiveCount": 2, + "trueNegativeCount": 0, + "falsePositiveCount": 0, + "falseNegativeCount": 0 + }, + "Time": { + "f1": 0.0, + "precision": 0.0, + "recall": 0.0, + "truePositiveCount": 0, + "trueNegativeCount": 0, + "falsePositiveCount": 0, + "falseNegativeCount": 2 + }, + "FromRelationshipName": { + "f1": 1.0, + "precision": 1.0, + "recall": 1.0, + "truePositiveCount": 1, + "trueNegativeCount": 0, + "falsePositiveCount": 0, + "falseNegativeCount": 0 + }, + "PositionReference": { + "f1": 0.0, + "precision": 0.0, + "recall": 0.0, + "truePositiveCount": 0, + "trueNegativeCount": 0, + "falsePositiveCount": 0, + "falseNegativeCount": 1 + } + }, + "microF1": 0.8923077, + "microPrecision": 0.8969072, + "microRecall": 0.8877551, + "macroF1": 0.7766601, + "macroPrecision": 0.7755879, + "macroRecall": 0.78849214 + }, + "intentsEvaluation": { + "confusionMatrix": { + "AddFlag": { + "AddFlag": { + "normalizedValue": 100.0, + "rawValue": 6.0 + } + }, + "AddMore": { + "AddMore": { + "normalizedValue": 100.0, + "rawValue": 17.0 + } + }, + "Cancel": { + "Cancel": { + "normalizedValue": 100.0, + "rawValue": 9.0 + } + }, + "CheckMessages": { + "CheckMessages": { + "normalizedValue": 100.0, + "rawValue": 9.0 + } + }, + "Confirm": { + "Confirm": { + "normalizedValue": 100.0, + "rawValue": 4.0 + } + }, + "Delete": { + "Delete": { + "normalizedValue": 100.0, + "rawValue": 5.0 + } + }, + "Forward": { + "Forward": { + "normalizedValue": 100.0, + "rawValue": 6.0 + } + }, + "None": { + "None": { + "normalizedValue": 100.0, + "rawValue": 1.0 + } + }, + "QueryLastText": { + "QueryLastText": { + "normalizedValue": 100.0, + "rawValue": 6.0 + } + }, + "ReadAloud": { + "ReadAloud": { + "normalizedValue": 100.0, + "rawValue": 16.0 + } + }, + "Reply": { + "Reply": { + "normalizedValue": 100.0, + "rawValue": 6.0 + } + }, + "SearchMessages": { + "SearchMessages": { + "normalizedValue": 100.0, + "rawValue": 9.0 + } + }, + "SendEmail": { + "SendEmail": { + "normalizedValue": 100.0, + "rawValue": 20.0 + } + }, + "ShowNext": { + "ShowNext": { + "normalizedValue": 100.0, + "rawValue": 4.0 + } + }, + "ShowPrevious": { + "ShowPrevious": { + "normalizedValue": 100.0, + "rawValue": 3.0 + } + } + }, + "intents": { + "AddMore": { + "f1": 1.0, + "precision": 1.0, + "recall": 1.0, + "truePositiveCount": 17, + "trueNegativeCount": 104, + "falsePositiveCount": 0, + "falseNegativeCount": 0 + }, + "Cancel": { + "f1": 1.0, + "precision": 1.0, + "recall": 1.0, + "truePositiveCount": 9, + "trueNegativeCount": 112, + "falsePositiveCount": 0, + "falseNegativeCount": 0 + }, + "SendEmail": { + "f1": 1.0, + "precision": 1.0, + "recall": 1.0, + "truePositiveCount": 20, + "trueNegativeCount": 101, + "falsePositiveCount": 0, + "falseNegativeCount": 0 + }, + "CheckMessages": { + "f1": 1.0, + "precision": 1.0, + "recall": 1.0, + "truePositiveCount": 9, + "trueNegativeCount": 112, + "falsePositiveCount": 0, + "falseNegativeCount": 0 + }, + "AddFlag": { + "f1": 1.0, + "precision": 1.0, + "recall": 1.0, + "truePositiveCount": 6, + "trueNegativeCount": 115, + "falsePositiveCount": 0, + "falseNegativeCount": 0 + }, + "Reply": { + "f1": 1.0, + "precision": 1.0, + "recall": 1.0, + "truePositiveCount": 6, + "trueNegativeCount": 115, + "falsePositiveCount": 0, + "falseNegativeCount": 0 + }, + "ReadAloud": { + "f1": 1.0, + "precision": 1.0, + "recall": 1.0, + "truePositiveCount": 16, + "trueNegativeCount": 105, + "falsePositiveCount": 0, + "falseNegativeCount": 0 + }, + "QueryLastText": { + "f1": 1.0, + "precision": 1.0, + "recall": 1.0, + "truePositiveCount": 6, + "trueNegativeCount": 115, + "falsePositiveCount": 0, + "falseNegativeCount": 0 + }, + "SearchMessages": { + "f1": 1.0, + "precision": 1.0, + "recall": 1.0, + "truePositiveCount": 9, + "trueNegativeCount": 112, + "falsePositiveCount": 0, + "falseNegativeCount": 0 + }, + "Delete": { + "f1": 1.0, + "precision": 1.0, + "recall": 1.0, + "truePositiveCount": 5, + "trueNegativeCount": 116, + "falsePositiveCount": 0, + "falseNegativeCount": 0 + }, + "Forward": { + "f1": 1.0, + "precision": 1.0, + "recall": 1.0, + "truePositiveCount": 6, + "trueNegativeCount": 115, + "falsePositiveCount": 0, + "falseNegativeCount": 0 + }, + "Confirm": { + "f1": 1.0, + "precision": 1.0, + "recall": 1.0, + "truePositiveCount": 4, + "trueNegativeCount": 117, + "falsePositiveCount": 0, + "falseNegativeCount": 0 + }, + "ShowNext": { + "f1": 1.0, + "precision": 1.0, + "recall": 1.0, + "truePositiveCount": 4, + "trueNegativeCount": 117, + "falsePositiveCount": 0, + "falseNegativeCount": 0 + }, + "ShowPrevious": { + "f1": 1.0, + "precision": 1.0, + "recall": 1.0, + "truePositiveCount": 3, + "trueNegativeCount": 118, + "falsePositiveCount": 0, + "falseNegativeCount": 0 + }, + "None": { + "f1": 1.0, + "precision": 1.0, + "recall": 1.0, + "truePositiveCount": 1, + "trueNegativeCount": 120, + "falsePositiveCount": 0, + "falseNegativeCount": 0 + } + }, + "microF1": 1.0, + "microPrecision": 1.0, + "microRecall": 1.0, + "macroF1": 1.0, + "macroPrecision": 1.0, + "macroRecall": 1.0 + }, + "evaluationOptions": { + "kind": "percentage", + "trainingSplitPercentage": 80, + "testingSplitPercentage": 20 + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulGetProject.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulGetProject.json new file mode 100644 index 000000000000..31a17667e0cb --- /dev/null +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulGetProject.json @@ -0,0 +1,26 @@ +{ + "operationId": "ConversationAuthoringProject_GetProject", + "title": "Successful Get Project", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2025-05-15-preview", + "projectName": "myproject" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "createdDateTime": "2022-04-18T13:53:03Z", + "lastModifiedDateTime": "2022-04-18T13:53:03Z", + "lastTrainedDateTime": "2022-04-18T14:14:28Z", + "lastDeployedDateTime": "2022-04-18T14:49:01Z", + "projectKind": "Conversation", + "projectName": "myproject", + "multilingual": false, + "description": "This is a sample conversation project.", + "language": "en" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulGetProjectDeletionStatus.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulGetProjectDeletionStatus.json new file mode 100644 index 000000000000..5182b4338774 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulGetProjectDeletionStatus.json @@ -0,0 +1,22 @@ +{ + "operationId": "ConversationAuthoringProject_GetProjectDeletionStatus", + "title": "Successful Get Project Deletion Status", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2025-05-15-preview", + "jobId": "129d3182-625d-496c-bcf9-43686e85160b_637858368000000000" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "jobId": "129d3182-625d-496c-bcf9-43686e85160b_637858368000000000", + "createdDateTime": "2022-04-18T14:02:34Z", + "lastUpdatedDateTime": "2022-04-18T14:02:34Z", + "expirationDateTime": "2022-04-25T14:02:34Z", + "status": "succeeded" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulGetSupportedLanguages.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulGetSupportedLanguages.json new file mode 100644 index 000000000000..285b8507d662 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulGetSupportedLanguages.json @@ -0,0 +1,400 @@ +{ + "operationId": "ConversationAuthoringListSupportedLanguages", + "title": "Successful Get Supported Languages", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2025-05-15-preview", + "projectKind": "Conversation" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "languageName": "English", + "languageCode": "en" + }, + { + "languageName": "English", + "languageCode": "en-us" + }, + { + "languageName": "English (UK)", + "languageCode": "en-gb" + }, + { + "languageName": "French", + "languageCode": "fr" + }, + { + "languageName": "Italian", + "languageCode": "it" + }, + { + "languageName": "Spanish", + "languageCode": "es" + }, + { + "languageName": "German", + "languageCode": "de" + }, + { + "languageName": "Portuguese (Brazil)", + "languageCode": "pt-br" + }, + { + "languageName": "Portuguese (Portugal)", + "languageCode": "pt-pt" + }, + { + "languageName": "Chinese (Simplified)", + "languageCode": "zh-hans" + }, + { + "languageName": "Japanese", + "languageCode": "ja" + }, + { + "languageName": "Korean", + "languageCode": "ko" + }, + { + "languageName": "Dutch", + "languageCode": "nl" + }, + { + "languageName": "Hindi", + "languageCode": "hi" + }, + { + "languageName": "Turkish", + "languageCode": "tr" + }, + { + "languageName": "Gujarati", + "languageCode": "gu" + }, + { + "languageName": "Marathi", + "languageCode": "mr" + }, + { + "languageName": "Tamil", + "languageCode": "ta" + }, + { + "languageName": "Telugu", + "languageCode": "te" + }, + { + "languageName": "Zulu", + "languageCode": "zu" + }, + { + "languageName": "Afrikaans", + "languageCode": "af" + }, + { + "languageName": "Amharic", + "languageCode": "am" + }, + { + "languageName": "Arabic", + "languageCode": "ar" + }, + { + "languageName": "Assamese", + "languageCode": "as" + }, + { + "languageName": "Azerbaijani", + "languageCode": "az" + }, + { + "languageName": "Belarusian", + "languageCode": "be" + }, + { + "languageName": "Bulgarian", + "languageCode": "bg" + }, + { + "languageName": "Breton", + "languageCode": "br" + }, + { + "languageName": "Bosnian", + "languageCode": "bs" + }, + { + "languageName": "Catalan", + "languageCode": "ca" + }, + { + "languageName": "Czech", + "languageCode": "cs" + }, + { + "languageName": "Welsh", + "languageCode": "cy" + }, + { + "languageName": "Danish", + "languageCode": "da" + }, + { + "languageName": "Greek", + "languageCode": "el" + }, + { + "languageName": "Esperanto", + "languageCode": "eo" + }, + { + "languageName": "Estonian", + "languageCode": "et" + }, + { + "languageName": "Basque", + "languageCode": "eu" + }, + { + "languageName": "Persian", + "languageCode": "fa" + }, + { + "languageName": "Finnish", + "languageCode": "fi" + }, + { + "languageName": "Western Frisian", + "languageCode": "fy" + }, + { + "languageName": "Irish", + "languageCode": "ga" + }, + { + "languageName": "Scottish Gaelic", + "languageCode": "gd" + }, + { + "languageName": "Galician", + "languageCode": "gl" + }, + { + "languageName": "Hausa", + "languageCode": "ha" + }, + { + "languageName": "Hebrew", + "languageCode": "he" + }, + { + "languageName": "Croatian", + "languageCode": "hr" + }, + { + "languageName": "Hungarian", + "languageCode": "hu" + }, + { + "languageName": "Armenian", + "languageCode": "hy" + }, + { + "languageName": "Indonesian", + "languageCode": "id" + }, + { + "languageName": "Javanese", + "languageCode": "jv" + }, + { + "languageName": "Georgian", + "languageCode": "ka" + }, + { + "languageName": "Kazakh", + "languageCode": "kk" + }, + { + "languageName": "Khmer", + "languageCode": "km" + }, + { + "languageName": "Kannada", + "languageCode": "kn" + }, + { + "languageName": "Kurdish (Kurmanji)", + "languageCode": "ku" + }, + { + "languageName": "Kyrgyz", + "languageCode": "ky" + }, + { + "languageName": "Latin", + "languageCode": "la" + }, + { + "languageName": "Lao", + "languageCode": "lo" + }, + { + "languageName": "Lithuanian", + "languageCode": "lt" + }, + { + "languageName": "Latvian", + "languageCode": "lv" + }, + { + "languageName": "Malagasy", + "languageCode": "mg" + }, + { + "languageName": "Macedonian", + "languageCode": "mk" + }, + { + "languageName": "Malayalam", + "languageCode": "ml" + }, + { + "languageName": "Mongolian", + "languageCode": "mn" + }, + { + "languageName": "Malay", + "languageCode": "ms" + }, + { + "languageName": "Burmese", + "languageCode": "my" + }, + { + "languageName": "Nepali", + "languageCode": "ne" + }, + { + "languageName": "Norwegian (Bokmal)", + "languageCode": "nb" + }, + { + "languageName": "Odia", + "languageCode": "or" + }, + { + "languageName": "Punjabi", + "languageCode": "pa" + }, + { + "languageName": "Polish", + "languageCode": "pl" + }, + { + "languageName": "Pashto", + "languageCode": "ps" + }, + { + "languageName": "Romanian", + "languageCode": "ro" + }, + { + "languageName": "Russian", + "languageCode": "ru" + }, + { + "languageName": "Sanskrit", + "languageCode": "sa" + }, + { + "languageName": "Sindhi", + "languageCode": "sd" + }, + { + "languageName": "Sinhala", + "languageCode": "si" + }, + { + "languageName": "Slovak", + "languageCode": "sk" + }, + { + "languageName": "Slovenian", + "languageCode": "sl" + }, + { + "languageName": "Somali", + "languageCode": "so" + }, + { + "languageName": "Albanian", + "languageCode": "sq" + }, + { + "languageName": "Serbian", + "languageCode": "sr" + }, + { + "languageName": "Sundanese", + "languageCode": "su" + }, + { + "languageName": "Swedish", + "languageCode": "sv" + }, + { + "languageName": "Swahili", + "languageCode": "sw" + }, + { + "languageName": "Thai", + "languageCode": "th" + }, + { + "languageName": "Filipino", + "languageCode": "tl" + }, + { + "languageName": "Uyghur", + "languageCode": "ug" + }, + { + "languageName": "Ukrainian", + "languageCode": "uk" + }, + { + "languageName": "Urdu", + "languageCode": "ur" + }, + { + "languageName": "Uzbek", + "languageCode": "uz" + }, + { + "languageName": "Vietnamese", + "languageCode": "vi" + }, + { + "languageName": "Xhosa", + "languageCode": "xh" + }, + { + "languageName": "Yiddish", + "languageCode": "yi" + }, + { + "languageName": "Chinese (Traditional)", + "languageCode": "zh-hant" + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulGetSupportedPrebuiltEntities.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulGetSupportedPrebuiltEntities.json new file mode 100644 index 000000000000..a5665ca9e912 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulGetSupportedPrebuiltEntities.json @@ -0,0 +1,100 @@ +{ + "operationId": "ConversationAuthoringListSupportedPrebuiltEntities", + "title": "Successful Get Supported Prebuilt Entities", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2025-05-15-preview", + "language": "en" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "category": "Person.Name", + "description": "Name of an individual", + "examples": "john, Sam, Lisa" + }, + { + "category": "General.Event", + "description": "Important events", + "examples": "World War two, Covid 19" + }, + { + "category": "General.Organization", + "description": "Companies and corporations", + "examples": "Microsoft, Amazon" + }, + { + "category": "Choice.Boolean", + "description": "boolean choice", + "examples": "yes, no, agreed" + }, + { + "category": "Quantity.Age", + "description": "Age of a person or thing", + "examples": "10-month-old, 19 years old, 58 year-old" + }, + { + "category": "Quantity.NumberRange", + "description": "a numeric interval", + "examples": "between 25 and 35, 25-35" + }, + { + "category": "Quantity.Number", + "description": "A cardinal number in numeric or text form", + "examples": "ten, forty two, 3.141, 10K" + }, + { + "category": "Quantity.Percentage", + "description": "A percentage, using the symbol % or the word \"percent\"", + "examples": "10%, 5.6 percent" + }, + { + "category": "Quantity.Ordinal", + "description": "An ordinal number in numeric or text form", + "examples": "first, second, tenth, 1st, 2nd, 10th" + }, + { + "category": "Quantity.Dimension", + "description": "Spacial dimensions, including length, distance, area, and volume", + "examples": "2 miles, 650 square kilometres, 9,350 feet" + }, + { + "category": "Quantity.Temperature", + "description": "A temperature in celsius or fahrenheit", + "examples": "32F, 34 degrees celsius, 2 deg C" + }, + { + "category": "Quantity.Currency", + "description": "Monetary amounts, including currency", + "examples": "1000.00 US dollars, £20.00, $ 67.5 B" + }, + { + "category": "DateTime", + "description": "exact date values", + "examples": "May 11th" + }, + { + "category": "Email", + "description": "Email addresses", + "examples": "user@example.net, user_name@example.com, user.Name12@example.net" + }, + { + "category": "Phone Number", + "description": "US phone numbers", + "examples": "123-456-7890, +1 123 456 789, (123)456-789" + }, + { + "category": "URL", + "description": "Websites URLs and links", + "examples": "www.example.com, http://example.net?name=my_name&age=10" + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulGetSupportedTrainingConfigVersions.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulGetSupportedTrainingConfigVersions.json new file mode 100644 index 000000000000..ede9a26b0a4d --- /dev/null +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulGetSupportedTrainingConfigVersions.json @@ -0,0 +1,24 @@ +{ + "operationId": "ConversationAuthoringListTrainingConfigVersions", + "title": "Successful Get Supported Training Config Versions", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2025-05-15-preview", + "projectKind": "Conversation" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "trainingConfigVersion": "2022-05-01", + "modelExpirationDate": "2022-10-28" + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulGetSwapDeploymentsStatus.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulGetSwapDeploymentsStatus.json new file mode 100644 index 000000000000..0527074d2585 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulGetSwapDeploymentsStatus.json @@ -0,0 +1,23 @@ +{ + "operationId": "ConversationAuthoringProject_GetSwapDeploymentsStatus", + "title": "Successful Get Swap Deployments Status", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2025-05-15-preview", + "projectName": "EmailApp", + "jobId": "c36a8775-35b9-4cb5-a8db-665e7d91aafe_637858368000000000" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "jobId": "c36a8775-35b9-4cb5-a8db-665e7d91aafe_637858368000000000", + "createdDateTime": "2022-04-18T16:09:50Z", + "lastUpdatedDateTime": "2022-04-18T16:09:58Z", + "expirationDateTime": "2022-04-25T16:09:50Z", + "status": "succeeded" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulGetTrainStatus.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulGetTrainStatus.json new file mode 100644 index 000000000000..8e40c31168e3 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulGetTrainStatus.json @@ -0,0 +1,43 @@ +{ + "operationId": "ConversationAuthoringProject_GetTrainingStatus", + "title": "Successful Get Train Status", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2025-05-15-preview", + "projectName": "EmailApp", + "jobId": "8ccf2ffe-e758-4d04-a44a-31512918c7e8_637858368000000000" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "result": { + "modelLabel": "model1", + "trainingConfigVersion": "2022-05-01", + "trainingMode": "standard", + "estimatedEndDateTime": "2022-04-18T15:47:58.8190649Z", + "trainingStatus": { + "percentComplete": 3, + "startDateTime": "2022-04-18T15:45:06.8190649Z", + "status": "running" + }, + "dataGenerationStatus": { + "percentComplete": 3, + "startDateTime": "2022-04-18T15:45:06.8190649Z", + "status": "running" + }, + "evaluationStatus": { + "percentComplete": 0, + "status": "notStarted" + } + }, + "jobId": "8ccf2ffe-e758-4d04-a44a-31512918c7e8_637858368000000000", + "createdDateTime": "2022-04-18T15:44:44Z", + "lastUpdatedDateTime": "2022-04-18T15:45:48Z", + "expirationDateTime": "2022-04-25T15:44:44Z", + "status": "running" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulGetUnassignDeploymentResourcesStatus.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulGetUnassignDeploymentResourcesStatus.json new file mode 100644 index 000000000000..594e0dd24fd5 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulGetUnassignDeploymentResourcesStatus.json @@ -0,0 +1,23 @@ +{ + "operationId": "ConversationAuthoringProject_GetUnassignDeploymentResourcesStatus", + "title": "Successful Get Unassign Deployment Resources Status", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2025-05-15-preview", + "projectName": "EmailApp", + "jobId": "66fa9a67-a561-42f1-8a13-f3a879b1a324_637858368000000000" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "jobId": "66fa9a67-a561-42f1-8a13-f3a879b1a324_637858368000000000", + "createdDateTime": "2022-04-18T15:52:48Z", + "lastUpdatedDateTime": "2022-04-18T15:53:04Z", + "expirationDateTime": "2022-04-25T15:52:48Z", + "status": "succeeded" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulImportProject.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulImportProject.json new file mode 100644 index 000000000000..77f4b59155c4 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulImportProject.json @@ -0,0 +1,89 @@ +{ + "operationId": "ConversationAuthoringProject_Import", + "title": "Successful Import Project", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2025-05-15-preview", + "projectName": "EmailApp", + "body": { + "projectFileVersion": "2022-05-01", + "stringIndexType": "Utf16CodeUnit", + "metadata": { + "projectKind": "Conversation", + "settings": { + "confidenceThreshold": 0.7 + }, + "projectName": "EmailApp", + "multilingual": true, + "description": "Trying out CLU", + "language": "en-us" + }, + "assets": { + "projectKind": "Conversation", + "intents": [ + { + "category": "Read", + "description": "The read intent", + "associatedEntities": [ + { + "category": "Sender" + } + ] + }, + { + "category": "Delete", + "description": "The delete intent" + } + ], + "entities": [ + { + "category": "Sender", + "description": "The description of Sender" + }, + { + "category": "Number", + "description": "The description of Number", + "regex": { + "expressions": [ + { + "regexKey": "UK Phone numbers", + "language": "en-us", + "regexPattern": "/^\\(?([0-9]{3})\\)?[-.\\s]?([0-9]{3})[-.\\s]?([0-9]{4})$/" + } + ] + } + } + ], + "utterances": [ + { + "text": "Open Blake's email", + "dataset": "Train", + "intent": "Read", + "entities": [ + { + "category": "Sender", + "offset": 5, + "length": 5 + } + ] + }, + { + "text": "Delete last email", + "language": "en-gb", + "dataset": "Test", + "intent": "Delete", + "entities": [] + } + ] + } + } + }, + "responses": { + "202": { + "headers": { + "operation-location": "{Endpoint}/language/authoring/analyze-conversations/projects/EmailApp/import/jobs/4d37982f-fded-4c2c-afe3-15953b5919b6_637858368000000000?api-version=2025-05-15-preview" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulListAssignedResourceDeployments.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulListAssignedResourceDeployments.json new file mode 100644 index 000000000000..f8c1e4b62c8e --- /dev/null +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulListAssignedResourceDeployments.json @@ -0,0 +1,28 @@ +{ + "operationId": "ConversationAuthoringListAssignedResourceDeployments", + "title": "Successful List Assigned Resource Deployments", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2025-05-15-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "projectName": "Booking", + "deploymentsMetadata": [ + { + "deploymentName": "staging", + "lastDeployedDateTime": "2022-04-18T14:49:01Z", + "deploymentExpirationDate": "2023-10-28" + } + ] + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulListDeploymentResources.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulListDeploymentResources.json new file mode 100644 index 000000000000..8400b97522c6 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulListDeploymentResources.json @@ -0,0 +1,27 @@ +{ + "operationId": "ConversationAuthoringListDeploymentResources", + "title": "Successful List Deployment Resources", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2025-05-15-preview", + "projectName": "EmailApp" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "azureResourceId": "/subscriptions/8ff19748-59ed-4e8a-af4b-7ce285849735/resourceGroups/test-rg/providers/Microsoft.CognitiveServices/accounts/LangTestWeu", + "region": "westeurope" + }, + { + "azureResourceId": "/subscriptions/8ff19748-59ed-4e8a-af4b-7ce285849735/resourceGroups/test-rg/providers/Microsoft.CognitiveServices/accounts/LangTestEus", + "region": "eastus" + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulListDeployments.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulListDeployments.json new file mode 100644 index 000000000000..dd4350fff5ec --- /dev/null +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulListDeployments.json @@ -0,0 +1,61 @@ +{ + "operationId": "ConversationAuthoringListDeployments", + "title": "Successful List Deployments", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2025-05-15-preview", + "projectName": "EmailApp" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "deploymentName": "production", + "modelId": "model1-20220418T034749-299f45b8114849538c1a750b21b05a94", + "lastTrainedDateTime": "2022-04-18T15:47:49.4334381Z", + "lastDeployedDateTime": "2022-04-18T16:03:51Z", + "deploymentExpirationDate": "2023-10-28", + "modelTrainingConfigVersion": "2022-05-01", + "assignedResources": [ + { + "resourceId": "/subscriptions/8ff19748-59ed-4e8a-af4b-7ce285849735/resourceGroups/test-rg/providers/Microsoft.CognitiveServices/accounts/LangTestWeu", + "region": "westeurope", + "assignedAoaiResource": { + "kind": "AzureOpenAI", + "resourceId": "/subscriptions/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/resourceGroups/resource-group-name/providers/Microsoft.CognitiveServices/accounts/aoai-account-name", + "deploymentName": "model-deployment-name" + } + }, + { + "resourceId": "/subscriptions/8ff19748-59ed-4e8a-af4b-7ce285849735/resourceGroups/test-rg/providers/Microsoft.CognitiveServices/accounts/LangTestEus", + "region": "eastus", + "assignedAoaiResource": { + "kind": "AzureOpenAI", + "resourceId": "/subscriptions/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/resourceGroups/resource-group-name/providers/Microsoft.CognitiveServices/accounts/aoai-account-name", + "deploymentName": "model-deployment-name" + } + } + ] + }, + { + "deploymentName": "staging", + "modelId": "model1-20220418T034749-299f45b8114849538c1a750b21b05a94", + "lastTrainedDateTime": "2022-04-18T15:47:49.4334381Z", + "lastDeployedDateTime": "2022-04-18T15:53:04Z", + "deploymentExpirationDate": "2023-10-28", + "modelTrainingConfigVersion": "2022-05-01", + "assignedResources": [ + { + "resourceId": "/subscriptions/8ff19748-59ed-4e8a-af4b-7ce285849735/resourceGroups/test-rg/providers/Microsoft.CognitiveServices/accounts/LangTestWeu", + "region": "westeurope" + } + ] + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulListExportedModels.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulListExportedModels.json new file mode 100644 index 000000000000..d856f152cd96 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulListExportedModels.json @@ -0,0 +1,36 @@ +{ + "operationId": "ConversationAuthoringListExportedModels", + "title": "Successful List Exported Models", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2025-05-15-preview", + "projectName": "LoanAgreements" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "exportedModelName": "exported-model1", + "modelId": "model1-20220418T034749-299f45b8114849538c1a750b21b05a94", + "lastTrainedDateTime": "2023-04-18T15:47:49Z", + "lastExportedModelDateTime": "2023-04-18T16:03:51Z", + "modelExpirationDate": "2023-10-28", + "modelTrainingConfigVersion": "2022-05-01" + }, + { + "exportedModelName": "exported-model2", + "modelId": "model2-20220418T052522-c63bd244dd9e4bf8adec1a7129968c99", + "lastTrainedDateTime": "2023-04-18T17:25:22Z", + "lastExportedModelDateTime": "2023-04-18T16:03:51Z", + "modelExpirationDate": "2023-10-28", + "modelTrainingConfigVersion": "2022-05-01" + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulListModels.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulListModels.json new file mode 100644 index 000000000000..96808b9bcdad --- /dev/null +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulListModels.json @@ -0,0 +1,38 @@ +{ + "operationId": "ConversationAuthoringListTrainedModels", + "title": "Successful List Models", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2025-05-15-preview", + "projectName": "EmailApp" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "label": "model1", + "modelId": "model1-20220418T034749-299f45b8114849538c1a750b21b05a94", + "lastTrainedDateTime": "2022-04-18T15:47:49Z", + "lastTrainingDurationInSeconds": 186, + "modelExpirationDate": "2022-10-28", + "modelTrainingConfigVersion": "2022-05-01", + "hasSnapshot": true + }, + { + "label": "model2", + "modelId": "model2-20220418T052522-c63bd244dd9e4bf8adec1a7129968c99", + "lastTrainedDateTime": "2022-04-18T17:25:22Z", + "lastTrainingDurationInSeconds": 192, + "modelExpirationDate": "2022-10-28", + "modelTrainingConfigVersion": "2022-05-01", + "hasSnapshot": true + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulListProjects.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulListProjects.json new file mode 100644 index 000000000000..502463b4f035 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulListProjects.json @@ -0,0 +1,37 @@ +{ + "operationId": "ConversationAuthoringListProjects", + "title": "Successful List Projects", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2025-05-15-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "createdDateTime": "2022-04-18T14:03:16Z", + "lastModifiedDateTime": "2022-04-18T14:03:16Z", + "projectKind": "Conversation", + "projectName": "myproject1", + "multilingual": false, + "description": "This is a sample conversation project.", + "language": "en" + }, + { + "createdDateTime": "2022-04-18T14:03:12Z", + "lastModifiedDateTime": "2022-04-18T14:03:12Z", + "projectKind": "Conversation", + "projectName": "myproject", + "multilingual": false, + "description": "This is a sample conversation project.", + "language": "en" + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulListTrainingJobs.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulListTrainingJobs.json new file mode 100644 index 000000000000..f43ed77250a2 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulListTrainingJobs.json @@ -0,0 +1,110 @@ +{ + "operationId": "ConversationAuthoringListTrainingJobs", + "title": "Successful List Training Jobs", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2025-05-15-preview", + "projectName": "EmailApp" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "result": { + "modelLabel": "model1", + "trainingConfigVersion": "2022-05-01", + "trainingMode": "advanced", + "trainingStatus": { + "percentComplete": 100, + "startDateTime": "2022-04-18T15:45:06.8190649Z", + "endDateTime": "2022-04-18T15:47:19.2639682Z", + "status": "succeeded" + }, + "dataGenerationStatus": { + "percentComplete": 100, + "startDateTime": "2022-04-18T15:45:06.8190649Z", + "endDateTime": "2022-04-18T15:47:19.2639682Z", + "status": "succeeded" + }, + "evaluationStatus": { + "percentComplete": 100, + "startDateTime": "2022-04-18T15:47:19.2734976Z", + "endDateTime": "2022-04-18T15:47:23.8378892Z", + "status": "succeeded" + } + }, + "jobId": "8ccf2ffe-e758-4d04-a44a-31512918c7e8_637858368000000000", + "createdDateTime": "2022-04-18T15:44:44Z", + "lastUpdatedDateTime": "2022-04-18T15:47:50Z", + "expirationDateTime": "2022-04-25T15:44:44Z", + "status": "succeeded" + }, + { + "result": { + "modelLabel": "model2", + "trainingConfigVersion": "2022-05-01", + "trainingMode": "standard", + "trainingStatus": { + "percentComplete": 100, + "startDateTime": "2022-04-18T17:22:39.3663023Z", + "endDateTime": "2022-04-18T17:24:51.9440947Z", + "status": "succeeded" + }, + "dataGenerationStatus": { + "percentComplete": 100, + "startDateTime": "2022-04-18T15:45:06.8190649Z", + "endDateTime": "2022-04-18T15:47:19.2639682Z", + "status": "succeeded" + }, + "evaluationStatus": { + "percentComplete": 100, + "startDateTime": "2022-04-18T17:24:51.9571747Z", + "endDateTime": "2022-04-18T17:24:58.1427823Z", + "status": "succeeded" + } + }, + "jobId": "9145f93f-6f37-418c-8527-d2ded84cece0_637858368000000000", + "createdDateTime": "2022-04-18T17:22:11Z", + "lastUpdatedDateTime": "2022-04-18T17:25:23Z", + "expirationDateTime": "2022-04-25T17:22:11Z", + "status": "succeeded" + }, + { + "result": { + "modelLabel": "model2", + "trainingConfigVersion": "2022-05-01", + "trainingMode": "standard", + "trainingStatus": { + "percentComplete": 100, + "startDateTime": "2022-04-18T17:44:41.388358Z", + "endDateTime": "2022-04-18T17:50:29.5675101Z", + "status": "succeeded" + }, + "dataGenerationStatus": { + "percentComplete": 100, + "startDateTime": "2022-04-18T15:45:06.8190649Z", + "endDateTime": "2022-04-18T15:47:19.2639682Z", + "status": "succeeded" + }, + "evaluationStatus": { + "percentComplete": 100, + "startDateTime": "2022-04-18T17:50:29.5808461Z", + "endDateTime": "2022-04-18T17:50:35.3482185Z", + "status": "succeeded" + } + }, + "jobId": "ee23c900-354d-4b6d-96e1-8197db2bd5f7_637858368000000000", + "createdDateTime": "2022-04-18T17:44:04Z", + "lastUpdatedDateTime": "2022-04-18T17:51:11Z", + "expirationDateTime": "2022-04-25T17:44:04Z", + "status": "succeeded" + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulLoadSnapshot.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulLoadSnapshot.json new file mode 100644 index 000000000000..3075f64097de --- /dev/null +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulLoadSnapshot.json @@ -0,0 +1,18 @@ +{ + "operationId": "ConversationAuthoringTrainedModel_LoadSnapshot", + "title": "Successful Load Snapshot", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2025-05-15-preview", + "projectName": "EmailApp", + "trainedModelLabel": "model1" + }, + "responses": { + "202": { + "headers": { + "operation-location": "{Endpoint}/language/authoring/analyze-conversations/projects/EmailApp/models/model1/load-snapshot/jobs/4d37982f-fded-4c2c-afe3-15953b5919b6_637858368000000000?api-version=2025-05-15-preview" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulSwapDeployments.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulSwapDeployments.json new file mode 100644 index 000000000000..d36d0e0f5204 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulSwapDeployments.json @@ -0,0 +1,21 @@ +{ + "operationId": "ConversationAuthoringProject_SwapDeployments", + "title": "Successful Swap Deployments", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2025-05-15-preview", + "projectName": "EmailApp", + "body": { + "firstDeploymentName": "production", + "secondDeploymentName": "staging" + } + }, + "responses": { + "202": { + "headers": { + "operation-location": "{Endpoint}/language/authoring/analyze-conversations/projects/EmailApp/deployments/swap/jobs/c36a8775-35b9-4cb5-a8db-665e7d91aafe_637858368000000000?api-version=2025-05-15-preview" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulTrainProject.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulTrainProject.json new file mode 100644 index 000000000000..ee6f4e1fb8d3 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulTrainProject.json @@ -0,0 +1,35 @@ +{ + "operationId": "ConversationAuthoringProject_Train", + "title": "Successful Train Project", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2025-05-15-preview", + "projectName": "EmailApp", + "body": { + "modelLabel": "model1", + "trainingMode": "standard", + "trainingConfigVersion": "latest", + "evaluationOptions": { + "kind": "percentage", + "testingSplitPercentage": 20, + "trainingSplitPercentage": 80 + }, + "dataGenerationSettings": { + "enableDataGeneration": true, + "dataGenerationConnectionInfo": { + "kind": "AzureOpenAI", + "resourceId": "/subscriptions/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/resourceGroups/resource-group-name/providers/Microsoft.CognitiveServices/accounts/aoai-account-name", + "deploymentName": "model-deployment-name" + } + } + } + }, + "responses": { + "202": { + "headers": { + "operation-location": "{Endpoint}/language/authoring/analyze-conversations/projects/EmailApp/train/jobs/4d37982f-fded-4c2c-afe3-15953b5919b6_637858368000000000?api-version=2025-05-15-preview" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulUnassignDeploymentResources.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulUnassignDeploymentResources.json new file mode 100644 index 000000000000..bf386aeb0d09 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulUnassignDeploymentResources.json @@ -0,0 +1,23 @@ +{ + "operationId": "ConversationAuthoringProject_UnassignDeploymentResources", + "title": "Successful Unassign Deployment Resources", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2025-05-15-preview", + "projectName": "EmailApp", + "deploymentName": "production", + "body": { + "assignedResourceIds": [ + "/subscriptions/8ff19748-59ed-4e8a-af4b-7ce285849735/resourceGroups/test-rg/providers/Microsoft.CognitiveServices/accounts/LangTestWeu" + ] + } + }, + "responses": { + "202": { + "headers": { + "operation-location": "{Endpoint}/language/authoring/analyze-conversations/projects/EmailApp/resources/unassign/jobs/66fa9a67-a561-42f1-8a13-f3a879b1a324_637858368000000000?api-version=2025-05-15-preview" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/readme.md b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/readme.md index a0b9a7e45320..4b60dc87d3d0 100644 --- a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/readme.md +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/readme.md @@ -51,6 +51,19 @@ modelerfour: lenient-model-deduplication: true ``` +### Release 2025-05-15-preview + +These settings apply only when `--tag=release_2025-05-15-preview` is specified on the command line. + +``` yaml $(tag) == 'release_2025-05-15-preview' +input-file: + - preview/2025-05-15-preview/analyzeconversations-authoring.json +title: + Microsoft Cognitive Language Service - Conversations Authoring +modelerfour: + lenient-model-deduplication: true +``` + ### Release 2023-04-01 These settings apply only when `--tag=release_2023-04-01` is specified on the command line. diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/routes.tsp b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/routes.tsp index d9c22a0f3388..8371893af780 100644 --- a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/routes.tsp +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/routes.tsp @@ -67,6 +67,14 @@ op conversationAuthoringListAssignedResourceDeployments is languageOperations.Re */ #suppress "@azure-tools/typespec-azure-core/use-standard-names" @added(Versions.v2025_11_01) +@renamedFrom( + Versions.v2025_05_15_preview, + "conversationAuthoringListProjectResources" +) +@renamedFrom( + Versions.v2025_11_15_preview, + "ConversationAuthoringListDeploymentResources" +) op conversationAuthoringListProjectResources is languageOperations.ResourceList< AnalyzeConversationAuthoringProjectResourceInfo, ListQueryParametersTrait @@ -114,7 +122,7 @@ op conversationAuthoringListTrainedModels is languageOperations.ResourceList< * Lists the exported models belonging to a project. */ #suppress "@azure-tools/typespec-azure-core/use-standard-names" -@added(Versions.v2025_11_15_preview) +@added(Versions.v2025_05_15_preview) op conversationAuthoringListExportedModels is languageOperations.ResourceList< AnalyzeConversationAuthoringExportedTrainedModel, ListQueryParametersTrait @@ -221,6 +229,14 @@ interface ConversationAuthoringDeployment { */ @body @clientName("details", "csharp") + @typeChangedFrom( + Versions.v2025_05_15_preview, + AnalyzeConversationAuthoringProjectAzureResourceIds + ) + @typeChangedFrom( + Versions.v2025_11_15_preview, + AnalyzeConversationAuthoringDeleteDeploymentOptions + ) body: AnalyzeConversationAuthoringProjectAzureResourceIds; }, AcceptedResponse, @@ -252,6 +268,8 @@ interface ConversationAuthoringProject { ) @access(Access.internal, "python") @added(Versions.v2025_11_01) + @renamedFrom(Versions.v2025_05_15_preview, "assignProjectResources") + @renamedFrom(Versions.v2025_11_15_preview, "AssignDeploymentResources") assignProjectResources is Foundations.LongRunningOperation< { /** @@ -284,6 +302,8 @@ interface ConversationAuthoringProject { ) @access(Access.internal, "python") @added(Versions.v2025_11_01) + @renamedFrom(Versions.v2025_05_15_preview, "unassignProjectResources") + @renamedFrom(Versions.v2025_11_15_preview, "unassignDeploymentResources") unassignProjectResources is Foundations.LongRunningOperation< { /** @@ -298,6 +318,14 @@ interface ConversationAuthoringProject { */ @body @clientName("details", "csharp") + @typeChangedFrom( + Versions.v2025_05_15_preview, + AnalyzeConversationAuthoringProjectAzureResourceIds + ) + @typeChangedFrom( + Versions.v2025_11_15_preview, + AnalyzeConversationAuthoringUnassignDeploymentResourcesOptions + ) body: AnalyzeConversationAuthoringProjectAzureResourceIds; }, AcceptedResponse, @@ -309,6 +337,11 @@ interface ConversationAuthoringProject { * Gets the status of an existing assign project resources job. */ @added(Versions.v2025_11_01) + @renamedFrom(Versions.v2025_05_15_preview, "getAssignProjectResourcesStatus") + @renamedFrom( + Versions.v2025_11_15_preview, + "getAssignDeploymentResourcesStatus" + ) getAssignProjectResourcesStatus is languageOperations.ResourceRead; /** @@ -318,6 +351,14 @@ interface ConversationAuthoringProject { @route("/authoring/analyze-conversations/projects/{projectName}/resources/unassign/jobs/{jobId}") @get @added(Versions.v2025_11_01) + @renamedFrom( + Versions.v2025_05_15_preview, + "getUnassignProjectResourcesStatus" + ) + @renamedFrom( + Versions.v2025_11_15_preview, + "getUnassignDeploymentResourcesStatus" + ) getUnassignProjectResourcesStatus is Azure.Core.Foundations.Operation< { /** @@ -535,7 +576,7 @@ interface ConversationAuthoringProject { */ #suppress "@azure-tools/typespec-azure-core/casing-style" @post - @added(Versions.v2025_11_15_preview) + @added(Versions.v2025_05_15_preview) @actionSeparator("/:") @action("authorize-copy") copyProjectAuthorization is languageOperations.ResourceAction< @@ -552,7 +593,7 @@ interface ConversationAuthoringProject { @post @pollingOperation(ConversationAuthoringProject.getCopyProjectStatus) @access(Access.internal, "python") - @added(Versions.v2025_11_15_preview) + @added(Versions.v2025_05_15_preview) copyProject is Foundations.LongRunningOperation< { /** @@ -577,7 +618,7 @@ interface ConversationAuthoringProject { /** * Gets the status of an existing copy project job. */ - @added(Versions.v2025_11_15_preview) + @added(Versions.v2025_05_15_preview) getCopyProjectStatus is languageOperations.ResourceRead; /** @@ -645,7 +686,7 @@ interface ConversationAuthoringExportedModel { /** * Gets the details of an exported model. */ - @added(Versions.v2025_11_15_preview) + @added(Versions.v2025_05_15_preview) getExportedModel is languageOperations.ResourceRead; /** @@ -657,7 +698,7 @@ interface ConversationAuthoringExportedModel { @pollingOperation( ConversationAuthoringExportedModel.getExportedModelJobStatus ) - @added(Versions.v2025_11_15_preview) + @added(Versions.v2025_05_15_preview) @access(Access.internal, "python") deleteExportedModel is Foundations.LongRunningOperation< { @@ -686,7 +727,7 @@ interface ConversationAuthoringExportedModel { @pollingOperation( ConversationAuthoringExportedModel.getExportedModelJobStatus ) - @added(Versions.v2025_11_15_preview) + @added(Versions.v2025_05_15_preview) @access(Access.internal, "python") createOrUpdateExportedModel is Foundations.LongRunningOperation< { @@ -716,7 +757,7 @@ interface ConversationAuthoringExportedModel { /** * Gets the status for an existing job to create or update an exported model. */ - @added(Versions.v2025_11_15_preview) + @added(Versions.v2025_05_15_preview) getExportedModelJobStatus is languageOperations.ResourceRead; } interface ConversationAuthoringTrainedModel { @@ -737,7 +778,7 @@ interface ConversationAuthoringTrainedModel { @route("/authoring/analyze-conversations/projects/{projectName}/models/{trainedModelLabel}/:evaluate") @post @pollingOperation(ConversationAuthoringTrainedModel.getEvaluationStatus) - @added(Versions.v2025_11_15_preview) + @added(Versions.v2025_05_15_preview) evaluateModel is Foundations.LongRunningOperation< { /** @@ -795,7 +836,7 @@ interface ConversationAuthoringTrainedModel { /** * Gets the status for an evaluation job. */ - @added(Versions.v2025_11_15_preview) + @added(Versions.v2025_05_15_preview) getEvaluationStatus is languageOperations.ResourceRead; /** diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeText/examples/2025-05-15-preview/SuccessfulAbstractiveSummarizationSummaryLengthPromptTaskResult.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeText/examples/2025-05-15-preview/SuccessfulAbstractiveSummarizationSummaryLengthPromptTaskResult.json new file mode 100644 index 000000000000..0aa480cacbde --- /dev/null +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeText/examples/2025-05-15-preview/SuccessfulAbstractiveSummarizationSummaryLengthPromptTaskResult.json @@ -0,0 +1,58 @@ +{ + "operationId": "AnalyzeTextJobStatus", + "title": "SuccessfulAbstractiveSummarizationSummaryLengthPromptTaskResult", + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2025-05-15-preview", + "Endpoint": "{Endpoint}", + "jobId": "c0f2a446-05d9-48fc-ba8f-3ef4af8d0b18" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "createdDateTime": "2020-10-01T15:00:45Z", + "displayName": "Document Abstractive Summarization Task Example", + "expirationDateTime": "2020-10-03T15:01:03Z", + "jobId": "c0f2a446-05d9-48fc-ba8f-3ef4af8d0b18", + "lastUpdatedDateTime": "2020-10-01T15:01:03Z", + "status": "succeeded", + "tasks": { + "completed": 1, + "failed": 0, + "inProgress": 0, + "total": 1, + "items": [ + { + "kind": "AbstractiveSummarizationLROResults", + "taskName": "Document Abstractive Summarization Task 1", + "lastUpdateDateTime": "2020-10-01T15:01:03Z", + "status": "succeeded", + "results": { + "documents": [ + { + "summaries": [ + { + "text": "XYZ-code is a joint representation of human cognition and language, which Microsoft aims to develop for cross-domain transfer learning. Learn how XYz-code can help Microsoft achieve cross-sensory and multilingual learning with human-centric approach.", + "contexts": [ + { + "offset": 0, + "length": 1619 + } + ] + } + ], + "id": "1", + "warnings": [] + } + ], + "errors": [], + "modelVersion": "latest" + } + } + ] + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeText/examples/2025-05-15-preview/SuccessfulAbstractiveSummarizationSummaryLengthPromptTaskSubmit.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeText/examples/2025-05-15-preview/SuccessfulAbstractiveSummarizationSummaryLengthPromptTaskSubmit.json new file mode 100644 index 000000000000..754dee836340 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeText/examples/2025-05-15-preview/SuccessfulAbstractiveSummarizationSummaryLengthPromptTaskSubmit.json @@ -0,0 +1,39 @@ +{ + "operationId": "AnalyzeTextSubmitJob", + "title": "SuccessfulAbstractiveSummarizationSummaryLengthPromptTaskSubmit", + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2025-05-15-preview", + "Endpoint": "{Endpoint}", + "jobId": "{Job ID}", + "body": { + "displayName": "Document Abstractive Summarization Task Example", + "analysisInput": { + "documents": [ + { + "id": "1", + "language": "en", + "text": "At Microsoft, we have been on a quest to advance AI beyond existing techniques, by taking a more holistic, human-centric approach to learning and understanding. As Chief Technology Officer of Azure AI Cognitive Services, I have been working with a team of amazing scientists and engineers to turn this quest into a reality. In my role, I enjoy a unique perspective in viewing the relationship among three attributes of human cognition: monolingual text (X), audio or visual sensory signals, (Y) and multilingual (Z). At the intersection of all three, there is magic—what we call XYZ-code as illustrated in Figure 1—a joint representation to create more powerful AI that can speak, hear, see, and understand humans better. We believe XYZ-code will enable us to fulfill our long-term vision: cross-domain transfer learning, spanning modalities and languages. The goal is to have pre-trained models that can jointly learn representations to support a broad range of downstream AI tasks, much in the way humans do today. Over the past five years, we have achieved human performance on benchmarks in conversational speech recognition, machine translation, conversational question answering, machine reading comprehension, and image captioning. These five breakthroughs provided us with strong signals toward our more ambitious aspiration to produce a leap in AI capabilities, achieving multi-sensory and multilingual learning that is closer in line with how humans learn and understand. I believe the joint XYZ-code is a foundational component of this aspiration, if grounded with external knowledge sources in the downstream AI tasks." + } + ] + }, + "tasks": [ + { + "kind": "AbstractiveSummarization", + "taskName": "Document Abstractive Summarization Task 1", + "parameters": { + "summaryLength": "medium", + "instruction": "XYZ-code" + } + } + ] + } + }, + "responses": { + "202": { + "headers": { + "Operation-Location": "{endpoint}/language/analyze-text/jobs/{jobId}?api-version=2025-05-15-preview" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeText/examples/2025-05-15-preview/SuccessfulAbstractiveSummarizationTaskResult.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeText/examples/2025-05-15-preview/SuccessfulAbstractiveSummarizationTaskResult.json new file mode 100644 index 000000000000..41581ae7d7d8 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeText/examples/2025-05-15-preview/SuccessfulAbstractiveSummarizationTaskResult.json @@ -0,0 +1,58 @@ +{ + "operationId": "AnalyzeTextJobStatus", + "title": "SuccessfulAbstractiveSummarizationTaskResult", + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2025-05-15-preview", + "Endpoint": "{Endpoint}", + "jobId": "c0f2a446-05d9-48fc-ba8f-3ef4af8d0b18" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "createdDateTime": "2020-10-01T15:00:45Z", + "displayName": "Document Abstractive Summarization Task Example", + "expirationDateTime": "2020-10-03T15:01:03Z", + "jobId": "c0f2a446-05d9-48fc-ba8f-3ef4af8d0b18", + "lastUpdatedDateTime": "2020-10-01T15:01:03Z", + "status": "succeeded", + "tasks": { + "completed": 1, + "failed": 0, + "inProgress": 0, + "total": 1, + "items": [ + { + "kind": "AbstractiveSummarizationLROResults", + "taskName": "Document Abstractive Summarization Task 1", + "lastUpdateDateTime": "2020-10-01T15:01:03Z", + "status": "succeeded", + "results": { + "documents": [ + { + "summaries": [ + { + "text": "Microsoft have been on a quest to advance AI beyond existing techniques.", + "contexts": [ + { + "offset": 0, + "length": 1629 + } + ] + } + ], + "id": "1", + "warnings": [] + } + ], + "errors": [], + "modelVersion": "latest" + } + } + ] + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeText/examples/2025-05-15-preview/SuccessfulAbstractiveSummarizationTaskSubmit.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeText/examples/2025-05-15-preview/SuccessfulAbstractiveSummarizationTaskSubmit.json new file mode 100644 index 000000000000..74cf057dcbc1 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeText/examples/2025-05-15-preview/SuccessfulAbstractiveSummarizationTaskSubmit.json @@ -0,0 +1,38 @@ +{ + "operationId": "AnalyzeTextSubmitJob", + "title": "SuccessfulAbstractiveSummarizationTaskSubmit", + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2025-05-15-preview", + "Endpoint": "{Endpoint}", + "jobId": "{Job ID}", + "body": { + "displayName": "Document Abstractive Summarization Task Example", + "analysisInput": { + "documents": [ + { + "id": "1", + "language": "en", + "text": "At Microsoft, we have been on a quest to advance AI beyond existing techniques, by taking a more holistic, human-centric approach to learning and understanding. As Chief Technology Officer of Azure AI Cognitive Services, I have been working with a team of amazing scientists and engineers to turn this quest into a reality. In my role, I enjoy a unique perspective in viewing the relationship among three attributes of human cognition: monolingual text (X), audio or visual sensory signals, (Y) and multilingual (Z). At the intersection of all three, there is magic—what we call XYZ-code as illustrated in Figure 1—a joint representation to create more powerful AI that can speak, hear, see, and understand humans better. We believe XYZ-code will enable us to fulfill our long-term vision: cross-domain transfer learning, spanning modalities and languages. The goal is to have pre-trained models that can jointly learn representations to support a broad range of downstream AI tasks, much in the way humans do today. Over the past five years, we have achieved human performance on benchmarks in conversational speech recognition, machine translation, conversational question answering, machine reading comprehension, and image captioning. These five breakthroughs provided us with strong signals toward our more ambitious aspiration to produce a leap in AI capabilities, achieving multi-sensory and multilingual learning that is closer in line with how humans learn and understand. I believe the joint XYZ-code is a foundational component of this aspiration, if grounded with external knowledge sources in the downstream AI tasks." + } + ] + }, + "tasks": [ + { + "kind": "AbstractiveSummarization", + "taskName": "Document Abstractive Summarization Task 1", + "parameters": { + "sentenceCount": 1 + } + } + ] + } + }, + "responses": { + "202": { + "headers": { + "Operation-Location": "{endpoint}/language/analyze-text/jobs/{jobId}?api-version=2025-05-15-preview" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeText/examples/2025-05-15-preview/SuccessfulAnalyzeTextJobsCancelRequest.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeText/examples/2025-05-15-preview/SuccessfulAnalyzeTextJobsCancelRequest.json new file mode 100644 index 000000000000..13ad6a087245 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeText/examples/2025-05-15-preview/SuccessfulAnalyzeTextJobsCancelRequest.json @@ -0,0 +1,17 @@ +{ + "operationId": "AnalyzeTextCancelJob", + "title": "SuccessfulAnalyzeTextJobsCancelRequest", + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2025-05-15-preview", + "Endpoint": "{Endpoint}", + "jobId": "c0f2a446-05d9-48fc-ba8f-3ef4af8d0b18" + }, + "responses": { + "202": { + "headers": { + "Operation-Location": "{Endpoint}/language/analyze-text/jobs/{jobId}?api-version=2023-11-15-preview" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeText/examples/2025-05-15-preview/SuccessfulAnalyzeTextJobsMultipleTaskStatusRequest.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeText/examples/2025-05-15-preview/SuccessfulAnalyzeTextJobsMultipleTaskStatusRequest.json new file mode 100644 index 000000000000..eec46a940eaa --- /dev/null +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeText/examples/2025-05-15-preview/SuccessfulAnalyzeTextJobsMultipleTaskStatusRequest.json @@ -0,0 +1,180 @@ +{ + "operationId": "AnalyzeTextJobStatus", + "title": "SuccessfulAnalyzeTextJobsMultipleTaskStatusRequest", + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2025-05-15-preview", + "Endpoint": "{Endpoint}", + "jobId": "c0f2a446-05d9-48fc-ba8f-3ef4af8d0b18" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "createdDateTime": "2020-10-01T15:00:45Z", + "displayName": "Extracting Location & US Region", + "expirationDateTime": "2020-10-03T15:01:03Z", + "jobId": "c0f2a446-05d9-48fc-ba8f-3ef4af8d0b18", + "lastUpdatedDateTime": "2020-10-01T15:01:03Z", + "status": "succeeded", + "tasks": { + "completed": 2, + "failed": 0, + "inProgress": 0, + "total": 2, + "items": [ + { + "kind": "EntityRecognitionLROResults", + "taskName": "Recognize Entities", + "lastUpdateDateTime": "2020-10-01T15:01:03Z", + "status": "succeeded", + "results": { + "documents": [ + { + "entities": [ + { + "category": "Event", + "type": "Event", + "confidenceScore": 0.61, + "length": 4, + "offset": 18, + "text": "trip", + "tags": [ + { + "name": "Event", + "confidenceScore": 0.61 + } + ] + }, + { + "category": "Location", + "type": "GPE", + "confidenceScore": 0.82, + "length": 7, + "offset": 26, + "tags": [ + { + "name": "Location", + "confidenceScore": 0.82 + }, + { + "name": "GPE", + "confidenceScore": 0.82 + } + ], + "text": "Seattle" + }, + { + "category": "Temporal", + "type": "DateRange", + "confidenceScore": 0.8, + "length": 9, + "offset": 34, + "text": "last week", + "tags": [ + { + "name": "DateRange", + "confidenceScore": 0.8 + }, + { + "name": "Temporal", + "confidenceScore": 0.8 + } + ] + } + ], + "id": "1", + "warnings": [] + }, + { + "entities": [ + { + "category": "Location", + "type": "GPE", + "confidenceScore": 0.52, + "length": 3, + "offset": 14, + "text": "NYC", + "tags": [ + { + "name": "Location", + "confidenceScore": 0.82 + }, + { + "name": "GPE", + "confidenceScore": 0.82 + } + ] + }, + { + "category": "Temporal", + "type": "Date", + "confidenceScore": 0.8, + "length": 8, + "offset": 18, + "text": "tomorrow", + "tags": [ + { + "name": "Date", + "confidenceScore": 0.8 + }, + { + "name": "Temporal", + "confidenceScore": 0.8 + } + ] + } + ], + "id": "2", + "warnings": [] + } + ], + "errors": [], + "modelVersion": "2020-04-01" + } + }, + { + "kind": "CustomEntityRecognitionLROResults", + "taskName": "Recognize US Regions", + "lastUpdateDateTime": "2020-10-01T15:01:03Z", + "status": "succeeded", + "results": { + "documents": [ + { + "entities": [ + { + "category": "USRegion", + "confidenceScore": 0.85, + "length": 17, + "offset": 45, + "text": "Pacific Northwest" + } + ], + "id": "1", + "warnings": [] + }, + { + "entities": [ + { + "category": "USRegion", + "confidenceScore": 0.88, + "length": 10, + "offset": 63, + "text": "East Coast" + } + ], + "id": "2", + "warnings": [] + } + ], + "errors": [], + "projectName": "MyProject", + "deploymentName": "MyDeployment" + } + } + ] + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeText/examples/2025-05-15-preview/SuccessfulAnalyzeTextJobsMultipleTaskSubmitRequest.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeText/examples/2025-05-15-preview/SuccessfulAnalyzeTextJobsMultipleTaskSubmitRequest.json new file mode 100644 index 000000000000..8da4921853e8 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeText/examples/2025-05-15-preview/SuccessfulAnalyzeTextJobsMultipleTaskSubmitRequest.json @@ -0,0 +1,51 @@ +{ + "operationId": "AnalyzeTextSubmitJob", + "title": "SuccessfulAnalyzeTextJobsMultipleTaskSubmitRequest", + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2025-05-15-preview", + "Endpoint": "{Endpoint}", + "jobId": "{Job ID}", + "body": { + "displayName": "Extracting Location & US Region", + "analysisInput": { + "documents": [ + { + "id": "1", + "language": "en", + "text": "I had a wonderful trip to Seattle last week." + }, + { + "id": "2", + "language": "en", + "text": "I'm flying to NYC tomorrow. See you there." + } + ] + }, + "tasks": [ + { + "kind": "EntityRecognition", + "taskName": "Recognize Entities", + "parameters": { + "modelVersion": "latest" + } + }, + { + "kind": "CustomEntityRecognition", + "taskName": "Recognize US Regions", + "parameters": { + "projectName": "MyProject", + "deploymentName": "MyDeployment" + } + } + ] + } + }, + "responses": { + "202": { + "headers": { + "Operation-Location": "{endpoint}/language/analyze-text/jobs/{jobId}?api-version=2025-05-15-preview" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeText/examples/2025-05-15-preview/SuccessfulEntityLinkingRequest.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeText/examples/2025-05-15-preview/SuccessfulEntityLinkingRequest.json new file mode 100644 index 000000000000..12939588e3d8 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeText/examples/2025-05-15-preview/SuccessfulEntityLinkingRequest.json @@ -0,0 +1,130 @@ +{ + "operationId": "AnalyzeText", + "title": "SuccessfulEntityLinkingRequest", + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2025-05-15-preview", + "Endpoint": "{Endpoint}", + "body": { + "kind": "EntityLinking", + "parameters": { + "modelVersion": "latest" + }, + "analysisInput": { + "documents": [ + { + "id": "1", + "language": "en", + "text": "Microsoft was founded by Bill Gates and Paul Allen." + }, + { + "id": "2", + "language": "en", + "text": "Pike place market is my favorite Seattle attraction." + } + ] + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "kind": "EntityLinkingResults", + "results": { + "documents": [ + { + "entities": [ + { + "dataSource": "Wikipedia", + "id": "Bill Gates", + "language": "en", + "matches": [ + { + "confidenceScore": 0.52, + "length": 10, + "offset": 25, + "text": "Bill Gates" + } + ], + "name": "Bill Gates", + "url": "https://en.wikipedia.org/wiki/Bill_Gates" + }, + { + "dataSource": "Wikipedia", + "id": "Paul Allen", + "language": "en", + "matches": [ + { + "confidenceScore": 0.54, + "length": 10, + "offset": 40, + "text": "Paul Allen" + } + ], + "name": "Paul Allen", + "url": "https://en.wikipedia.org/wiki/Paul_Allen" + }, + { + "dataSource": "Wikipedia", + "id": "Microsoft", + "language": "en", + "matches": [ + { + "confidenceScore": 0.49, + "length": 9, + "offset": 0, + "text": "Microsoft" + } + ], + "name": "Microsoft", + "url": "https://en.wikipedia.org/wiki/Microsoft" + } + ], + "id": "1", + "warnings": [] + }, + { + "entities": [ + { + "dataSource": "Wikipedia", + "id": "Pike Place Market", + "language": "en", + "matches": [ + { + "confidenceScore": 0.86, + "length": 17, + "offset": 0, + "text": "Pike place market" + } + ], + "name": "Pike Place Market", + "url": "https://en.wikipedia.org/wiki/Pike_Place_Market" + }, + { + "dataSource": "Wikipedia", + "id": "Seattle", + "language": "en", + "matches": [ + { + "confidenceScore": 0.27, + "length": 7, + "offset": 33, + "text": "Seattle" + } + ], + "name": "Seattle", + "url": "https://en.wikipedia.org/wiki/Seattle" + } + ], + "id": "2", + "warnings": [] + } + ], + "errors": [], + "modelVersion": "2020-02-01" + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeText/examples/2025-05-15-preview/SuccessfulEntityRecognitionExclusionRequest.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeText/examples/2025-05-15-preview/SuccessfulEntityRecognitionExclusionRequest.json new file mode 100644 index 000000000000..a0a0464c9ad4 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeText/examples/2025-05-15-preview/SuccessfulEntityRecognitionExclusionRequest.json @@ -0,0 +1,136 @@ +{ + "operationId": "AnalyzeText", + "title": "SuccessfulEntityRecognitionExclusionRequest", + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2025-05-15-preview", + "Endpoint": "{Endpoint}", + "body": { + "kind": "EntityRecognition", + "parameters": { + "modelVersion": "latest", + "exclusionList": [ + "Numeric" + ], + "overlapPolicy": { + "policyKind": "allowOverlap" + } + }, + "analysisInput": { + "documents": [ + { + "id": "2", + "language": "en", + "text": "When I was 5 years old I had $90.00 dollars to my name." + }, + { + "id": "3", + "language": "en", + "text": "When we flew from LAX it seemed like we were moving at 10 meters per second. I was lucky to see Amsterdam, Effile Tower, and the Nile." + } + ] + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "kind": "EntityRecognitionResults", + "results": { + "documents": [ + { + "entities": [], + "id": "2", + "warnings": [] + }, + { + "entities": [ + { + "text": "LAX", + "category": "Location", + "type": "Airport", + "offset": 18, + "length": 3, + "confidenceScore": 0.72, + "tags": [ + { + "name": "Location", + "confidenceScore": 0.9 + }, + { + "name": "Structural", + "confidenceScore": 0.72 + } + ] + }, + { + "text": "Amsterdam", + "category": "Location", + "type": "City", + "offset": 96, + "length": 9, + "confidenceScore": 0.8, + "tags": [ + { + "name": "Location", + "confidenceScore": 0.84 + }, + { + "name": "GPE", + "confidenceScore": 0.84 + }, + { + "name": "City", + "confidenceScore": 0.8 + } + ] + }, + { + "text": "Eiffel Tower", + "category": "Location", + "type": "Structural", + "offset": 107, + "length": 12, + "confidenceScore": 0.9, + "tags": [ + { + "name": "Location", + "confidenceScore": 0.9 + }, + { + "name": "Structural", + "confidenceScore": 0.9 + } + ] + }, + { + "text": "Nile", + "category": "Location", + "type": "Geological", + "offset": 129, + "length": 4, + "confidenceScore": 0.63, + "tags": [ + { + "name": "Location", + "confidenceScore": 0.9 + }, + { + "name": "Geological", + "confidenceScore": 0.63 + } + ] + } + ], + "id": "3", + "warnings": [] + } + ], + "errors": [], + "modelVersion": "2021-06-01" + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeText/examples/2025-05-15-preview/SuccessfulEntityRecognitionInclusionRequest.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeText/examples/2025-05-15-preview/SuccessfulEntityRecognitionInclusionRequest.json new file mode 100644 index 000000000000..d9ac4bd22910 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeText/examples/2025-05-15-preview/SuccessfulEntityRecognitionInclusionRequest.json @@ -0,0 +1,133 @@ +{ + "operationId": "AnalyzeText", + "title": "SuccessfulEntityRecognitionInclusionRequest", + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2025-05-15-preview", + "Endpoint": "{Endpoint}", + "body": { + "kind": "EntityRecognition", + "parameters": { + "modelVersion": "latest", + "inclusionList": [ + "Location" + ] + }, + "analysisInput": { + "documents": [ + { + "id": "2", + "language": "en", + "text": "When I was 5 years old I had $90.00 dollars to my name." + }, + { + "id": "3", + "language": "en", + "text": "When we flew from LAX it seemed like we were moving at 10 meters per second. I was lucky to see Amsterdam, Effile Tower, and the Nile." + } + ] + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "kind": "EntityRecognitionResults", + "results": { + "documents": [ + { + "entities": [], + "id": "2", + "warnings": [] + }, + { + "entities": [ + { + "text": "LAX", + "category": "Location", + "type": "Structural", + "offset": 18, + "length": 3, + "confidenceScore": 0.72, + "tags": [ + { + "name": "Location", + "confidenceScore": 0.9 + }, + { + "name": "Structural", + "confidenceScore": 0.72 + } + ] + }, + { + "text": "Amsterdam", + "category": "Location", + "type": "City", + "offset": 96, + "length": 9, + "confidenceScore": 0.8, + "tags": [ + { + "name": "Location", + "confidenceScore": 0.84 + }, + { + "name": "GPE", + "confidenceScore": 0.84 + }, + { + "name": "City", + "confidenceScore": 0.8 + } + ] + }, + { + "text": "Eiffel Tower", + "category": "Location", + "type": "Structural", + "offset": 107, + "length": 12, + "confidenceScore": 0.9, + "tags": [ + { + "name": "Location", + "confidenceScore": 0.9 + }, + { + "name": "Structural", + "confidenceScore": 0.9 + } + ] + }, + { + "text": "Nile", + "category": "Location", + "type": "Geological", + "offset": 129, + "length": 4, + "confidenceScore": 0.63, + "tags": [ + { + "name": "Location", + "confidenceScore": 0.9 + }, + { + "name": "Geological", + "confidenceScore": 0.63 + } + ] + } + ], + "id": "3", + "warnings": [] + } + ], + "errors": [], + "modelVersion": "2021-06-01" + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeText/examples/2025-05-15-preview/SuccessfulEntityRecognitionInferenceOptionsRequest.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeText/examples/2025-05-15-preview/SuccessfulEntityRecognitionInferenceOptionsRequest.json new file mode 100644 index 000000000000..03f9e9c7d832 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeText/examples/2025-05-15-preview/SuccessfulEntityRecognitionInferenceOptionsRequest.json @@ -0,0 +1,83 @@ +{ + "operationId": "AnalyzeText", + "title": "SuccessfulEntityRecognitionInferenceOptionsRequest", + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2025-05-15-preview", + "Endpoint": "{Endpoint}", + "body": { + "kind": "EntityRecognition", + "parameters": { + "modelVersion": "latest", + "inferenceOptions": { + "excludeNormalizedValues": true + } + }, + "analysisInput": { + "documents": [ + { + "id": "1", + "language": "en", + "text": "When I was 5 years old I had $90.00 dollars to my name." + } + ] + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "kind": "EntityRecognitionResults", + "results": { + "documents": [ + { + "entities": [ + { + "text": "5 years old", + "category": "Numeric", + "type": "Age", + "offset": 11, + "length": 11, + "confidenceScore": 0.99, + "tags": [ + { + "name": "Numeric", + "confidenceScore": 0.99 + }, + { + "name": "Age", + "confidenceScore": 0.99 + } + ] + }, + { + "text": "$90.00", + "category": "Numeric", + "type": "Currency", + "offset": 29, + "length": 14, + "confidenceScore": 0.99, + "tags": [ + { + "name": "Numeric", + "confidenceScore": 0.99 + }, + { + "name": "Currency", + "confidenceScore": 0.99 + } + ] + } + ], + "id": "1", + "warnings": [] + } + ], + "errors": [], + "modelVersion": "2023-09-01" + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeText/examples/2025-05-15-preview/SuccessfulEntityRecognitionOverlapPolicy.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeText/examples/2025-05-15-preview/SuccessfulEntityRecognitionOverlapPolicy.json new file mode 100644 index 000000000000..a266f02e7e6b --- /dev/null +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeText/examples/2025-05-15-preview/SuccessfulEntityRecognitionOverlapPolicy.json @@ -0,0 +1,79 @@ +{ + "operationId": "AnalyzeText", + "title": "SuccessfulEntityRecognitionOverlapPolicy", + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2025-05-15-preview", + "Endpoint": "{Endpoint}", + "body": { + "kind": "EntityRecognition", + "parameters": { + "modelVersion": "latest", + "overlapPolicy": { + "policyKind": "matchLongest" + } + }, + "analysisInput": { + "documents": [ + { + "id": "4", + "language": "en", + "text": "25th April Meeting was an intresting one. At least we gont to experience the WorldCup" + } + ] + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "kind": "EntityRecognitionResults", + "results": { + "documents": [ + { + "entities": [ + { + "text": "25th April Meeting", + "category": "Event", + "type": "Event", + "offset": 0, + "length": 18, + "confidenceScore": 0.59, + "tags": [ + { + "name": "Event", + "confidenceScore": 0.59 + } + ] + }, + { + "text": "Worldcup", + "category": "Event", + "type": "SportsEvent", + "offset": 0, + "length": 8, + "confidenceScore": 0.51, + "tags": [ + { + "name": "Event", + "confidenceScore": 0.55 + }, + { + "name": "SportsEvent", + "confidenceScore": 0.51 + } + ] + } + ], + "id": "4", + "warnings": [] + } + ], + "errors": [], + "modelVersion": "2021-06-01" + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeText/examples/2025-05-15-preview/SuccessfulEntityRecognitionRequest.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeText/examples/2025-05-15-preview/SuccessfulEntityRecognitionRequest.json new file mode 100644 index 000000000000..6b8d169d0594 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeText/examples/2025-05-15-preview/SuccessfulEntityRecognitionRequest.json @@ -0,0 +1,339 @@ +{ + "operationId": "AnalyzeText", + "title": "SuccessfulEntityRecognitionRequest", + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2025-05-15-preview", + "Endpoint": "{Endpoint}", + "body": { + "kind": "EntityRecognition", + "parameters": { + "modelVersion": "latest", + "overlapPolicy": { + "policyKind": "allowOverlap" + } + }, + "analysisInput": { + "documents": [ + { + "id": "2", + "language": "en", + "text": "When I was 5 years old I had $90.00 dollars to my name." + }, + { + "id": "3", + "language": "en", + "text": "When we flew from LAX it seemed like we were moving at 10 meters per second. I was lucky to see Amsterdam, Effile Tower, and the Nile." + }, + { + "id": "4", + "language": "en", + "text": "25th April Meeting was an intresting one. At least we gont to experience the WorldCup" + }, + { + "id": "5", + "language": "en", + "text": "My IP is 127.12.1.1 and my phone number is 5555555555" + } + ] + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "kind": "EntityRecognitionResults", + "results": { + "documents": [ + { + "entities": [ + { + "text": "5 years old", + "category": "Numeric", + "type": "Age", + "offset": 11, + "length": 11, + "confidenceScore": 0.99, + "tags": [ + { + "name": "Numeric", + "confidenceScore": 0.99 + }, + { + "name": "Age", + "confidenceScore": 0.99 + } + ], + "metadata": { + "metadataKind": "AgeMetadata", + "unit": "Year", + "value": 5.0 + } + }, + { + "text": "$90.00", + "category": "Numeric", + "type": "Currency", + "offset": 29, + "length": 14, + "confidenceScore": 0.99, + "tags": [ + { + "name": "Numeric", + "confidenceScore": 0.99 + }, + { + "name": "Currency", + "confidenceScore": 0.99 + } + ], + "metadata": { + "metadataKind": "CurrencyMetadata", + "unit": "Dollar", + "iso4217": "USD", + "value": 90.0 + } + } + ], + "id": "2", + "warnings": [] + }, + { + "entities": [ + { + "text": "LAX", + "category": "Location", + "type": "Structural", + "offset": 18, + "length": 3, + "confidenceScore": 0.72, + "tags": [ + { + "name": "Location", + "confidenceScore": 0.9 + }, + { + "name": "Structural", + "confidenceScore": 0.72 + } + ] + }, + { + "text": "10 meters per second", + "category": "Numeric", + "type": "Speed", + "offset": 55, + "length": 20, + "confidenceScore": 0.8, + "tags": [ + { + "name": "Dimension", + "confidenceScore": 0.84 + }, + { + "name": "Numeric", + "confidenceScore": 0.84 + }, + { + "name": "Speed", + "confidenceScore": 0.8 + } + ], + "metadata": { + "metadataKind": "SpeedMetadata", + "unit": "MetersPerSecond", + "value": 10.0 + } + }, + { + "text": "Amsterdam", + "category": "Location", + "type": "City", + "offset": 96, + "length": 9, + "confidenceScore": 0.8, + "tags": [ + { + "name": "Location", + "confidenceScore": 0.84 + }, + { + "name": "GPE", + "confidenceScore": 0.84 + }, + { + "name": "City", + "confidenceScore": 0.8 + } + ] + }, + { + "text": "Eiffel Tower", + "category": "Location", + "type": "Structural", + "offset": 107, + "length": 12, + "confidenceScore": 0.9, + "tags": [ + { + "name": "Location", + "confidenceScore": 0.9 + }, + { + "name": "Structural", + "confidenceScore": 0.9 + } + ] + }, + { + "text": "Nile", + "category": "Location", + "type": "Geological", + "offset": 129, + "length": 4, + "confidenceScore": 0.63, + "tags": [ + { + "name": "Location", + "confidenceScore": 0.9 + }, + { + "name": "Geological", + "confidenceScore": 0.63 + } + ] + } + ], + "id": "3", + "warnings": [] + }, + { + "entities": [ + { + "text": "25th April", + "category": "Temporal", + "type": "Date", + "offset": 0, + "length": 10, + "confidenceScore": 0.58, + "tags": [ + { + "name": "Temporal", + "confidenceScore": 0.9 + }, + { + "name": "Date", + "confidenceScore": 0.58 + } + ], + "metadata": { + "metadataKind": "DateMetadata", + "dateValues": [ + { + "timex": "XXXX-04-25", + "value": "2022-04-25" + }, + { + "timex": "XXXX-04-25", + "value": "2023-04-25" + } + ] + } + }, + { + "text": "25th April Meeting", + "category": "Event", + "type": "Event", + "offset": 0, + "length": 18, + "confidenceScore": 0.55, + "tags": [ + { + "name": "Event", + "confidenceScore": 0.55 + } + ] + }, + { + "text": "25th April Meeting", + "category": "Event", + "type": "CulturalEvent", + "offset": 0, + "length": 18, + "confidenceScore": 0.55, + "tags": [ + { + "name": "Event", + "confidenceScore": 0.55 + }, + { + "name": "CulturalEvent", + "confidenceScore": 0.55 + } + ] + }, + { + "text": "Worldcup", + "category": "Event", + "type": "SportsEvent", + "offset": 0, + "length": 8, + "confidenceScore": 0.51, + "tags": [ + { + "name": "Event", + "confidenceScore": 0.55 + }, + { + "name": "SportsEvent", + "confidenceScore": 0.51 + } + ] + } + ], + "id": "4", + "warnings": [] + }, + { + "entities": [ + { + "text": "127.12.1.1", + "category": "IP", + "type": "IP", + "offset": 9, + "length": 10, + "confidenceScore": 0.8, + "tags": [ + { + "name": "IP", + "confidenceScore": 0.8 + } + ] + }, + { + "text": "5555555555", + "category": "PhoneNumber", + "type": "PhoneNumber", + "offset": 45, + "length": 9, + "confidenceScore": 0.8, + "tags": [ + { + "name": "PhoneNumber", + "confidenceScore": 0.8 + } + ] + } + ], + "id": "5", + "warnings": [] + } + ], + "errors": [], + "modelVersion": "2021-06-01" + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeText/examples/2025-05-15-preview/SuccessfulHealthcareDocumentTypePostRequest.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeText/examples/2025-05-15-preview/SuccessfulHealthcareDocumentTypePostRequest.json new file mode 100644 index 000000000000..3c7aff2de00f --- /dev/null +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeText/examples/2025-05-15-preview/SuccessfulHealthcareDocumentTypePostRequest.json @@ -0,0 +1,38 @@ +{ + "operationId": "AnalyzeTextSubmitJob", + "title": "SuccessfulHealthcareDocumentTypePostRequest", + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2025-05-15-preview", + "Endpoint": "{Endpoint}", + "jobId": "{Job ID}", + "body": { + "analysisInput": { + "documents": [ + { + "text": "Prescribed 100mg ibuprofen, taken twice daily.", + "id": "1", + "language": "en" + } + ] + }, + "tasks": [ + { + "kind": "Healthcare", + "parameters": { + "modelVersion": "latest", + "fhirVersion": "4.0.1", + "documentType": "DischargeSummary" + } + } + ] + } + }, + "responses": { + "202": { + "headers": { + "Operation-Location": "{Endpoint}/language/analyze-text/jobs/{jobId}?api-version=2025-05-15-preview" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeText/examples/2025-05-15-preview/SuccessfulHealthcareDocumentTypeTaskStatusRequest.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeText/examples/2025-05-15-preview/SuccessfulHealthcareDocumentTypeTaskStatusRequest.json new file mode 100644 index 000000000000..5121c8443744 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeText/examples/2025-05-15-preview/SuccessfulHealthcareDocumentTypeTaskStatusRequest.json @@ -0,0 +1,554 @@ +{ + "operationId": "AnalyzeTextJobStatus", + "title": "SuccessfulHealthcareDocumentTypeTaskStatusRequest", + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2025-05-15-preview", + "Endpoint": "{Endpoint}", + "jobId": "15e4a46b-62e2-4386-8d36-9c2a92bb45dd" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "createdDateTime": "2022-09-06T23:47:43Z", + "displayName": "Providing Document Type", + "expirationDateTime": "2022-09-07T23:47:43Z", + "jobId": "15e4a46b-62e2-4386-8d36-9c2a92bb45dd", + "lastUpdatedDateTime": "2022-09-06T23:48:10Z", + "status": "succeeded", + "errors": [], + "tasks": { + "completed": 1, + "failed": 0, + "inProgress": 0, + "total": 1, + "items": [ + { + "kind": "HealthcareLROResults", + "lastUpdateDateTime": "2022-09-06T23:48:10.1762027Z", + "status": "succeeded", + "results": { + "documents": [ + { + "id": "a", + "entities": [ + { + "offset": 11, + "length": 5, + "text": "100mg", + "category": "Dosage", + "confidenceScore": 0.98 + }, + { + "offset": 17, + "length": 9, + "text": "ibuprofen", + "category": "MedicationName", + "confidenceScore": 1.0, + "name": "ibuprofen", + "links": [ + { + "dataSource": "UMLS", + "id": "C0020740" + }, + { + "dataSource": "AOD", + "id": "0000019879" + }, + { + "dataSource": "ATC", + "id": "M01AE01" + }, + { + "dataSource": "CCPSS", + "id": "0046165" + }, + { + "dataSource": "CHV", + "id": "0000006519" + }, + { + "dataSource": "CSP", + "id": "2270-2077" + }, + { + "dataSource": "DRUGBANK", + "id": "DB01050" + }, + { + "dataSource": "GS", + "id": "1611" + }, + { + "dataSource": "LCH_NW", + "id": "sh97005926" + }, + { + "dataSource": "LNC", + "id": "LP16165-0" + }, + { + "dataSource": "MEDCIN", + "id": "40458" + }, + { + "dataSource": "MMSL", + "id": "d00015" + }, + { + "dataSource": "MSH", + "id": "D007052" + }, + { + "dataSource": "MTHSPL", + "id": "WK2XYI10QM" + }, + { + "dataSource": "NCI", + "id": "C561" + }, + { + "dataSource": "NCI_CTRP", + "id": "C561" + }, + { + "dataSource": "NCI_DCP", + "id": "00803" + }, + { + "dataSource": "NCI_DTP", + "id": "NSC0256857" + }, + { + "dataSource": "NCI_FDA", + "id": "WK2XYI10QM" + }, + { + "dataSource": "NCI_NCI-GLOSS", + "id": "CDR0000613511" + }, + { + "dataSource": "NDDF", + "id": "002377" + }, + { + "dataSource": "PDQ", + "id": "CDR0000040475" + }, + { + "dataSource": "RCD", + "id": "x02MO" + }, + { + "dataSource": "RXNORM", + "id": "5640" + }, + { + "dataSource": "SNM", + "id": "E-7772" + }, + { + "dataSource": "SNMI", + "id": "C-603C0" + }, + { + "dataSource": "SNOMEDCT_US", + "id": "387207008" + }, + { + "dataSource": "USP", + "id": "m39860" + }, + { + "dataSource": "USPMG", + "id": "MTHU000060" + }, + { + "dataSource": "VANDF", + "id": "4017840" + } + ] + }, + { + "offset": 34, + "length": 11, + "text": "twice daily", + "category": "Frequency", + "confidenceScore": 1.0 + } + ], + "relations": [ + { + "confidenceScore": 1.0, + "relationType": "DosageOfMedication", + "entities": [ + { + "ref": "#/results/documents/0/entities/0", + "role": "Dosage" + }, + { + "ref": "#/results/documents/0/entities/1", + "role": "Medication" + } + ] + }, + { + "confidenceScore": 1.0, + "relationType": "FrequencyOfMedication", + "entities": [ + { + "ref": "#/results/documents/0/entities/1", + "role": "Medication" + }, + { + "ref": "#/results/documents/0/entities/2", + "role": "Frequency" + } + ] + } + ], + "warnings": [], + "fhirBundle": { + "resourceType": "Bundle", + "id": "6ee4a7c0-5911-4c4b-bea2-3c2a1fe5c65f", + "meta": { + "profile": [ + "http://hl7.org/fhir/4.0.1/StructureDefinition/Bundle" + ] + }, + "identifier": { + "system": "urn:ietf:rfc:3986", + "value": "urn:uuid:6ee4a7c0-5911-4c4b-bea2-3c2a1fe5c65f" + }, + "type": "document", + "entry": [ + { + "fullUrl": "Composition/5bd33290-b92e-4aa5-becf-535578207946", + "resource": { + "resourceType": "Composition", + "id": "5bd33290-b92e-4aa5-becf-535578207946", + "status": "final", + "type": { + "coding": [ + { + "system": "http://loinc.org", + "code": "18842-5", + "display": "Discharge summary" + } + ], + "text": "Discharge summary" + }, + "subject": { + "reference": "Patient/efcccdf7-87f0-4061-b553-09fc11734594", + "type": "Patient" + }, + "encounter": { + "reference": "Encounter/76214457-f94c-4ccf-95ef-ab31e7232d63", + "type": "Encounter", + "display": "unknown" + }, + "date": "2022-09-06", + "author": [ + { + "reference": "Practitioner/bba2dee3-2eb3-4973-b4b9-62d498b17046", + "type": "Practitioner", + "display": "Unknown" + } + ], + "title": "Discharge summary", + "section": [ + { + "title": "General", + "code": { + "coding": [ + { + "system": "", + "display": "Unrecognized Section" + } + ], + "text": "General" + }, + "text": { + "status": "additional", + "div": "
\r\n\t\t\t\t\t\t\t

General

\r\n\t\t\t\t\t\t\t

Prescribed 100mg ibuprofen, taken twice daily.

\r\n\t\t\t\t\t
" + }, + "entry": [ + { + "reference": "List/6d743a3e-e7a2-4cee-a0b5-64361b6c93ad", + "type": "List", + "display": "General" + } + ] + } + ] + } + }, + { + "fullUrl": "Practitioner/bba2dee3-2eb3-4973-b4b9-62d498b17046", + "resource": { + "resourceType": "Practitioner", + "id": "bba2dee3-2eb3-4973-b4b9-62d498b17046", + "name": [ + { + "text": "Unknown", + "family": "Unknown" + } + ] + } + }, + { + "fullUrl": "Patient/efcccdf7-87f0-4061-b553-09fc11734594", + "resource": { + "resourceType": "Patient", + "id": "efcccdf7-87f0-4061-b553-09fc11734594", + "gender": "unknown" + } + }, + { + "fullUrl": "Encounter/76214457-f94c-4ccf-95ef-ab31e7232d63", + "resource": { + "resourceType": "Encounter", + "id": "76214457-f94c-4ccf-95ef-ab31e7232d63", + "meta": { + "profile": [ + "http://hl7.org/fhir/us/core/StructureDefinition/us-core-encounter" + ] + }, + "status": "finished", + "class": { + "system": "http://terminology.hl7.org/CodeSystem/v3-ActCode", + "display": "unknown" + }, + "subject": { + "reference": "Patient/efcccdf7-87f0-4061-b553-09fc11734594", + "type": "Patient" + }, + "period": { + "start": "2022-09-06", + "end": "2022-09-06" + } + } + }, + { + "fullUrl": "MedicationStatement/ac0264b6-63b7-4cf2-a7c3-f7340788aca7", + "resource": { + "resourceType": "MedicationStatement", + "id": "ac0264b6-63b7-4cf2-a7c3-f7340788aca7", + "extension": [ + { + "extension": [ + { + "url": "offset", + "valueInteger": 17 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "status": "active", + "medicationCodeableConcept": { + "coding": [ + { + "system": "http://www.nlm.nih.gov/research/umls", + "code": "C0020740", + "display": "ibuprofen" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/aod", + "code": "0000019879" + }, + { + "system": "http://www.whocc.no/atc", + "code": "M01AE01" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/ccpss", + "code": "0046165" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/chv", + "code": "0000006519" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/csp", + "code": "2270-2077" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/drugbank", + "code": "DB01050" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/gs", + "code": "1611" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/lch_nw", + "code": "sh97005926" + }, + { + "system": "http://loinc.org", + "code": "LP16165-0" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/medcin", + "code": "40458" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/mmsl", + "code": "d00015" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/msh", + "code": "D007052" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/mthspl", + "code": "WK2XYI10QM" + }, + { + "system": "http://ncimeta.nci.nih.gov", + "code": "C561" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nci_ctrp", + "code": "C561" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nci_dcp", + "code": "00803" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nci_dtp", + "code": "NSC0256857" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nci_fda", + "code": "WK2XYI10QM" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nci_nci-gloss", + "code": "CDR0000613511" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nddf", + "code": "002377" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/pdq", + "code": "CDR0000040475" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/rcd", + "code": "x02MO" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/rxnorm", + "code": "5640" + }, + { + "system": "http://snomed.info/sct", + "code": "E-7772" + }, + { + "system": "http://snomed.info/sct", + "code": "C-603C0" + }, + { + "system": "http://snomed.info/sct", + "code": "387207008" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/usp", + "code": "m39860" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/uspmg", + "code": "MTHU000060" + }, + { + "system": "http://hl7.org/fhir/ndfrt", + "code": "4017840" + } + ], + "text": "ibuprofen" + }, + "subject": { + "reference": "Patient/efcccdf7-87f0-4061-b553-09fc11734594", + "type": "Patient" + }, + "context": { + "reference": "Encounter/76214457-f94c-4ccf-95ef-ab31e7232d63", + "type": "Encounter", + "display": "unknown" + }, + "dosage": [ + { + "text": "100mg", + "timing": { + "repeat": { + "frequency": 2, + "period": 1, + "periodUnit": "d" + }, + "code": { + "text": "twice daily" + } + }, + "doseAndRate": [ + { + "doseQuantity": { + "value": 100 + } + } + ] + } + ] + } + }, + { + "fullUrl": "List/6d743a3e-e7a2-4cee-a0b5-64361b6c93ad", + "resource": { + "resourceType": "List", + "id": "6d743a3e-e7a2-4cee-a0b5-64361b6c93ad", + "status": "current", + "mode": "snapshot", + "title": "General", + "subject": { + "reference": "Patient/efcccdf7-87f0-4061-b553-09fc11734594", + "type": "Patient" + }, + "encounter": { + "reference": "Encounter/76214457-f94c-4ccf-95ef-ab31e7232d63", + "type": "Encounter", + "display": "unknown" + }, + "entry": [ + { + "item": { + "reference": "MedicationStatement/ac0264b6-63b7-4cf2-a7c3-f7340788aca7", + "type": "MedicationStatement", + "display": "ibuprofen" + } + } + ] + } + } + ] + } + } + ], + "errors": [], + "modelVersion": "2022-03-01" + } + } + ] + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeText/examples/2025-05-15-preview/SuccessfulHealthcarePostRequest.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeText/examples/2025-05-15-preview/SuccessfulHealthcarePostRequest.json new file mode 100644 index 000000000000..30793bfedaf2 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeText/examples/2025-05-15-preview/SuccessfulHealthcarePostRequest.json @@ -0,0 +1,36 @@ +{ + "operationId": "AnalyzeTextSubmitJob", + "title": "SuccessfulHealthcarePostRequest", + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2025-05-15-preview", + "Endpoint": "{Endpoint}", + "jobId": "{Job ID}", + "body": { + "analysisInput": { + "documents": [ + { + "text": "Prescribed 100mg ibuprofen, taken twice daily.", + "id": "1", + "language": "en" + } + ] + }, + "tasks": [ + { + "kind": "Healthcare", + "parameters": { + "modelVersion": "latest" + } + } + ] + } + }, + "responses": { + "202": { + "headers": { + "Operation-Location": "{Endpoint}/language/analyze-text/jobs/{jobId}?api-version=2025-05-15-preview" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeText/examples/2025-05-15-preview/SuccessfulHealthcareTaskStatusRequest.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeText/examples/2025-05-15-preview/SuccessfulHealthcareTaskStatusRequest.json new file mode 100644 index 000000000000..c6c7999f9355 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeText/examples/2025-05-15-preview/SuccessfulHealthcareTaskStatusRequest.json @@ -0,0 +1,222 @@ +{ + "operationId": "AnalyzeTextJobStatus", + "title": "SuccessfulHealthcareTaskStatusRequest", + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2025-05-15-preview", + "Endpoint": "{Endpoint}", + "jobId": "1780194a-e9c1-4298-b0d4-fdc59ba818a0" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "createdDateTime": "2022-07-20T18:43:35Z", + "displayName": "Extracting Location & US Region", + "expirationDateTime": "2022-07-21T18:43:35Z", + "jobId": "1780194a-e9c1-4298-b0d4-fdc59ba818a0", + "lastUpdatedDateTime": "2022-07-20T18:43:36Z", + "status": "succeeded", + "tasks": { + "completed": 1, + "failed": 0, + "inProgress": 0, + "total": 1, + "items": [ + { + "kind": "HealthcareLROResults", + "lastUpdateDateTime": "2022-07-20T18:43:36.7159045Z", + "status": "succeeded", + "results": { + "documents": [ + { + "id": "1", + "entities": [ + { + "offset": 11, + "length": 5, + "text": "100mg", + "category": "Dosage", + "confidenceScore": 0.98 + }, + { + "offset": 17, + "length": 9, + "text": "ibuprofen", + "category": "MedicationName", + "confidenceScore": 1, + "name": "ibuprofen", + "links": [ + { + "dataSource": "UMLS", + "id": "C0020740" + }, + { + "dataSource": "AOD", + "id": "0000019879" + }, + { + "dataSource": "ATC", + "id": "M01AE01" + }, + { + "dataSource": "CCPSS", + "id": "0046165" + }, + { + "dataSource": "CHV", + "id": "0000006519" + }, + { + "dataSource": "CSP", + "id": "2270-2077" + }, + { + "dataSource": "DRUGBANK", + "id": "DB01050" + }, + { + "dataSource": "GS", + "id": "1611" + }, + { + "dataSource": "LCH_NW", + "id": "sh97005926" + }, + { + "dataSource": "LNC", + "id": "LP16165-0" + }, + { + "dataSource": "MEDCIN", + "id": "40458" + }, + { + "dataSource": "MMSL", + "id": "d00015" + }, + { + "dataSource": "MSH", + "id": "D007052" + }, + { + "dataSource": "MTHSPL", + "id": "WK2XYI10QM" + }, + { + "dataSource": "NCI", + "id": "C561" + }, + { + "dataSource": "NCI_CTRP", + "id": "C561" + }, + { + "dataSource": "NCI_DCP", + "id": "00803" + }, + { + "dataSource": "NCI_DTP", + "id": "NSC0256857" + }, + { + "dataSource": "NCI_FDA", + "id": "WK2XYI10QM" + }, + { + "dataSource": "NCI_NCI-GLOSS", + "id": "CDR0000613511" + }, + { + "dataSource": "NDDF", + "id": "002377" + }, + { + "dataSource": "PDQ", + "id": "CDR0000040475" + }, + { + "dataSource": "RCD", + "id": "x02MO" + }, + { + "dataSource": "RXNORM", + "id": "5640" + }, + { + "dataSource": "SNM", + "id": "E-7772" + }, + { + "dataSource": "SNMI", + "id": "C-603C0" + }, + { + "dataSource": "SNOMEDCT_US", + "id": "387207008" + }, + { + "dataSource": "USP", + "id": "m39860" + }, + { + "dataSource": "USPMG", + "id": "MTHU000060" + }, + { + "dataSource": "VANDF", + "id": "4017840" + } + ] + }, + { + "offset": 34, + "length": 11, + "text": "twice daily", + "category": "Frequency", + "confidenceScore": 1 + } + ], + "relations": [ + { + "confidenceScore": 1, + "relationType": "DosageOfMedication", + "entities": [ + { + "ref": "#/results/documents/0/entities/0", + "role": "Dosage" + }, + { + "ref": "#/results/documents/0/entities/1", + "role": "Medication" + } + ] + }, + { + "confidenceScore": 1, + "relationType": "FrequencyOfMedication", + "entities": [ + { + "ref": "#/results/documents/0/entities/1", + "role": "Medication" + }, + { + "ref": "#/results/documents/0/entities/2", + "role": "Frequency" + } + ] + } + ], + "warnings": [] + } + ], + "errors": [], + "modelVersion": "2022-03-01" + } + } + ] + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeText/examples/2025-05-15-preview/SuccessfulKeyPhraseExtractionRequest.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeText/examples/2025-05-15-preview/SuccessfulKeyPhraseExtractionRequest.json new file mode 100644 index 000000000000..1ce055cfabbf --- /dev/null +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeText/examples/2025-05-15-preview/SuccessfulKeyPhraseExtractionRequest.json @@ -0,0 +1,73 @@ +{ + "operationId": "AnalyzeText", + "title": "SuccessfulKeyPhraseExtractionRequest", + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2025-05-15-preview", + "Endpoint": "{Endpoint}", + "body": { + "kind": "KeyPhraseExtraction", + "parameters": { + "modelVersion": "latest" + }, + "analysisInput": { + "documents": [ + { + "id": "1", + "language": "en", + "text": "Microsoft was founded by Bill Gates and Paul Allen." + }, + { + "id": "2", + "language": "en", + "text": "Text Analytics is one of the Azure Cognitive Services." + }, + { + "id": "3", + "language": "en", + "text": "My cat might need to see a veterinarian." + } + ] + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "kind": "KeyPhraseExtractionResults", + "results": { + "documents": [ + { + "id": "1", + "keyPhrases": [ + "Bill Gates", + "Paul Allen", + "Microsoft" + ], + "warnings": [] + }, + { + "id": "2", + "keyPhrases": [ + "Azure Cognitive Services", + "Text Analytics" + ], + "warnings": [] + }, + { + "id": "3", + "keyPhrases": [ + "cat", + "veterinarian" + ], + "warnings": [] + } + ], + "errors": [], + "modelVersion": "2021-06-01" + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeText/examples/2025-05-15-preview/SuccessfulLanguageDetectionRequest.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeText/examples/2025-05-15-preview/SuccessfulLanguageDetectionRequest.json new file mode 100644 index 000000000000..c1de4b0e4cec --- /dev/null +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeText/examples/2025-05-15-preview/SuccessfulLanguageDetectionRequest.json @@ -0,0 +1,93 @@ +{ + "operationId": "AnalyzeText", + "title": "SuccessfulLanguageDetectionRequest", + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2025-05-15-preview", + "Endpoint": "{Endpoint}", + "body": { + "kind": "LanguageDetection", + "parameters": { + "modelVersion": "latest" + }, + "analysisInput": { + "documents": [ + { + "id": "1", + "text": "Hello world" + }, + { + "id": "2", + "text": "Bonjour tout le monde" + }, + { + "id": "3", + "text": "Hola mundo" + }, + { + "id": "4", + "text": "Tumhara naam kya hai?" + } + ] + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "kind": "LanguageDetectionResults", + "results": { + "documents": [ + { + "detectedLanguage": { + "confidenceScore": 1, + "iso6391Name": "en", + "name": "English", + "scriptName": "Latin", + "scriptIso15924Code": "Latn" + }, + "id": "1", + "warnings": [] + }, + { + "detectedLanguage": { + "confidenceScore": 1, + "iso6391Name": "fr", + "name": "French", + "scriptName": "Latin", + "scriptIso15924Code": "Latn" + }, + "id": "2", + "warnings": [] + }, + { + "detectedLanguage": { + "confidenceScore": 1, + "iso6391Name": "es", + "name": "Spanish", + "scriptName": "Latin", + "scriptIso15924Code": "Latn" + }, + "id": "3", + "warnings": [] + }, + { + "detectedLanguage": { + "confidenceScore": 1, + "iso6391Name": "hi", + "name": "Hindi", + "scriptName": "Latin", + "scriptIso15924Code": "Latn" + }, + "id": "4", + "warnings": [] + } + ], + "errors": [], + "modelVersion": "2023-12-01" + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeText/examples/2025-05-15-preview/SuccessfulPiiEntityRecognitionExclusionRequest.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeText/examples/2025-05-15-preview/SuccessfulPiiEntityRecognitionExclusionRequest.json new file mode 100644 index 000000000000..0aee08e7cbe8 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeText/examples/2025-05-15-preview/SuccessfulPiiEntityRecognitionExclusionRequest.json @@ -0,0 +1,101 @@ +{ + "operationId": "AnalyzeText", + "title": "SuccessfulPiiEntityRecognitionExclusionRequest", + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2025-05-15-preview", + "Endpoint": "{Endpoint}", + "body": { + "kind": "PiiEntityRecognition", + "parameters": { + "modelVersion": "latest", + "excludePiiCategories": [ + "USSocialSecurityNumber" + ] + }, + "analysisInput": { + "documents": [ + { + "id": "1", + "language": "en", + "text": "My SSN is 859-98-0987" + }, + { + "id": "2", + "language": "en", + "text": "Your ABA number - 111000025 - is the first 9 digits in the lower left hand corner of your personal check." + }, + { + "id": "3", + "language": "en", + "text": "Is 998.214.865-68 your Brazilian CPF number?" + } + ] + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "kind": "PiiEntityRecognitionResults", + "results": { + "documents": [ + { + "id": "2", + "redactedText": "Your ABA number - ********* - is the first 9 digits in the lower left hand corner of your personal check.", + "entities": [ + { + "category": "ABARoutingNumber", + "type": "ABARoutingNumber", + "confidenceScore": 0.75, + "length": 9, + "offset": 18, + "text": "111000025", + "tags": [ + { + "name": "Number", + "confidenceScore": 0.8 + }, + { + "name": "Numeric", + "confidenceScore": 0.8 + } + ] + } + ], + "warnings": [] + }, + { + "id": "3", + "redactedText": "Is ************** your Brazilian CPF number?", + "entities": [ + { + "category": "BRCPFNumber", + "type": "BRCPFNumber", + "confidenceScore": 0.85, + "length": 14, + "offset": 3, + "text": "998.214.865-68", + "tags": [ + { + "name": "Number", + "confidenceScore": 0.8 + }, + { + "name": "Numeric", + "confidenceScore": 0.8 + } + ] + } + ], + "warnings": [] + } + ], + "errors": [], + "modelVersion": "2021-01-15" + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeText/examples/2025-05-15-preview/SuccessfulPiiEntityRecognitionMaskedEntities.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeText/examples/2025-05-15-preview/SuccessfulPiiEntityRecognitionMaskedEntities.json new file mode 100644 index 000000000000..e4ef9df573d8 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeText/examples/2025-05-15-preview/SuccessfulPiiEntityRecognitionMaskedEntities.json @@ -0,0 +1,82 @@ +{ + "operationId": "AnalyzeText", + "title": "SuccessfulPiiEntityRecognitionMaskedEntitiesRequest", + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2025-05-15-preview", + "Endpoint": "{Endpoint}", + "body": { + "kind": "PiiEntityRecognition", + "parameters": { + "modelVersion": "latest", + "redactionPolicy": { + "policyKind": "entityMask" + } + }, + "analysisInput": { + "documents": [ + { + "id": "1", + "language": "en", + "text": "My name is John Doe My phone number is 424 878 9192" + } + ] + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "kind": "PiiEntityRecognitionResults", + "results": { + "documents": [ + { + "id": "1", + "redactedText": "My name is [PERSON_1] My phone number is [PHONENUMBER_1]", + "entities": [ + { + "category": "Person", + "type": "Person", + "tags": [ + { + "name": "Person", + "confidenceScore": 0.65 + } + ], + "length": 8, + "offset": 11, + "mask": "[Person_1]", + "maskOffset": 11, + "maskLength": 9, + "text": "John Doe", + "confidenceScore": 0.65 + }, + { + "category": "PhoneNumber", + "type": "PhoneNumber", + "tags": [ + { + "name": "PhoneNumber", + "confidenceScore": 0.8 + } + ], + "length": 12, + "offset": 36, + "mask": "[PHONENUMBER_1]", + "maskOffset": 41, + "maskLength": 13, + "text": "424 878 9192", + "confidenceScore": 0.8 + } + ], + "warnings": [] + } + ], + "errors": [], + "modelVersion": "2021-01-15" + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeText/examples/2025-05-15-preview/SuccessfulPiiEntityRecognitionRedactionPolicyRequest.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeText/examples/2025-05-15-preview/SuccessfulPiiEntityRecognitionRedactionPolicyRequest.json new file mode 100644 index 000000000000..a9e6150507c8 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeText/examples/2025-05-15-preview/SuccessfulPiiEntityRecognitionRedactionPolicyRequest.json @@ -0,0 +1,127 @@ +{ + "operationId": "AnalyzeText", + "title": "SuccessfulPiiEntityRecognitionRedactionPolicyRequest", + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2025-05-15-preview", + "Endpoint": "{Endpoint}", + "body": { + "kind": "PiiEntityRecognition", + "parameters": { + "modelVersion": "latest", + "redactionPolicy": { + "policyKind": "characterMask", + "redactionCharacter": "-" + } + }, + "analysisInput": { + "documents": [ + { + "id": "1", + "language": "en", + "text": "My SSN is 859-98-0987" + }, + { + "id": "2", + "language": "en", + "text": "Your ABA number - 111000025 - is the first 9 digits in the lower left hand corner of your personal check." + }, + { + "id": "3", + "language": "en", + "text": "Is 998.214.865-68 your Brazilian CPF number?" + } + ] + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "kind": "PiiEntityRecognitionResults", + "results": { + "documents": [ + { + "id": "1", + "redactedText": "My SSN is -----------", + "entities": [ + { + "category": "USSocialSecurityNumber", + "type": "USSocialSecurityNumber", + "confidenceScore": 0.65, + "length": 11, + "offset": 28, + "text": "859-98-0987", + "tags": [ + { + "name": "Number", + "confidenceScore": 0.8 + }, + { + "name": "Numeric", + "confidenceScore": 0.8 + } + ] + } + ], + "warnings": [] + }, + { + "id": "2", + "redactedText": "Your ABA number - --------- - is the first 9 digits in the lower left hand corner of your personal check.", + "entities": [ + { + "category": "ABARoutingNumber", + "type": "ABARoutingNumber", + "confidenceScore": 0.75, + "length": 9, + "offset": 18, + "text": "111000025", + "tags": [ + { + "name": "Number", + "confidenceScore": 0.8 + }, + { + "name": "Numeric", + "confidenceScore": 0.8 + } + ] + } + ], + "warnings": [] + }, + { + "id": "3", + "redactedText": "Is -------------- your Brazilian CPF number?", + "entities": [ + { + "category": "BRCPFNumber", + "type": "", + "confidenceScore": 0.85, + "length": 14, + "offset": 3, + "text": "998.214.865-68", + "tags": [ + { + "name": "Number", + "confidenceScore": 0.8 + }, + { + "name": "Numeric", + "confidenceScore": 0.8 + } + ] + } + ], + "warnings": [] + } + ], + "errors": [], + "modelVersion": "2021-01-15" + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeText/examples/2025-05-15-preview/SuccessfulPiiEntityRecognitionRequest.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeText/examples/2025-05-15-preview/SuccessfulPiiEntityRecognitionRequest.json new file mode 100644 index 000000000000..a293143bcfaa --- /dev/null +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeText/examples/2025-05-15-preview/SuccessfulPiiEntityRecognitionRequest.json @@ -0,0 +1,123 @@ +{ + "operationId": "AnalyzeText", + "title": "SuccessfulPiiEntityRecognitionRequest", + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2025-05-15-preview", + "Endpoint": "{Endpoint}", + "body": { + "kind": "PiiEntityRecognition", + "parameters": { + "modelVersion": "latest" + }, + "analysisInput": { + "documents": [ + { + "id": "1", + "language": "en", + "text": "My SSN is 859-98-0987" + }, + { + "id": "2", + "language": "en", + "text": "Your ABA number - 111000025 - is the first 9 digits in the lower left hand corner of your personal check." + }, + { + "id": "3", + "language": "en", + "text": "Is 998.214.865-68 your Brazilian CPF number?" + } + ] + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "kind": "PiiEntityRecognitionResults", + "results": { + "documents": [ + { + "id": "1", + "redactedText": "My SSN is ***********", + "entities": [ + { + "category": "USSocialSecurityNumber", + "type": "USSocialSecurityNumber", + "confidenceScore": 0.65, + "length": 11, + "offset": 28, + "text": "859-98-0987", + "tags": [ + { + "name": "Number", + "confidenceScore": 0.8 + }, + { + "name": "Numeric", + "confidenceScore": 0.8 + } + ] + } + ], + "warnings": [] + }, + { + "id": "2", + "redactedText": "Your ABA number - ********* - is the first 9 digits in the lower left hand corner of your personal check.", + "entities": [ + { + "category": "ABARoutingNumber", + "type": "ABARoutingNumber", + "confidenceScore": 0.75, + "length": 9, + "offset": 18, + "text": "111000025", + "tags": [ + { + "name": "Number", + "confidenceScore": 0.8 + }, + { + "name": "Numeric", + "confidenceScore": 0.8 + } + ] + } + ], + "warnings": [] + }, + { + "id": "3", + "redactedText": "Is ************** your Brazilian CPF number?", + "entities": [ + { + "category": "BRCPFNumber", + "type": "BRCPFNumber", + "confidenceScore": 0.85, + "length": 14, + "offset": 3, + "text": "998.214.865-68", + "tags": [ + { + "name": "Number", + "confidenceScore": 0.8 + }, + { + "name": "Numeric", + "confidenceScore": 0.8 + } + ] + } + ], + "warnings": [] + } + ], + "errors": [], + "modelVersion": "2021-01-15" + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeText/examples/2025-05-15-preview/SuccessfulSentimentAnalysisRequest.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeText/examples/2025-05-15-preview/SuccessfulSentimentAnalysisRequest.json new file mode 100644 index 000000000000..e64a31f70ffd --- /dev/null +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeText/examples/2025-05-15-preview/SuccessfulSentimentAnalysisRequest.json @@ -0,0 +1,150 @@ +{ + "operationId": "AnalyzeText", + "title": "SuccessfulSentimentAnalysisRequest", + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2025-05-15-preview", + "Endpoint": "{Endpoint}", + "body": { + "kind": "SentimentAnalysis", + "parameters": { + "modelVersion": "latest" + }, + "analysisInput": { + "documents": [ + { + "id": "1", + "language": "en", + "text": "Great atmosphere. Close to plenty of restaurants, hotels, and transit! Staff are friendly and helpful." + } + ] + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "kind": "SentimentAnalysisResults", + "results": { + "documents": [ + { + "confidenceScores": { + "negative": 0, + "neutral": 0, + "positive": 1 + }, + "id": "1", + "sentences": [ + { + "targets": [ + { + "confidenceScores": { + "negative": 0, + "positive": 1 + }, + "length": 10, + "offset": 6, + "relations": [ + { + "ref": "#/documents/0/sentences/0/assessments/0", + "relationType": "assessment" + } + ], + "sentiment": "positive", + "text": "atmosphere" + } + ], + "confidenceScores": { + "negative": 0, + "neutral": 0, + "positive": 1 + }, + "length": 17, + "offset": 0, + "assessments": [ + { + "confidenceScores": { + "negative": 0, + "positive": 1 + }, + "isNegated": false, + "length": 5, + "offset": 0, + "sentiment": "positive", + "text": "great" + } + ], + "sentiment": "positive", + "text": "Great atmosphere." + }, + { + "targets": [ + { + "confidenceScores": { + "negative": 0.01, + "positive": 0.99 + }, + "length": 11, + "offset": 37, + "relations": [ + { + "ref": "#/documents/0/sentences/1/assessments/0", + "relationType": "assessment" + } + ], + "sentiment": "positive", + "text": "restaurants" + }, + { + "confidenceScores": { + "negative": 0.01, + "positive": 0.99 + }, + "length": 6, + "offset": 50, + "relations": [ + { + "ref": "#/documents/0/sentences/1/assessments/0", + "relationType": "assessment" + } + ], + "sentiment": "positive", + "text": "hotels" + } + ], + "confidenceScores": { + "negative": 0.01, + "neutral": 0.86, + "positive": 0.13 + }, + "length": 52, + "offset": 18, + "assessments": [ + { + "confidenceScores": { + "negative": 0.01, + "positive": 0.99 + }, + "isNegated": false, + "length": 15, + "offset": 18, + "sentiment": "positive", + "text": "Close to plenty" + } + ], + "sentiment": "neutral", + "text": "Close to plenty of restaurants, hotels, and transit!" + } + ], + "sentiment": "positive", + "warnings": [] + } + ], + "errors": [], + "modelVersion": "2021-10-01" + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeText/main.tsp b/specification/cognitiveservices/data-plane/LanguageAnalyzeText/main.tsp index 387b01ea9105..55401fade381 100644 --- a/specification/cognitiveservices/data-plane/LanguageAnalyzeText/main.tsp +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeText/main.tsp @@ -55,6 +55,9 @@ enum Versions { /** Version 2025-11-01 */ v2025_11_01: "2025-11-01", + /** Version 2025-05-15-preview */ + v2025_05_15_preview: "2025-05-15-preview", + /** Version 2025-11-15-preview */ v2025_11_15_preview: "2025-11-15-preview", } diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeText/models/common.models.tsp b/specification/cognitiveservices/data-plane/LanguageAnalyzeText/models/common.models.tsp index 508f95c09b18..74a8d2e3434e 100644 --- a/specification/cognitiveservices/data-plane/LanguageAnalyzeText/models/common.models.tsp +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeText/models/common.models.tsp @@ -188,11 +188,11 @@ model AnalyzeTextJobsInput { tasks: AnalyzeTextLROTask[]; /** Default language to use for records requesting automatic language detection. */ - @added(Versions.v2025_11_15_preview) + @added(Versions.v2025_05_15_preview) defaultLanguage?: string; /** Optional duration in seconds after which the job will be canceled if not completed. */ - @added(Versions.v2025_11_15_preview) + @added(Versions.v2025_05_15_preview) cancelAfter?: float32; } @@ -358,7 +358,7 @@ model MultiLanguageInput { } /** Defines the detected language for the document. */ -@added(Versions.v2025_11_15_preview) +@added(Versions.v2025_05_15_preview) model DocumentDetectedLanguage { /** If 'language' is set to 'auto' for the document in the request this field will contain a 2 letter ISO 639-1 representation of the language detected for this document. */ detectedLanguage?: DetectedLanguage; diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeText/models/custom.text.tsp b/specification/cognitiveservices/data-plane/LanguageAnalyzeText/models/custom.text.tsp index 0a25676220a4..8273033d9d31 100644 --- a/specification/cognitiveservices/data-plane/LanguageAnalyzeText/models/custom.text.tsp +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeText/models/custom.text.tsp @@ -29,12 +29,12 @@ model CustomEntitiesLROTask extends AnalyzeTextLROTask { /** Contains the list of detected custom entities result for the documents. */ model CustomEntitiesResult is CustomResult { /** Enumeration of the document results. */ - @typeChangedFrom(Versions.v2025_11_15_preview, EntitiesDocumentResult[]) + @typeChangedFrom(Versions.v2025_05_15_preview, EntitiesDocumentResult[]) documents: EntitiesDocumentResultWithDetectedLanguage[]; } /** Contains the entity recognition task result for the document with detected language. */ -@added(Versions.v2025_11_15_preview) +@added(Versions.v2025_05_15_preview) model EntitiesDocumentResultWithDetectedLanguage { ...EntitiesDocumentResult; ...DocumentDetectedLanguage; @@ -56,7 +56,7 @@ model CustomSingleLabelClassificationLROTask extends AnalyzeTextLROTask { /** Contains the custom label classification results. */ model CustomLabelClassificationResult is CustomResult { /** Response by document */ - @typeChangedFrom(Versions.v2025_11_15_preview, ClassificationDocumentResult[]) + @typeChangedFrom(Versions.v2025_05_15_preview, ClassificationDocumentResult[]) documents: ClassificationDocumentResultWithDetectedLanguage[]; } @@ -125,7 +125,7 @@ model CustomMultiLabelClassificationLROResult extends AnalyzeTextLROResult { } /** This object contains information of the detected entity components. The possible component types may expand in the future. Parsing code should handle unexpected values gracefully */ -@added(Versions.v2025_11_15_preview) +@added(Versions.v2025_05_15_preview) @discriminator("entityComponentKind") model EntityComponentInformation { /** Kind of entity component. */ @@ -133,7 +133,7 @@ model EntityComponentInformation { } /** Kind of entity components supported. */ -@added(Versions.v2025_11_15_preview) +@added(Versions.v2025_05_15_preview) union entityComponentKind { string, @@ -148,7 +148,7 @@ union entityComponentKind { } /** This object contains information of the prebuilt component of the detected entity. */ -@added(Versions.v2025_11_15_preview) +@added(Versions.v2025_05_15_preview) model PrebuiltComponent extends EntityComponentInformation { /** Kind of entity component. */ entityComponentKind: entityComponentKind.PrebuiltComponent; @@ -158,7 +158,7 @@ model PrebuiltComponent extends EntityComponentInformation { } /** This object contains information of the learned component of the detected entity. */ -@added(Versions.v2025_11_15_preview) +@added(Versions.v2025_05_15_preview) model LearnedComponent extends EntityComponentInformation { /** Kind of entity component. */ entityComponentKind: entityComponentKind.LearnedComponent; @@ -168,7 +168,7 @@ model LearnedComponent extends EntityComponentInformation { } /** This object contains information of the list component of the detected entity. */ -@added(Versions.v2025_11_15_preview) +@added(Versions.v2025_05_15_preview) model ListComponent extends EntityComponentInformation { /** Kind of entity component. */ entityComponentKind: entityComponentKind.ListComponent; @@ -178,7 +178,7 @@ model ListComponent extends EntityComponentInformation { } /** Specifies either one or multiple categories per document. Defaults to multi classification which may return more than one class for each document. */ -@added(Versions.v2025_11_15_preview) +@added(Versions.v2025_05_15_preview) union ClassificationType { string, diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeText/models/entity.linking.tsp b/specification/cognitiveservices/data-plane/LanguageAnalyzeText/models/entity.linking.tsp index 3eb1b50e24c6..51e5118ecc36 100644 --- a/specification/cognitiveservices/data-plane/LanguageAnalyzeText/models/entity.linking.tsp +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeText/models/entity.linking.tsp @@ -46,7 +46,7 @@ model EntityLinkingTaskResult extends AnalyzeTextTaskResult { /** Entity linking result. */ model EntityLinkingResult is PreBuiltResult { /** Response by document */ - @typeChangedFrom(Versions.v2025_11_15_preview, LinkedEntitiesDocumentResult[]) + @typeChangedFrom(Versions.v2025_05_15_preview, LinkedEntitiesDocumentResult[]) documents: EntityLinkingResultWithDetectedLanguage[]; } @@ -57,7 +57,7 @@ model LinkedEntitiesDocumentResult is DocumentResult { } /** Entity linking document result with auto language detection. */ -@added(Versions.v2025_11_15_preview) +@added(Versions.v2025_05_15_preview) model EntityLinkingResultWithDetectedLanguage { ...LinkedEntitiesDocumentResult; ...DocumentDetectedLanguage; diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeText/models/entity.recognition.tsp b/specification/cognitiveservices/data-plane/LanguageAnalyzeText/models/entity.recognition.tsp index ea2adafe59e6..86b9069d7c9d 100644 --- a/specification/cognitiveservices/data-plane/LanguageAnalyzeText/models/entity.recognition.tsp +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeText/models/entity.recognition.tsp @@ -56,7 +56,7 @@ model EntitiesTaskResult extends AnalyzeTextTaskResult { kind: AnalyzeTextTaskResultsKind.EntityRecognitionResults; /** Results for entity recognition. */ - @typeChangedFrom(Versions.v2025_11_15_preview, EntitiesResult) + @typeChangedFrom(Versions.v2025_05_15_preview, EntitiesResult) results: EntitiesWithMetadataAutoResult; } @@ -68,7 +68,7 @@ model EntitiesResult is PreBuiltResult { } /** Contains the entity recognition task result. */ -@added(Versions.v2025_11_15_preview) +@added(Versions.v2025_05_15_preview) model EntitiesWithMetadataAutoResult is PreBuiltResult { /** Response by document */ documents: EntitiesDocumentResultWithMetadataDetectedLanguage[]; @@ -81,7 +81,7 @@ model EntitiesDocumentResult is DocumentResult { } /** Contains the entity recognition task result for the document with metadata and detected language. */ -@added(Versions.v2025_11_15_preview) +@added(Versions.v2025_05_15_preview) model EntitiesDocumentResultWithMetadataDetectedLanguage is EntitiesDocumentResultWithMetadata { ...DocumentDetectedLanguage; diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeText/models/healthcare.tsp b/specification/cognitiveservices/data-plane/LanguageAnalyzeText/models/healthcare.tsp index 5aebfcd088e2..02b2d239d792 100644 --- a/specification/cognitiveservices/data-plane/LanguageAnalyzeText/models/healthcare.tsp +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeText/models/healthcare.tsp @@ -76,7 +76,7 @@ model HealthcareLROTask extends AnalyzeTextLROTask { model HealthcareResult is PreBuiltResult { /** List of result objects for the processed Healthcare documents. */ @typeChangedFrom( - Versions.v2025_11_15_preview, + Versions.v2025_05_15_preview, HealthcareEntitiesDocumentResult[] ) documents: HealthcareEntitiesDocumentResultWithDocumentDetectedLanguage[]; @@ -488,7 +488,7 @@ model HealthcareLROResult extends AnalyzeTextLROResult { } /** Result object for the processed Healthcare document with detected language. */ -@added(Versions.v2025_11_15_preview) +@added(Versions.v2025_05_15_preview) model HealthcareEntitiesDocumentResultWithDocumentDetectedLanguage is HealthcareEntitiesDocumentResult { ...DocumentDetectedLanguage; diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeText/models/key.phrase.extraction.tsp b/specification/cognitiveservices/data-plane/LanguageAnalyzeText/models/key.phrase.extraction.tsp index 6d947d6fafee..7ac1bf0ac4e6 100644 --- a/specification/cognitiveservices/data-plane/LanguageAnalyzeText/models/key.phrase.extraction.tsp +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeText/models/key.phrase.extraction.tsp @@ -43,7 +43,7 @@ model KeyPhraseTaskResult extends AnalyzeTextTaskResult { @doc("Contains the KeyPhraseResult.") model KeyPhraseResult is PreBuiltResult { @doc("Response by document") - @typeChangedFrom(Versions.v2025_11_15_preview, KeyPhrasesDocumentResult[]) + @typeChangedFrom(Versions.v2025_05_15_preview, KeyPhrasesDocumentResult[]) documents: KeyPhrasesDocumentResultWithDetectedLanguage[]; } diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeText/models/pii.entity.recognition.tsp b/specification/cognitiveservices/data-plane/LanguageAnalyzeText/models/pii.entity.recognition.tsp index fcc647d9b5d2..6dfd509622cf 100644 --- a/specification/cognitiveservices/data-plane/LanguageAnalyzeText/models/pii.entity.recognition.tsp +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeText/models/pii.entity.recognition.tsp @@ -32,15 +32,20 @@ model PiiTaskParameters is PreBuiltTaskParametersLoggingOptOut { stringIndexType?: StringIndexType = StringIndexType.TextElements_v8; /** Enumeration of PII categories to be excluded in the response. */ - @added(Versions.v2025_11_15_preview) + @added(Versions.v2025_05_15_preview) excludePiiCategories?: PiiCategoriesExclude[]; + /** RedactionPolicy to be used on the input. */ + @added(Versions.v2025_05_15_preview) + @removed(Versions.v2025_11_15_preview) + redactionPolicy?: BaseRedactionPolicy; + /** Policy for specific words and terms that should be excluded from detection by the PII detection service */ - @added(Versions.v2025_11_15_preview) + @added(Versions.v2025_05_15_preview) valueExclusionPolicy?: ValueExclusionPolicy; /** (Optional) request parameter that allows the user to provide synonyms for context words that to enhance pii entity detection. */ - @added(Versions.v2025_11_15_preview) + @added(Versions.v2025_05_15_preview) entitySynonyms?: EntitySynonyms[]; /** List of RedactionPolicies to be used on the input. */ @@ -57,7 +62,7 @@ model PiiTaskParameters is PreBuiltTaskParametersLoggingOptOut { } /** Object that allows the user to provide synonyms for context words that to enhance pii entity detection. */ -@added(Versions.v2025_11_15_preview) +@added(Versions.v2025_05_15_preview) model EntitySynonyms { /** The entity name */ entityType: EntityCategory; @@ -90,7 +95,7 @@ model ConfidenceScoreThresholdOverride { } /** The entity synonyms used to enhance pii entity detection */ -@added(Versions.v2025_11_15_preview) +@added(Versions.v2025_05_15_preview) model EntitySynonym { /** The synonym to be used for context */ synonym: string; @@ -100,7 +105,7 @@ model EntitySynonym { } /** Policy for specific words and terms that should be excluded from detection by the PII detection service */ -@added(Versions.v2025_11_15_preview) +@added(Versions.v2025_05_15_preview) model ValueExclusionPolicy { /** Option to make the values excluded values case sensitive */ caseSensitive: boolean = false; @@ -110,7 +115,7 @@ model ValueExclusionPolicy { } /** The abstract base class for RedactionPolicy. */ -@added(Versions.v2025_11_15_preview) +@added(Versions.v2025_05_15_preview) @discriminator("policyKind") model BaseRedactionPolicy { /** The entity RedactionPolicy object kind. */ @@ -130,7 +135,7 @@ model BaseRedactionPolicy { } /** Represents the policy of redacting with a redaction character */ -@added(Versions.v2025_11_15_preview) +@added(Versions.v2025_05_15_preview) model CharacterMaskPolicyType extends BaseRedactionPolicy { /** The entity RedactionPolicy object kind. */ policyKind: RedactionPolicyKind.characterMask; @@ -158,21 +163,21 @@ model SyntheticReplacementPolicyType extends BaseRedactionPolicy { } /** Represents the policy of not redacting found PII. */ -@added(Versions.v2025_11_15_preview) +@added(Versions.v2025_05_15_preview) model NoMaskPolicyType extends BaseRedactionPolicy { /** The entity RedactionPolicy object kind. */ policyKind: RedactionPolicyKind.noMask; } /** Represents the policy of redacting PII with the entity type. */ -@added(Versions.v2025_11_15_preview) +@added(Versions.v2025_05_15_preview) model EntityMaskPolicyType extends BaseRedactionPolicy { /** The entity OverlapPolicy object kind. */ policyKind: RedactionPolicyKind.entityMask; } /** Kinds of redaction policies supported. */ -@added(Versions.v2025_11_15_preview) +@added(Versions.v2025_05_15_preview) union RedactionPolicyKind { string, @@ -214,7 +219,7 @@ model PiiTaskResult extends AnalyzeTextTaskResult { #suppress "@azure-tools/typespec-azure-core/casing-style" model PiiResult is PreBuiltResult { /** Response by document */ - @typeChangedFrom(Versions.v2025_11_15_preview, PiiEntitiesDocumentResult[]) + @typeChangedFrom(Versions.v2025_05_15_preview, PiiEntitiesDocumentResult[]) documents: PiiResultWithDetectedLanguage[]; } @@ -239,15 +244,15 @@ model PiiEntityWithTags is Entity { tags?: EntityTag[]; /** Optional field which will be returned only when using the redaction policy kind “MaskWithEntityType”. This field will contain the exact mask text used to mask the PII entity in the original text */ - @added(Versions.v2025_11_15_preview) + @added(Versions.v2025_05_15_preview) mask?: string; /** Start position of masked text in the redacted text when using the redaction policy kind “MaskWithEntityType”. */ - @added(Versions.v2025_11_15_preview) + @added(Versions.v2025_05_15_preview) maskOffset?: int32; /** The length of the masked text. Will be present when using the redaction policy kind “MaskWithEntityType”. */ - @added(Versions.v2025_11_15_preview) + @added(Versions.v2025_05_15_preview) maskLength?: int32; } @@ -258,7 +263,7 @@ model PiiEntitiesDocumentResult is DocumentResult { redactedText: string; /** Recognized entities in the document. */ - @typeChangedFrom(Versions.v2025_11_15_preview, Entity[]) + @typeChangedFrom(Versions.v2025_05_15_preview, Entity[]) entities: PiiEntityWithTags[]; } @@ -825,7 +830,7 @@ union PiiCategoriesExclude { DriversLicenseNumber: "DriversLicenseNumber", /** Neighborhood */ - @added(Versions.v2025_11_15_preview) + @added(Versions.v2025_05_15_preview) Neighborhood: "Neighborhood", /** Sort Code. 6-digit number used in the UK to identify a specific bank and branch where a bank account is held */ @@ -833,19 +838,21 @@ union PiiCategoriesExclude { SortCode: "SortCode", /** PIN */ - @added(Versions.v2025_11_15_preview) + @added(Versions.v2025_05_15_preview) PIN: "PIN", /** VIN */ - @added(Versions.v2025_11_15_preview) + @added(Versions.v2025_05_15_preview) VIN: "VIN", /** VIN */ @added(Versions.v2025_11_01) + @removed(Versions.v2025_05_15_preview) + @added(Versions.v2025_11_15_preview) VehicleIdentificationNumber: "VehicleIdentificationNumber", /** License Plate */ - @added(Versions.v2025_11_15_preview) + @added(Versions.v2025_05_15_preview) LicensePlate: "LicensePlate", /** KR Passport Number */ diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeText/models/sentiment.analysis.tsp b/specification/cognitiveservices/data-plane/LanguageAnalyzeText/models/sentiment.analysis.tsp index 20a894fbd0ea..61cb593eb7e8 100644 --- a/specification/cognitiveservices/data-plane/LanguageAnalyzeText/models/sentiment.analysis.tsp +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeText/models/sentiment.analysis.tsp @@ -77,7 +77,7 @@ union TokenSentimentValue { /** Sentiment analysis results for the input documents. */ model SentimentResponse is PreBuiltResult { /** The sentiment analysis results for each document in the input. */ - @typeChangedFrom(Versions.v2025_11_15_preview, SentimentDocumentResult[]) + @typeChangedFrom(Versions.v2025_05_15_preview, SentimentDocumentResult[]) documents: SentimentDocumentResultWithDetectedLanguage[]; } diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeText/models/summarization.tsp b/specification/cognitiveservices/data-plane/LanguageAnalyzeText/models/summarization.tsp index 3f52b2512cb8..ffd7382096bc 100644 --- a/specification/cognitiveservices/data-plane/LanguageAnalyzeText/models/summarization.tsp +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeText/models/summarization.tsp @@ -19,7 +19,7 @@ model ExtractiveSummarizationTaskParameters is PreBuiltTaskParameters { stringIndexType?: StringIndexType = StringIndexType.TextElements_v8; /** (Optional) If provided, the query will be used to extract most relevant sentences from the document. */ - @added(Versions.v2025_11_15_preview) + @added(Versions.v2025_05_15_preview) query?: string; } @@ -40,7 +40,7 @@ model ExtractiveSummarizationResult is PreBuiltResult { /** Response by document */ @added(Versions.v2023_04_01) @typeChangedFrom( - Versions.v2025_11_15_preview, + Versions.v2025_05_15_preview, ExtractedSummaryDocumentResult[] ) documents: ExtractedSummaryDocumentResultWithDetectedLanguage[]; @@ -66,7 +66,7 @@ model ExtractedSummaryDocumentResult is DocumentResult { } /** A ranked list of sentences representing the extracted summary. */ -@added(Versions.v2025_11_15_preview) +@added(Versions.v2025_05_15_preview) model ExtractedSummaryDocumentResultWithDetectedLanguage is ExtractedSummaryDocumentResult { ...DocumentDetectedLanguage; @@ -116,7 +116,7 @@ model AbstractiveSummarizationTaskParameters is PreBuiltTaskParameters { ...AbstractiveSummarizationTaskParametersBase; /** (Optional) If provided, the query will be used to generate the summary. */ - @added(Versions.v2025_11_15_preview) + @added(Versions.v2025_05_15_preview) instruction?: string; } @@ -137,7 +137,7 @@ model AbstractiveSummarizationResultBase { /** Response by document */ @added(Versions.v2023_04_01) @typeChangedFrom( - Versions.v2025_11_15_preview, + Versions.v2025_05_15_preview, AbstractiveSummaryDocumentResult[] ) documents: AbstractiveSummaryDocumentResultWithDetectedLanguage[]; @@ -157,7 +157,7 @@ model AbstractiveSummaryDocumentResult is DocumentResult { } /** An object representing the Abstractive Summarization result of a single document with detected language. */ -@added(Versions.v2025_11_15_preview) +@added(Versions.v2025_05_15_preview) model AbstractiveSummaryDocumentResultWithDetectedLanguage is AbstractiveSummaryDocumentResult { ...DocumentDetectedLanguage; diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeText/preview/2025-05-15-preview/analyzetext.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeText/preview/2025-05-15-preview/analyzetext.json new file mode 100644 index 000000000000..960a3761b802 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeText/preview/2025-05-15-preview/analyzetext.json @@ -0,0 +1,9866 @@ +{ + "swagger": "2.0", + "info": { + "title": "Microsoft Cognitive Language Service - Text Analysis", + "version": "2025-05-15-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 https://learn.microsoft.com/azure/cognitive-services/language-service/overview.0", + "x-typespec-generated": [ + { + "emitter": "@azure-tools/typespec-autorest" + } + ] + }, + "schemes": [ + "https" + ], + "x-ms-parameterized-host": { + "hostTemplate": "{Endpoint}/language", + "useSchemePrefix": false, + "parameters": [ + { + "name": "Endpoint", + "in": "path", + "description": "Supported Cognitive Services endpoint (e.g., https://.api.cognitiveservices.azure.com).", + "required": true, + "type": "string", + "format": "uri", + "x-ms-skip-url-encoding": true + } + ] + }, + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "security": [ + { + "ApiKeyAuth": [] + }, + { + "OAuth2Auth": [ + "https://cognitiveservices.azure.com/.default" + ] + } + ], + "securityDefinitions": { + "ApiKeyAuth": { + "type": "apiKey", + "name": "Ocp-Apim-Subscription-Key", + "in": "header" + }, + "OAuth2Auth": { + "type": "oauth2", + "flow": "accessCode", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "https://cognitiveservices.azure.com/.default": "" + }, + "tokenUrl": "https://login.microsoftonline.com/common/oauth2/token" + } + }, + "tags": [], + "paths": { + "/:analyze-text": { + "post": { + "operationId": "AnalyzeText", + "description": "Request text analysis over a collection of documents.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "showStats", + "in": "query", + "description": "(Optional) if set to true, response will contain request and document level statistics.", + "required": false, + "type": "boolean" + }, + { + "name": "body", + "in": "body", + "description": "The input documents to analyze.", + "required": true, + "schema": { + "$ref": "#/definitions/AnalyzeTextTask" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/AnalyzeTextTaskResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "SuccessfulEntityLinkingRequest": { + "$ref": "./examples/SuccessfulEntityLinkingRequest.json" + }, + "SuccessfulEntityRecognitionExclusionRequest": { + "$ref": "./examples/SuccessfulEntityRecognitionExclusionRequest.json" + }, + "SuccessfulEntityRecognitionInclusionRequest": { + "$ref": "./examples/SuccessfulEntityRecognitionInclusionRequest.json" + }, + "SuccessfulEntityRecognitionInferenceOptionsRequest": { + "$ref": "./examples/SuccessfulEntityRecognitionInferenceOptionsRequest.json" + }, + "SuccessfulEntityRecognitionOverlapPolicy": { + "$ref": "./examples/SuccessfulEntityRecognitionOverlapPolicy.json" + }, + "SuccessfulEntityRecognitionRequest": { + "$ref": "./examples/SuccessfulEntityRecognitionRequest.json" + }, + "SuccessfulKeyPhraseExtractionRequest": { + "$ref": "./examples/SuccessfulKeyPhraseExtractionRequest.json" + }, + "SuccessfulLanguageDetectionRequest": { + "$ref": "./examples/SuccessfulLanguageDetectionRequest.json" + }, + "SuccessfulPiiEntityRecognitionExclusionRequest": { + "$ref": "./examples/SuccessfulPiiEntityRecognitionExclusionRequest.json" + }, + "SuccessfulPiiEntityRecognitionMaskedEntitiesRequest": { + "$ref": "./examples/SuccessfulPiiEntityRecognitionMaskedEntities.json" + }, + "SuccessfulPiiEntityRecognitionRedactionPolicyRequest": { + "$ref": "./examples/SuccessfulPiiEntityRecognitionRedactionPolicyRequest.json" + }, + "SuccessfulPiiEntityRecognitionRequest": { + "$ref": "./examples/SuccessfulPiiEntityRecognitionRequest.json" + }, + "SuccessfulSentimentAnalysisRequest": { + "$ref": "./examples/SuccessfulSentimentAnalysisRequest.json" + } + } + } + }, + "/analyze-text/jobs": { + "post": { + "operationId": "AnalyzeTextSubmitJob", + "description": "Submit a collection of text documents for analysis. Specify one or more unique tasks to be executed as a long-running operation.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "body", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/AnalyzeTextJobsInput" + } + } + ], + "responses": { + "202": { + "description": "The request has been accepted for processing, but processing has not yet completed.", + "headers": { + "Operation-Location": { + "type": "string", + "format": "uri", + "description": "The location for monitoring the operation state." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "SuccessfulAbstractiveSummarizationSummaryLengthPromptTaskSubmit": { + "$ref": "./examples/SuccessfulAbstractiveSummarizationSummaryLengthPromptTaskSubmit.json" + }, + "SuccessfulAbstractiveSummarizationTaskSubmit": { + "$ref": "./examples/SuccessfulAbstractiveSummarizationTaskSubmit.json" + }, + "SuccessfulAnalyzeTextJobsMultipleTaskSubmitRequest": { + "$ref": "./examples/SuccessfulAnalyzeTextJobsMultipleTaskSubmitRequest.json" + }, + "SuccessfulHealthcareDocumentTypePostRequest": { + "$ref": "./examples/SuccessfulHealthcareDocumentTypePostRequest.json" + }, + "SuccessfulHealthcarePostRequest": { + "$ref": "./examples/SuccessfulHealthcarePostRequest.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/analyze-text/jobs/{jobId}": { + "get": { + "operationId": "AnalyzeTextJobStatus", + "summary": "Get analysis status and results", + "description": "Get the status of an analysis job. A job can consist of one or more tasks. After all tasks succeed, the job transitions to the succeeded state and results are available for each task.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "jobId", + "in": "path", + "description": "job ID", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "name": "showStats", + "in": "query", + "description": "(Optional) if set to true, response will contain request and document level statistics.", + "required": false, + "type": "boolean" + }, + { + "name": "top", + "in": "query", + "description": "The maximum number of resources to return from the collection.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "skip", + "in": "query", + "description": "An offset into the collection of the first resource to be returned.", + "required": false, + "type": "integer", + "format": "int32" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/AnalyzeTextJobState" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "SuccessfulAbstractiveSummarizationSummaryLengthPromptTaskResult": { + "$ref": "./examples/SuccessfulAbstractiveSummarizationSummaryLengthPromptTaskResult.json" + }, + "SuccessfulAbstractiveSummarizationTaskResult": { + "$ref": "./examples/SuccessfulAbstractiveSummarizationTaskResult.json" + }, + "SuccessfulAnalyzeTextJobsMultipleTaskStatusRequest": { + "$ref": "./examples/SuccessfulAnalyzeTextJobsMultipleTaskStatusRequest.json" + }, + "SuccessfulHealthcareDocumentTypeTaskStatusRequest": { + "$ref": "./examples/SuccessfulHealthcareDocumentTypeTaskStatusRequest.json" + }, + "SuccessfulHealthcareTaskStatusRequest": { + "$ref": "./examples/SuccessfulHealthcareTaskStatusRequest.json" + } + } + } + }, + "/analyze-text/jobs/{jobId}:cancel": { + "post": { + "operationId": "AnalyzeTextCancelJob", + "summary": "Cancel a long-running Text Analysis job.", + "description": "Cancel a long-running Text Analysis job.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "jobId", + "in": "path", + "description": "The job ID to cancel.", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "202": { + "description": "The request has been accepted for processing, but processing has not yet completed.", + "headers": { + "Operation-Location": { + "type": "string", + "format": "uri", + "description": "The location for monitoring the operation state." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "SuccessfulAnalyzeTextJobsCancelRequest": { + "$ref": "./examples/SuccessfulAnalyzeTextJobsCancelRequest.json" + } + }, + "x-ms-long-running-operation": true + } + } + }, + "definitions": { + "AbstractiveSummarizationLROResult": { + "type": "object", + "description": "An object representing the results for an Abstractive Summarization task.", + "properties": { + "results": { + "$ref": "#/definitions/AbstractiveSummarizationResult", + "description": "Results of the task." + } + }, + "required": [ + "results" + ], + "allOf": [ + { + "$ref": "#/definitions/AnalyzeTextLROResult" + } + ], + "x-ms-discriminator-value": "AbstractiveSummarizationLROResults" + }, + "AbstractiveSummarizationLROTask": { + "type": "object", + "description": "An object representing the task definition for an Abstractive Summarization task.", + "properties": { + "parameters": { + "$ref": "#/definitions/AbstractiveSummarizationTaskParameters", + "description": "Parameters for the Abstractive Summarization task." + } + }, + "allOf": [ + { + "$ref": "#/definitions/AnalyzeTextLROTask" + } + ], + "x-ms-discriminator-value": "AbstractiveSummarization" + }, + "AbstractiveSummarizationResult": { + "type": "object", + "description": "An object representing the pre-built Abstractive Summarization results of each document.", + "properties": { + "errors": { + "type": "array", + "description": "Errors by document id.", + "items": { + "$ref": "#/definitions/DocumentError" + } + }, + "statistics": { + "$ref": "#/definitions/RequestStatistics", + "description": "if showStats=true was specified in the request this field will contain information about the request payload." + }, + "modelVersion": { + "type": "string", + "description": "This field indicates which model is used for scoring." + }, + "documents": { + "type": "array", + "description": "Response by document", + "items": { + "$ref": "#/definitions/AbstractiveSummaryDocumentResultWithDetectedLanguage" + } + } + }, + "required": [ + "errors", + "modelVersion", + "documents" + ] + }, + "AbstractiveSummarizationTaskParameters": { + "type": "object", + "description": "Supported parameters for the pre-built Abstractive Summarization task.", + "properties": { + "loggingOptOut": { + "type": "boolean", + "description": "logging opt out", + "default": false + }, + "modelVersion": { + "type": "string", + "description": "model version", + "default": "latest" + }, + "sentenceCount": { + "type": "integer", + "format": "int32", + "description": "Controls the approximate number of sentences in the output summaries." + }, + "stringIndexType": { + "type": "string", + "description": "String index type", + "default": "TextElements_v8", + "enum": [ + "TextElements_v8", + "UnicodeCodePoint", + "Utf16CodeUnit" + ], + "x-ms-enum": { + "name": "StringIndexType", + "modelAsString": true, + "values": [ + { + "name": "TextElements_v8", + "value": "TextElements_v8", + "description": "Returned offset and length values will correspond to TextElements (Graphemes and Grapheme clusters) confirming to the Unicode 8.0.0 standard. Use this option if your application is written in .Net Framework or .Net Core and you will be using StringInfo." + }, + { + "name": "UnicodeCodePoint", + "value": "UnicodeCodePoint", + "description": "Returned offset and length values will correspond to Unicode code points. Use this option if your application is written in a language that support Unicode, for example Python." + }, + { + "name": "Utf16CodeUnit", + "value": "Utf16CodeUnit", + "description": "Returned offset and length values will correspond to UTF-16 code units. Use this option if your application is written in a language that support Unicode, for example Java, JavaScript." + } + ] + } + }, + "summaryLength": { + "$ref": "#/definitions/SummaryLengthBucket", + "description": "(NOTE: Recommended to use summaryLength over sentenceCount) Controls the approximate length of the output summaries." + }, + "instruction": { + "type": "string", + "description": "(Optional) If provided, the query will be used to generate the summary." + } + } + }, + "AbstractiveSummary": { + "type": "object", + "description": "An object representing a single summary with context for given document.", + "properties": { + "text": { + "type": "string", + "description": "The text of the summary." + }, + "contexts": { + "type": "array", + "description": "The context list of the summary.", + "items": { + "$ref": "#/definitions/SummaryContext" + } + } + }, + "required": [ + "text" + ] + }, + "AbstractiveSummaryDocumentResultWithDetectedLanguage": { + "type": "object", + "description": "An object representing the Abstractive Summarization result of a single document with detected language.", + "properties": { + "id": { + "type": "string", + "description": "Unique, non-empty document identifier." + }, + "warnings": { + "type": "array", + "description": "Warnings encountered while processing document.", + "items": { + "$ref": "#/definitions/DocumentWarning" + } + }, + "statistics": { + "$ref": "#/definitions/DocumentStatistics", + "description": "if showStats=true was specified in the request this field will contain information about the document payload." + }, + "summaries": { + "type": "array", + "description": "A list of abstractive summaries.", + "items": { + "$ref": "#/definitions/AbstractiveSummary" + } + }, + "detectedLanguage": { + "$ref": "#/definitions/DetectedLanguage", + "description": "If 'language' is set to 'auto' for the document in the request this field will contain a 2 letter ISO 639-1 representation of the language detected for this document." + } + }, + "required": [ + "id", + "warnings", + "summaries" + ] + }, + "AgeMetadata": { + "type": "object", + "description": "Represents the Age entity Metadata model.", + "properties": { + "value": { + "type": "number", + "format": "double", + "description": "The numeric value that the extracted text denotes." + }, + "unit": { + "$ref": "#/definitions/AgeUnit", + "description": "Unit of measure for age." + } + }, + "required": [ + "value", + "unit" + ], + "allOf": [ + { + "$ref": "#/definitions/BaseMetadata" + } + ], + "x-ms-discriminator-value": "AgeMetadata" + }, + "AgeUnit": { + "type": "string", + "description": "The Age Unit of measurement", + "enum": [ + "Unspecified", + "Year", + "Month", + "Week", + "Day" + ], + "x-ms-enum": { + "name": "AgeUnit", + "modelAsString": true, + "values": [ + { + "name": "Unspecified", + "value": "Unspecified", + "description": "Unspecified time period" + }, + { + "name": "Year", + "value": "Year", + "description": "Time period of a year" + }, + { + "name": "Month", + "value": "Month", + "description": "Time period of a month" + }, + { + "name": "Week", + "value": "Week", + "description": "Time period of a week" + }, + { + "name": "Day", + "value": "Day", + "description": "Time period of a day" + } + ] + } + }, + "AllowOverlapEntityPolicyType": { + "type": "object", + "description": "Represents the allow overlap policy. Will apply no post processing logic for the entities. Whatever the model predicts is what will be returned to the user. This allows the user to get a full view of every single model's possible values and apply their own custom logic on entity selection", + "allOf": [ + { + "$ref": "#/definitions/BaseEntityOverlapPolicy" + } + ], + "x-ms-discriminator-value": "allowOverlap" + }, + "AnalyzeTextEntityLinkingInput": { + "type": "object", + "description": "Contains the analyze text Entity linking input.", + "properties": { + "analysisInput": { + "$ref": "#/definitions/MultiLanguageAnalysisInput", + "description": "Contains the analysis input to be handled by the service." + }, + "parameters": { + "$ref": "#/definitions/EntityLinkingTaskParameters", + "description": "Task parameters." + } + }, + "allOf": [ + { + "$ref": "#/definitions/AnalyzeTextTask" + } + ], + "x-ms-discriminator-value": "EntityLinking" + }, + "AnalyzeTextEntityRecognitionInput": { + "type": "object", + "description": "The entity recognition analyze text input task request.", + "properties": { + "analysisInput": { + "$ref": "#/definitions/MultiLanguageAnalysisInput", + "description": "The input to be analyzed." + }, + "parameters": { + "$ref": "#/definitions/EntitiesTaskParameters", + "description": "Task parameters." + } + }, + "allOf": [ + { + "$ref": "#/definitions/AnalyzeTextTask" + } + ], + "x-ms-discriminator-value": "EntityRecognition" + }, + "AnalyzeTextJobState": { + "type": "object", + "description": "The object containing the analyze job LRO job state.", + "properties": { + "displayName": { + "type": "string", + "description": "display name" + }, + "createdDateTime": { + "type": "string", + "format": "date-time", + "description": "Date and time job created" + }, + "expirationDateTime": { + "type": "string", + "format": "date-time", + "description": "Date and time job expires" + }, + "jobId": { + "$ref": "#/definitions/Azure.Core.uuid", + "description": "job ID", + "readOnly": true + }, + "lastUpdatedDateTime": { + "type": "string", + "format": "date-time", + "description": "last updated date and time" + }, + "status": { + "$ref": "#/definitions/State", + "description": "status" + }, + "errors": { + "type": "array", + "description": "errors", + "items": { + "$ref": "#/definitions/Error" + } + }, + "nextLink": { + "type": "string", + "description": "next link" + }, + "tasks": { + "$ref": "#/definitions/Tasks", + "description": "List of tasks." + }, + "statistics": { + "$ref": "#/definitions/RequestStatistics", + "description": "if showStats=true was specified in the request this field will contain information about the request payload." + } + }, + "required": [ + "createdDateTime", + "jobId", + "lastUpdatedDateTime", + "status", + "tasks" + ] + }, + "AnalyzeTextJobsInput": { + "type": "object", + "description": "The input object for the analyze text LRO.", + "properties": { + "displayName": { + "type": "string", + "description": "Name for the task." + }, + "analysisInput": { + "$ref": "#/definitions/MultiLanguageAnalysisInput", + "description": "Contains the input to be analyzed." + }, + "tasks": { + "type": "array", + "description": "List of tasks to be performed as part of the LRO.", + "items": { + "$ref": "#/definitions/AnalyzeTextLROTask" + } + }, + "defaultLanguage": { + "type": "string", + "description": "Default language to use for records requesting automatic language detection." + }, + "cancelAfter": { + "type": "number", + "format": "float", + "description": "Optional duration in seconds after which the job will be canceled if not completed." + } + }, + "required": [ + "analysisInput", + "tasks" + ] + }, + "AnalyzeTextKeyPhraseExtractionInput": { + "type": "object", + "description": "Contains the analyze text KeyPhraseExtraction task input.", + "properties": { + "analysisInput": { + "$ref": "#/definitions/MultiLanguageAnalysisInput", + "description": "Contains the input documents." + }, + "parameters": { + "$ref": "#/definitions/KeyPhraseTaskParameters", + "description": "Key phrase extraction task parameters." + } + }, + "allOf": [ + { + "$ref": "#/definitions/AnalyzeTextTask" + } + ], + "x-ms-discriminator-value": "KeyPhraseExtraction" + }, + "AnalyzeTextLROResult": { + "type": "object", + "description": "Contains the AnalyzeText long running operation result object.", + "properties": { + "lastUpdateDateTime": { + "type": "string", + "format": "date-time", + "description": "The last updated time in UTC for the task." + }, + "status": { + "$ref": "#/definitions/State", + "description": "The status of the task at the mentioned last update time." + }, + "taskName": { + "type": "string", + "description": "task name" + }, + "kind": { + "$ref": "#/definitions/AnalyzeTextLROResultsKind", + "description": "Kind of the task." + } + }, + "discriminator": "kind", + "required": [ + "lastUpdateDateTime", + "status", + "kind" + ] + }, + "AnalyzeTextLROResultsKind": { + "type": "string", + "description": "The kind of the response object returned by the analyze-text long running task.", + "enum": [ + "SentimentAnalysisLROResults", + "EntityRecognitionLROResults", + "PiiEntityRecognitionLROResults", + "KeyPhraseExtractionLROResults", + "EntityLinkingLROResults", + "HealthcareLROResults", + "CustomEntityRecognitionLROResults", + "CustomSingleLabelClassificationLROResults", + "CustomMultiLabelClassificationLROResults", + "ExtractiveSummarizationLROResults", + "AbstractiveSummarizationLROResults" + ], + "x-ms-enum": { + "name": "AnalyzeTextLROResultsKind", + "modelAsString": true, + "values": [ + { + "name": "SentimentAnalysisLROResults", + "value": "SentimentAnalysisLROResults", + "description": "Sentiment analysis LRO results" + }, + { + "name": "EntityRecognitionLROResults", + "value": "EntityRecognitionLROResults", + "description": "Entity recognition LRO results" + }, + { + "name": "PiiEntityRecognitionLROResults", + "value": "PiiEntityRecognitionLROResults", + "description": "PII entity recognition LRO results" + }, + { + "name": "KeyPhraseExtractionLROResults", + "value": "KeyPhraseExtractionLROResults", + "description": "Key phrase extraction LRO results" + }, + { + "name": "EntityLinkingLROResults", + "value": "EntityLinkingLROResults", + "description": "Entity linking LRO results" + }, + { + "name": "HealthcareLROResults", + "value": "HealthcareLROResults", + "description": "Healthcare LRO results" + }, + { + "name": "CustomEntityRecognitionLROResults", + "value": "CustomEntityRecognitionLROResults", + "description": "Custom entity recognition LRO results" + }, + { + "name": "CustomSingleLabelClassificationLROResults", + "value": "CustomSingleLabelClassificationLROResults", + "description": "Custom single label classification LRO results" + }, + { + "name": "CustomMultiLabelClassificationLROResults", + "value": "CustomMultiLabelClassificationLROResults", + "description": "Custom multi label classification LRO results" + }, + { + "name": "ExtractiveSummarizationLROResults", + "value": "ExtractiveSummarizationLROResults", + "description": "Extractive summarization LRO results" + }, + { + "name": "AbstractiveSummarizationLROResults", + "value": "AbstractiveSummarizationLROResults", + "description": "Abstractive summarization LRO results" + } + ] + } + }, + "AnalyzeTextLROTask": { + "type": "object", + "description": "The long running task to be performed by the service on the input documents.", + "properties": { + "taskName": { + "type": "string", + "description": "task name" + }, + "kind": { + "$ref": "#/definitions/AnalyzeTextLROTaskKind", + "description": "The kind of task to perform." + } + }, + "discriminator": "kind", + "required": [ + "kind" + ] + }, + "AnalyzeTextLROTaskKind": { + "type": "string", + "description": "The kind of the long running analyze text tasks supported.", + "enum": [ + "SentimentAnalysis", + "EntityRecognition", + "PiiEntityRecognition", + "KeyPhraseExtraction", + "EntityLinking", + "Healthcare", + "CustomEntityRecognition", + "CustomSingleLabelClassification", + "CustomMultiLabelClassification", + "ExtractiveSummarization", + "AbstractiveSummarization" + ], + "x-ms-enum": { + "name": "AnalyzeTextLROTaskKind", + "modelAsString": true, + "values": [ + { + "name": "SentimentAnalysis", + "value": "SentimentAnalysis", + "description": "Sentiment analysis task" + }, + { + "name": "EntityRecognition", + "value": "EntityRecognition", + "description": "Entity recognition task" + }, + { + "name": "PiiEntityRecognition", + "value": "PiiEntityRecognition", + "description": "PII entity recognition task" + }, + { + "name": "KeyPhraseExtraction", + "value": "KeyPhraseExtraction", + "description": "Key phrase extraction task" + }, + { + "name": "EntityLinking", + "value": "EntityLinking", + "description": "Entity linking task" + }, + { + "name": "Healthcare", + "value": "Healthcare", + "description": "Healthcare task" + }, + { + "name": "CustomEntityRecognition", + "value": "CustomEntityRecognition", + "description": "Custom entity recognition task" + }, + { + "name": "CustomSingleLabelClassification", + "value": "CustomSingleLabelClassification", + "description": "Custom single label classification task" + }, + { + "name": "CustomMultiLabelClassification", + "value": "CustomMultiLabelClassification", + "description": "Custom multi label classification task" + }, + { + "name": "ExtractiveSummarization", + "value": "ExtractiveSummarization", + "description": "Extractive summarization task" + }, + { + "name": "AbstractiveSummarization", + "value": "AbstractiveSummarization", + "description": "Abstractive summarization task" + } + ] + } + }, + "AnalyzeTextLanguageDetectionInput": { + "type": "object", + "description": "Contains the language detection document analysis task input.", + "properties": { + "analysisInput": { + "$ref": "#/definitions/LanguageDetectionAnalysisInput", + "description": "Documents to be analyzed." + }, + "parameters": { + "$ref": "#/definitions/LanguageDetectionTaskParameters", + "description": "task parameters." + } + }, + "allOf": [ + { + "$ref": "#/definitions/AnalyzeTextTask" + } + ], + "x-ms-discriminator-value": "LanguageDetection" + }, + "AnalyzeTextPiiEntitiesRecognitionInput": { + "type": "object", + "description": "Contains the analyze text PIIEntityRecognition task input.", + "properties": { + "analysisInput": { + "$ref": "#/definitions/MultiLanguageAnalysisInput", + "description": "Contains the input documents." + }, + "parameters": { + "$ref": "#/definitions/PiiTaskParameters", + "description": "Pii task parameters." + } + }, + "allOf": [ + { + "$ref": "#/definitions/AnalyzeTextTask" + } + ], + "x-ms-discriminator-value": "PiiEntityRecognition" + }, + "AnalyzeTextSentimentAnalysisInput": { + "type": "object", + "description": "Contains the analyze text SentimentAnalysis task input.", + "properties": { + "analysisInput": { + "$ref": "#/definitions/MultiLanguageAnalysisInput", + "description": "Contains the input documents." + }, + "parameters": { + "$ref": "#/definitions/SentimentAnalysisTaskParameters", + "description": "Sentiment Analysis task parameters." + } + }, + "allOf": [ + { + "$ref": "#/definitions/AnalyzeTextTask" + } + ], + "x-ms-discriminator-value": "SentimentAnalysis" + }, + "AnalyzeTextTask": { + "type": "object", + "description": "Collection of documents to analyze and a single task to execute.", + "properties": { + "kind": { + "$ref": "#/definitions/AnalyzeTextTaskKind", + "description": "The kind of task to perform." + } + }, + "discriminator": "kind", + "required": [ + "kind" + ] + }, + "AnalyzeTextTaskKind": { + "type": "string", + "description": "The kind of the analyze-text tasks supported.", + "enum": [ + "SentimentAnalysis", + "EntityRecognition", + "PiiEntityRecognition", + "KeyPhraseExtraction", + "LanguageDetection", + "EntityLinking" + ], + "x-ms-enum": { + "name": "AnalyzeTextTaskKind", + "modelAsString": true, + "values": [ + { + "name": "SentimentAnalysis", + "value": "SentimentAnalysis", + "description": "Sentiment analysis task" + }, + { + "name": "EntityRecognition", + "value": "EntityRecognition", + "description": "Entity recognition task" + }, + { + "name": "PiiEntityRecognition", + "value": "PiiEntityRecognition", + "description": "PII entity recognition task" + }, + { + "name": "KeyPhraseExtraction", + "value": "KeyPhraseExtraction", + "description": "Key phrase extraction task" + }, + { + "name": "LanguageDetection", + "value": "LanguageDetection", + "description": "Language detection task" + }, + { + "name": "EntityLinking", + "value": "EntityLinking", + "description": "Entity linking task" + } + ] + } + }, + "AnalyzeTextTaskResult": { + "type": "object", + "description": "The result object for the analyze task.", + "properties": { + "kind": { + "$ref": "#/definitions/AnalyzeTextTaskResultsKind", + "description": "The kind of task result." + } + }, + "discriminator": "kind", + "required": [ + "kind" + ] + }, + "AnalyzeTextTaskResultsKind": { + "type": "string", + "description": "The kind of the response object returned by the analyze-text task.", + "enum": [ + "SentimentAnalysisResults", + "EntityRecognitionResults", + "PiiEntityRecognitionResults", + "KeyPhraseExtractionResults", + "LanguageDetectionResults", + "EntityLinkingResults" + ], + "x-ms-enum": { + "name": "AnalyzeTextTaskResultsKind", + "modelAsString": true, + "values": [ + { + "name": "SentimentAnalysisResults", + "value": "SentimentAnalysisResults", + "description": "Sentiment analysis results" + }, + { + "name": "EntityRecognitionResults", + "value": "EntityRecognitionResults", + "description": "Entity recognition results" + }, + { + "name": "PiiEntityRecognitionResults", + "value": "PiiEntityRecognitionResults", + "description": "PII entity recognition results" + }, + { + "name": "KeyPhraseExtractionResults", + "value": "KeyPhraseExtractionResults", + "description": "Key phrase extraction results" + }, + { + "name": "LanguageDetectionResults", + "value": "LanguageDetectionResults", + "description": "Language detection results" + }, + { + "name": "EntityLinkingResults", + "value": "EntityLinkingResults", + "description": "Entity linking results" + } + ] + } + }, + "AreaMetadata": { + "type": "object", + "description": "Represents the Area entity Metadata model.", + "properties": { + "value": { + "type": "number", + "format": "double", + "description": "The numeric value that the extracted text denotes." + }, + "unit": { + "$ref": "#/definitions/AreaUnit", + "description": "Unit of measure for area." + } + }, + "required": [ + "value", + "unit" + ], + "allOf": [ + { + "$ref": "#/definitions/BaseMetadata" + } + ], + "x-ms-discriminator-value": "AreaMetadata" + }, + "AreaUnit": { + "type": "string", + "description": "The area unit of measurement.", + "enum": [ + "Unspecified", + "SquareKilometer", + "SquareHectometer", + "SquareDecameter", + "SquareDecimeter", + "SquareMeter", + "SquareCentimeter", + "SquareMillimeter", + "SquareInch", + "SquareFoot", + "SquareMile", + "SquareYard", + "Acre" + ], + "x-ms-enum": { + "name": "AreaUnit", + "modelAsString": true, + "values": [ + { + "name": "Unspecified", + "value": "Unspecified", + "description": "Unspecified area unit" + }, + { + "name": "SquareKilometer", + "value": "SquareKilometer", + "description": "Area unit in square kilometers" + }, + { + "name": "SquareHectometer", + "value": "SquareHectometer", + "description": "Area unit in square hectometers" + }, + { + "name": "SquareDecameter", + "value": "SquareDecameter", + "description": "Area unit in square decameters" + }, + { + "name": "SquareDecimeter", + "value": "SquareDecimeter", + "description": "Area unit in square decimeters" + }, + { + "name": "SquareMeter", + "value": "SquareMeter", + "description": "Area unit in square meters" + }, + { + "name": "SquareCentimeter", + "value": "SquareCentimeter", + "description": "Area unit in square centimeters" + }, + { + "name": "SquareMillimeter", + "value": "SquareMillimeter", + "description": "Area unit in square millimeters" + }, + { + "name": "SquareInch", + "value": "SquareInch", + "description": "Area unit in square inches" + }, + { + "name": "SquareFoot", + "value": "SquareFoot", + "description": "Area unit in square feet" + }, + { + "name": "SquareMile", + "value": "SquareMile", + "description": "Area unit in square miles" + }, + { + "name": "SquareYard", + "value": "SquareYard", + "description": "Area unit in square yards" + }, + { + "name": "Acre", + "value": "Acre", + "description": "Area unit in acres" + } + ] + } + }, + "Association": { + "type": "string", + "description": "Describes if the entity is the subject of the text or if it describes someone else.", + "enum": [ + "subject", + "other" + ], + "x-ms-enum": { + "name": "Association", + "modelAsString": false, + "values": [ + { + "name": "subject", + "value": "subject", + "description": "Subject association" + }, + { + "name": "other", + "value": "other", + "description": "Other association" + } + ] + } + }, + "Azure.Core.uuid": { + "type": "string", + "format": "uuid", + "description": "Universally Unique Identifier" + }, + "BaseEntityOverlapPolicy": { + "type": "object", + "description": "The abstract base class for entity OverlapPolicy.", + "properties": { + "policyKind": { + "type": "string", + "description": "The entity OverlapPolicy object kind.", + "default": "matchLongest", + "enum": [ + "matchLongest", + "allowOverlap" + ], + "x-ms-enum": { + "name": "policyKind", + "modelAsString": true, + "values": [ + { + "name": "matchLongest", + "value": "matchLongest", + "description": "Represents MatchLongestEntityPolicyType" + }, + { + "name": "allowOverlap", + "value": "allowOverlap", + "description": "Represents AllowOverlapEntityPolicyType" + } + ] + } + } + }, + "discriminator": "policyKind", + "required": [ + "policyKind" + ] + }, + "BaseMetadata": { + "type": "object", + "description": "The abstract base class for entity Metadata.", + "properties": { + "metadataKind": { + "$ref": "#/definitions/MetadataKind", + "description": "The entity Metadata object kind." + } + }, + "discriminator": "metadataKind", + "required": [ + "metadataKind" + ] + }, + "BaseRedactionPolicy": { + "type": "object", + "description": "The abstract base class for RedactionPolicy.", + "properties": { + "policyKind": { + "type": "string", + "description": "The entity RedactionPolicy object kind.", + "default": "characterMask", + "enum": [ + "noMask", + "characterMask", + "entityMask" + ], + "x-ms-enum": { + "name": "RedactionPolicyKind", + "modelAsString": true, + "values": [ + { + "name": "noMask", + "value": "noMask", + "description": "Do not redact detected entities." + }, + { + "name": "characterMask", + "value": "characterMask", + "description": "React detected entities with redaction character." + }, + { + "name": "entityMask", + "value": "entityMask", + "description": "Redact detected entities with entity type." + } + ] + } + } + }, + "discriminator": "policyKind", + "required": [ + "policyKind" + ] + }, + "Certainty": { + "type": "string", + "description": "Describes the entities certainty and polarity.", + "enum": [ + "positive", + "positivePossible", + "neutralPossible", + "negativePossible", + "negative" + ], + "x-ms-enum": { + "name": "Certainty", + "modelAsString": false, + "values": [ + { + "name": "positive", + "value": "positive", + "description": "Positive certainty" + }, + { + "name": "positivePossible", + "value": "positivePossible", + "description": "Possibly positive certainty" + }, + { + "name": "neutralPossible", + "value": "neutralPossible", + "description": "Possibly neutral certainty" + }, + { + "name": "negativePossible", + "value": "negativePossible", + "description": "Possibly negative certainty" + }, + { + "name": "negative", + "value": "negative", + "description": "Negative certainty" + } + ] + } + }, + "CharacterMaskPolicyType": { + "type": "object", + "description": "Represents the policy of redacting with a redaction character", + "properties": { + "redactionCharacter": { + "type": "string", + "description": "Optional parameter to use a Custom Character to be used for redaction in PII responses. Default character will bce * as before. We allow specific ascii characters for redaction.", + "default": "*", + "enum": [ + "!", + "#", + "$", + "%", + "&", + "*", + "+", + "-", + "=", + "?", + "@", + "^", + "_", + "~" + ], + "x-ms-enum": { + "name": "redactionCharacter", + "modelAsString": true, + "values": [ + { + "name": "exclamationPoint", + "value": "!", + "description": "Exclamation point character" + }, + { + "name": "numberSign", + "value": "#", + "description": "Number sign character" + }, + { + "name": "dollar", + "value": "$", + "description": "Dollar sign character" + }, + { + "name": "perCent", + "value": "%", + "description": "Percent sign character" + }, + { + "name": "ampersand", + "value": "&", + "description": "Ampersand character" + }, + { + "name": "asterisk", + "value": "*", + "description": "Asterisk character" + }, + { + "name": "plus", + "value": "+", + "description": "Plus sign character" + }, + { + "name": "minus", + "value": "-", + "description": "Minus sign character" + }, + { + "name": "equals", + "value": "=", + "description": "Equals sign character" + }, + { + "name": "questionMark", + "value": "?", + "description": "Question mark character" + }, + { + "name": "atSign", + "value": "@", + "description": "At sign character" + }, + { + "name": "caret", + "value": "^", + "description": "Caret character" + }, + { + "name": "underscore", + "value": "_", + "description": "Underscore character" + }, + { + "name": "tilde", + "value": "~", + "description": "Tilde character" + } + ] + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/BaseRedactionPolicy" + } + ], + "x-ms-discriminator-value": "characterMask" + }, + "ClassificationDocumentResultWithDetectedLanguage": { + "type": "object", + "description": "Contains the classification doc result for the task with detected language.", + "properties": { + "id": { + "type": "string", + "description": "Unique, non-empty document identifier." + }, + "warnings": { + "type": "array", + "description": "Warnings encountered while processing document.", + "items": { + "$ref": "#/definitions/DocumentWarning" + } + }, + "statistics": { + "$ref": "#/definitions/DocumentStatistics", + "description": "if showStats=true was specified in the request this field will contain information about the document payload." + }, + "class": { + "type": "array", + "description": "Contains the classification doc results for all docs.", + "items": { + "$ref": "#/definitions/ClassificationResult" + } + }, + "detectedLanguage": { + "$ref": "#/definitions/DetectedLanguage", + "description": "If 'language' is set to 'auto' for the document in the request this field will contain a 2 letter ISO 639-1 representation of the language detected for this document." + } + }, + "required": [ + "id", + "warnings", + "class" + ] + }, + "ClassificationResult": { + "type": "object", + "description": "Contains the classification result.", + "properties": { + "category": { + "type": "string", + "description": "Classification type." + }, + "confidenceScore": { + "type": "number", + "format": "double", + "description": "Confidence score between 0 and 1 of the recognized class." + } + }, + "required": [ + "category", + "confidenceScore" + ] + }, + "Conditionality": { + "type": "string", + "description": "Describes any conditionality on the entity.", + "enum": [ + "hypothetical", + "conditional" + ], + "x-ms-enum": { + "name": "Conditionality", + "modelAsString": false, + "values": [ + { + "name": "hypothetical", + "value": "hypothetical", + "description": "Hypothetical conditionality" + }, + { + "name": "conditional", + "value": "conditional", + "description": "Conditional conditionality" + } + ] + } + }, + "CurrencyMetadata": { + "type": "object", + "description": "Represents the Currency ) entity Metadata model.", + "properties": { + "value": { + "type": "number", + "format": "double", + "description": "The numeric value that the extracted text denotes." + }, + "unit": { + "type": "string", + "description": "Currency unit." + }, + "iso4217": { + "type": "string", + "description": "The alphabetic code based on another ISO standard, ISO 3166, which lists the codes for country names. The first two letters of the ISO 4217 three-letter code are the same as the code for the country name, and, where possible, the third letter corresponds to the first letter of the currency name." + } + }, + "required": [ + "value", + "unit" + ], + "allOf": [ + { + "$ref": "#/definitions/BaseMetadata" + } + ], + "x-ms-discriminator-value": "CurrencyMetadata" + }, + "CustomEntitiesLROTask": { + "type": "object", + "description": "Contains the custom text LRO task.", + "properties": { + "parameters": { + "$ref": "#/definitions/CustomEntitiesTaskParameters", + "description": "task parameters." + } + }, + "allOf": [ + { + "$ref": "#/definitions/AnalyzeTextLROTask" + } + ], + "x-ms-discriminator-value": "CustomEntityRecognition" + }, + "CustomEntitiesResult": { + "type": "object", + "description": "Contains the list of detected custom entities result for the documents.", + "properties": { + "errors": { + "type": "array", + "description": "Errors by document id.", + "items": { + "$ref": "#/definitions/DocumentError" + } + }, + "statistics": { + "$ref": "#/definitions/RequestStatistics", + "description": "if showStats=true was specified in the request this field will contain information about the request payload." + }, + "projectName": { + "type": "string", + "description": "This field indicates the project name for the model." + }, + "deploymentName": { + "type": "string", + "description": "This field indicates the deployment name for the model." + }, + "documents": { + "type": "array", + "description": "Enumeration of the document results.", + "items": { + "$ref": "#/definitions/EntitiesDocumentResultWithDetectedLanguage" + } + } + }, + "required": [ + "errors", + "projectName", + "deploymentName", + "documents" + ] + }, + "CustomEntitiesTaskParameters": { + "type": "object", + "description": "Supported parameters for a Custom Entities task.", + "properties": { + "loggingOptOut": { + "type": "boolean", + "description": "logging opt out", + "default": false + }, + "projectName": { + "type": "string", + "description": "This field indicates the project name for the model." + }, + "deploymentName": { + "type": "string", + "description": "This field indicates the deployment name for the model." + }, + "stringIndexType": { + "type": "string", + "description": "Optional parameter to provide the string index type used to interpret string offsets. Defaults to TextElements (Graphemes).", + "default": "TextElements_v8", + "enum": [ + "TextElements_v8", + "UnicodeCodePoint", + "Utf16CodeUnit" + ], + "x-ms-enum": { + "name": "StringIndexType", + "modelAsString": true, + "values": [ + { + "name": "TextElements_v8", + "value": "TextElements_v8", + "description": "Returned offset and length values will correspond to TextElements (Graphemes and Grapheme clusters) confirming to the Unicode 8.0.0 standard. Use this option if your application is written in .Net Framework or .Net Core and you will be using StringInfo." + }, + { + "name": "UnicodeCodePoint", + "value": "UnicodeCodePoint", + "description": "Returned offset and length values will correspond to Unicode code points. Use this option if your application is written in a language that support Unicode, for example Python." + }, + { + "name": "Utf16CodeUnit", + "value": "Utf16CodeUnit", + "description": "Returned offset and length values will correspond to UTF-16 code units. Use this option if your application is written in a language that support Unicode, for example Java, JavaScript." + } + ] + } + } + }, + "required": [ + "projectName", + "deploymentName" + ] + }, + "CustomEntityRecognitionLROResult": { + "type": "object", + "description": "Contains the custom entity recognition job result.", + "properties": { + "results": { + "$ref": "#/definitions/CustomEntitiesResult", + "description": "List of results." + } + }, + "required": [ + "results" + ], + "allOf": [ + { + "$ref": "#/definitions/AnalyzeTextLROResult" + } + ], + "x-ms-discriminator-value": "CustomEntityRecognitionLROResults" + }, + "CustomLabelClassificationResult": { + "type": "object", + "description": "Contains the custom label classification results.", + "properties": { + "errors": { + "type": "array", + "description": "Errors by document id.", + "items": { + "$ref": "#/definitions/DocumentError" + } + }, + "statistics": { + "$ref": "#/definitions/RequestStatistics", + "description": "if showStats=true was specified in the request this field will contain information about the request payload." + }, + "projectName": { + "type": "string", + "description": "This field indicates the project name for the model." + }, + "deploymentName": { + "type": "string", + "description": "This field indicates the deployment name for the model." + }, + "documents": { + "type": "array", + "description": "Response by document", + "items": { + "$ref": "#/definitions/ClassificationDocumentResultWithDetectedLanguage" + } + } + }, + "required": [ + "errors", + "projectName", + "deploymentName", + "documents" + ] + }, + "CustomMultiLabelClassificationLROResult": { + "type": "object", + "description": "Contains the custom multi label classification job result.", + "properties": { + "results": { + "$ref": "#/definitions/CustomLabelClassificationResult", + "description": "List of results." + } + }, + "required": [ + "results" + ], + "allOf": [ + { + "$ref": "#/definitions/AnalyzeTextLROResult" + } + ], + "x-ms-discriminator-value": "CustomMultiLabelClassificationLROResults" + }, + "CustomMultiLabelClassificationLROTask": { + "type": "object", + "description": "Use custom models to classify text into multi label taxonomy", + "properties": { + "parameters": { + "$ref": "#/definitions/CustomMultiLabelClassificationTaskParameters", + "description": "Task parameters." + } + }, + "allOf": [ + { + "$ref": "#/definitions/AnalyzeTextLROTask" + } + ], + "x-ms-discriminator-value": "CustomMultiLabelClassification" + }, + "CustomMultiLabelClassificationTaskParameters": { + "type": "object", + "description": "Supported parameters for a Custom Multi Classification task.", + "properties": { + "loggingOptOut": { + "type": "boolean", + "description": "logging opt out", + "default": false + }, + "projectName": { + "type": "string", + "description": "This field indicates the project name for the model." + }, + "deploymentName": { + "type": "string", + "description": "This field indicates the deployment name for the model." + } + }, + "required": [ + "projectName", + "deploymentName" + ] + }, + "CustomSingleLabelClassificationLROResult": { + "type": "object", + "description": "Contains the custom single label classification job result.", + "properties": { + "results": { + "$ref": "#/definitions/CustomLabelClassificationResult", + "description": "List of results." + } + }, + "required": [ + "results" + ], + "allOf": [ + { + "$ref": "#/definitions/AnalyzeTextLROResult" + } + ], + "x-ms-discriminator-value": "CustomSingleLabelClassificationLROResults" + }, + "CustomSingleLabelClassificationLROTask": { + "type": "object", + "description": "Use custom models to classify text into single label taxonomy", + "properties": { + "parameters": { + "$ref": "#/definitions/CustomSingleLabelClassificationTaskParameters", + "description": "Task parameters" + } + }, + "allOf": [ + { + "$ref": "#/definitions/AnalyzeTextLROTask" + } + ], + "x-ms-discriminator-value": "CustomSingleLabelClassification" + }, + "CustomSingleLabelClassificationTaskParameters": { + "type": "object", + "description": "Supported parameters for a Custom Single Classification task.", + "properties": { + "loggingOptOut": { + "type": "boolean", + "description": "logging opt out", + "default": false + }, + "projectName": { + "type": "string", + "description": "This field indicates the project name for the model." + }, + "deploymentName": { + "type": "string", + "description": "This field indicates the deployment name for the model." + } + }, + "required": [ + "projectName", + "deploymentName" + ] + }, + "DateMetadata": { + "type": "object", + "description": "A Metadata for date entity instances.", + "properties": { + "dateValues": { + "type": "array", + "description": "List of date values.", + "items": { + "$ref": "#/definitions/DateValue" + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/BaseMetadata" + } + ], + "x-ms-discriminator-value": "DateMetadata" + }, + "DateTimeMetadata": { + "type": "object", + "description": "A Metadata for datetime entity instances.", + "properties": { + "dateValues": { + "type": "array", + "description": "List of date values.", + "items": { + "$ref": "#/definitions/DateValue" + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/BaseMetadata" + } + ], + "x-ms-discriminator-value": "DateTimeMetadata" + }, + "DateValue": { + "type": "object", + "description": "Represents the date value.", + "properties": { + "timex": { + "type": "string", + "description": "An extended ISO 8601 date/time representation as described in (https://github.com/Microsoft/Recognizers-Text/blob/master/Patterns/English/English-DateTime.yaml)" + }, + "value": { + "type": "string", + "description": "The actual time that the extracted text denote." + }, + "modifier": { + "$ref": "#/definitions/TemporalModifier", + "description": "Modifier for datetime to indicate point of reference like before, after etc." + } + }, + "required": [ + "timex", + "value" + ] + }, + "DetectedLanguage": { + "type": "object", + "description": "Contains the details of the detected language for the text.", + "properties": { + "name": { + "type": "string", + "description": "Long name of a detected language (e.g. English, French)." + }, + "iso6391Name": { + "type": "string", + "description": "A two letter representation of the detected language according to the ISO 639-1 standard (e.g. en, fr)." + }, + "confidenceScore": { + "type": "number", + "format": "double", + "description": "A confidence score between 0 and 1. Scores close to 1 indicate 100% certainty that the identified language is true." + }, + "scriptName": { + "$ref": "#/definitions/ScriptKind", + "description": "Identifies the script name of the input document according to the ISO 15924 standard." + }, + "scriptIso15924Code": { + "$ref": "#/definitions/ScriptCode", + "description": "Identifies the script code of the input document according to the ISO 15924 standard." + } + }, + "required": [ + "name", + "iso6391Name", + "confidenceScore" + ] + }, + "DocumentError": { + "type": "object", + "description": "Contains details of errors encountered during a job execution.", + "properties": { + "id": { + "type": "string", + "description": "The ID of the input document." + }, + "error": { + "$ref": "#/definitions/Error", + "description": "Error encountered." + } + }, + "required": [ + "id", + "error" + ] + }, + "DocumentSentimentValue": { + "type": "string", + "description": "Predicted sentiment for document (Negative, Neutral, Positive, or Mixed).", + "enum": [ + "positive", + "neutral", + "negative", + "mixed" + ], + "x-ms-enum": { + "name": "DocumentSentimentValue", + "modelAsString": false, + "values": [ + { + "name": "positive", + "value": "positive", + "description": "Positive statement" + }, + { + "name": "neutral", + "value": "neutral", + "description": "Neutral statement" + }, + { + "name": "negative", + "value": "negative", + "description": "Negative statement" + }, + { + "name": "mixed", + "value": "mixed", + "description": "Mixed statement" + } + ] + } + }, + "DocumentStatistics": { + "type": "object", + "description": "if showStats=true was specified in the request this field will contain information about the document payload.", + "properties": { + "charactersCount": { + "type": "integer", + "format": "int32", + "description": "Number of text elements recognized in the document." + }, + "transactionsCount": { + "type": "integer", + "format": "int32", + "description": "Number of transactions for the document." + } + }, + "required": [ + "charactersCount", + "transactionsCount" + ] + }, + "DocumentWarning": { + "type": "object", + "description": "Contains the warnings object with warnings encountered for the processed document.", + "properties": { + "code": { + "$ref": "#/definitions/WarningCodeValue", + "description": "Warning code." + }, + "message": { + "type": "string", + "description": "Warning message." + }, + "targetRef": { + "type": "string", + "description": "A JSON pointer reference indicating the target object." + } + }, + "required": [ + "code", + "message" + ] + }, + "EntitiesDocumentResultWithDetectedLanguage": { + "type": "object", + "description": "Contains the entity recognition task result for the document with detected language.", + "properties": { + "id": { + "type": "string", + "description": "Unique, non-empty document identifier." + }, + "warnings": { + "type": "array", + "description": "Warnings encountered while processing document.", + "items": { + "$ref": "#/definitions/DocumentWarning" + } + }, + "statistics": { + "$ref": "#/definitions/DocumentStatistics", + "description": "if showStats=true was specified in the request this field will contain information about the document payload." + }, + "entities": { + "type": "array", + "description": "Recognized entities in the document.", + "items": { + "$ref": "#/definitions/Entity" + } + }, + "detectedLanguage": { + "$ref": "#/definitions/DetectedLanguage", + "description": "If 'language' is set to 'auto' for the document in the request this field will contain a 2 letter ISO 639-1 representation of the language detected for this document." + } + }, + "required": [ + "id", + "warnings", + "entities" + ] + }, + "EntitiesDocumentResultWithMetadata": { + "type": "object", + "description": "Entity documents result with metadata.", + "properties": { + "id": { + "type": "string", + "description": "Unique, non-empty document identifier." + }, + "warnings": { + "type": "array", + "description": "Warnings encountered while processing document.", + "items": { + "$ref": "#/definitions/DocumentWarning" + } + }, + "statistics": { + "$ref": "#/definitions/DocumentStatistics", + "description": "if showStats=true was specified in the request this field will contain information about the document payload." + }, + "entities": { + "type": "array", + "description": "Recognized entities in the document.", + "items": { + "$ref": "#/definitions/EntityWithMetadata" + } + } + }, + "required": [ + "id", + "warnings", + "entities" + ] + }, + "EntitiesDocumentResultWithMetadataDetectedLanguage": { + "type": "object", + "description": "Contains the entity recognition task result for the document with metadata and detected language.", + "properties": { + "id": { + "type": "string", + "description": "Unique, non-empty document identifier." + }, + "warnings": { + "type": "array", + "description": "Warnings encountered while processing document.", + "items": { + "$ref": "#/definitions/DocumentWarning" + } + }, + "statistics": { + "$ref": "#/definitions/DocumentStatistics", + "description": "if showStats=true was specified in the request this field will contain information about the document payload." + }, + "entities": { + "type": "array", + "description": "Recognized entities in the document.", + "items": { + "$ref": "#/definitions/EntityWithMetadata" + } + }, + "detectedLanguage": { + "$ref": "#/definitions/DetectedLanguage", + "description": "If 'language' is set to 'auto' for the document in the request this field will contain a 2 letter ISO 639-1 representation of the language detected for this document." + } + }, + "required": [ + "id", + "warnings", + "entities" + ] + }, + "EntitiesLROTask": { + "type": "object", + "description": "An object representing the task definition for an Entities Recognition task.", + "properties": { + "parameters": { + "$ref": "#/definitions/EntitiesTaskParameters", + "description": "Task parameters." + } + }, + "allOf": [ + { + "$ref": "#/definitions/AnalyzeTextLROTask" + } + ], + "x-ms-discriminator-value": "EntityRecognition" + }, + "EntitiesResult": { + "type": "object", + "description": "Contains the entity recognition task result.", + "properties": { + "errors": { + "type": "array", + "description": "Errors by document id.", + "items": { + "$ref": "#/definitions/DocumentError" + } + }, + "statistics": { + "$ref": "#/definitions/RequestStatistics", + "description": "if showStats=true was specified in the request this field will contain information about the request payload." + }, + "modelVersion": { + "type": "string", + "description": "This field indicates which model is used for scoring." + }, + "documents": { + "type": "array", + "description": "Response by document", + "items": { + "$ref": "#/definitions/EntitiesDocumentResultWithMetadata" + } + } + }, + "required": [ + "errors", + "modelVersion", + "documents" + ] + }, + "EntitiesTaskParameters": { + "type": "object", + "description": "Supported parameters for an Entity Recognition task.", + "properties": { + "loggingOptOut": { + "type": "boolean", + "description": "logging opt out", + "default": false + }, + "modelVersion": { + "type": "string", + "description": "model version", + "default": "latest" + }, + "stringIndexType": { + "type": "string", + "description": "(Optional) parameter to provide the string index type used to interpret string offsets. Defaults to TextElements (Graphemes).", + "default": "TextElements_v8", + "enum": [ + "TextElements_v8", + "UnicodeCodePoint", + "Utf16CodeUnit" + ], + "x-ms-enum": { + "name": "StringIndexType", + "modelAsString": true, + "values": [ + { + "name": "TextElements_v8", + "value": "TextElements_v8", + "description": "Returned offset and length values will correspond to TextElements (Graphemes and Grapheme clusters) confirming to the Unicode 8.0.0 standard. Use this option if your application is written in .Net Framework or .Net Core and you will be using StringInfo." + }, + { + "name": "UnicodeCodePoint", + "value": "UnicodeCodePoint", + "description": "Returned offset and length values will correspond to Unicode code points. Use this option if your application is written in a language that support Unicode, for example Python." + }, + { + "name": "Utf16CodeUnit", + "value": "Utf16CodeUnit", + "description": "Returned offset and length values will correspond to UTF-16 code units. Use this option if your application is written in a language that support Unicode, for example Java, JavaScript." + } + ] + } + }, + "inclusionList": { + "type": "array", + "description": "(Optional) request parameter that limits the output to the requested entity types included in this list. We will apply inclusionList before exclusionList", + "items": { + "$ref": "#/definitions/EntityCategory" + } + }, + "exclusionList": { + "type": "array", + "description": "(Optional) request parameter that filters out any entities that are included the excludeList. When a user specifies an excludeList, they cannot get a prediction returned with an entity in that list. We will apply inclusionList before exclusionList", + "items": { + "$ref": "#/definitions/EntityCategory" + } + }, + "overlapPolicy": { + "$ref": "#/definitions/BaseEntityOverlapPolicy", + "description": "(Optional) describes the type of overlap policy to apply to the ner output." + }, + "inferenceOptions": { + "$ref": "#/definitions/EntityInferenceOptions", + "description": "(Optional) request parameter that allows the user to provide settings for running the inference." + } + } + }, + "EntitiesTaskResult": { + "type": "object", + "description": "Contains the entity task", + "properties": { + "results": { + "$ref": "#/definitions/EntitiesWithMetadataAutoResult", + "description": "Results for entity recognition." + } + }, + "required": [ + "results" + ], + "allOf": [ + { + "$ref": "#/definitions/AnalyzeTextTaskResult" + } + ], + "x-ms-discriminator-value": "EntityRecognitionResults" + }, + "EntitiesWithMetadataAutoResult": { + "type": "object", + "description": "Contains the entity recognition task result.", + "properties": { + "errors": { + "type": "array", + "description": "Errors by document id.", + "items": { + "$ref": "#/definitions/DocumentError" + } + }, + "statistics": { + "$ref": "#/definitions/RequestStatistics", + "description": "if showStats=true was specified in the request this field will contain information about the request payload." + }, + "modelVersion": { + "type": "string", + "description": "This field indicates which model is used for scoring." + }, + "documents": { + "type": "array", + "description": "Response by document", + "items": { + "$ref": "#/definitions/EntitiesDocumentResultWithMetadataDetectedLanguage" + } + } + }, + "required": [ + "errors", + "modelVersion", + "documents" + ] + }, + "Entity": { + "type": "object", + "description": "Defines the detected entity object containing the entity category and entity text detected, etc.", + "properties": { + "text": { + "type": "string", + "description": "Entity text as appears in the request." + }, + "category": { + "type": "string", + "description": "Entity type." + }, + "subcategory": { + "type": "string", + "description": "(Optional) Entity sub type." + }, + "offset": { + "type": "integer", + "format": "int32", + "description": "Start position for the entity text. Use of different 'stringIndexType' values can affect the offset returned." + }, + "length": { + "type": "integer", + "format": "int32", + "description": "Length for the entity text. Use of different 'stringIndexType' values can affect the length returned." + }, + "confidenceScore": { + "type": "number", + "format": "double", + "description": "Confidence score between 0 and 1 of the extracted entity." + } + }, + "required": [ + "text", + "category", + "offset", + "length", + "confidenceScore" + ] + }, + "EntityCategory": { + "type": "string", + "description": "Contains all the entity categories detected by entity recognition.", + "enum": [ + "Address", + "Numeric", + "Age", + "Currency", + "Number", + "NumberRange", + "Percentage", + "Ordinal", + "Temperature", + "Dimension", + "Length", + "Weight", + "Height", + "Speed", + "Area", + "Volume", + "Information", + "Temporal", + "Date", + "Time", + "DateTime", + "DateRange", + "TimeRange", + "DateTimeRange", + "Duration", + "SetTemporal", + "Event", + "SportsEvent", + "CulturalEvent", + "NaturalEvent", + "Location", + "GPE", + "City", + "State", + "CountryRegion", + "Continent", + "Structural", + "Airport", + "Geological", + "Organization", + "OrganizationMedical", + "OrganizationStockExchange", + "OrganizationSports", + "Person", + "PersonType", + "Email", + "URL", + "IP", + "PhoneNumber", + "Product", + "ComputingProduct", + "Skill" + ], + "x-ms-enum": { + "name": "EntityCategory", + "modelAsString": true, + "values": [ + { + "name": "Address", + "value": "Address", + "description": "Specific street-level mentions of locations: house/building numbers, streets, avenues, highways, intersections referenced by name." + }, + { + "name": "Numeric", + "value": "Numeric", + "description": "Numeric values, including digits and number words." + }, + { + "name": "Age", + "value": "Age", + "description": "Age-related values." + }, + { + "name": "Currency", + "value": "Currency", + "description": "Currency-related values." + }, + { + "name": "Number", + "value": "Number", + "description": "Numbers without a unit" + }, + { + "name": "NumberRange", + "value": "NumberRange", + "description": "Range of Numbers" + }, + { + "name": "Percentage", + "value": "Percentage", + "description": "Percentage-related values." + }, + { + "name": "Ordinal", + "value": "Ordinal", + "description": "Ordinal numbers." + }, + { + "name": "Temperature", + "value": "Temperature", + "description": "Temperature-related values." + }, + { + "name": "Dimension", + "value": "Dimension", + "description": "Dimension of measurements" + }, + { + "name": "Length", + "value": "Length", + "description": "Length of an object." + }, + { + "name": "Weight", + "value": "Weight", + "description": "Weight of an object." + }, + { + "name": "Height", + "value": "Height", + "description": "Height of an object." + }, + { + "name": "Speed", + "value": "Speed", + "description": "Speed of an object." + }, + { + "name": "Area", + "value": "Area", + "description": "Area of an object." + }, + { + "name": "Volume", + "value": "Volume", + "description": "Volume of an object." + }, + { + "name": "Information", + "value": "Information", + "description": "Unit of measure for digital information." + }, + { + "name": "Temporal", + "value": "Temporal", + "description": "Items relating to time." + }, + { + "name": "Date", + "value": "Date", + "description": "Calendar dates." + }, + { + "name": "Time", + "value": "Time", + "description": "Times of day." + }, + { + "name": "DateTime", + "value": "DateTime", + "description": "Calendar dates with time." + }, + { + "name": "DateRange", + "value": "DateRange", + "description": "Range of dates." + }, + { + "name": "TimeRange", + "value": "TimeRange", + "description": "Range of times." + }, + { + "name": "DateTimeRange", + "value": "DateTimeRange", + "description": "Range of date and time." + }, + { + "name": "Duration", + "value": "Duration", + "description": "Duration of time." + }, + { + "name": "SetTemporal", + "value": "SetTemporal", + "description": "Set of time-related values." + }, + { + "name": "Event", + "value": "Event", + "description": "Social, sports, business, political, educational, natural, historical, criminal, violent, legal, military events with a timed period." + }, + { + "name": "SportsEvent", + "value": "SportsEvent", + "description": "Sports event-related values." + }, + { + "name": "CulturalEvent", + "value": "CulturalEvent", + "description": "Cultural event-related values." + }, + { + "name": "NaturalEvent", + "value": "NaturalEvent", + "description": "Natural event-related values." + }, + { + "name": "Location", + "value": "Location", + "description": "Particular point or place in physical space." + }, + { + "name": "GPE", + "value": "GPE", + "description": "Cities, countries/regions, states." + }, + { + "name": "City", + "value": "City", + "description": "City-related values." + }, + { + "name": "State", + "value": "State", + "description": "State-related values." + }, + { + "name": "CountryRegion", + "value": "CountryRegion", + "description": "Country or region-related values." + }, + { + "name": "Continent", + "value": "Continent", + "description": "Continent-related values." + }, + { + "name": "Structural", + "value": "Structural", + "description": "Manmade structures." + }, + { + "name": "Airport", + "value": "Airport", + "description": "Airports." + }, + { + "name": "Geological", + "value": "Geological", + "description": "Geographic and natural features such as rivers, oceans, and deserts." + }, + { + "name": "Organization", + "value": "Organization", + "description": "Corporations, agencies, and other groups of people defined by some established organizational structure. These labels can include companies, political parties/movements, musical bands, sport clubs, government bodies, and public organizations. Nationalities or religions are not ORGANIZATION." + }, + { + "name": "OrganizationMedical", + "value": "OrganizationMedical", + "description": "Medical companies and groups." + }, + { + "name": "OrganizationStockExchange", + "value": "OrganizationStockExchange", + "description": "Stock exchange groups." + }, + { + "name": "OrganizationSports", + "value": "OrganizationSports", + "description": "Sports-related organizations." + }, + { + "name": "Person", + "value": "Person", + "description": "First, last, and middle names, names of fictional characters, and aliases. Titles, such as 'Mr.' or 'President', are not considered part of the named entity." + }, + { + "name": "PersonType", + "value": "PersonType", + "description": "Human roles classified by a group membership." + }, + { + "name": "Email", + "value": "Email", + "description": "Email addresses." + }, + { + "name": "URL", + "value": "URL", + "description": "URLs to websites." + }, + { + "name": "IP", + "value": "IP", + "description": "network IP addresses." + }, + { + "name": "PhoneNumber", + "value": "PhoneNumber", + "description": "Phone numbers (US and EU phone numbers only)." + }, + { + "name": "Product", + "value": "Product", + "description": "Single or group of commercial, consumable objects, electronics, vehicles, food groups." + }, + { + "name": "ComputingProduct", + "value": "ComputingProduct", + "description": "Computing products." + }, + { + "name": "Skill", + "value": "Skill", + "description": "A capability, skill, or expertise." + } + ] + } + }, + "EntityInferenceOptions": { + "type": "object", + "description": "The class that houses the inference options allowed for named entity recognition.", + "properties": { + "excludeNormalizedValues": { + "type": "boolean", + "description": "Option to include/exclude the detected entity values to be normalized and included in the metadata. The numeric and temporal entity types support value normalization.", + "default": false + } + } + }, + "EntityLinkingLROResult": { + "type": "object", + "description": "Contains the analyze text Entity linking task LRO result.", + "properties": { + "results": { + "$ref": "#/definitions/EntityLinkingResult", + "description": "Entity linking result." + } + }, + "required": [ + "results" + ], + "allOf": [ + { + "$ref": "#/definitions/AnalyzeTextLROResult" + } + ], + "x-ms-discriminator-value": "EntityLinkingLROResults" + }, + "EntityLinkingLROTask": { + "type": "object", + "description": "Contains the analyze text Entity linking LRO task.", + "properties": { + "parameters": { + "$ref": "#/definitions/EntityLinkingTaskParameters", + "description": "Task parameters." + } + }, + "allOf": [ + { + "$ref": "#/definitions/AnalyzeTextLROTask" + } + ], + "x-ms-discriminator-value": "EntityLinking" + }, + "EntityLinkingResult": { + "type": "object", + "description": "Entity linking result.", + "properties": { + "errors": { + "type": "array", + "description": "Errors by document id.", + "items": { + "$ref": "#/definitions/DocumentError" + } + }, + "statistics": { + "$ref": "#/definitions/RequestStatistics", + "description": "if showStats=true was specified in the request this field will contain information about the request payload." + }, + "modelVersion": { + "type": "string", + "description": "This field indicates which model is used for scoring." + }, + "documents": { + "type": "array", + "description": "Response by document", + "items": { + "$ref": "#/definitions/EntityLinkingResultWithDetectedLanguage" + } + } + }, + "required": [ + "errors", + "modelVersion", + "documents" + ] + }, + "EntityLinkingResultWithDetectedLanguage": { + "type": "object", + "description": "Entity linking document result with auto language detection.", + "properties": { + "id": { + "type": "string", + "description": "Unique, non-empty document identifier." + }, + "warnings": { + "type": "array", + "description": "Warnings encountered while processing document.", + "items": { + "$ref": "#/definitions/DocumentWarning" + } + }, + "statistics": { + "$ref": "#/definitions/DocumentStatistics", + "description": "if showStats=true was specified in the request this field will contain information about the document payload." + }, + "entities": { + "type": "array", + "description": "Recognized well known entities in the document.", + "items": { + "$ref": "#/definitions/LinkedEntity" + } + }, + "detectedLanguage": { + "$ref": "#/definitions/DetectedLanguage", + "description": "If 'language' is set to 'auto' for the document in the request this field will contain a 2 letter ISO 639-1 representation of the language detected for this document." + } + }, + "required": [ + "id", + "warnings", + "entities" + ] + }, + "EntityLinkingTaskParameters": { + "type": "object", + "description": "Supported parameters for an Entity Linking task.", + "properties": { + "loggingOptOut": { + "type": "boolean", + "description": "logging opt out", + "default": false + }, + "modelVersion": { + "type": "string", + "description": "model version", + "default": "latest" + }, + "stringIndexType": { + "type": "string", + "description": "Optional parameter to provide the string index type used to interpret string offsets. Defaults to TextElements (Graphemes).", + "default": "TextElements_v8", + "enum": [ + "TextElements_v8", + "UnicodeCodePoint", + "Utf16CodeUnit" + ], + "x-ms-enum": { + "name": "StringIndexType", + "modelAsString": true, + "values": [ + { + "name": "TextElements_v8", + "value": "TextElements_v8", + "description": "Returned offset and length values will correspond to TextElements (Graphemes and Grapheme clusters) confirming to the Unicode 8.0.0 standard. Use this option if your application is written in .Net Framework or .Net Core and you will be using StringInfo." + }, + { + "name": "UnicodeCodePoint", + "value": "UnicodeCodePoint", + "description": "Returned offset and length values will correspond to Unicode code points. Use this option if your application is written in a language that support Unicode, for example Python." + }, + { + "name": "Utf16CodeUnit", + "value": "Utf16CodeUnit", + "description": "Returned offset and length values will correspond to UTF-16 code units. Use this option if your application is written in a language that support Unicode, for example Java, JavaScript." + } + ] + } + } + } + }, + "EntityLinkingTaskResult": { + "type": "object", + "description": "Contains the analyze text Entity linking task result.", + "properties": { + "results": { + "$ref": "#/definitions/EntityLinkingResult", + "description": "Entity linking result." + } + }, + "required": [ + "results" + ], + "allOf": [ + { + "$ref": "#/definitions/AnalyzeTextTaskResult" + } + ], + "x-ms-discriminator-value": "EntityLinkingResults" + }, + "EntityMaskPolicyType": { + "type": "object", + "description": "Represents the policy of redacting PII with the entity type.", + "allOf": [ + { + "$ref": "#/definitions/BaseRedactionPolicy" + } + ], + "x-ms-discriminator-value": "entityMask" + }, + "EntityRecognitionLROResult": { + "type": "object", + "description": "Contains the entity recognition job task result.", + "properties": { + "results": { + "$ref": "#/definitions/EntitiesResult", + "description": "Results for the task." + } + }, + "required": [ + "results" + ], + "allOf": [ + { + "$ref": "#/definitions/AnalyzeTextLROResult" + } + ], + "x-ms-discriminator-value": "EntityRecognitionLROResults" + }, + "EntitySynonym": { + "type": "object", + "description": "The entity synonyms used to enhance pii entity detection", + "properties": { + "synonym": { + "type": "string", + "description": "The synonym to be used for context" + }, + "language": { + "type": "string", + "description": "The 2 letter ISO 639-1 language the synonym" + } + }, + "required": [ + "synonym" + ] + }, + "EntitySynonyms": { + "type": "object", + "description": "Object that allows the user to provide synonyms for context words that to enhance pii entity detection.", + "properties": { + "entityType": { + "$ref": "#/definitions/EntityCategory", + "description": "The entity name" + }, + "synonyms": { + "type": "array", + "description": "The entity synonyms", + "items": { + "$ref": "#/definitions/EntitySynonym" + } + } + }, + "required": [ + "entityType", + "synonyms" + ] + }, + "EntityTag": { + "type": "object", + "description": "Entity tag object which contains the name of the tags abd any associated confidence score. Entity Tags are used to express some similarities/affinity between entities.", + "properties": { + "name": { + "type": "string", + "description": "Name of the tag. Entity Tag names will be unique globally." + }, + "confidenceScore": { + "type": "number", + "format": "double", + "description": "Detection score between 0 and 1 of the extracted entity." + } + }, + "required": [ + "name" + ] + }, + "EntityWithMetadata": { + "type": "object", + "description": "Entity object with tags and metadata.", + "properties": { + "text": { + "type": "string", + "description": "Entity text as appears in the request." + }, + "category": { + "type": "string", + "description": "Entity type." + }, + "subcategory": { + "type": "string", + "description": "(Optional) Entity sub type." + }, + "offset": { + "type": "integer", + "format": "int32", + "description": "Start position for the entity text. Use of different 'stringIndexType' values can affect the offset returned." + }, + "length": { + "type": "integer", + "format": "int32", + "description": "Length for the entity text. Use of different 'stringIndexType' values can affect the length returned." + }, + "confidenceScore": { + "type": "number", + "format": "double", + "description": "Confidence score between 0 and 1 of the extracted entity." + }, + "type": { + "type": "string", + "description": "An entity type is the lowest (or finest) granularity at which the entity has been detected. The type maps to the specific metadata attributes associated with the entity detected." + }, + "tags": { + "type": "array", + "description": "List of entity tags. Tags are to express some similarities/affinity between entities.", + "items": { + "$ref": "#/definitions/EntityTag" + } + }, + "metadata": { + "$ref": "#/definitions/BaseMetadata", + "description": "The entity metadata object." + } + }, + "required": [ + "text", + "category", + "offset", + "length", + "confidenceScore" + ] + }, + "Error": { + "type": "object", + "description": "The error response object returned when the service encounters some errors during processing the request.", + "properties": { + "code": { + "$ref": "#/definitions/ErrorCode", + "description": "One of a server-defined set of error codes." + }, + "message": { + "type": "string", + "description": "A human-readable representation of the error." + }, + "target": { + "type": "string", + "description": "The target of the error." + }, + "details": { + "type": "array", + "description": "An array of details about specific errors that led to this reported error.", + "items": { + "$ref": "#/definitions/Error" + } + }, + "innererror": { + "$ref": "#/definitions/InnerErrorModel", + "description": "An object containing more specific information than the current object about the error." + } + }, + "required": [ + "code", + "message" + ] + }, + "ErrorCode": { + "type": "string", + "description": "Human-readable error code.", + "enum": [ + "InvalidRequest", + "InvalidArgument", + "Unauthorized", + "Forbidden", + "NotFound", + "ProjectNotFound", + "OperationNotFound", + "AzureCognitiveSearchNotFound", + "AzureCognitiveSearchIndexNotFound", + "TooManyRequests", + "AzureCognitiveSearchThrottling", + "AzureCognitiveSearchIndexLimitReached", + "InternalServerError", + "ServiceUnavailable", + "Timeout", + "QuotaExceeded", + "Conflict", + "Warning" + ], + "x-ms-enum": { + "name": "ErrorCode", + "modelAsString": true, + "values": [ + { + "name": "InvalidRequest", + "value": "InvalidRequest", + "description": "Invalid request error" + }, + { + "name": "InvalidArgument", + "value": "InvalidArgument", + "description": "Invalid argument error" + }, + { + "name": "Unauthorized", + "value": "Unauthorized", + "description": "Unauthorized access error" + }, + { + "name": "Forbidden", + "value": "Forbidden", + "description": "Forbidden access error" + }, + { + "name": "NotFound", + "value": "NotFound", + "description": "Not found error" + }, + { + "name": "ProjectNotFound", + "value": "ProjectNotFound", + "description": "Project not found error" + }, + { + "name": "OperationNotFound", + "value": "OperationNotFound", + "description": "Operation not found error" + }, + { + "name": "AzureCognitiveSearchNotFound", + "value": "AzureCognitiveSearchNotFound", + "description": "Azure Cognitive Search not found error" + }, + { + "name": "AzureCognitiveSearchIndexNotFound", + "value": "AzureCognitiveSearchIndexNotFound", + "description": "Azure Cognitive Search index not found error" + }, + { + "name": "TooManyRequests", + "value": "TooManyRequests", + "description": "Too many requests error" + }, + { + "name": "AzureCognitiveSearchThrottling", + "value": "AzureCognitiveSearchThrottling", + "description": "Azure Cognitive Search throttling error" + }, + { + "name": "AzureCognitiveSearchIndexLimitReached", + "value": "AzureCognitiveSearchIndexLimitReached", + "description": "Azure Cognitive Search index limit reached error" + }, + { + "name": "InternalServerError", + "value": "InternalServerError", + "description": "Internal server error" + }, + { + "name": "ServiceUnavailable", + "value": "ServiceUnavailable", + "description": "Service unavailable error" + }, + { + "name": "Timeout", + "value": "Timeout", + "description": "Timeout error" + }, + { + "name": "QuotaExceeded", + "value": "QuotaExceeded", + "description": "Quota exceeded error" + }, + { + "name": "Conflict", + "value": "Conflict", + "description": "Conflict error" + }, + { + "name": "Warning", + "value": "Warning", + "description": "Warning error" + } + ] + } + }, + "ErrorResponse": { + "type": "object", + "description": "Error response.", + "properties": { + "error": { + "$ref": "#/definitions/Error", + "description": "The error object." + } + }, + "required": [ + "error" + ] + }, + "ExtractedSummaryDocumentResultWithDetectedLanguage": { + "type": "object", + "description": "A ranked list of sentences representing the extracted summary.", + "properties": { + "id": { + "type": "string", + "description": "Unique, non-empty document identifier." + }, + "warnings": { + "type": "array", + "description": "Warnings encountered while processing document.", + "items": { + "$ref": "#/definitions/DocumentWarning" + } + }, + "statistics": { + "$ref": "#/definitions/DocumentStatistics", + "description": "if showStats=true was specified in the request this field will contain information about the document payload." + }, + "sentences": { + "type": "array", + "description": "Specifies the the extracted sentences from the input document.", + "items": { + "$ref": "#/definitions/ExtractedSummarySentence" + } + }, + "detectedLanguage": { + "$ref": "#/definitions/DetectedLanguage", + "description": "If 'language' is set to 'auto' for the document in the request this field will contain a 2 letter ISO 639-1 representation of the language detected for this document." + } + }, + "required": [ + "id", + "warnings", + "sentences" + ] + }, + "ExtractedSummarySentence": { + "type": "object", + "description": "Represents an extracted sentences from the input document.", + "properties": { + "text": { + "type": "string", + "description": "The extracted sentence text." + }, + "rankScore": { + "type": "number", + "format": "double", + "description": "A double value representing the relevance of the sentence within the summary. Higher values indicate higher importance." + }, + "offset": { + "type": "integer", + "format": "int32", + "description": "The sentence offset from the start of the document, based on the value of the parameter StringIndexType." + }, + "length": { + "type": "integer", + "format": "int32", + "description": "The length of the sentence." + } + }, + "required": [ + "text", + "rankScore", + "offset", + "length" + ] + }, + "ExtractiveSummarizationLROResult": { + "type": "object", + "description": "An object representing the results for an Extractive Summarization task.", + "properties": { + "results": { + "$ref": "#/definitions/ExtractiveSummarizationResult", + "description": "Results of the task." + } + }, + "required": [ + "results" + ], + "allOf": [ + { + "$ref": "#/definitions/AnalyzeTextLROResult" + } + ], + "x-ms-discriminator-value": "ExtractiveSummarizationLROResults" + }, + "ExtractiveSummarizationLROTask": { + "type": "object", + "description": "An object representing the task definition for an Extractive Summarization task.", + "properties": { + "parameters": { + "$ref": "#/definitions/ExtractiveSummarizationTaskParameters", + "description": "Parameters for the Extractive Summarization task." + } + }, + "allOf": [ + { + "$ref": "#/definitions/AnalyzeTextLROTask" + } + ], + "x-ms-discriminator-value": "ExtractiveSummarization" + }, + "ExtractiveSummarizationResult": { + "type": "object", + "description": "An object representing the pre-built Extractive Summarization results of each document.", + "properties": { + "errors": { + "type": "array", + "description": "Errors by document id.", + "items": { + "$ref": "#/definitions/DocumentError" + } + }, + "statistics": { + "$ref": "#/definitions/RequestStatistics", + "description": "if showStats=true was specified in the request this field will contain information about the request payload." + }, + "modelVersion": { + "type": "string", + "description": "This field indicates which model is used for scoring." + }, + "documents": { + "type": "array", + "description": "Response by document", + "items": { + "$ref": "#/definitions/ExtractedSummaryDocumentResultWithDetectedLanguage" + } + } + }, + "required": [ + "errors", + "modelVersion", + "documents" + ] + }, + "ExtractiveSummarizationTaskParameters": { + "type": "object", + "description": "Supported parameters for an Extractive Summarization task.", + "properties": { + "loggingOptOut": { + "type": "boolean", + "description": "logging opt out", + "default": false + }, + "modelVersion": { + "type": "string", + "description": "model version", + "default": "latest" + }, + "sentenceCount": { + "type": "integer", + "format": "int64", + "description": "Specifies the number of sentences in the extracted summary.", + "default": 3 + }, + "sortBy": { + "type": "string", + "description": "Specifies how to sort the extracted summaries.", + "default": "Offset", + "enum": [ + "Offset", + "Rank" + ], + "x-ms-enum": { + "name": "ExtractiveSummarizationSortingCriteria", + "modelAsString": true, + "values": [ + { + "name": "Offset", + "value": "Offset", + "description": "Indicates that results should be sorted in order of appearance in the text." + }, + { + "name": "Rank", + "value": "Rank", + "description": "Indicates that results should be sorted in order of importance (i.e. rank score) according to the model." + } + ] + } + }, + "stringIndexType": { + "type": "string", + "description": "Specifies the method used to interpret string offsets.", + "default": "TextElements_v8", + "enum": [ + "TextElements_v8", + "UnicodeCodePoint", + "Utf16CodeUnit" + ], + "x-ms-enum": { + "name": "StringIndexType", + "modelAsString": true, + "values": [ + { + "name": "TextElements_v8", + "value": "TextElements_v8", + "description": "Returned offset and length values will correspond to TextElements (Graphemes and Grapheme clusters) confirming to the Unicode 8.0.0 standard. Use this option if your application is written in .Net Framework or .Net Core and you will be using StringInfo." + }, + { + "name": "UnicodeCodePoint", + "value": "UnicodeCodePoint", + "description": "Returned offset and length values will correspond to Unicode code points. Use this option if your application is written in a language that support Unicode, for example Python." + }, + { + "name": "Utf16CodeUnit", + "value": "Utf16CodeUnit", + "description": "Returned offset and length values will correspond to UTF-16 code units. Use this option if your application is written in a language that support Unicode, for example Java, JavaScript." + } + ] + } + }, + "query": { + "type": "string", + "description": "(Optional) If provided, the query will be used to extract most relevant sentences from the document." + } + } + }, + "FhirBundle": { + "type": "object", + "description": "JSON bundle containing a FHIR compatible object for consumption in other Healthcare tools. For additional information see https://www.hl7.org/fhir/overview.html.", + "additionalProperties": {} + }, + "HealthcareAssertion": { + "type": "object", + "description": "Assertion of the entity.", + "properties": { + "conditionality": { + "$ref": "#/definitions/Conditionality", + "description": "Describes any conditionality on the entity." + }, + "certainty": { + "$ref": "#/definitions/Certainty", + "description": "Describes the entities certainty and polarity." + }, + "association": { + "$ref": "#/definitions/Association", + "description": "Describes if the entity is the subject of the text or if it describes someone else." + }, + "temporality": { + "$ref": "#/definitions/Temporality", + "description": "Describes temporal information regarding the entity." + } + } + }, + "HealthcareEntitiesDocumentResultWithDocumentDetectedLanguage": { + "type": "object", + "description": "Result object for the processed Healthcare document with detected language.", + "properties": { + "id": { + "type": "string", + "description": "Unique, non-empty document identifier." + }, + "warnings": { + "type": "array", + "description": "Warnings encountered while processing document.", + "items": { + "$ref": "#/definitions/DocumentWarning" + } + }, + "statistics": { + "$ref": "#/definitions/DocumentStatistics", + "description": "if showStats=true was specified in the request this field will contain information about the document payload." + }, + "entities": { + "type": "array", + "description": "Healthcare entities.", + "items": { + "$ref": "#/definitions/HealthcareEntity" + } + }, + "relations": { + "type": "array", + "description": "Healthcare entity relations.", + "items": { + "$ref": "#/definitions/HealthcareRelation" + } + }, + "fhirBundle": { + "$ref": "#/definitions/FhirBundle", + "description": "JSON bundle containing a FHIR compatible object for consumption in other Healthcare tools. For additional information see https://www.hl7.org/fhir/overview.html." + }, + "detectedLanguage": { + "$ref": "#/definitions/DetectedLanguage", + "description": "If 'language' is set to 'auto' for the document in the request this field will contain a 2 letter ISO 639-1 representation of the language detected for this document." + } + }, + "required": [ + "id", + "warnings", + "entities", + "relations" + ] + }, + "HealthcareEntity": { + "type": "object", + "description": "Healthcare entity extracted from the document", + "properties": { + "text": { + "type": "string", + "description": "Entity text as appears in the request." + }, + "category": { + "$ref": "#/definitions/healthcareEntityCategory", + "description": "Healthcare Entity Category." + }, + "subcategory": { + "type": "string", + "description": "(Optional) Entity sub type." + }, + "offset": { + "type": "integer", + "format": "int32", + "description": "Start position for the entity text. Use of different 'stringIndexType' values can affect the offset returned." + }, + "length": { + "type": "integer", + "format": "int32", + "description": "Length for the entity text. Use of different 'stringIndexType' values can affect the length returned." + }, + "confidenceScore": { + "type": "number", + "format": "double", + "description": "Confidence score between 0 and 1 of the extracted entity." + }, + "assertion": { + "$ref": "#/definitions/HealthcareAssertion", + "description": "Assertion of the entity." + }, + "name": { + "type": "string", + "description": "Preferred name for the entity. Example: 'histologically' would have a 'name' of 'histologic'." + }, + "links": { + "type": "array", + "description": "Entity references in known data sources.", + "items": { + "$ref": "#/definitions/HealthcareEntityLink" + } + } + }, + "required": [ + "text", + "category", + "offset", + "length", + "confidenceScore" + ] + }, + "HealthcareEntityLink": { + "type": "object", + "description": "Reference to an entity in known data sources.", + "properties": { + "dataSource": { + "type": "string", + "description": "Entity Catalog. Examples include: UMLS, CHV, MSH, etc." + }, + "id": { + "type": "string", + "description": "Entity id in the given source catalog." + } + }, + "required": [ + "dataSource", + "id" + ] + }, + "HealthcareLROResult": { + "type": "object", + "description": "Healthcare Analyze Text long tunning operation result object.", + "properties": { + "results": { + "$ref": "#/definitions/HealthcareResult", + "description": "Results of the task." + } + }, + "required": [ + "results" + ], + "allOf": [ + { + "$ref": "#/definitions/AnalyzeTextLROResult" + } + ], + "x-ms-discriminator-value": "HealthcareLROResults" + }, + "HealthcareLROTask": { + "type": "object", + "description": "The long running task to be performed by the service on the Healthcare input documents.", + "properties": { + "parameters": { + "$ref": "#/definitions/HealthcareTaskParameters", + "description": "Parameters for the Healthcare task." + } + }, + "allOf": [ + { + "$ref": "#/definitions/AnalyzeTextLROTask" + } + ], + "x-ms-discriminator-value": "Healthcare" + }, + "HealthcareRelation": { + "type": "object", + "description": "Every relation is an entity graph of a certain relationType, where all entities are connected and have specific roles within the relation context.", + "properties": { + "relationType": { + "$ref": "#/definitions/relationType", + "description": "Type of relation. Examples include: `DosageOfMedication` or 'FrequencyOfMedication', etc." + }, + "entities": { + "type": "array", + "description": "The entities in the relation.", + "items": { + "$ref": "#/definitions/HealthcareRelationEntity" + } + }, + "confidenceScore": { + "type": "number", + "format": "double", + "description": "Confidence score between 0 and 1 of the extracted relation." + } + }, + "required": [ + "relationType", + "entities" + ] + }, + "HealthcareRelationEntity": { + "type": "object", + "description": "Entity in the relation.", + "properties": { + "ref": { + "type": "string", + "description": "Reference link object, using a JSON pointer RFC 6901 (URI Fragment Identifier Representation), pointing to the entity ." + }, + "role": { + "type": "string", + "description": "Role of entity in the relationship. For example: 'CD20-positive diffuse large B-cell lymphoma' has the following entities with their roles in parenthesis: CD20 (GeneOrProtein), Positive (Expression), diffuse large B-cell lymphoma (Diagnosis)." + } + }, + "required": [ + "ref", + "role" + ] + }, + "HealthcareResult": { + "type": "object", + "description": "Result object for the processed Healthcare task.", + "properties": { + "errors": { + "type": "array", + "description": "Errors by document id.", + "items": { + "$ref": "#/definitions/DocumentError" + } + }, + "statistics": { + "$ref": "#/definitions/RequestStatistics", + "description": "if showStats=true was specified in the request this field will contain information about the request payload." + }, + "modelVersion": { + "type": "string", + "description": "This field indicates which model is used for scoring." + }, + "documents": { + "type": "array", + "description": "List of result objects for the processed Healthcare documents.", + "items": { + "$ref": "#/definitions/HealthcareEntitiesDocumentResultWithDocumentDetectedLanguage" + } + } + }, + "required": [ + "errors", + "modelVersion", + "documents" + ] + }, + "HealthcareTaskParameters": { + "type": "object", + "description": "Supported parameters for a Healthcare task.", + "properties": { + "loggingOptOut": { + "type": "boolean", + "description": "logging opt out", + "default": false + }, + "modelVersion": { + "type": "string", + "description": "model version", + "default": "latest" + }, + "stringIndexType": { + "type": "string", + "description": "Specifies the method used to interpret string offsets.", + "default": "TextElements_v8", + "enum": [ + "TextElements_v8", + "UnicodeCodePoint", + "Utf16CodeUnit" + ], + "x-ms-enum": { + "name": "StringIndexType", + "modelAsString": true, + "values": [ + { + "name": "TextElements_v8", + "value": "TextElements_v8", + "description": "Returned offset and length values will correspond to TextElements (Graphemes and Grapheme clusters) confirming to the Unicode 8.0.0 standard. Use this option if your application is written in .Net Framework or .Net Core and you will be using StringInfo." + }, + { + "name": "UnicodeCodePoint", + "value": "UnicodeCodePoint", + "description": "Returned offset and length values will correspond to Unicode code points. Use this option if your application is written in a language that support Unicode, for example Python." + }, + { + "name": "Utf16CodeUnit", + "value": "Utf16CodeUnit", + "description": "Returned offset and length values will correspond to UTF-16 code units. Use this option if your application is written in a language that support Unicode, for example Java, JavaScript." + } + ] + } + }, + "fhirVersion": { + "$ref": "#/definitions/fhirVersion", + "description": "The FHIR Spec version that the result will use to format the fhirBundle. For additional information see https://www.hl7.org/fhir/overview.html." + }, + "documentType": { + "$ref": "#/definitions/healthcareDocumentType", + "description": "Document type that can be provided as input for Fhir Documents. Expect to have fhirVersion provided when used. Behavior of using None enum is the same as not using the documentType parameter." + } + } + }, + "InformationMetadata": { + "type": "object", + "description": "Represents the Information (data) entity Metadata model.", + "properties": { + "value": { + "type": "number", + "format": "double", + "description": "The numeric value that the extracted text denotes." + }, + "unit": { + "$ref": "#/definitions/InformationUnit", + "description": "Unit of measure for information." + } + }, + "required": [ + "value", + "unit" + ], + "allOf": [ + { + "$ref": "#/definitions/BaseMetadata" + } + ], + "x-ms-discriminator-value": "InformationMetadata" + }, + "InformationUnit": { + "type": "string", + "description": "The information (data) Unit of measurement.", + "enum": [ + "Unspecified", + "Bit", + "Kilobit", + "Megabit", + "Gigabit", + "Terabit", + "Petabit", + "Byte", + "Kilobyte", + "Megabyte", + "Gigabyte", + "Terabyte", + "Petabyte" + ], + "x-ms-enum": { + "name": "InformationUnit", + "modelAsString": true, + "values": [ + { + "name": "Unspecified", + "value": "Unspecified", + "description": "Unspecified data size unit" + }, + { + "name": "Bit", + "value": "Bit", + "description": "Data size unit in bits" + }, + { + "name": "Kilobit", + "value": "Kilobit", + "description": "Data size unit in kilobits" + }, + { + "name": "Megabit", + "value": "Megabit", + "description": "Data size unit in megabits" + }, + { + "name": "Gigabit", + "value": "Gigabit", + "description": "Data size unit in gigabits" + }, + { + "name": "Terabit", + "value": "Terabit", + "description": "Data size unit in terabits" + }, + { + "name": "Petabit", + "value": "Petabit", + "description": "Data size unit in petabits" + }, + { + "name": "Byte", + "value": "Byte", + "description": "Data size unit in bytes" + }, + { + "name": "Kilobyte", + "value": "Kilobyte", + "description": "Data size unit in kilobytes" + }, + { + "name": "Megabyte", + "value": "Megabyte", + "description": "Data size unit in megabytes" + }, + { + "name": "Gigabyte", + "value": "Gigabyte", + "description": "Data size unit in gigabytes" + }, + { + "name": "Terabyte", + "value": "Terabyte", + "description": "Data size unit in terabytes" + }, + { + "name": "Petabyte", + "value": "Petabyte", + "description": "Data size unit in petabytes" + } + ] + } + }, + "InnerErrorCode": { + "type": "string", + "description": "Human-readable error code.", + "enum": [ + "InvalidRequest", + "InvalidParameterValue", + "KnowledgeBaseNotFound", + "AzureCognitiveSearchNotFound", + "AzureCognitiveSearchThrottling", + "ExtractionFailure", + "InvalidRequestBodyFormat", + "EmptyRequest", + "MissingInputDocuments", + "InvalidDocument", + "ModelVersionIncorrect", + "InvalidDocumentBatch", + "UnsupportedLanguageCode", + "InvalidCountryHint" + ], + "x-ms-enum": { + "name": "InnerErrorCode", + "modelAsString": true, + "values": [ + { + "name": "InvalidRequest", + "value": "InvalidRequest", + "description": "Invalid request error" + }, + { + "name": "InvalidParameterValue", + "value": "InvalidParameterValue", + "description": "Invalid parameter value error" + }, + { + "name": "KnowledgeBaseNotFound", + "value": "KnowledgeBaseNotFound", + "description": "Knowledge base not found error" + }, + { + "name": "AzureCognitiveSearchNotFound", + "value": "AzureCognitiveSearchNotFound", + "description": "Azure Cognitive Search not found error" + }, + { + "name": "AzureCognitiveSearchThrottling", + "value": "AzureCognitiveSearchThrottling", + "description": "Azure Cognitive Search throttling error" + }, + { + "name": "ExtractionFailure", + "value": "ExtractionFailure", + "description": "Extraction failure error" + }, + { + "name": "InvalidRequestBodyFormat", + "value": "InvalidRequestBodyFormat", + "description": "Invalid request body format error" + }, + { + "name": "EmptyRequest", + "value": "EmptyRequest", + "description": "Empty request error" + }, + { + "name": "MissingInputDocuments", + "value": "MissingInputDocuments", + "description": "Missing input documents error" + }, + { + "name": "InvalidDocument", + "value": "InvalidDocument", + "description": "Invalid document error" + }, + { + "name": "ModelVersionIncorrect", + "value": "ModelVersionIncorrect", + "description": "Model version incorrect error" + }, + { + "name": "InvalidDocumentBatch", + "value": "InvalidDocumentBatch", + "description": "Invalid document batch error" + }, + { + "name": "UnsupportedLanguageCode", + "value": "UnsupportedLanguageCode", + "description": "Unsupported language code error" + }, + { + "name": "InvalidCountryHint", + "value": "InvalidCountryHint", + "description": "Invalid country hint error" + } + ] + } + }, + "InnerErrorModel": { + "type": "object", + "description": "An object containing more specific information about the error. As per Microsoft One API guidelines - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.", + "properties": { + "code": { + "$ref": "#/definitions/InnerErrorCode", + "description": "One of a server-defined set of error codes." + }, + "message": { + "type": "string", + "description": "Error message." + }, + "details": { + "type": "object", + "description": "Error details.", + "additionalProperties": { + "type": "string" + } + }, + "target": { + "type": "string", + "description": "Error target." + }, + "innererror": { + "$ref": "#/definitions/InnerErrorModel", + "description": "An object containing more specific information than the current object about the error." + } + }, + "required": [ + "code", + "message" + ] + }, + "KeyPhraseExtractionLROResult": { + "type": "object", + "description": "Contains the analyze text KeyPhraseExtraction LRO task.", + "properties": { + "results": { + "$ref": "#/definitions/KeyPhraseResult", + "description": "The list of Key phrase extraction results" + } + }, + "required": [ + "results" + ], + "allOf": [ + { + "$ref": "#/definitions/AnalyzeTextLROResult" + } + ], + "x-ms-discriminator-value": "KeyPhraseExtractionLROResults" + }, + "KeyPhraseLROTask": { + "type": "object", + "description": "An object representing the task definition for a Key Phrase Extraction task.", + "properties": { + "parameters": { + "$ref": "#/definitions/KeyPhraseTaskParameters", + "description": "Key phrase extraction task parameters." + } + }, + "allOf": [ + { + "$ref": "#/definitions/AnalyzeTextLROTask" + } + ], + "x-ms-discriminator-value": "KeyPhraseExtraction" + }, + "KeyPhraseResult": { + "type": "object", + "description": "Contains the KeyPhraseResult.", + "properties": { + "errors": { + "type": "array", + "description": "Errors by document id.", + "items": { + "$ref": "#/definitions/DocumentError" + } + }, + "statistics": { + "$ref": "#/definitions/RequestStatistics", + "description": "if showStats=true was specified in the request this field will contain information about the request payload." + }, + "modelVersion": { + "type": "string", + "description": "This field indicates which model is used for scoring." + }, + "documents": { + "type": "array", + "description": "Response by document", + "items": { + "$ref": "#/definitions/KeyPhrasesDocumentResultWithDetectedLanguage" + } + } + }, + "required": [ + "errors", + "modelVersion", + "documents" + ] + }, + "KeyPhraseTaskParameters": { + "type": "object", + "description": "Supported parameters for a Key Phrase Extraction task.", + "properties": { + "loggingOptOut": { + "type": "boolean", + "description": "logging opt out", + "default": false + }, + "modelVersion": { + "type": "string", + "description": "model version", + "default": "latest" + } + } + }, + "KeyPhraseTaskResult": { + "type": "object", + "description": "Contains the analyze text KeyPhraseExtraction task result.", + "properties": { + "results": { + "$ref": "#/definitions/KeyPhraseResult", + "description": "The list of Key phrase extraction results" + } + }, + "required": [ + "results" + ], + "allOf": [ + { + "$ref": "#/definitions/AnalyzeTextTaskResult" + } + ], + "x-ms-discriminator-value": "KeyPhraseExtractionResults" + }, + "KeyPhrasesDocumentResultWithDetectedLanguage": { + "type": "object", + "description": "A ranked list of sentences representing the extracted summary.", + "properties": { + "id": { + "type": "string", + "description": "Unique, non-empty document identifier." + }, + "warnings": { + "type": "array", + "description": "Warnings encountered while processing document.", + "items": { + "$ref": "#/definitions/DocumentWarning" + } + }, + "statistics": { + "$ref": "#/definitions/DocumentStatistics", + "description": "if showStats=true was specified in the request this field will contain information about the document payload." + }, + "keyPhrases": { + "type": "array", + "description": "A list of representative words or phrases. The number of key phrases returned is proportional to the number of words in the input document.", + "items": { + "type": "string" + } + }, + "detectedLanguage": { + "$ref": "#/definitions/DetectedLanguage", + "description": "If 'language' is set to 'auto' for the document in the request this field will contain a 2 letter ISO 639-1 representation of the language detected for this document." + } + }, + "required": [ + "id", + "warnings", + "keyPhrases" + ] + }, + "LanguageDetectionAnalysisInput": { + "type": "object", + "description": "Contains the language detection document analysis input.", + "properties": { + "documents": { + "type": "array", + "description": "List of documents to be analyzed.", + "items": { + "$ref": "#/definitions/LanguageInput" + } + } + } + }, + "LanguageDetectionDocumentResult": { + "type": "object", + "description": "Contains the language detection for a document.", + "properties": { + "id": { + "type": "string", + "description": "Unique, non-empty document identifier." + }, + "warnings": { + "type": "array", + "description": "Warnings encountered while processing document.", + "items": { + "$ref": "#/definitions/DocumentWarning" + } + }, + "statistics": { + "$ref": "#/definitions/DocumentStatistics", + "description": "if showStats=true was specified in the request this field will contain information about the document payload." + }, + "detectedLanguage": { + "$ref": "#/definitions/DetectedLanguage", + "description": "Detected Language." + } + }, + "required": [ + "id", + "warnings", + "detectedLanguage" + ] + }, + "LanguageDetectionResult": { + "type": "object", + "description": "Contains the language detection result for the request.", + "properties": { + "errors": { + "type": "array", + "description": "Errors by document id.", + "items": { + "$ref": "#/definitions/DocumentError" + } + }, + "statistics": { + "$ref": "#/definitions/RequestStatistics", + "description": "if showStats=true was specified in the request this field will contain information about the request payload." + }, + "modelVersion": { + "type": "string", + "description": "This field indicates which model is used for scoring." + }, + "documents": { + "type": "array", + "description": "Enumeration of language detection results for each input document.", + "items": { + "$ref": "#/definitions/LanguageDetectionDocumentResult" + } + } + }, + "required": [ + "errors", + "modelVersion", + "documents" + ] + }, + "LanguageDetectionTaskParameters": { + "type": "object", + "description": "Supported parameters for a Language Detection task.", + "properties": { + "loggingOptOut": { + "type": "boolean", + "description": "logging opt out", + "default": false + }, + "modelVersion": { + "type": "string", + "description": "model version", + "default": "latest" + } + } + }, + "LanguageDetectionTaskResult": { + "type": "object", + "description": "Contains the language detection task result for the request.", + "properties": { + "results": { + "$ref": "#/definitions/LanguageDetectionResult", + "description": "Contains the language detection results." + } + }, + "required": [ + "results" + ], + "allOf": [ + { + "$ref": "#/definitions/AnalyzeTextTaskResult" + } + ], + "x-ms-discriminator-value": "LanguageDetectionResults" + }, + "LanguageInput": { + "type": "object", + "description": "Contains the language detection input.", + "properties": { + "id": { + "type": "string", + "description": "A unique, non-empty document identifier." + }, + "text": { + "type": "string", + "description": "The input text to process." + }, + "countryHint": { + "type": "string", + "description": "The country hint to help with language detection of the text." + } + }, + "required": [ + "id", + "text" + ] + }, + "LengthMetadata": { + "type": "object", + "description": "Represents the Length entity Metadata model.", + "properties": { + "value": { + "type": "number", + "format": "double", + "description": "The numeric value that the extracted text denotes." + }, + "unit": { + "$ref": "#/definitions/LengthUnit", + "description": "Unit of measure for length." + } + }, + "required": [ + "value", + "unit" + ], + "allOf": [ + { + "$ref": "#/definitions/BaseMetadata" + } + ], + "x-ms-discriminator-value": "LengthMetadata" + }, + "LengthUnit": { + "type": "string", + "description": "The length unit of measurement.", + "enum": [ + "Unspecified", + "Kilometer", + "Hectometer", + "Decameter", + "Meter", + "Decimeter", + "Centimeter", + "Millimeter", + "Micrometer", + "Nanometer", + "Picometer", + "Mile", + "Yard", + "Inch", + "Foot", + "LightYear", + "Point" + ], + "x-ms-enum": { + "name": "LengthUnit", + "modelAsString": true, + "values": [ + { + "name": "Unspecified", + "value": "Unspecified", + "description": "Unspecified length unit." + }, + { + "name": "Kilometer", + "value": "Kilometer", + "description": "Length unit in kilometers." + }, + { + "name": "Hectometer", + "value": "Hectometer", + "description": "Length unit in hectometers." + }, + { + "name": "Decameter", + "value": "Decameter", + "description": "Length unit in decameters." + }, + { + "name": "Meter", + "value": "Meter", + "description": "Length unit in meters." + }, + { + "name": "Decimeter", + "value": "Decimeter", + "description": "Length unit in decimeters." + }, + { + "name": "Centimeter", + "value": "Centimeter", + "description": "Length unit in centimeters." + }, + { + "name": "Millimeter", + "value": "Millimeter", + "description": "Length unit in millimeters." + }, + { + "name": "Micrometer", + "value": "Micrometer", + "description": "Length unit in micrometers." + }, + { + "name": "Nanometer", + "value": "Nanometer", + "description": "Length unit in nanometers." + }, + { + "name": "Picometer", + "value": "Picometer", + "description": "Length unit in picometers." + }, + { + "name": "Mile", + "value": "Mile", + "description": "Length unit in miles." + }, + { + "name": "Yard", + "value": "Yard", + "description": "Length unit in yards." + }, + { + "name": "Inch", + "value": "Inch", + "description": "Length unit in inches." + }, + { + "name": "Foot", + "value": "Foot", + "description": "Length unit in feet." + }, + { + "name": "LightYear", + "value": "LightYear", + "description": "Length unit in light years." + }, + { + "name": "Point", + "value": "Point", + "description": "Length unit in points." + } + ] + } + }, + "LinkedEntity": { + "type": "object", + "description": "The LinkedEntity object containing the detected entity with the associated sources/links.", + "properties": { + "name": { + "type": "string", + "description": "Entity Linking formal name." + }, + "matches": { + "type": "array", + "description": "List of instances this entity appears in the text.", + "items": { + "$ref": "#/definitions/Match" + } + }, + "language": { + "type": "string", + "description": "Language used in the data source." + }, + "id": { + "type": "string", + "description": "Unique identifier of the recognized entity from the data source." + }, + "url": { + "type": "string", + "description": "URL for the entity's page from the data source." + }, + "dataSource": { + "type": "string", + "description": "Data source used to extract entity linking, such as Wiki/Bing etc." + }, + "bingId": { + "type": "string", + "description": "Bing Entity Search API unique identifier of the recognized entity." + } + }, + "required": [ + "name", + "matches", + "language", + "url", + "dataSource" + ] + }, + "Match": { + "type": "object", + "description": "The Match object containing the detected entity text with the offset and the length.", + "properties": { + "confidenceScore": { + "type": "number", + "format": "double", + "description": "If a well known item is recognized, a decimal number denoting the confidence level between 0 and 1 will be returned." + }, + "text": { + "type": "string", + "description": "Entity text as appears in the request." + }, + "offset": { + "type": "integer", + "format": "int32", + "description": "Start position for the entity match text." + }, + "length": { + "type": "integer", + "format": "int32", + "description": "Length for the entity match text." + } + }, + "required": [ + "confidenceScore", + "text", + "offset", + "length" + ] + }, + "MatchLongestEntityPolicyType": { + "type": "object", + "description": "Represents the Match longest overlap policy. No overlapping entities as far as it is possible. 1. If there are overlapping entities, the longest one will be returned. 2. If the set of characters predicted for 2 or more entities are exactly the same, select the entity that has the higher confidence score.3. If the entity scores are identical, return all entities that are still present after applying the previous rules. 3. If there is partial overlap (as in Hello Text Analytics) follow the above steps starting from 1.", + "allOf": [ + { + "$ref": "#/definitions/BaseEntityOverlapPolicy" + } + ], + "x-ms-discriminator-value": "matchLongest" + }, + "MetadataKind": { + "type": "string", + "description": "The entity Metadata object kind.", + "enum": [ + "DateMetadata", + "DateTimeMetadata", + "TimeMetadata", + "TemporalSetMetadata", + "NumberMetadata", + "OrdinalMetadata", + "SpeedMetadata", + "WeightMetadata", + "LengthMetadata", + "VolumeMetadata", + "AreaMetadata", + "AgeMetadata", + "InformationMetadata", + "TemperatureMetadata", + "CurrencyMetadata", + "NumericRangeMetadata", + "TemporalSpanMetadata" + ], + "x-ms-enum": { + "name": "MetadataKind", + "modelAsString": true, + "values": [ + { + "name": "DateMetadata", + "value": "DateMetadata", + "description": "Metadata for date-related values." + }, + { + "name": "DateTimeMetadata", + "value": "DateTimeMetadata", + "description": "Metadata for date and time-related values." + }, + { + "name": "TimeMetadata", + "value": "TimeMetadata", + "description": "Metadata for time-related values." + }, + { + "name": "TemporalSetMetadata", + "value": "TemporalSetMetadata", + "description": "Metadata for set of time-related values." + }, + { + "name": "NumberMetadata", + "value": "NumberMetadata", + "description": "Metadata for numeric values." + }, + { + "name": "OrdinalMetadata", + "value": "OrdinalMetadata", + "description": "Metadata for ordinal numbers." + }, + { + "name": "SpeedMetadata", + "value": "SpeedMetadata", + "description": "Metadata for speed-related values." + }, + { + "name": "WeightMetadata", + "value": "WeightMetadata", + "description": "Metadata for weight-related values." + }, + { + "name": "LengthMetadata", + "value": "LengthMetadata", + "description": "Metadata for length-related values." + }, + { + "name": "VolumeMetadata", + "value": "VolumeMetadata", + "description": "Metadata for volume-related values." + }, + { + "name": "AreaMetadata", + "value": "AreaMetadata", + "description": "Metadata for area-related values." + }, + { + "name": "AgeMetadata", + "value": "AgeMetadata", + "description": "Metadata for age-related values." + }, + { + "name": "InformationMetadata", + "value": "InformationMetadata", + "description": "Metadata for information-related values." + }, + { + "name": "TemperatureMetadata", + "value": "TemperatureMetadata", + "description": "Metadata for temperature-related values." + }, + { + "name": "CurrencyMetadata", + "value": "CurrencyMetadata", + "description": "Metadata for currency-related values." + }, + { + "name": "NumericRangeMetadata", + "value": "NumericRangeMetadata", + "description": "Metadata for numeric range values." + }, + { + "name": "TemporalSpanMetadata", + "value": "TemporalSpanMetadata", + "description": "Metadata for temporal span values." + } + ] + } + }, + "MultiLanguageAnalysisInput": { + "type": "object", + "description": "Collection of input documents to be analyzed by the service.", + "properties": { + "documents": { + "type": "array", + "description": "The input documents to be analyzed.", + "items": { + "$ref": "#/definitions/MultiLanguageInput" + } + } + } + }, + "MultiLanguageInput": { + "type": "object", + "description": "Contains an input document to be analyzed by the service.", + "properties": { + "id": { + "type": "string", + "description": "A unique, non-empty document identifier." + }, + "text": { + "type": "string", + "description": "The input text to process." + }, + "language": { + "type": "string", + "description": "(Optional) This is the 2 letter ISO 639-1 representation of a language. For example, use \\\"en\\\" for English; \\\"es\\\" for Spanish etc. If not set, use \\\"en\\\" for English as default. (Following only applies to 2023-04-15-preview and above) For Auto Language Detection, use \\\"auto\\\". If not set, use \\\"en\\\" for English as default." + } + }, + "required": [ + "id", + "text" + ] + }, + "NoMaskPolicyType": { + "type": "object", + "description": "Represents the policy of not redacting found PII.", + "allOf": [ + { + "$ref": "#/definitions/BaseRedactionPolicy" + } + ], + "x-ms-discriminator-value": "noMask" + }, + "NumberKind": { + "type": "string", + "description": "The type of the extracted number entity.", + "enum": [ + "Integer", + "Decimal", + "Power", + "Fraction", + "Percent", + "Unspecified" + ], + "x-ms-enum": { + "name": "NumberKind", + "modelAsString": true, + "values": [ + { + "name": "Integer", + "value": "Integer", + "description": "Integer number" + }, + { + "name": "Decimal", + "value": "Decimal", + "description": "Decimal number" + }, + { + "name": "Power", + "value": "Power", + "description": "Power number" + }, + { + "name": "Fraction", + "value": "Fraction", + "description": "Fraction number" + }, + { + "name": "Percent", + "value": "Percent", + "description": "Percent number" + }, + { + "name": "Unspecified", + "value": "Unspecified", + "description": "Unspecified number kind" + } + ] + } + }, + "NumberMetadata": { + "type": "object", + "description": "A metadata for numeric entity instances.", + "properties": { + "numberKind": { + "$ref": "#/definitions/NumberKind", + "description": "Kind of the number type." + }, + "value": { + "type": "number", + "format": "double", + "description": "A numeric representation of what the extracted text denotes." + } + }, + "required": [ + "numberKind", + "value" + ], + "allOf": [ + { + "$ref": "#/definitions/BaseMetadata" + } + ], + "x-ms-discriminator-value": "NumberMetadata" + }, + "NumericRangeMetadata": { + "type": "object", + "description": "represents the Metadata of numeric intervals.", + "properties": { + "rangeKind": { + "$ref": "#/definitions/RangeKind", + "description": "Kind of numeric ranges supported - like Number, Speed, etc." + }, + "minimum": { + "type": "number", + "format": "double", + "description": "The beginning value of the interval." + }, + "maximum": { + "type": "number", + "format": "double", + "description": "The ending value of the interval." + }, + "rangeInclusivity": { + "$ref": "#/definitions/RangeInclusivity", + "description": "The inclusiveness of this range." + } + }, + "required": [ + "rangeKind", + "minimum", + "maximum" + ], + "allOf": [ + { + "$ref": "#/definitions/BaseMetadata" + } + ], + "x-ms-discriminator-value": "NumericRangeMetadata" + }, + "OrdinalMetadata": { + "type": "object", + "description": "A metadata for numeric entity instances.", + "properties": { + "offset": { + "type": "string", + "description": "The offset with respect to the reference (e.g., offset = -1 indicates the second to last)" + }, + "relativeTo": { + "$ref": "#/definitions/RelativeTo", + "description": "The reference point that the ordinal number denotes." + }, + "value": { + "type": "string", + "description": "A simple arithmetic expression that the ordinal denotes." + } + }, + "required": [ + "offset", + "relativeTo", + "value" + ], + "allOf": [ + { + "$ref": "#/definitions/BaseMetadata" + } + ], + "x-ms-discriminator-value": "OrdinalMetadata" + }, + "PiiCategoriesExclude": { + "type": "string", + "description": "(Optional) describes the PII categories to return", + "enum": [ + "ABARoutingNumber", + "ARNationalIdentityNumber", + "AUBankAccountNumber", + "AUDriversLicenseNumber", + "AUMedicalAccountNumber", + "AUPassportNumber", + "AUTaxFileNumber", + "AUBusinessNumber", + "AUCompanyNumber", + "ATIdentityCard", + "ATTaxIdentificationNumber", + "ATValueAddedTaxNumber", + "AzureDocumentDBAuthKey", + "AzureIAASDatabaseConnectionAndSQLString", + "AzureIoTConnectionString", + "AzurePublishSettingPassword", + "AzureRedisCacheString", + "AzureSAS", + "AzureServiceBusString", + "AzureStorageAccountKey", + "AzureStorageAccountGeneric", + "BENationalNumber", + "BENationalNumberV2", + "BEValueAddedTaxNumber", + "BRCPFNumber", + "BRLegalEntityNumber", + "BRNationalIDRG", + "BGUniformCivilNumber", + "CABankAccountNumber", + "CADriversLicenseNumber", + "CAHealthServiceNumber", + "CAPassportNumber", + "CAPersonalHealthIdentification", + "CASocialInsuranceNumber", + "CLIdentityCardNumber", + "CNResidentIdentityCardNumber", + "CreditCardNumber", + "HRIdentityCardNumber", + "HRNationalIDNumber", + "HRPersonalIdentificationNumber", + "HRPersonalIdentificationOIBNumberV2", + "CYIdentityCard", + "CYTaxIdentificationNumber", + "CZPersonalIdentityNumber", + "CZPersonalIdentityV2", + "DKPersonalIdentificationNumber", + "DKPersonalIdentificationV2", + "DrugEnforcementAgencyNumber", + "EEPersonalIdentificationCode", + "EUDebitCardNumber", + "EUDriversLicenseNumber", + "EUGPSCoordinates", + "EUNationalIdentificationNumber", + "EUPassportNumber", + "EUSocialSecurityNumber", + "EUTaxIdentificationNumber", + "FIEuropeanHealthNumber", + "FINationalID", + "FINationalIDV2", + "FIPassportNumber", + "FRDriversLicenseNumber", + "FRHealthInsuranceNumber", + "FRNationalID", + "FRPassportNumber", + "FRSocialSecurityNumber", + "FRTaxIdentificationNumber", + "FRValueAddedTaxNumber", + "DEDriversLicenseNumber", + "DEPassportNumber", + "DEIdentityCardNumber", + "DETaxIdentificationNumber", + "DEValueAddedNumber", + "GRNationalIDCard", + "GRNationalIDV2", + "GRTaxIdentificationNumber", + "HKIdentityCardNumber", + "HUValueAddedNumber", + "HUPersonalIdentificationNumber", + "HUTaxIdentificationNumber", + "INPermanentAccount", + "INUniqueIdentificationNumber", + "IDIdentityCardNumber", + "InternationalBankingAccountNumber", + "IEPersonalPublicServiceNumber", + "IEPersonalPublicServiceNumberV2", + "ILBankAccountNumber", + "ILNationalID", + "ITDriversLicenseNumber", + "ITFiscalCode", + "ITValueAddedTaxNumber", + "JPBankAccountNumber", + "JPDriversLicenseNumber", + "JPPassportNumber", + "JPResidentRegistrationNumber", + "JPSocialInsuranceNumber", + "JPMyNumberCorporate", + "JPMyNumberPersonal", + "JPResidenceCardNumber", + "LVPersonalCode", + "LTPersonalCode", + "LUNationalIdentificationNumberNatural", + "LUNationalIdentificationNumberNonNatural", + "MYIdentityCardNumber", + "MTIdentityCardNumber", + "MTTaxIDNumber", + "NLCitizensServiceNumber", + "NLCitizensServiceNumberV2", + "NLTaxIdentificationNumber", + "NLValueAddedTaxNumber", + "NZBankAccountNumber", + "NZDriversLicenseNumber", + "NZInlandRevenueNumber", + "NZMinistryOfHealthNumber", + "NZSocialWelfareNumber", + "NOIdentityNumber", + "PHUnifiedMultiPurposeIDNumber", + "PLIdentityCard", + "PLNationalID", + "PLNationalIDV2", + "PLPassportNumber", + "PLTaxIdentificationNumber", + "PLREGONNumber", + "PTCitizenCardNumber", + "PTCitizenCardNumberV2", + "PTTaxIdentificationNumber", + "ROPersonalNumericalCode", + "RUPassportNumberDomestic", + "RUPassportNumberInternational", + "SANationalID", + "SGNationalRegistrationIdentityCardNumber", + "SKPersonalNumber", + "SITaxIdentificationNumber", + "SIUniqueMasterCitizenNumber", + "ZAIdentificationNumber", + "KRResidentRegistrationNumber", + "ESDNI", + "ESSocialSecurityNumber", + "ESTaxIdentificationNumber", + "SQLServerConnectionString", + "SENationalID", + "SENationalIDV2", + "SEPassportNumber", + "SETaxIdentificationNumber", + "SWIFTCode", + "CHSocialSecurityNumber", + "TWNationalID", + "TWPassportNumber", + "TWResidentCertificate", + "THPopulationIdentificationCode", + "TRNationalIdentificationNumber", + "UKDriversLicenseNumber", + "UKElectoralRollNumber", + "UKNationalHealthNumber", + "UKNationalInsuranceNumber", + "UKUniqueTaxpayerNumber", + "USUKPassportNumber", + "USBankAccountNumber", + "USDriversLicenseNumber", + "USIndividualTaxpayerIdentification", + "USSocialSecurityNumber", + "UAPassportNumberDomestic", + "UAPassportNumberInternational", + "Organization", + "Email", + "URL", + "Age", + "PhoneNumber", + "IPAddress", + "Date", + "Person", + "Address", + "DateOfBirth", + "BankAccountNumber", + "PassportNumber", + "DriversLicenseNumber", + "Neighborhood", + "SortCode", + "PIN", + "VIN", + "LicensePlate" + ], + "x-ms-enum": { + "name": "PiiCategoriesExclude", + "modelAsString": true, + "values": [ + { + "name": "ABARoutingNumber", + "value": "ABARoutingNumber", + "description": "ABA Routing number" + }, + { + "name": "ARNationalIdentityNumber", + "value": "ARNationalIdentityNumber", + "description": "AR National Identity Number" + }, + { + "name": "AUBankAccountNumber", + "value": "AUBankAccountNumber", + "description": "AT Bank Account Number" + }, + { + "name": "AUDriversLicenseNumber", + "value": "AUDriversLicenseNumber", + "description": "AU Driver's License Number" + }, + { + "name": "AUMedicalAccountNumber", + "value": "AUMedicalAccountNumber", + "description": "AU Medical Account Number" + }, + { + "name": "AUPassportNumber", + "value": "AUPassportNumber", + "description": "AU Passport Number" + }, + { + "name": "AUTaxFileNumber", + "value": "AUTaxFileNumber", + "description": "AU Tax File Number" + }, + { + "name": "AUBusinessNumber", + "value": "AUBusinessNumber", + "description": "AU Business Number" + }, + { + "name": "AUCompanyNumber", + "value": "AUCompanyNumber", + "description": "AU Company Number" + }, + { + "name": "ATIdentityCard", + "value": "ATIdentityCard", + "description": "AT Identity Card" + }, + { + "name": "ATTaxIdentificationNumber", + "value": "ATTaxIdentificationNumber", + "description": "AT Tax Identification Number" + }, + { + "name": "ATValueAddedTaxNumber", + "value": "ATValueAddedTaxNumber", + "description": "AT Value Added Tax Number" + }, + { + "name": "AzureDocumentDBAuthKey", + "value": "AzureDocumentDBAuthKey", + "description": "Azure Document DB Auth Key" + }, + { + "name": "AzureIAASDatabaseConnectionAndSQLString", + "value": "AzureIAASDatabaseConnectionAndSQLString", + "description": "Azure IAAS Database Connection And SQL String" + }, + { + "name": "AzureIoTConnectionString", + "value": "AzureIoTConnectionString", + "description": "Azure IoT Connection String" + }, + { + "name": "AzurePublishSettingPassword", + "value": "AzurePublishSettingPassword", + "description": "Azure Publish Setting Password" + }, + { + "name": "AzureRedisCacheString", + "value": "AzureRedisCacheString", + "description": "Azure Redis Cache String" + }, + { + "name": "AzureSAS", + "value": "AzureSAS", + "description": "Azure SAS" + }, + { + "name": "AzureServiceBusString", + "value": "AzureServiceBusString", + "description": "Azure Service Bus String" + }, + { + "name": "AzureStorageAccountKey", + "value": "AzureStorageAccountKey", + "description": "Azure Storage Account Key" + }, + { + "name": "AzureStorageAccountGeneric", + "value": "AzureStorageAccountGeneric", + "description": "Azure Storage Account Generic" + }, + { + "name": "BENationalNumber", + "value": "BENationalNumber", + "description": "BE National Number" + }, + { + "name": "BENationalNumberV2", + "value": "BENationalNumberV2", + "description": "BE National Number V2" + }, + { + "name": "BEValueAddedTaxNumber", + "value": "BEValueAddedTaxNumber", + "description": "BE Value Added Tax Number" + }, + { + "name": "BRCPFNumber", + "value": "BRCPFNumber", + "description": "BR CPF Number" + }, + { + "name": "BRLegalEntityNumber", + "value": "BRLegalEntityNumber", + "description": "BR Legal Entity Number" + }, + { + "name": "BRNationalIDRG", + "value": "BRNationalIDRG", + "description": "BR National ID RG" + }, + { + "name": "BGUniformCivilNumber", + "value": "BGUniformCivilNumber", + "description": "BG Uniform Civil Number" + }, + { + "name": "CABankAccountNumber", + "value": "CABankAccountNumber", + "description": "CA Bank Account Number" + }, + { + "name": "CADriversLicenseNumber", + "value": "CADriversLicenseNumber", + "description": "CA Driver's License Number" + }, + { + "name": "CAHealthServiceNumber", + "value": "CAHealthServiceNumber", + "description": "CA Health Service Number" + }, + { + "name": "CAPassportNumber", + "value": "CAPassportNumber", + "description": "CA Passport Number" + }, + { + "name": "CAPersonalHealthIdentification", + "value": "CAPersonalHealthIdentification", + "description": "CA Personal Health Identification" + }, + { + "name": "CASocialInsuranceNumber", + "value": "CASocialInsuranceNumber", + "description": "CA Social Insurance Number" + }, + { + "name": "CLIdentityCardNumber", + "value": "CLIdentityCardNumber", + "description": "CL Identity Card Number" + }, + { + "name": "CNResidentIdentityCardNumber", + "value": "CNResidentIdentityCardNumber", + "description": "CN Resident Identity Card Number" + }, + { + "name": "CreditCardNumber", + "value": "CreditCardNumber", + "description": "Credit Card Number" + }, + { + "name": "HRIdentityCardNumber", + "value": "HRIdentityCardNumber", + "description": "HR Identity Card Number" + }, + { + "name": "HRNationalIDNumber", + "value": "HRNationalIDNumber", + "description": "HR National ID Number" + }, + { + "name": "HRPersonalIdentificationNumber", + "value": "HRPersonalIdentificationNumber", + "description": "HR Personal Identification Number" + }, + { + "name": "HRPersonalIdentificationOIBNumberV2", + "value": "HRPersonalIdentificationOIBNumberV2", + "description": "HR Personal Identification OIB Number V2" + }, + { + "name": "CYIdentityCard", + "value": "CYIdentityCard", + "description": "CY Identity Card" + }, + { + "name": "CYTaxIdentificationNumber", + "value": "CYTaxIdentificationNumber", + "description": "CY Tax Identification Number" + }, + { + "name": "CZPersonalIdentityNumber", + "value": "CZPersonalIdentityNumber", + "description": "CZ Personal Identity Number" + }, + { + "name": "CZPersonalIdentityV2", + "value": "CZPersonalIdentityV2", + "description": "CZ Personal Identity V2" + }, + { + "name": "DKPersonalIdentificationNumber", + "value": "DKPersonalIdentificationNumber", + "description": "DK Personal Identification Number" + }, + { + "name": "DKPersonalIdentificationV2", + "value": "DKPersonalIdentificationV2", + "description": "DK Personal Identification V2" + }, + { + "name": "DrugEnforcementAgencyNumber", + "value": "DrugEnforcementAgencyNumber", + "description": "Drug Enforcement Agency Number" + }, + { + "name": "EEPersonalIdentificationCode", + "value": "EEPersonalIdentificationCode", + "description": "EE Personal Identification Code" + }, + { + "name": "EUDebitCardNumber", + "value": "EUDebitCardNumber", + "description": "EU Debit Card Number" + }, + { + "name": "EUDriversLicenseNumber", + "value": "EUDriversLicenseNumber", + "description": "EU Driver's License Number" + }, + { + "name": "EUGPSCoordinates", + "value": "EUGPSCoordinates", + "description": "EU GPS Coordinates" + }, + { + "name": "EUNationalIdentificationNumber", + "value": "EUNationalIdentificationNumber", + "description": "EU National Identification Number" + }, + { + "name": "EUPassportNumber", + "value": "EUPassportNumber", + "description": "EU Passport Number" + }, + { + "name": "EUSocialSecurityNumber", + "value": "EUSocialSecurityNumber", + "description": "EU Social Security Number" + }, + { + "name": "EUTaxIdentificationNumber", + "value": "EUTaxIdentificationNumber", + "description": "EU Tax Identification Number" + }, + { + "name": "FIEuropeanHealthNumber", + "value": "FIEuropeanHealthNumber", + "description": "FI European Health Number" + }, + { + "name": "FINationalID", + "value": "FINationalID", + "description": "FI National ID" + }, + { + "name": "FINationalIDV2", + "value": "FINationalIDV2", + "description": "FI National ID V2" + }, + { + "name": "FIPassportNumber", + "value": "FIPassportNumber", + "description": "FI Passport Number" + }, + { + "name": "FRDriversLicenseNumber", + "value": "FRDriversLicenseNumber", + "description": "FR Driver's License Number" + }, + { + "name": "FRHealthInsuranceNumber", + "value": "FRHealthInsuranceNumber", + "description": "FR Health Insurance Number" + }, + { + "name": "FRNationalID", + "value": "FRNationalID", + "description": "FR National ID" + }, + { + "name": "FRPassportNumber", + "value": "FRPassportNumber", + "description": "FR Passport Number" + }, + { + "name": "FRSocialSecurityNumber", + "value": "FRSocialSecurityNumber", + "description": "FR Social Security Number" + }, + { + "name": "FRTaxIdentificationNumber", + "value": "FRTaxIdentificationNumber", + "description": "FR Tax Identification Number" + }, + { + "name": "FRValueAddedTaxNumber", + "value": "FRValueAddedTaxNumber", + "description": "FR Value Added Tax Number" + }, + { + "name": "DEDriversLicenseNumber", + "value": "DEDriversLicenseNumber", + "description": "DE Driver's License Number" + }, + { + "name": "DEPassportNumber", + "value": "DEPassportNumber", + "description": "DE Passport Number" + }, + { + "name": "DEIdentityCardNumber", + "value": "DEIdentityCardNumber", + "description": "DE Identity Card Number" + }, + { + "name": "DETaxIdentificationNumber", + "value": "DETaxIdentificationNumber", + "description": "DE Tax Identification Number" + }, + { + "name": "DEValueAddedNumber", + "value": "DEValueAddedNumber", + "description": "DE Value Added Number" + }, + { + "name": "GRNationalIDCard", + "value": "GRNationalIDCard", + "description": "GR National ID Card" + }, + { + "name": "GRNationalIDV2", + "value": "GRNationalIDV2", + "description": "GR National ID V2" + }, + { + "name": "GRTaxIdentificationNumber", + "value": "GRTaxIdentificationNumber", + "description": "GR Tax Identification Number" + }, + { + "name": "HKIdentityCardNumber", + "value": "HKIdentityCardNumber", + "description": "HK Identity Card Number" + }, + { + "name": "HUValueAddedNumber", + "value": "HUValueAddedNumber", + "description": "HU Value Added Number" + }, + { + "name": "HUPersonalIdentificationNumber", + "value": "HUPersonalIdentificationNumber", + "description": "HU Personal Identification Number" + }, + { + "name": "HUTaxIdentificationNumber", + "value": "HUTaxIdentificationNumber", + "description": "HU Tax Identification Number" + }, + { + "name": "INPermanentAccount", + "value": "INPermanentAccount", + "description": "IN Permanent Account" + }, + { + "name": "INUniqueIdentificationNumber", + "value": "INUniqueIdentificationNumber", + "description": "IN Unique Identification Number" + }, + { + "name": "IDIdentityCardNumber", + "value": "IDIdentityCardNumber", + "description": "ID Identity Card Number" + }, + { + "name": "InternationalBankingAccountNumber", + "value": "InternationalBankingAccountNumber", + "description": "International Banking Account Number" + }, + { + "name": "IEPersonalPublicServiceNumber", + "value": "IEPersonalPublicServiceNumber", + "description": "IE Personal Public Service Number" + }, + { + "name": "IEPersonalPublicServiceNumberV2", + "value": "IEPersonalPublicServiceNumberV2", + "description": "IE Personal Public Service Number V2" + }, + { + "name": "ILBankAccountNumber", + "value": "ILBankAccountNumber", + "description": "IL Bank Account Number" + }, + { + "name": "ILNationalID", + "value": "ILNationalID", + "description": "IL National ID" + }, + { + "name": "ITDriversLicenseNumber", + "value": "ITDriversLicenseNumber", + "description": "IT Driver's License Number" + }, + { + "name": "ITFiscalCode", + "value": "ITFiscalCode", + "description": "IT Fiscal Code" + }, + { + "name": "ITValueAddedTaxNumber", + "value": "ITValueAddedTaxNumber", + "description": "IT Value Added Tax Number" + }, + { + "name": "JPBankAccountNumber", + "value": "JPBankAccountNumber", + "description": "JP Bank Account Number" + }, + { + "name": "JPDriversLicenseNumber", + "value": "JPDriversLicenseNumber", + "description": "JP Driver's License Number" + }, + { + "name": "JPPassportNumber", + "value": "JPPassportNumber", + "description": "JP Passport Number" + }, + { + "name": "JPResidentRegistrationNumber", + "value": "JPResidentRegistrationNumber", + "description": "JP Resident Registration Number" + }, + { + "name": "JPSocialInsuranceNumber", + "value": "JPSocialInsuranceNumber", + "description": "JP Social Insurance Number" + }, + { + "name": "JPMyNumberCorporate", + "value": "JPMyNumberCorporate", + "description": "JP My Number Corporate" + }, + { + "name": "JPMyNumberPersonal", + "value": "JPMyNumberPersonal", + "description": "JP My Number Personal" + }, + { + "name": "JPResidenceCardNumber", + "value": "JPResidenceCardNumber", + "description": "JP Residence Card Number" + }, + { + "name": "LVPersonalCode", + "value": "LVPersonalCode", + "description": "LV Personal Code" + }, + { + "name": "LTPersonalCode", + "value": "LTPersonalCode", + "description": "LT Personal Code" + }, + { + "name": "LUNationalIdentificationNumberNatural", + "value": "LUNationalIdentificationNumberNatural", + "description": "LU National Identification Number Natural" + }, + { + "name": "LUNationalIdentificationNumberNonNatural", + "value": "LUNationalIdentificationNumberNonNatural", + "description": "LU National Identification Number Non Natural" + }, + { + "name": "MYIdentityCardNumber", + "value": "MYIdentityCardNumber", + "description": "MY Identity Card Number" + }, + { + "name": "MTIdentityCardNumber", + "value": "MTIdentityCardNumber", + "description": "MT Identity Card Number" + }, + { + "name": "MTTaxIDNumber", + "value": "MTTaxIDNumber", + "description": "MT Tax ID Number" + }, + { + "name": "NLCitizensServiceNumber", + "value": "NLCitizensServiceNumber", + "description": "NL Citizens Service Number" + }, + { + "name": "NLCitizensServiceNumberV2", + "value": "NLCitizensServiceNumberV2", + "description": "NL Citizens Service Number V2" + }, + { + "name": "NLTaxIdentificationNumber", + "value": "NLTaxIdentificationNumber", + "description": "NL Tax Identification Number" + }, + { + "name": "NLValueAddedTaxNumber", + "value": "NLValueAddedTaxNumber", + "description": "NL Value Added Tax Number" + }, + { + "name": "NZBankAccountNumber", + "value": "NZBankAccountNumber", + "description": "NZ Bank Account Number" + }, + { + "name": "NZDriversLicenseNumber", + "value": "NZDriversLicenseNumber", + "description": "NZ Driver's License Number" + }, + { + "name": "NZInlandRevenueNumber", + "value": "NZInlandRevenueNumber", + "description": "NZ Inland Revenue Number" + }, + { + "name": "NZMinistryOfHealthNumber", + "value": "NZMinistryOfHealthNumber", + "description": "NZ Ministry Of Health Number" + }, + { + "name": "NZSocialWelfareNumber", + "value": "NZSocialWelfareNumber", + "description": "NZ Social Welfare Number" + }, + { + "name": "NOIdentityNumber", + "value": "NOIdentityNumber", + "description": "NO Identity Number" + }, + { + "name": "PHUnifiedMultiPurposeIDNumber", + "value": "PHUnifiedMultiPurposeIDNumber", + "description": "PH Unified Multi Purpose ID Number" + }, + { + "name": "PLIdentityCard", + "value": "PLIdentityCard", + "description": "PL Identity Card" + }, + { + "name": "PLNationalID", + "value": "PLNationalID", + "description": "PL National ID" + }, + { + "name": "PLNationalIDV2", + "value": "PLNationalIDV2", + "description": "PL National ID V2" + }, + { + "name": "PLPassportNumber", + "value": "PLPassportNumber", + "description": "PL Passport Number" + }, + { + "name": "PLTaxIdentificationNumber", + "value": "PLTaxIdentificationNumber", + "description": "PL Tax Identification Number" + }, + { + "name": "PLREGONNumber", + "value": "PLREGONNumber", + "description": "PL REGON Number" + }, + { + "name": "PTCitizenCardNumber", + "value": "PTCitizenCardNumber", + "description": "PT Citizen Card Number" + }, + { + "name": "PTCitizenCardNumberV2", + "value": "PTCitizenCardNumberV2", + "description": "PT Citizen Card Number V2" + }, + { + "name": "PTTaxIdentificationNumber", + "value": "PTTaxIdentificationNumber", + "description": "PT Tax Identification Number" + }, + { + "name": "ROPersonalNumericalCode", + "value": "ROPersonalNumericalCode", + "description": "RO Personal Numerical Code" + }, + { + "name": "RUPassportNumberDomestic", + "value": "RUPassportNumberDomestic", + "description": "RU Passport Number Domestic" + }, + { + "name": "RUPassportNumberInternational", + "value": "RUPassportNumberInternational", + "description": "RU Passport Number International" + }, + { + "name": "SANationalID", + "value": "SANationalID", + "description": "SA National ID" + }, + { + "name": "SGNationalRegistrationIdentityCardNumber", + "value": "SGNationalRegistrationIdentityCardNumber", + "description": "SG National Registration Identity Card Number" + }, + { + "name": "SKPersonalNumber", + "value": "SKPersonalNumber", + "description": "SK Personal Number" + }, + { + "name": "SITaxIdentificationNumber", + "value": "SITaxIdentificationNumber", + "description": "SI Tax Identification Number" + }, + { + "name": "SIUniqueMasterCitizenNumber", + "value": "SIUniqueMasterCitizenNumber", + "description": "SI Unique Master Citizen Number" + }, + { + "name": "ZAIdentificationNumber", + "value": "ZAIdentificationNumber", + "description": "ZA Identification Number" + }, + { + "name": "KRResidentRegistrationNumber", + "value": "KRResidentRegistrationNumber", + "description": "KR Resident Registration Number" + }, + { + "name": "ESDNI", + "value": "ESDNI", + "description": "ES DNI" + }, + { + "name": "ESSocialSecurityNumber", + "value": "ESSocialSecurityNumber", + "description": "ES Social Security Number" + }, + { + "name": "ESTaxIdentificationNumber", + "value": "ESTaxIdentificationNumber", + "description": "ES Tax Identification Number" + }, + { + "name": "SQLServerConnectionString", + "value": "SQLServerConnectionString", + "description": "SQL Server Connection String" + }, + { + "name": "SENationalID", + "value": "SENationalID", + "description": "SE National ID" + }, + { + "name": "SENationalIDV2", + "value": "SENationalIDV2", + "description": "SE National ID V2" + }, + { + "name": "SEPassportNumber", + "value": "SEPassportNumber", + "description": "SE Passport Number" + }, + { + "name": "SETaxIdentificationNumber", + "value": "SETaxIdentificationNumber", + "description": "SE Tax Identification Number" + }, + { + "name": "SWIFTCode", + "value": "SWIFTCode", + "description": "SWIFT Code" + }, + { + "name": "CHSocialSecurityNumber", + "value": "CHSocialSecurityNumber", + "description": "CH Social Security Number" + }, + { + "name": "TWNationalID", + "value": "TWNationalID", + "description": "TW National ID" + }, + { + "name": "TWPassportNumber", + "value": "TWPassportNumber", + "description": "TW Passport Number" + }, + { + "name": "TWResidentCertificate", + "value": "TWResidentCertificate", + "description": "TW Resident Certificate" + }, + { + "name": "THPopulationIdentificationCode", + "value": "THPopulationIdentificationCode", + "description": "TH Population Identification Code" + }, + { + "name": "TRNationalIdentificationNumber", + "value": "TRNationalIdentificationNumber", + "description": "TR National Identification Number" + }, + { + "name": "UKDriversLicenseNumber", + "value": "UKDriversLicenseNumber", + "description": "UK Driver's License Number" + }, + { + "name": "UKElectoralRollNumber", + "value": "UKElectoralRollNumber", + "description": "UK Electoral Roll Number" + }, + { + "name": "UKNationalHealthNumber", + "value": "UKNationalHealthNumber", + "description": "UK National Health Number" + }, + { + "name": "UKNationalInsuranceNumber", + "value": "UKNationalInsuranceNumber", + "description": "UK National Insurance Number" + }, + { + "name": "UKUniqueTaxpayerNumber", + "value": "UKUniqueTaxpayerNumber", + "description": "UK Unique Taxpayer Number" + }, + { + "name": "USUKPassportNumber", + "value": "USUKPassportNumber", + "description": "US UK Passport Number" + }, + { + "name": "USBankAccountNumber", + "value": "USBankAccountNumber", + "description": "US Bank Account Number" + }, + { + "name": "USDriversLicenseNumber", + "value": "USDriversLicenseNumber", + "description": "US Driver's License Number" + }, + { + "name": "USIndividualTaxpayerIdentification", + "value": "USIndividualTaxpayerIdentification", + "description": "US Individual Taxpayer Identification" + }, + { + "name": "USSocialSecurityNumber", + "value": "USSocialSecurityNumber", + "description": "US Social Security Number" + }, + { + "name": "UAPassportNumberDomestic", + "value": "UAPassportNumberDomestic", + "description": "UA Passport Number Domestic" + }, + { + "name": "UAPassportNumberInternational", + "value": "UAPassportNumberInternational", + "description": "UA Passport Number International" + }, + { + "name": "Organization", + "value": "Organization", + "description": "Organization" + }, + { + "name": "Email", + "value": "Email", + "description": "Email" + }, + { + "name": "URL", + "value": "URL", + "description": "URL" + }, + { + "name": "Age", + "value": "Age", + "description": "Age" + }, + { + "name": "PhoneNumber", + "value": "PhoneNumber", + "description": "Phone Number" + }, + { + "name": "IPAddress", + "value": "IPAddress", + "description": "IP Address" + }, + { + "name": "Date", + "value": "Date", + "description": "Date" + }, + { + "name": "Person", + "value": "Person", + "description": "Person" + }, + { + "name": "Address", + "value": "Address", + "description": "Address" + }, + { + "name": "DateOfBirth", + "value": "DateOfBirth", + "description": "Date Of Birth" + }, + { + "name": "BankAccountNumber", + "value": "BankAccountNumber", + "description": "Bank Account Number" + }, + { + "name": "PassportNumber", + "value": "PassportNumber", + "description": "Passport Number" + }, + { + "name": "DriversLicenseNumber", + "value": "DriversLicenseNumber", + "description": "Drivers License Number" + }, + { + "name": "Neighborhood", + "value": "Neighborhood", + "description": "Neighborhood" + }, + { + "name": "SortCode", + "value": "SortCode", + "description": "Sort Code. 6-digit number used in the UK to identify a specific bank and branch where a bank account is held" + }, + { + "name": "PIN", + "value": "PIN", + "description": "PIN" + }, + { + "name": "VIN", + "value": "VIN", + "description": "VIN" + }, + { + "name": "LicensePlate", + "value": "LicensePlate", + "description": "License Plate" + } + ] + } + }, + "PiiCategory": { + "type": "string", + "description": "(Optional) describes the PII categories to return", + "enum": [ + "ABARoutingNumber", + "ARNationalIdentityNumber", + "AUBankAccountNumber", + "AUDriversLicenseNumber", + "AUMedicalAccountNumber", + "AUPassportNumber", + "AUTaxFileNumber", + "AUBusinessNumber", + "AUCompanyNumber", + "ATIdentityCard", + "ATTaxIdentificationNumber", + "ATValueAddedTaxNumber", + "AzureDocumentDBAuthKey", + "AzureIAASDatabaseConnectionAndSQLString", + "AzureIoTConnectionString", + "AzurePublishSettingPassword", + "AzureRedisCacheString", + "AzureSAS", + "AzureServiceBusString", + "AzureStorageAccountKey", + "AzureStorageAccountGeneric", + "BENationalNumber", + "BENationalNumberV2", + "BEValueAddedTaxNumber", + "BRCPFNumber", + "BRLegalEntityNumber", + "BRNationalIDRG", + "BGUniformCivilNumber", + "CABankAccountNumber", + "CADriversLicenseNumber", + "CAHealthServiceNumber", + "CAPassportNumber", + "CAPersonalHealthIdentification", + "CASocialInsuranceNumber", + "CLIdentityCardNumber", + "CNResidentIdentityCardNumber", + "CreditCardNumber", + "HRIdentityCardNumber", + "HRNationalIDNumber", + "HRPersonalIdentificationNumber", + "HRPersonalIdentificationOIBNumberV2", + "CYIdentityCard", + "CYTaxIdentificationNumber", + "CZPersonalIdentityNumber", + "CZPersonalIdentityV2", + "DKPersonalIdentificationNumber", + "DKPersonalIdentificationV2", + "DrugEnforcementAgencyNumber", + "EEPersonalIdentificationCode", + "EUDebitCardNumber", + "EUDriversLicenseNumber", + "EUGPSCoordinates", + "EUNationalIdentificationNumber", + "EUPassportNumber", + "EUSocialSecurityNumber", + "EUTaxIdentificationNumber", + "FIEuropeanHealthNumber", + "FINationalID", + "FINationalIDV2", + "FIPassportNumber", + "FRDriversLicenseNumber", + "FRHealthInsuranceNumber", + "FRNationalID", + "FRPassportNumber", + "FRSocialSecurityNumber", + "FRTaxIdentificationNumber", + "FRValueAddedTaxNumber", + "DEDriversLicenseNumber", + "DEPassportNumber", + "DEIdentityCardNumber", + "DETaxIdentificationNumber", + "DEValueAddedNumber", + "GRNationalIDCard", + "GRNationalIDV2", + "GRTaxIdentificationNumber", + "HKIdentityCardNumber", + "HUValueAddedNumber", + "HUPersonalIdentificationNumber", + "HUTaxIdentificationNumber", + "INPermanentAccount", + "INUniqueIdentificationNumber", + "IDIdentityCardNumber", + "InternationalBankingAccountNumber", + "IEPersonalPublicServiceNumber", + "IEPersonalPublicServiceNumberV2", + "ILBankAccountNumber", + "ILNationalID", + "ITDriversLicenseNumber", + "ITFiscalCode", + "ITValueAddedTaxNumber", + "JPBankAccountNumber", + "JPDriversLicenseNumber", + "JPPassportNumber", + "JPResidentRegistrationNumber", + "JPSocialInsuranceNumber", + "JPMyNumberCorporate", + "JPMyNumberPersonal", + "JPResidenceCardNumber", + "LVPersonalCode", + "LTPersonalCode", + "LUNationalIdentificationNumberNatural", + "LUNationalIdentificationNumberNonNatural", + "MYIdentityCardNumber", + "MTIdentityCardNumber", + "MTTaxIDNumber", + "NLCitizensServiceNumber", + "NLCitizensServiceNumberV2", + "NLTaxIdentificationNumber", + "NLValueAddedTaxNumber", + "NZBankAccountNumber", + "NZDriversLicenseNumber", + "NZInlandRevenueNumber", + "NZMinistryOfHealthNumber", + "NZSocialWelfareNumber", + "NOIdentityNumber", + "PHUnifiedMultiPurposeIDNumber", + "PLIdentityCard", + "PLNationalID", + "PLNationalIDV2", + "PLPassportNumber", + "PLTaxIdentificationNumber", + "PLREGONNumber", + "PTCitizenCardNumber", + "PTCitizenCardNumberV2", + "PTTaxIdentificationNumber", + "ROPersonalNumericalCode", + "RUPassportNumberDomestic", + "RUPassportNumberInternational", + "SANationalID", + "SGNationalRegistrationIdentityCardNumber", + "SKPersonalNumber", + "SITaxIdentificationNumber", + "SIUniqueMasterCitizenNumber", + "ZAIdentificationNumber", + "KRResidentRegistrationNumber", + "ESDNI", + "ESSocialSecurityNumber", + "ESTaxIdentificationNumber", + "SQLServerConnectionString", + "SENationalID", + "SENationalIDV2", + "SEPassportNumber", + "SETaxIdentificationNumber", + "SWIFTCode", + "CHSocialSecurityNumber", + "TWNationalID", + "TWPassportNumber", + "TWResidentCertificate", + "THPopulationIdentificationCode", + "TRNationalIdentificationNumber", + "UKDriversLicenseNumber", + "UKElectoralRollNumber", + "UKNationalHealthNumber", + "UKNationalInsuranceNumber", + "UKUniqueTaxpayerNumber", + "USUKPassportNumber", + "USBankAccountNumber", + "USDriversLicenseNumber", + "USIndividualTaxpayerIdentification", + "USSocialSecurityNumber", + "UAPassportNumberDomestic", + "UAPassportNumberInternational", + "Organization", + "Email", + "URL", + "Age", + "PhoneNumber", + "IPAddress", + "Date", + "Person", + "Address", + "DateOfBirth", + "BankAccountNumber", + "PassportNumber", + "DriversLicenseNumber", + "Neighborhood", + "SortCode", + "PIN", + "VIN", + "LicensePlate", + "All", + "Default" + ], + "x-ms-enum": { + "name": "PiiCategory", + "modelAsString": true, + "values": [ + { + "name": "ABARoutingNumber", + "value": "ABARoutingNumber", + "description": "ABA Routing number" + }, + { + "name": "ARNationalIdentityNumber", + "value": "ARNationalIdentityNumber", + "description": "AR National Identity Number" + }, + { + "name": "AUBankAccountNumber", + "value": "AUBankAccountNumber", + "description": "AT Bank Account Number" + }, + { + "name": "AUDriversLicenseNumber", + "value": "AUDriversLicenseNumber", + "description": "AU Driver's License Number" + }, + { + "name": "AUMedicalAccountNumber", + "value": "AUMedicalAccountNumber", + "description": "AU Medical Account Number" + }, + { + "name": "AUPassportNumber", + "value": "AUPassportNumber", + "description": "AU Passport Number" + }, + { + "name": "AUTaxFileNumber", + "value": "AUTaxFileNumber", + "description": "AU Tax File Number" + }, + { + "name": "AUBusinessNumber", + "value": "AUBusinessNumber", + "description": "AU Business Number" + }, + { + "name": "AUCompanyNumber", + "value": "AUCompanyNumber", + "description": "AU Company Number" + }, + { + "name": "ATIdentityCard", + "value": "ATIdentityCard", + "description": "AT Identity Card" + }, + { + "name": "ATTaxIdentificationNumber", + "value": "ATTaxIdentificationNumber", + "description": "AT Tax Identification Number" + }, + { + "name": "ATValueAddedTaxNumber", + "value": "ATValueAddedTaxNumber", + "description": "AT Value Added Tax Number" + }, + { + "name": "AzureDocumentDBAuthKey", + "value": "AzureDocumentDBAuthKey", + "description": "Azure Document DB Auth Key" + }, + { + "name": "AzureIAASDatabaseConnectionAndSQLString", + "value": "AzureIAASDatabaseConnectionAndSQLString", + "description": "Azure IAAS Database Connection And SQL String" + }, + { + "name": "AzureIoTConnectionString", + "value": "AzureIoTConnectionString", + "description": "Azure IoT Connection String" + }, + { + "name": "AzurePublishSettingPassword", + "value": "AzurePublishSettingPassword", + "description": "Azure Publish Setting Password" + }, + { + "name": "AzureRedisCacheString", + "value": "AzureRedisCacheString", + "description": "Azure Redis Cache String" + }, + { + "name": "AzureSAS", + "value": "AzureSAS", + "description": "Azure SAS" + }, + { + "name": "AzureServiceBusString", + "value": "AzureServiceBusString", + "description": "Azure Service Bus String" + }, + { + "name": "AzureStorageAccountKey", + "value": "AzureStorageAccountKey", + "description": "Azure Storage Account Key" + }, + { + "name": "AzureStorageAccountGeneric", + "value": "AzureStorageAccountGeneric", + "description": "Azure Storage Account Generic" + }, + { + "name": "BENationalNumber", + "value": "BENationalNumber", + "description": "BE National Number" + }, + { + "name": "BENationalNumberV2", + "value": "BENationalNumberV2", + "description": "BE National Number V2" + }, + { + "name": "BEValueAddedTaxNumber", + "value": "BEValueAddedTaxNumber", + "description": "BE Value Added Tax Number" + }, + { + "name": "BRCPFNumber", + "value": "BRCPFNumber", + "description": "BR CPF Number" + }, + { + "name": "BRLegalEntityNumber", + "value": "BRLegalEntityNumber", + "description": "BR Legal Entity Number" + }, + { + "name": "BRNationalIDRG", + "value": "BRNationalIDRG", + "description": "BR National ID RG" + }, + { + "name": "BGUniformCivilNumber", + "value": "BGUniformCivilNumber", + "description": "BG Uniform Civil Number" + }, + { + "name": "CABankAccountNumber", + "value": "CABankAccountNumber", + "description": "CA Bank Account Number" + }, + { + "name": "CADriversLicenseNumber", + "value": "CADriversLicenseNumber", + "description": "CA Driver's License Number" + }, + { + "name": "CAHealthServiceNumber", + "value": "CAHealthServiceNumber", + "description": "CA Health Service Number" + }, + { + "name": "CAPassportNumber", + "value": "CAPassportNumber", + "description": "CA Passport Number" + }, + { + "name": "CAPersonalHealthIdentification", + "value": "CAPersonalHealthIdentification", + "description": "CA Personal Health Identification" + }, + { + "name": "CASocialInsuranceNumber", + "value": "CASocialInsuranceNumber", + "description": "CA Social Insurance Number" + }, + { + "name": "CLIdentityCardNumber", + "value": "CLIdentityCardNumber", + "description": "CL Identity Card Number" + }, + { + "name": "CNResidentIdentityCardNumber", + "value": "CNResidentIdentityCardNumber", + "description": "CN Resident Identity Card Number" + }, + { + "name": "CreditCardNumber", + "value": "CreditCardNumber", + "description": "Credit Card Number" + }, + { + "name": "HRIdentityCardNumber", + "value": "HRIdentityCardNumber", + "description": "HR Identity Card Number" + }, + { + "name": "HRNationalIDNumber", + "value": "HRNationalIDNumber", + "description": "HR National ID Number" + }, + { + "name": "HRPersonalIdentificationNumber", + "value": "HRPersonalIdentificationNumber", + "description": "HR Personal Identification Number" + }, + { + "name": "HRPersonalIdentificationOIBNumberV2", + "value": "HRPersonalIdentificationOIBNumberV2", + "description": "HR Personal Identification OIB Number V2" + }, + { + "name": "CYIdentityCard", + "value": "CYIdentityCard", + "description": "CY Identity Card" + }, + { + "name": "CYTaxIdentificationNumber", + "value": "CYTaxIdentificationNumber", + "description": "CY Tax Identification Number" + }, + { + "name": "CZPersonalIdentityNumber", + "value": "CZPersonalIdentityNumber", + "description": "CZ Personal Identity Number" + }, + { + "name": "CZPersonalIdentityV2", + "value": "CZPersonalIdentityV2", + "description": "CZ Personal Identity V2" + }, + { + "name": "DKPersonalIdentificationNumber", + "value": "DKPersonalIdentificationNumber", + "description": "DK Personal Identification Number" + }, + { + "name": "DKPersonalIdentificationV2", + "value": "DKPersonalIdentificationV2", + "description": "DK Personal Identification V2" + }, + { + "name": "DrugEnforcementAgencyNumber", + "value": "DrugEnforcementAgencyNumber", + "description": "Drug Enforcement Agency Number" + }, + { + "name": "EEPersonalIdentificationCode", + "value": "EEPersonalIdentificationCode", + "description": "EE Personal Identification Code" + }, + { + "name": "EUDebitCardNumber", + "value": "EUDebitCardNumber", + "description": "EU Debit Card Number" + }, + { + "name": "EUDriversLicenseNumber", + "value": "EUDriversLicenseNumber", + "description": "EU Driver's License Number" + }, + { + "name": "EUGPSCoordinates", + "value": "EUGPSCoordinates", + "description": "EU GPS Coordinates" + }, + { + "name": "EUNationalIdentificationNumber", + "value": "EUNationalIdentificationNumber", + "description": "EU National Identification Number" + }, + { + "name": "EUPassportNumber", + "value": "EUPassportNumber", + "description": "EU Passport Number" + }, + { + "name": "EUSocialSecurityNumber", + "value": "EUSocialSecurityNumber", + "description": "EU Social Security Number" + }, + { + "name": "EUTaxIdentificationNumber", + "value": "EUTaxIdentificationNumber", + "description": "EU Tax Identification Number" + }, + { + "name": "FIEuropeanHealthNumber", + "value": "FIEuropeanHealthNumber", + "description": "FI European Health Number" + }, + { + "name": "FINationalID", + "value": "FINationalID", + "description": "FI National ID" + }, + { + "name": "FINationalIDV2", + "value": "FINationalIDV2", + "description": "FI National ID V2" + }, + { + "name": "FIPassportNumber", + "value": "FIPassportNumber", + "description": "FI Passport Number" + }, + { + "name": "FRDriversLicenseNumber", + "value": "FRDriversLicenseNumber", + "description": "FR Driver's License Number" + }, + { + "name": "FRHealthInsuranceNumber", + "value": "FRHealthInsuranceNumber", + "description": "FR Health Insurance Number" + }, + { + "name": "FRNationalID", + "value": "FRNationalID", + "description": "FR National ID" + }, + { + "name": "FRPassportNumber", + "value": "FRPassportNumber", + "description": "FR Passport Number" + }, + { + "name": "FRSocialSecurityNumber", + "value": "FRSocialSecurityNumber", + "description": "FR Social Security Number" + }, + { + "name": "FRTaxIdentificationNumber", + "value": "FRTaxIdentificationNumber", + "description": "FR Tax Identification Number" + }, + { + "name": "FRValueAddedTaxNumber", + "value": "FRValueAddedTaxNumber", + "description": "FR Value Added Tax Number" + }, + { + "name": "DEDriversLicenseNumber", + "value": "DEDriversLicenseNumber", + "description": "DE Driver's License Number" + }, + { + "name": "DEPassportNumber", + "value": "DEPassportNumber", + "description": "DE Passport Number" + }, + { + "name": "DEIdentityCardNumber", + "value": "DEIdentityCardNumber", + "description": "DE Identity Card Number" + }, + { + "name": "DETaxIdentificationNumber", + "value": "DETaxIdentificationNumber", + "description": "DE Tax Identification Number" + }, + { + "name": "DEValueAddedNumber", + "value": "DEValueAddedNumber", + "description": "DE Value Added Number" + }, + { + "name": "GRNationalIDCard", + "value": "GRNationalIDCard", + "description": "GR National ID Card" + }, + { + "name": "GRNationalIDV2", + "value": "GRNationalIDV2", + "description": "GR National ID V2" + }, + { + "name": "GRTaxIdentificationNumber", + "value": "GRTaxIdentificationNumber", + "description": "GR Tax Identification Number" + }, + { + "name": "HKIdentityCardNumber", + "value": "HKIdentityCardNumber", + "description": "HK Identity Card Number" + }, + { + "name": "HUValueAddedNumber", + "value": "HUValueAddedNumber", + "description": "HU Value Added Number" + }, + { + "name": "HUPersonalIdentificationNumber", + "value": "HUPersonalIdentificationNumber", + "description": "HU Personal Identification Number" + }, + { + "name": "HUTaxIdentificationNumber", + "value": "HUTaxIdentificationNumber", + "description": "HU Tax Identification Number" + }, + { + "name": "INPermanentAccount", + "value": "INPermanentAccount", + "description": "IN Permanent Account" + }, + { + "name": "INUniqueIdentificationNumber", + "value": "INUniqueIdentificationNumber", + "description": "IN Unique Identification Number" + }, + { + "name": "IDIdentityCardNumber", + "value": "IDIdentityCardNumber", + "description": "ID Identity Card Number" + }, + { + "name": "InternationalBankingAccountNumber", + "value": "InternationalBankingAccountNumber", + "description": "International Banking Account Number" + }, + { + "name": "IEPersonalPublicServiceNumber", + "value": "IEPersonalPublicServiceNumber", + "description": "IE Personal Public Service Number" + }, + { + "name": "IEPersonalPublicServiceNumberV2", + "value": "IEPersonalPublicServiceNumberV2", + "description": "IE Personal Public Service Number V2" + }, + { + "name": "ILBankAccountNumber", + "value": "ILBankAccountNumber", + "description": "IL Bank Account Number" + }, + { + "name": "ILNationalID", + "value": "ILNationalID", + "description": "IL National ID" + }, + { + "name": "ITDriversLicenseNumber", + "value": "ITDriversLicenseNumber", + "description": "IT Driver's License Number" + }, + { + "name": "ITFiscalCode", + "value": "ITFiscalCode", + "description": "IT Fiscal Code" + }, + { + "name": "ITValueAddedTaxNumber", + "value": "ITValueAddedTaxNumber", + "description": "IT Value Added Tax Number" + }, + { + "name": "JPBankAccountNumber", + "value": "JPBankAccountNumber", + "description": "JP Bank Account Number" + }, + { + "name": "JPDriversLicenseNumber", + "value": "JPDriversLicenseNumber", + "description": "JP Driver's License Number" + }, + { + "name": "JPPassportNumber", + "value": "JPPassportNumber", + "description": "JP Passport Number" + }, + { + "name": "JPResidentRegistrationNumber", + "value": "JPResidentRegistrationNumber", + "description": "JP Resident Registration Number" + }, + { + "name": "JPSocialInsuranceNumber", + "value": "JPSocialInsuranceNumber", + "description": "JP Social Insurance Number" + }, + { + "name": "JPMyNumberCorporate", + "value": "JPMyNumberCorporate", + "description": "JP My Number Corporate" + }, + { + "name": "JPMyNumberPersonal", + "value": "JPMyNumberPersonal", + "description": "JP My Number Personal" + }, + { + "name": "JPResidenceCardNumber", + "value": "JPResidenceCardNumber", + "description": "JP Residence Card Number" + }, + { + "name": "LVPersonalCode", + "value": "LVPersonalCode", + "description": "LV Personal Code" + }, + { + "name": "LTPersonalCode", + "value": "LTPersonalCode", + "description": "LT Personal Code" + }, + { + "name": "LUNationalIdentificationNumberNatural", + "value": "LUNationalIdentificationNumberNatural", + "description": "LU National Identification Number Natural" + }, + { + "name": "LUNationalIdentificationNumberNonNatural", + "value": "LUNationalIdentificationNumberNonNatural", + "description": "LU National Identification Number Non Natural" + }, + { + "name": "MYIdentityCardNumber", + "value": "MYIdentityCardNumber", + "description": "MY Identity Card Number" + }, + { + "name": "MTIdentityCardNumber", + "value": "MTIdentityCardNumber", + "description": "MT Identity Card Number" + }, + { + "name": "MTTaxIDNumber", + "value": "MTTaxIDNumber", + "description": "MT Tax ID Number" + }, + { + "name": "NLCitizensServiceNumber", + "value": "NLCitizensServiceNumber", + "description": "NL Citizens Service Number" + }, + { + "name": "NLCitizensServiceNumberV2", + "value": "NLCitizensServiceNumberV2", + "description": "NL Citizens Service Number V2" + }, + { + "name": "NLTaxIdentificationNumber", + "value": "NLTaxIdentificationNumber", + "description": "NL Tax Identification Number" + }, + { + "name": "NLValueAddedTaxNumber", + "value": "NLValueAddedTaxNumber", + "description": "NL Value Added Tax Number" + }, + { + "name": "NZBankAccountNumber", + "value": "NZBankAccountNumber", + "description": "NZ Bank Account Number" + }, + { + "name": "NZDriversLicenseNumber", + "value": "NZDriversLicenseNumber", + "description": "NZ Driver's License Number" + }, + { + "name": "NZInlandRevenueNumber", + "value": "NZInlandRevenueNumber", + "description": "NZ Inland Revenue Number" + }, + { + "name": "NZMinistryOfHealthNumber", + "value": "NZMinistryOfHealthNumber", + "description": "NZ Ministry Of Health Number" + }, + { + "name": "NZSocialWelfareNumber", + "value": "NZSocialWelfareNumber", + "description": "NZ Social Welfare Number" + }, + { + "name": "NOIdentityNumber", + "value": "NOIdentityNumber", + "description": "NO Identity Number" + }, + { + "name": "PHUnifiedMultiPurposeIDNumber", + "value": "PHUnifiedMultiPurposeIDNumber", + "description": "PH Unified Multi Purpose ID Number" + }, + { + "name": "PLIdentityCard", + "value": "PLIdentityCard", + "description": "PL Identity Card" + }, + { + "name": "PLNationalID", + "value": "PLNationalID", + "description": "PL National ID" + }, + { + "name": "PLNationalIDV2", + "value": "PLNationalIDV2", + "description": "PL National ID V2" + }, + { + "name": "PLPassportNumber", + "value": "PLPassportNumber", + "description": "PL Passport Number" + }, + { + "name": "PLTaxIdentificationNumber", + "value": "PLTaxIdentificationNumber", + "description": "PL Tax Identification Number" + }, + { + "name": "PLREGONNumber", + "value": "PLREGONNumber", + "description": "PL REGON Number" + }, + { + "name": "PTCitizenCardNumber", + "value": "PTCitizenCardNumber", + "description": "PT Citizen Card Number" + }, + { + "name": "PTCitizenCardNumberV2", + "value": "PTCitizenCardNumberV2", + "description": "PT Citizen Card Number V2" + }, + { + "name": "PTTaxIdentificationNumber", + "value": "PTTaxIdentificationNumber", + "description": "PT Tax Identification Number" + }, + { + "name": "ROPersonalNumericalCode", + "value": "ROPersonalNumericalCode", + "description": "RO Personal Numerical Code" + }, + { + "name": "RUPassportNumberDomestic", + "value": "RUPassportNumberDomestic", + "description": "RU Passport Number Domestic" + }, + { + "name": "RUPassportNumberInternational", + "value": "RUPassportNumberInternational", + "description": "RU Passport Number International" + }, + { + "name": "SANationalID", + "value": "SANationalID", + "description": "SA National ID" + }, + { + "name": "SGNationalRegistrationIdentityCardNumber", + "value": "SGNationalRegistrationIdentityCardNumber", + "description": "SG National Registration Identity Card Number" + }, + { + "name": "SKPersonalNumber", + "value": "SKPersonalNumber", + "description": "SK Personal Number" + }, + { + "name": "SITaxIdentificationNumber", + "value": "SITaxIdentificationNumber", + "description": "SI Tax Identification Number" + }, + { + "name": "SIUniqueMasterCitizenNumber", + "value": "SIUniqueMasterCitizenNumber", + "description": "SI Unique Master Citizen Number" + }, + { + "name": "ZAIdentificationNumber", + "value": "ZAIdentificationNumber", + "description": "ZA Identification Number" + }, + { + "name": "KRResidentRegistrationNumber", + "value": "KRResidentRegistrationNumber", + "description": "KR Resident Registration Number" + }, + { + "name": "ESDNI", + "value": "ESDNI", + "description": "ES DNI" + }, + { + "name": "ESSocialSecurityNumber", + "value": "ESSocialSecurityNumber", + "description": "ES Social Security Number" + }, + { + "name": "ESTaxIdentificationNumber", + "value": "ESTaxIdentificationNumber", + "description": "ES Tax Identification Number" + }, + { + "name": "SQLServerConnectionString", + "value": "SQLServerConnectionString", + "description": "SQL Server Connection String" + }, + { + "name": "SENationalID", + "value": "SENationalID", + "description": "SE National ID" + }, + { + "name": "SENationalIDV2", + "value": "SENationalIDV2", + "description": "SE National ID V2" + }, + { + "name": "SEPassportNumber", + "value": "SEPassportNumber", + "description": "SE Passport Number" + }, + { + "name": "SETaxIdentificationNumber", + "value": "SETaxIdentificationNumber", + "description": "SE Tax Identification Number" + }, + { + "name": "SWIFTCode", + "value": "SWIFTCode", + "description": "SWIFT Code" + }, + { + "name": "CHSocialSecurityNumber", + "value": "CHSocialSecurityNumber", + "description": "CH Social Security Number" + }, + { + "name": "TWNationalID", + "value": "TWNationalID", + "description": "TW National ID" + }, + { + "name": "TWPassportNumber", + "value": "TWPassportNumber", + "description": "TW Passport Number" + }, + { + "name": "TWResidentCertificate", + "value": "TWResidentCertificate", + "description": "TW Resident Certificate" + }, + { + "name": "THPopulationIdentificationCode", + "value": "THPopulationIdentificationCode", + "description": "TH Population Identification Code" + }, + { + "name": "TRNationalIdentificationNumber", + "value": "TRNationalIdentificationNumber", + "description": "TR National Identification Number" + }, + { + "name": "UKDriversLicenseNumber", + "value": "UKDriversLicenseNumber", + "description": "UK Driver's License Number" + }, + { + "name": "UKElectoralRollNumber", + "value": "UKElectoralRollNumber", + "description": "UK Electoral Roll Number" + }, + { + "name": "UKNationalHealthNumber", + "value": "UKNationalHealthNumber", + "description": "UK National Health Number" + }, + { + "name": "UKNationalInsuranceNumber", + "value": "UKNationalInsuranceNumber", + "description": "UK National Insurance Number" + }, + { + "name": "UKUniqueTaxpayerNumber", + "value": "UKUniqueTaxpayerNumber", + "description": "UK Unique Taxpayer Number" + }, + { + "name": "USUKPassportNumber", + "value": "USUKPassportNumber", + "description": "US UK Passport Number" + }, + { + "name": "USBankAccountNumber", + "value": "USBankAccountNumber", + "description": "US Bank Account Number" + }, + { + "name": "USDriversLicenseNumber", + "value": "USDriversLicenseNumber", + "description": "US Driver's License Number" + }, + { + "name": "USIndividualTaxpayerIdentification", + "value": "USIndividualTaxpayerIdentification", + "description": "US Individual Taxpayer Identification" + }, + { + "name": "USSocialSecurityNumber", + "value": "USSocialSecurityNumber", + "description": "US Social Security Number" + }, + { + "name": "UAPassportNumberDomestic", + "value": "UAPassportNumberDomestic", + "description": "UA Passport Number Domestic" + }, + { + "name": "UAPassportNumberInternational", + "value": "UAPassportNumberInternational", + "description": "UA Passport Number International" + }, + { + "name": "Organization", + "value": "Organization", + "description": "Organization" + }, + { + "name": "Email", + "value": "Email", + "description": "Email" + }, + { + "name": "URL", + "value": "URL", + "description": "URL" + }, + { + "name": "Age", + "value": "Age", + "description": "Age" + }, + { + "name": "PhoneNumber", + "value": "PhoneNumber", + "description": "Phone Number" + }, + { + "name": "IPAddress", + "value": "IPAddress", + "description": "IP Address" + }, + { + "name": "Date", + "value": "Date", + "description": "Date" + }, + { + "name": "Person", + "value": "Person", + "description": "Person" + }, + { + "name": "Address", + "value": "Address", + "description": "Address" + }, + { + "name": "DateOfBirth", + "value": "DateOfBirth", + "description": "Date Of Birth" + }, + { + "name": "BankAccountNumber", + "value": "BankAccountNumber", + "description": "Bank Account Number" + }, + { + "name": "PassportNumber", + "value": "PassportNumber", + "description": "Passport Number" + }, + { + "name": "DriversLicenseNumber", + "value": "DriversLicenseNumber", + "description": "Drivers License Number" + }, + { + "name": "Neighborhood", + "value": "Neighborhood", + "description": "Neighborhood" + }, + { + "name": "SortCode", + "value": "SortCode", + "description": "Sort Code. 6-digit number used in the UK to identify a specific bank and branch where a bank account is held" + }, + { + "name": "PIN", + "value": "PIN", + "description": "PIN" + }, + { + "name": "VIN", + "value": "VIN", + "description": "VIN" + }, + { + "name": "LicensePlate", + "value": "LicensePlate", + "description": "License Plate" + }, + { + "name": "All", + "value": "All", + "description": "All PII categories." + }, + { + "name": "Default", + "value": "Default", + "description": "Default PII categories for the language." + } + ] + } + }, + "PiiEntityRecognitionLROResult": { + "type": "object", + "description": "Contains the PII LRO results.", + "properties": { + "results": { + "$ref": "#/definitions/PiiResult", + "description": "The list of pii results" + } + }, + "required": [ + "results" + ], + "allOf": [ + { + "$ref": "#/definitions/AnalyzeTextLROResult" + } + ], + "x-ms-discriminator-value": "PiiEntityRecognitionLROResults" + }, + "PiiEntityWithTags": { + "type": "object", + "description": "Entity object with tags.", + "properties": { + "text": { + "type": "string", + "description": "Entity text as appears in the request." + }, + "category": { + "type": "string", + "description": "Entity type." + }, + "subcategory": { + "type": "string", + "description": "(Optional) Entity sub type." + }, + "offset": { + "type": "integer", + "format": "int32", + "description": "Start position for the entity text. Use of different 'stringIndexType' values can affect the offset returned." + }, + "length": { + "type": "integer", + "format": "int32", + "description": "Length for the entity text. Use of different 'stringIndexType' values can affect the length returned." + }, + "confidenceScore": { + "type": "number", + "format": "double", + "description": "Confidence score between 0 and 1 of the extracted entity." + }, + "type": { + "type": "string", + "description": "An entity type is the lowest (or finest) granularity at which the entity has been detected. The type maps to the specific metadata attributes associated with the entity detected." + }, + "tags": { + "type": "array", + "description": "List of entity tags. Tags are to express some similarities/affinity between entities.", + "items": { + "$ref": "#/definitions/EntityTag" + } + }, + "mask": { + "type": "string", + "description": "Optional field which will be returned only when using the redaction policy kind “MaskWithEntityType”. This field will contain the exact mask text used to mask the PII entity in the original text" + }, + "maskOffset": { + "type": "integer", + "format": "int32", + "description": "Start position of masked text in the redacted text when using the redaction policy kind “MaskWithEntityType”." + }, + "maskLength": { + "type": "integer", + "format": "int32", + "description": "The length of the masked text. Will be present when using the redaction policy kind “MaskWithEntityType”." + } + }, + "required": [ + "text", + "category", + "offset", + "length", + "confidenceScore" + ] + }, + "PiiLROTask": { + "type": "object", + "description": "Contains the analyze text PIIEntityRecognition LRO task.", + "properties": { + "parameters": { + "$ref": "#/definitions/PiiTaskParameters", + "description": "Pii task parameters." + } + }, + "allOf": [ + { + "$ref": "#/definitions/AnalyzeTextLROTask" + } + ], + "x-ms-discriminator-value": "PiiEntityRecognition" + }, + "PiiResult": { + "type": "object", + "description": "Contains the PiiResult.", + "properties": { + "errors": { + "type": "array", + "description": "Errors by document id.", + "items": { + "$ref": "#/definitions/DocumentError" + } + }, + "statistics": { + "$ref": "#/definitions/RequestStatistics", + "description": "if showStats=true was specified in the request this field will contain information about the request payload." + }, + "modelVersion": { + "type": "string", + "description": "This field indicates which model is used for scoring." + }, + "documents": { + "type": "array", + "description": "Response by document", + "items": { + "$ref": "#/definitions/PiiResultWithDetectedLanguage" + } + } + }, + "required": [ + "errors", + "modelVersion", + "documents" + ] + }, + "PiiResultWithDetectedLanguage": { + "type": "object", + "description": "Contains the PII results with detected language.", + "properties": { + "id": { + "type": "string", + "description": "Unique, non-empty document identifier." + }, + "warnings": { + "type": "array", + "description": "Warnings encountered while processing document.", + "items": { + "$ref": "#/definitions/DocumentWarning" + } + }, + "statistics": { + "$ref": "#/definitions/DocumentStatistics", + "description": "if showStats=true was specified in the request this field will contain information about the document payload." + }, + "redactedText": { + "type": "string", + "description": "Returns redacted text." + }, + "entities": { + "type": "array", + "description": "Recognized entities in the document.", + "items": { + "$ref": "#/definitions/PiiEntityWithTags" + } + }, + "detectedLanguage": { + "$ref": "#/definitions/DetectedLanguage", + "description": "If 'language' is set to 'auto' for the document in the request this field will contain a 2 letter ISO 639-1 representation of the language detected for this document." + } + }, + "required": [ + "id", + "warnings", + "redactedText", + "entities" + ] + }, + "PiiTaskParameters": { + "type": "object", + "description": "Supported parameters for a PII Entities Recognition task.", + "properties": { + "loggingOptOut": { + "type": "boolean", + "description": "logging opt out", + "default": true + }, + "modelVersion": { + "type": "string", + "description": "model version", + "default": "latest" + }, + "domain": { + "type": "string", + "description": "Domain for PII task", + "default": "none", + "enum": [ + "phi", + "none" + ], + "x-ms-enum": { + "name": "PiiDomain", + "modelAsString": true, + "values": [ + { + "name": "phi", + "value": "phi", + "description": "Indicates that entities in the Personal Health Information domain should be redacted." + }, + { + "name": "none", + "value": "none", + "description": "Indicates that no domain is specified." + } + ] + } + }, + "piiCategories": { + "type": "array", + "description": "Enumeration of PII categories to be returned in the response.", + "items": { + "$ref": "#/definitions/PiiCategory" + } + }, + "stringIndexType": { + "type": "string", + "description": "StringIndexType to be used for analysis.", + "default": "TextElements_v8", + "enum": [ + "TextElements_v8", + "UnicodeCodePoint", + "Utf16CodeUnit" + ], + "x-ms-enum": { + "name": "StringIndexType", + "modelAsString": true, + "values": [ + { + "name": "TextElements_v8", + "value": "TextElements_v8", + "description": "Returned offset and length values will correspond to TextElements (Graphemes and Grapheme clusters) confirming to the Unicode 8.0.0 standard. Use this option if your application is written in .Net Framework or .Net Core and you will be using StringInfo." + }, + { + "name": "UnicodeCodePoint", + "value": "UnicodeCodePoint", + "description": "Returned offset and length values will correspond to Unicode code points. Use this option if your application is written in a language that support Unicode, for example Python." + }, + { + "name": "Utf16CodeUnit", + "value": "Utf16CodeUnit", + "description": "Returned offset and length values will correspond to UTF-16 code units. Use this option if your application is written in a language that support Unicode, for example Java, JavaScript." + } + ] + } + }, + "excludePiiCategories": { + "type": "array", + "description": "Enumeration of PII categories to be excluded in the response.", + "items": { + "$ref": "#/definitions/PiiCategoriesExclude" + } + }, + "redactionPolicy": { + "$ref": "#/definitions/BaseRedactionPolicy", + "description": "RedactionPolicy to be used on the input." + }, + "valueExclusionPolicy": { + "$ref": "#/definitions/ValueExclusionPolicy", + "description": "Policy for specific words and terms that should be excluded from detection by the PII detection service" + }, + "entitySynonyms": { + "type": "array", + "description": "(Optional) request parameter that allows the user to provide synonyms for context words that to enhance pii entity detection.", + "items": { + "$ref": "#/definitions/EntitySynonyms" + } + } + } + }, + "PiiTaskResult": { + "type": "object", + "description": "Contains the analyze text PIIEntityRecognition LRO task.", + "properties": { + "results": { + "$ref": "#/definitions/PiiResult", + "description": "The list of pii results" + } + }, + "required": [ + "results" + ], + "allOf": [ + { + "$ref": "#/definitions/AnalyzeTextTaskResult" + } + ], + "x-ms-discriminator-value": "PiiEntityRecognitionResults" + }, + "RangeInclusivity": { + "type": "string", + "description": "The range inclusiveness of this property property.", + "enum": [ + "NoneInclusive", + "LeftInclusive", + "RightInclusive", + "LeftRightInclusive" + ], + "x-ms-enum": { + "name": "RangeInclusivity", + "modelAsString": true, + "values": [ + { + "name": "NoneInclusive", + "value": "NoneInclusive", + "description": "No inclusivity" + }, + { + "name": "LeftInclusive", + "value": "LeftInclusive", + "description": "Left side inclusive" + }, + { + "name": "RightInclusive", + "value": "RightInclusive", + "description": "Right side inclusive" + }, + { + "name": "LeftRightInclusive", + "value": "LeftRightInclusive", + "description": "Both sides inclusive" + } + ] + } + }, + "RangeKind": { + "type": "string", + "description": "The kind of the number range entity.", + "enum": [ + "Number", + "Speed", + "Weight", + "Length", + "Volume", + "Area", + "Age", + "Information", + "Temperature", + "Currency" + ], + "x-ms-enum": { + "name": "RangeKind", + "modelAsString": true, + "values": [ + { + "name": "Number", + "value": "Number", + "description": "Number range" + }, + { + "name": "Speed", + "value": "Speed", + "description": "Speed range" + }, + { + "name": "Weight", + "value": "Weight", + "description": "Weight range" + }, + { + "name": "Length", + "value": "Length", + "description": "Length range" + }, + { + "name": "Volume", + "value": "Volume", + "description": "Volume range" + }, + { + "name": "Area", + "value": "Area", + "description": "Area range" + }, + { + "name": "Age", + "value": "Age", + "description": "Age range" + }, + { + "name": "Information", + "value": "Information", + "description": "Information range" + }, + { + "name": "Temperature", + "value": "Temperature", + "description": "Temperature range" + }, + { + "name": "Currency", + "value": "Currency", + "description": "Currency range" + } + ] + } + }, + "RelativeTo": { + "type": "string", + "description": "The reference point that the ordinal number denotes.", + "enum": [ + "Current", + "End", + "Start" + ], + "x-ms-enum": { + "name": "RelativeTo", + "modelAsString": true, + "values": [ + { + "name": "Current", + "value": "Current", + "description": "Current state or position" + }, + { + "name": "End", + "value": "End", + "description": "End state or position" + }, + { + "name": "Start", + "value": "Start", + "description": "Start state or position" + } + ] + } + }, + "RequestStatistics": { + "type": "object", + "description": "if showStats=true was specified in the request this field will contain information about the request payload.", + "properties": { + "documentsCount": { + "type": "integer", + "format": "int32", + "description": "Number of documents submitted in the request." + }, + "validDocumentsCount": { + "type": "integer", + "format": "int32", + "description": "Number of valid documents. This excludes empty, over-size limit or non-supported languages documents." + }, + "erroneousDocumentsCount": { + "type": "integer", + "format": "int32", + "description": "Number of invalid documents. This includes empty, over-size limit or non-supported languages documents." + }, + "transactionsCount": { + "type": "integer", + "format": "int64", + "description": "Number of transactions for the request." + } + }, + "required": [ + "documentsCount", + "validDocumentsCount", + "erroneousDocumentsCount", + "transactionsCount" + ] + }, + "ScriptCode": { + "type": "string", + "description": "Identifies the script of the input document. Maps to the ISO 15924 standard script code.", + "enum": [ + "Arab", + "Armn", + "Beng", + "Cans", + "Cyrl", + "Deva", + "Ethi", + "Geor", + "Grek", + "Gujr", + "Guru", + "Hang", + "Hani", + "Hans", + "Hant", + "Hebr", + "Jpan", + "Khmr", + "Knda", + "Laoo", + "Latn", + "Mlym", + "Mong", + "Mtei", + "Mymr", + "Olck", + "Orya", + "Sinh", + "Shrd", + "Taml", + "Telu", + "Thaa", + "Thai", + "Tibt" + ], + "x-ms-enum": { + "name": "ScriptCode", + "modelAsString": true, + "values": [ + { + "name": "Arab", + "value": "Arab", + "description": "Script code for the Arabic script." + }, + { + "name": "Armn", + "value": "Armn", + "description": "Script code for the Armenian script." + }, + { + "name": "Beng", + "value": "Beng", + "description": "Script code for the Bangla script." + }, + { + "name": "Cans", + "value": "Cans", + "description": "Script code for the UnifiedCanadianAboriginalSyllabics script." + }, + { + "name": "Cyrl", + "value": "Cyrl", + "description": "Script code for the Cyrillic script." + }, + { + "name": "Deva", + "value": "Deva", + "description": "Script code for the Devanagari script." + }, + { + "name": "Ethi", + "value": "Ethi", + "description": "Script code for the Ethiopic script." + }, + { + "name": "Geor", + "value": "Geor", + "description": "Script code for the Georgian script." + }, + { + "name": "Grek", + "value": "Grek", + "description": "Script code for the Greek script." + }, + { + "name": "Gujr", + "value": "Gujr", + "description": "Script code for the Gujarati script." + }, + { + "name": "Guru", + "value": "Guru", + "description": "Script code for the Gurmukhi script." + }, + { + "name": "Hang", + "value": "Hang", + "description": "Script code for the Hangul script." + }, + { + "name": "Hani", + "value": "Hani", + "description": "Script code for the HanLiteral script." + }, + { + "name": "Hans", + "value": "Hans", + "description": "Script code for the HanSimplified script." + }, + { + "name": "Hant", + "value": "Hant", + "description": "Script code for the HanTraditional script." + }, + { + "name": "Hebr", + "value": "Hebr", + "description": "Script code for the Hebrew script." + }, + { + "name": "Jpan", + "value": "Jpan", + "description": "Script code for the Japanese script." + }, + { + "name": "Khmr", + "value": "Khmr", + "description": "Script code for the Khmer script." + }, + { + "name": "Knda", + "value": "Knda", + "description": "Script code for the Kannada script." + }, + { + "name": "Laoo", + "value": "Laoo", + "description": "Script code for the Lao script." + }, + { + "name": "Latn", + "value": "Latn", + "description": "Script code for the Latin script." + }, + { + "name": "Mlym", + "value": "Mlym", + "description": "Script code for the Malayalam script." + }, + { + "name": "Mong", + "value": "Mong", + "description": "Script code for the Mongolian script." + }, + { + "name": "Mtei", + "value": "Mtei", + "description": "Script code for the Meitei script." + }, + { + "name": "Mymr", + "value": "Mymr", + "description": "Script code for the Myanmar script." + }, + { + "name": "Olck", + "value": "Olck", + "description": "Script code for the Santali script." + }, + { + "name": "Orya", + "value": "Orya", + "description": "Script code for the Odia script." + }, + { + "name": "Sinh", + "value": "Sinh", + "description": "Script code for the Sinhala script." + }, + { + "name": "Shrd", + "value": "Shrd", + "description": "Script code for the Sharada script." + }, + { + "name": "Taml", + "value": "Taml", + "description": "Script code for the Tamil script." + }, + { + "name": "Telu", + "value": "Telu", + "description": "Script code for the Telugu script." + }, + { + "name": "Thaa", + "value": "Thaa", + "description": "Script code for the Thaana script." + }, + { + "name": "Thai", + "value": "Thai", + "description": "Script code for the Thai script." + }, + { + "name": "Tibt", + "value": "Tibt", + "description": "Script code for the Tibetan script." + } + ] + } + }, + "ScriptKind": { + "type": "string", + "description": "Identifies the script of the input document. Maps to the ISO 15924 standard formal name.", + "enum": [ + "Arabic", + "Armenian", + "Bangla", + "UnifiedCanadianAboriginalSyllabics", + "Cyrillic", + "Devanagari", + "Ethiopic", + "Georgian", + "Greek", + "Gujarati", + "Gurmukhi", + "Hangul", + "HanLiteral", + "HanSimplified", + "HanTraditional", + "Hebrew", + "Japanese", + "Khmer", + "Kannada", + "Lao", + "Latin", + "Malayalam", + "Meitei", + "Mongolian", + "Myanmar", + "Odia", + "Santali", + "Sharada", + "Sinhala", + "Tamil", + "Telugu", + "Thaana", + "Thai", + "Tibetan" + ], + "x-ms-enum": { + "name": "ScriptKind", + "modelAsString": true, + "values": [ + { + "name": "Arabic", + "value": "Arabic", + "description": "Script name for the Arabic script." + }, + { + "name": "Armenian", + "value": "Armenian", + "description": "Script name for the Armenian script." + }, + { + "name": "Bangla", + "value": "Bangla", + "description": "Script name for the Bangla script." + }, + { + "name": "UnifiedCanadianAboriginalSyllabics", + "value": "UnifiedCanadianAboriginalSyllabics", + "description": "Script name for the UnifiedCanadianAboriginalSyllabics script." + }, + { + "name": "Cyrillic", + "value": "Cyrillic", + "description": "Script name for the Cyrillic script." + }, + { + "name": "Devanagari", + "value": "Devanagari", + "description": "Script name for the Devanagari script." + }, + { + "name": "Ethiopic", + "value": "Ethiopic", + "description": "Script name for the Ethiopic script." + }, + { + "name": "Georgian", + "value": "Georgian", + "description": "Script name for the Georgian script." + }, + { + "name": "Greek", + "value": "Greek", + "description": "Script name for the Greek script." + }, + { + "name": "Gujarati", + "value": "Gujarati", + "description": "Script name for the Gujarati script." + }, + { + "name": "Gurmukhi", + "value": "Gurmukhi", + "description": "Script name for the Gurmukhi script." + }, + { + "name": "Hangul", + "value": "Hangul", + "description": "Script name for the Hangul script." + }, + { + "name": "HanLiteral", + "value": "HanLiteral", + "description": "Script name for the HanLiteral script." + }, + { + "name": "HanSimplified", + "value": "HanSimplified", + "description": "Script name for the HanSimplified script." + }, + { + "name": "HanTraditional", + "value": "HanTraditional", + "description": "Script name for the HanTraditional script." + }, + { + "name": "Hebrew", + "value": "Hebrew", + "description": "Script name for the Hebrew script." + }, + { + "name": "Japanese", + "value": "Japanese", + "description": "Script name for the Japanese script." + }, + { + "name": "Khmer", + "value": "Khmer", + "description": "Script name for the Khmer script." + }, + { + "name": "Kannada", + "value": "Kannada", + "description": "Script name for the Kannada script." + }, + { + "name": "Lao", + "value": "Lao", + "description": "Script name for the Lao script." + }, + { + "name": "Latin", + "value": "Latin", + "description": "Script name for the Latin script." + }, + { + "name": "Malayalam", + "value": "Malayalam", + "description": "Script name for the Malayalam script." + }, + { + "name": "Meitei", + "value": "Meitei", + "description": "Script name for the Meitei script." + }, + { + "name": "Mongolian", + "value": "Mongolian", + "description": "Script name for the Mongolian script." + }, + { + "name": "Myanmar", + "value": "Myanmar", + "description": "Script name for the Myanmar script." + }, + { + "name": "Odia", + "value": "Odia", + "description": "Script name for the Odia script." + }, + { + "name": "Santali", + "value": "Santali", + "description": "Script name for the Santali script." + }, + { + "name": "Sharada", + "value": "Sharada", + "description": "Script name for the Sharada script." + }, + { + "name": "Sinhala", + "value": "Sinhala", + "description": "Script name for the Sinhala script." + }, + { + "name": "Tamil", + "value": "Tamil", + "description": "Script name for the Tamil script." + }, + { + "name": "Telugu", + "value": "Telugu", + "description": "Script name for the Telugu script." + }, + { + "name": "Thaana", + "value": "Thaana", + "description": "Script name for the Thaana script." + }, + { + "name": "Thai", + "value": "Thai", + "description": "Script name for the Thai script." + }, + { + "name": "Tibetan", + "value": "Tibetan", + "description": "Script name for the Tibetan script." + } + ] + } + }, + "SentenceAssessment": { + "type": "object", + "description": "Represents a sentence assessment and the assessments or target objects related to it.", + "properties": { + "sentiment": { + "$ref": "#/definitions/TokenSentimentValue", + "description": "The sentiment of the sentence." + }, + "confidenceScores": { + "$ref": "#/definitions/TargetConfidenceScoreLabel", + "description": "Represents the confidence scores across all sentiment classes: positive and negative." + }, + "offset": { + "type": "integer", + "format": "int32", + "description": "The target offset from the start of the sentence." + }, + "length": { + "type": "integer", + "format": "int32", + "description": "The length of the target." + }, + "text": { + "type": "string", + "description": "The target text detected." + }, + "isNegated": { + "type": "boolean", + "description": "The indicator representing if the assessment is negated." + } + }, + "required": [ + "sentiment", + "confidenceScores", + "offset", + "length", + "text", + "isNegated" + ] + }, + "SentenceSentiment": { + "type": "object", + "description": "A document's sentence sentiment.", + "properties": { + "text": { + "type": "string", + "description": "The sentence text." + }, + "sentiment": { + "$ref": "#/definitions/SentenceSentimentValue", + "description": "The predicted Sentiment for the sentence." + }, + "confidenceScores": { + "$ref": "#/definitions/SentimentConfidenceScores", + "description": "The sentiment confidence score between 0 and 1 for the sentence for all classes." + }, + "offset": { + "type": "integer", + "format": "int32", + "description": "The target offset from the start of the sentence." + }, + "length": { + "type": "integer", + "format": "int32", + "description": "The length of the target." + }, + "targets": { + "type": "array", + "description": "The array of sentence targets for the sentence.", + "items": { + "$ref": "#/definitions/SentenceTarget" + } + }, + "assessments": { + "type": "array", + "description": "The array of assessments for the sentence.", + "items": { + "$ref": "#/definitions/SentenceAssessment" + } + } + }, + "required": [ + "text", + "sentiment", + "confidenceScores", + "offset", + "length" + ] + }, + "SentenceSentimentValue": { + "type": "string", + "description": "The predicted Sentiment for the sentence.", + "enum": [ + "positive", + "neutral", + "negative" + ], + "x-ms-enum": { + "name": "SentenceSentimentValue", + "modelAsString": false, + "values": [ + { + "name": "positive", + "value": "positive", + "description": "Positive sentiment" + }, + { + "name": "neutral", + "value": "neutral", + "description": "Neutral sentiment" + }, + { + "name": "negative", + "value": "negative", + "description": "Negative sentiment" + } + ] + } + }, + "SentenceTarget": { + "type": "object", + "description": "Represents a sentence target and the assessments or target objects related to it.", + "properties": { + "sentiment": { + "$ref": "#/definitions/TokenSentimentValue", + "description": "The sentiment of the sentence." + }, + "confidenceScores": { + "$ref": "#/definitions/TargetConfidenceScoreLabel", + "description": "Represents the confidence scores across all sentiment classes: positive and negative." + }, + "offset": { + "type": "integer", + "format": "int32", + "description": "The target offset from the start of the sentence." + }, + "length": { + "type": "integer", + "format": "int32", + "description": "The length of the target." + }, + "text": { + "type": "string", + "description": "The target text detected." + }, + "relations": { + "type": "array", + "description": "The array of either assessment or target objects which is related to the target.", + "items": { + "$ref": "#/definitions/TargetRelation" + } + } + }, + "required": [ + "sentiment", + "confidenceScores", + "offset", + "length", + "text", + "relations" + ] + }, + "SentimentAnalysisLROTask": { + "type": "object", + "description": "An object representing the task definition for a Sentiment Analysis task.", + "properties": { + "parameters": { + "$ref": "#/definitions/SentimentAnalysisTaskParameters", + "description": "Parameters for the Sentiment Analysis task." + } + }, + "allOf": [ + { + "$ref": "#/definitions/AnalyzeTextLROTask" + } + ], + "x-ms-discriminator-value": "SentimentAnalysis" + }, + "SentimentAnalysisTaskParameters": { + "type": "object", + "description": "Supported parameters for a Sentiment Analysis task.", + "properties": { + "loggingOptOut": { + "type": "boolean", + "description": "logging opt out", + "default": false + }, + "modelVersion": { + "type": "string", + "description": "model version", + "default": "latest" + }, + "opinionMining": { + "type": "boolean", + "description": "Whether to use opinion mining in the request or not.", + "default": false + }, + "stringIndexType": { + "type": "string", + "description": "Specifies the method used to interpret string offsets.", + "default": "TextElements_v8", + "enum": [ + "TextElements_v8", + "UnicodeCodePoint", + "Utf16CodeUnit" + ], + "x-ms-enum": { + "name": "StringIndexType", + "modelAsString": true, + "values": [ + { + "name": "TextElements_v8", + "value": "TextElements_v8", + "description": "Returned offset and length values will correspond to TextElements (Graphemes and Grapheme clusters) confirming to the Unicode 8.0.0 standard. Use this option if your application is written in .Net Framework or .Net Core and you will be using StringInfo." + }, + { + "name": "UnicodeCodePoint", + "value": "UnicodeCodePoint", + "description": "Returned offset and length values will correspond to Unicode code points. Use this option if your application is written in a language that support Unicode, for example Python." + }, + { + "name": "Utf16CodeUnit", + "value": "Utf16CodeUnit", + "description": "Returned offset and length values will correspond to UTF-16 code units. Use this option if your application is written in a language that support Unicode, for example Java, JavaScript." + } + ] + } + } + } + }, + "SentimentConfidenceScores": { + "type": "object", + "description": "Represents the confidence scores between 0 and 1 across all sentiment classes: positive, neutral, negative.", + "properties": { + "positive": { + "type": "number", + "format": "double", + "description": "Confidence score for positive sentiment" + }, + "neutral": { + "type": "number", + "format": "double", + "description": "Confidence score for neutral sentiment" + }, + "negative": { + "type": "number", + "format": "double", + "description": "Confidence score for negative sentiment" + } + }, + "required": [ + "positive", + "neutral", + "negative" + ] + }, + "SentimentDocumentResultWithDetectedLanguage": { + "type": "object", + "description": "Sentiment analysis per document.", + "properties": { + "id": { + "type": "string", + "description": "Unique, non-empty document identifier." + }, + "warnings": { + "type": "array", + "description": "Warnings encountered while processing document.", + "items": { + "$ref": "#/definitions/DocumentWarning" + } + }, + "statistics": { + "$ref": "#/definitions/DocumentStatistics", + "description": "if showStats=true was specified in the request this field will contain information about the document payload." + }, + "sentiment": { + "$ref": "#/definitions/DocumentSentimentValue", + "description": "Predicted sentiment for document (Negative, Neutral, Positive, or Mixed)." + }, + "confidenceScores": { + "$ref": "#/definitions/SentimentConfidenceScores", + "description": "The sentiment confidence score between 0 and 1 for the sentence for all classes." + }, + "sentences": { + "type": "array", + "description": "The document's sentences sentiment.", + "items": { + "$ref": "#/definitions/SentenceSentiment" + } + }, + "detectedLanguage": { + "$ref": "#/definitions/DetectedLanguage", + "description": "If 'language' is set to 'auto' for the document in the request this field will contain a 2 letter ISO 639-1 representation of the language detected for this document." + } + }, + "required": [ + "id", + "warnings", + "sentiment", + "confidenceScores", + "sentences" + ] + }, + "SentimentLROResult": { + "type": "object", + "description": "Contains the Sentiment Analysis LRO results.", + "properties": { + "results": { + "$ref": "#/definitions/SentimentResponse", + "description": "The sentiment analysis results" + } + }, + "required": [ + "results" + ], + "allOf": [ + { + "$ref": "#/definitions/AnalyzeTextLROResult" + } + ], + "x-ms-discriminator-value": "SentimentAnalysisLROResults" + }, + "SentimentResponse": { + "type": "object", + "description": "Sentiment analysis results for the input documents.", + "properties": { + "errors": { + "type": "array", + "description": "Errors by document id.", + "items": { + "$ref": "#/definitions/DocumentError" + } + }, + "statistics": { + "$ref": "#/definitions/RequestStatistics", + "description": "if showStats=true was specified in the request this field will contain information about the request payload." + }, + "modelVersion": { + "type": "string", + "description": "This field indicates which model is used for scoring." + }, + "documents": { + "type": "array", + "description": "The sentiment analysis results for each document in the input.", + "items": { + "$ref": "#/definitions/SentimentDocumentResultWithDetectedLanguage" + } + } + }, + "required": [ + "errors", + "modelVersion", + "documents" + ] + }, + "SentimentTaskResult": { + "type": "object", + "description": "Contains the analyze text SentimentAnalysis LRO task result.", + "properties": { + "results": { + "$ref": "#/definitions/SentimentResponse", + "description": "The sentiment analysis results" + } + }, + "required": [ + "results" + ], + "allOf": [ + { + "$ref": "#/definitions/AnalyzeTextTaskResult" + } + ], + "x-ms-discriminator-value": "SentimentAnalysisResults" + }, + "SpeedMetadata": { + "type": "object", + "description": "Represents the Speed entity Metadata model.", + "properties": { + "value": { + "type": "number", + "format": "double", + "description": "The numeric value that the extracted text denotes." + }, + "unit": { + "$ref": "#/definitions/SpeedUnit", + "description": "Unit of measure for speed." + } + }, + "required": [ + "value", + "unit" + ], + "allOf": [ + { + "$ref": "#/definitions/BaseMetadata" + } + ], + "x-ms-discriminator-value": "SpeedMetadata" + }, + "SpeedUnit": { + "type": "string", + "description": "The speed Unit of measurement", + "enum": [ + "Unspecified", + "MetersPerSecond", + "KilometersPerHour", + "KilometersPerMinute", + "KilometersPerSecond", + "MilesPerHour", + "Knots", + "FeetPerSecond", + "FeetPerMinute", + "YardsPerMinute", + "YardsPerSecond", + "MetersPerMillisecond", + "CentimetersPerMillisecond", + "KilometersPerMillisecond" + ], + "x-ms-enum": { + "name": "SpeedUnit", + "modelAsString": true, + "values": [ + { + "name": "Unspecified", + "value": "Unspecified", + "description": "Unspecified speed unit." + }, + { + "name": "MetersPerSecond", + "value": "MetersPerSecond", + "description": "Speed unit in meters per second." + }, + { + "name": "KilometersPerHour", + "value": "KilometersPerHour", + "description": "Speed unit in kilometers per hour." + }, + { + "name": "KilometersPerMinute", + "value": "KilometersPerMinute", + "description": "Speed unit in kilometers per minute." + }, + { + "name": "KilometersPerSecond", + "value": "KilometersPerSecond", + "description": "Speed unit in kilometers per second." + }, + { + "name": "MilesPerHour", + "value": "MilesPerHour", + "description": "Speed unit in miles per hour." + }, + { + "name": "Knots", + "value": "Knots", + "description": "Speed unit in knots." + }, + { + "name": "FeetPerSecond", + "value": "FeetPerSecond", + "description": "Speed unit in feet per second." + }, + { + "name": "FeetPerMinute", + "value": "FeetPerMinute", + "description": "Speed unit in feet per minute." + }, + { + "name": "YardsPerMinute", + "value": "YardsPerMinute", + "description": "Speed unit in yards per minute." + }, + { + "name": "YardsPerSecond", + "value": "YardsPerSecond", + "description": "Speed unit in yards per second." + }, + { + "name": "MetersPerMillisecond", + "value": "MetersPerMillisecond", + "description": "Speed unit in meters per millisecond." + }, + { + "name": "CentimetersPerMillisecond", + "value": "CentimetersPerMillisecond", + "description": "Speed unit in centimeters per millisecond." + }, + { + "name": "KilometersPerMillisecond", + "value": "KilometersPerMillisecond", + "description": "Speed unit in Kilometers per millisecond." + } + ] + } + }, + "State": { + "type": "string", + "description": "The status of the task at the mentioned last update time.", + "enum": [ + "notStarted", + "running", + "succeeded", + "partiallyCompleted", + "failed", + "cancelled", + "cancelling" + ], + "x-ms-enum": { + "name": "State", + "modelAsString": true, + "values": [ + { + "name": "notStarted", + "value": "notStarted", + "description": "Not started status" + }, + { + "name": "running", + "value": "running", + "description": "Running status" + }, + { + "name": "succeeded", + "value": "succeeded", + "description": "Succeeded status" + }, + { + "name": "partiallyCompleted", + "value": "partiallyCompleted", + "description": "Partially completed status" + }, + { + "name": "failed", + "value": "failed", + "description": "Failed status" + }, + { + "name": "cancelled", + "value": "cancelled", + "description": "Cancelled status" + }, + { + "name": "cancelling", + "value": "cancelling", + "description": "Cancelling status" + } + ] + } + }, + "SummaryContext": { + "type": "object", + "description": "The context of the summary.", + "properties": { + "offset": { + "type": "integer", + "format": "int32", + "description": "Start position for the context. Use of different 'stringIndexType' values can affect the offset returned." + }, + "length": { + "type": "integer", + "format": "int32", + "description": "The length of the context. Use of different 'stringIndexType' values can affect the length returned." + } + }, + "required": [ + "offset", + "length" + ] + }, + "SummaryLengthBucket": { + "type": "string", + "description": "Enum that defines the length of the output summaries.", + "enum": [ + "short", + "medium", + "long" + ], + "x-ms-enum": { + "name": "SummaryLengthBucket", + "modelAsString": true, + "values": [ + { + "name": "short", + "value": "short", + "description": "Instructs model to generate shorter length summaries." + }, + { + "name": "medium", + "value": "medium", + "description": "Instructs model to generate medium length summaries." + }, + { + "name": "long", + "value": "long", + "description": "Instructs model to generate longer length summaries." + } + ] + } + }, + "TargetConfidenceScoreLabel": { + "type": "object", + "description": "Represents the confidence scores across all sentiment classes: positive and negative.", + "properties": { + "positive": { + "type": "number", + "format": "double", + "description": "Confidence score for positive sentiment" + }, + "negative": { + "type": "number", + "format": "double", + "description": "Confidence score for negative sentiment" + } + }, + "required": [ + "positive", + "negative" + ] + }, + "TargetRelation": { + "type": "object", + "description": "Represents the relation between assessments and/or targets.", + "properties": { + "ref": { + "type": "string", + "description": "The JSON pointer indicating the linked object." + }, + "relationType": { + "$ref": "#/definitions/TargetRelationType", + "description": "The type related to the target." + } + }, + "required": [ + "ref", + "relationType" + ] + }, + "TargetRelationType": { + "type": "string", + "description": "The type related to the target.", + "enum": [ + "assessment", + "target" + ], + "x-ms-enum": { + "name": "TargetRelationType", + "modelAsString": false, + "values": [ + { + "name": "assessment", + "value": "assessment", + "description": "Assessment relation." + }, + { + "name": "target", + "value": "target", + "description": "Target relation." + } + ] + } + }, + "Tasks": { + "type": "object", + "description": "Container for the tasks status for the LRO job.", + "properties": { + "completed": { + "type": "integer", + "format": "int32", + "description": "Count of completed tasks." + }, + "failed": { + "type": "integer", + "format": "int32", + "description": "Count of failed tasks." + }, + "inProgress": { + "type": "integer", + "format": "int32", + "description": "Count of inprogress tasks." + }, + "total": { + "type": "integer", + "format": "int32", + "description": "Count of total tasks." + }, + "items": { + "type": "array", + "description": "Enumerable of Analyze text job results.", + "items": { + "$ref": "#/definitions/AnalyzeTextLROResult" + } + } + }, + "required": [ + "completed", + "failed", + "inProgress", + "total" + ] + }, + "TemperatureMetadata": { + "type": "object", + "description": "Represents the Information entity Metadata model.", + "properties": { + "value": { + "type": "number", + "format": "double", + "description": "The numeric value that the extracted text denotes." + }, + "unit": { + "$ref": "#/definitions/TemperatureUnit", + "description": "Unit of measure for temperature." + } + }, + "required": [ + "value", + "unit" + ], + "allOf": [ + { + "$ref": "#/definitions/BaseMetadata" + } + ], + "x-ms-discriminator-value": "TemperatureMetadata" + }, + "TemperatureUnit": { + "type": "string", + "description": "The temperature Unit of measurement.", + "enum": [ + "Unspecified", + "Fahrenheit", + "Kelvin", + "Rankine", + "Celsius" + ], + "x-ms-enum": { + "name": "TemperatureUnit", + "modelAsString": true, + "values": [ + { + "name": "Unspecified", + "value": "Unspecified", + "description": "Unspecified temperature unit" + }, + { + "name": "Fahrenheit", + "value": "Fahrenheit", + "description": "Temperature unit in Fahrenheit" + }, + { + "name": "Kelvin", + "value": "Kelvin", + "description": "Temperature unit in Kelvin" + }, + { + "name": "Rankine", + "value": "Rankine", + "description": "Temperature unit in Rankine" + }, + { + "name": "Celsius", + "value": "Celsius", + "description": "Temperature unit in Celsius" + } + ] + } + }, + "TemporalModifier": { + "type": "string", + "description": "An optional modifier of a date/time instance.", + "enum": [ + "AfterApprox", + "Before", + "BeforeStart", + "Approx", + "ReferenceUndefined", + "SinceEnd", + "AfterMid", + "Start", + "After", + "BeforeEnd", + "Until", + "End", + "Less", + "Since", + "AfterStart", + "BeforeApprox", + "Mid", + "More" + ], + "x-ms-enum": { + "name": "TemporalModifier", + "modelAsString": true, + "values": [ + { + "name": "AfterApprox", + "value": "AfterApprox", + "description": "After an approximate time" + }, + { + "name": "Before", + "value": "Before", + "description": "Before a specific time" + }, + { + "name": "BeforeStart", + "value": "BeforeStart", + "description": "Before the start of a time period" + }, + { + "name": "Approx", + "value": "Approx", + "description": "Approximately at a specific time" + }, + { + "name": "ReferenceUndefined", + "value": "ReferenceUndefined", + "description": "Reference to an undefined time" + }, + { + "name": "SinceEnd", + "value": "SinceEnd", + "description": "Since the end of a time period" + }, + { + "name": "AfterMid", + "value": "AfterMid", + "description": "After the middle of a time period" + }, + { + "name": "Start", + "value": "Start", + "description": "At the start of a time period" + }, + { + "name": "After", + "value": "After", + "description": "After a specific time" + }, + { + "name": "BeforeEnd", + "value": "BeforeEnd", + "description": "Before the end of a time period" + }, + { + "name": "Until", + "value": "Until", + "description": "Until a specific time" + }, + { + "name": "End", + "value": "End", + "description": "At the end of a time period" + }, + { + "name": "Less", + "value": "Less", + "description": "Less than a specific time" + }, + { + "name": "Since", + "value": "Since", + "description": "Since a specific time" + }, + { + "name": "AfterStart", + "value": "AfterStart", + "description": "After the start of a time period" + }, + { + "name": "BeforeApprox", + "value": "BeforeApprox", + "description": "Before an approximate time" + }, + { + "name": "Mid", + "value": "Mid", + "description": "In the middle of a time period" + }, + { + "name": "More", + "value": "More", + "description": "More than a specific time" + } + ] + } + }, + "TemporalSetMetadata": { + "type": "object", + "description": "A Metadata for temporal set entity instances.", + "properties": { + "dateValues": { + "type": "array", + "description": "List of date values.", + "items": { + "$ref": "#/definitions/DateValue" + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/BaseMetadata" + } + ], + "x-ms-discriminator-value": "TemporalSetMetadata" + }, + "TemporalSpanMetadata": { + "type": "object", + "description": "represents the Metadata of a date and/or time span.", + "properties": { + "spanValues": { + "type": "array", + "description": "List of temporal spans detected.", + "items": { + "$ref": "#/definitions/TemporalSpanValues" + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/BaseMetadata" + } + ], + "x-ms-discriminator-value": "TemporalSpanMetadata" + }, + "TemporalSpanValues": { + "type": "object", + "description": "Temporal span object.", + "properties": { + "begin": { + "type": "string", + "description": "Start value for the span." + }, + "end": { + "type": "string", + "description": "End value for the span." + }, + "duration": { + "type": "string", + "description": "An optional duration value formatted based on the ISO 8601 (https://en.wikipedia.org/wiki/ISO_8601#Durations)" + }, + "modifier": { + "$ref": "#/definitions/TemporalModifier", + "description": "Modifier for datetime to indicate point of reference like before, after etc." + }, + "timex": { + "type": "string", + "description": "An optional triplet containing the beginning, the end, and the duration all stated as ISO 8601 formatted strings." + } + } + }, + "Temporality": { + "type": "string", + "description": "Describes temporal information regarding the entity.", + "enum": [ + "current", + "past", + "future" + ], + "x-ms-enum": { + "name": "Temporality", + "modelAsString": false, + "values": [ + { + "name": "current", + "value": "current", + "description": "Current temporality" + }, + { + "name": "past", + "value": "past", + "description": "Past temporality" + }, + { + "name": "future", + "value": "future", + "description": "Future temporality" + } + ] + } + }, + "TimeMetadata": { + "type": "object", + "description": "A Metadata for time entity instances.", + "properties": { + "dateValues": { + "type": "array", + "description": "List of date values.", + "items": { + "$ref": "#/definitions/DateValue" + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/BaseMetadata" + } + ], + "x-ms-discriminator-value": "TimeMetadata" + }, + "TokenSentimentValue": { + "type": "string", + "description": "The predicted Sentiment for the sentence.", + "enum": [ + "positive", + "mixed", + "negative" + ], + "x-ms-enum": { + "name": "TokenSentimentValue", + "modelAsString": false, + "values": [ + { + "name": "positive", + "value": "positive", + "description": "Positive sentiment" + }, + { + "name": "mixed", + "value": "mixed", + "description": "Mixed sentiment" + }, + { + "name": "negative", + "value": "negative", + "description": "Negative sentiment" + } + ] + } + }, + "ValueExclusionPolicy": { + "type": "object", + "description": "Policy for specific words and terms that should be excluded from detection by the PII detection service", + "properties": { + "caseSensitive": { + "type": "boolean", + "description": "Option to make the values excluded values case sensitive", + "default": false + }, + "excludedValues": { + "type": "array", + "description": "List of words and terms that should be excluded from detection by the PII detection service", + "items": { + "type": "string" + } + } + }, + "required": [ + "caseSensitive", + "excludedValues" + ] + }, + "VolumeMetadata": { + "type": "object", + "description": "Represents the Volume entity Metadata model.", + "properties": { + "value": { + "type": "number", + "format": "double", + "description": "The numeric value that the extracted text denotes." + }, + "unit": { + "$ref": "#/definitions/VolumeUnit", + "description": "Unit of measure for volume." + } + }, + "required": [ + "value", + "unit" + ], + "allOf": [ + { + "$ref": "#/definitions/BaseMetadata" + } + ], + "x-ms-discriminator-value": "VolumeMetadata" + }, + "VolumeUnit": { + "type": "string", + "description": "The Volume Unit of measurement", + "enum": [ + "Unspecified", + "CubicMeter", + "CubicCentimeter", + "CubicMillimeter", + "Hectoliter", + "Decaliter", + "Liter", + "Centiliter", + "Milliliter", + "CubicYard", + "CubicInch", + "CubicFoot", + "CubicMile", + "FluidOunce", + "Teaspoon", + "Tablespoon", + "Pint", + "Quart", + "Cup", + "Gill", + "Pinch", + "FluidDram", + "Barrel", + "Minim", + "Cord", + "Peck", + "Bushel", + "Hogshead" + ], + "x-ms-enum": { + "name": "VolumeUnit", + "modelAsString": true, + "values": [ + { + "name": "Unspecified", + "value": "Unspecified", + "description": "Unspecified volume unit." + }, + { + "name": "CubicMeter", + "value": "CubicMeter", + "description": "Volume unit in cubic meters." + }, + { + "name": "CubicCentimeter", + "value": "CubicCentimeter", + "description": "Volume unit in cubic centimeters." + }, + { + "name": "CubicMillimeter", + "value": "CubicMillimeter", + "description": "Volume unit in cubic millimeters." + }, + { + "name": "Hectoliter", + "value": "Hectoliter", + "description": "Volume unit in hectoliters." + }, + { + "name": "Decaliter", + "value": "Decaliter", + "description": "Volume unit in decaliters." + }, + { + "name": "Liter", + "value": "Liter", + "description": "Volume unit in liters." + }, + { + "name": "Centiliter", + "value": "Centiliter", + "description": "Volume unit in centiliters." + }, + { + "name": "Milliliter", + "value": "Milliliter", + "description": "Volume unit in milliliters." + }, + { + "name": "CubicYard", + "value": "CubicYard", + "description": "Volume unit in cubic yards." + }, + { + "name": "CubicInch", + "value": "CubicInch", + "description": "Volume unit in cubic inches." + }, + { + "name": "CubicFoot", + "value": "CubicFoot", + "description": "Volume unit in cubic feet." + }, + { + "name": "CubicMile", + "value": "CubicMile", + "description": "Volume unit in cubic miles." + }, + { + "name": "FluidOunce", + "value": "FluidOunce", + "description": "Volume unit in fluid ounces." + }, + { + "name": "Teaspoon", + "value": "Teaspoon", + "description": "Volume unit in teaspoons." + }, + { + "name": "Tablespoon", + "value": "Tablespoon", + "description": "Volume unit in tablespoons." + }, + { + "name": "Pint", + "value": "Pint", + "description": "Volume unit in pints." + }, + { + "name": "Quart", + "value": "Quart", + "description": "Volume unit in quarts." + }, + { + "name": "Cup", + "value": "Cup", + "description": "Volume unit in cups." + }, + { + "name": "Gill", + "value": "Gill", + "description": "Volume unit in gills." + }, + { + "name": "Pinch", + "value": "Pinch", + "description": "Volume unit in pinches." + }, + { + "name": "FluidDram", + "value": "FluidDram", + "description": "Volume unit in fluid drams." + }, + { + "name": "Barrel", + "value": "Barrel", + "description": "Volume unit in barrels." + }, + { + "name": "Minim", + "value": "Minim", + "description": "Volume unit in minims." + }, + { + "name": "Cord", + "value": "Cord", + "description": "Volume unit in cords." + }, + { + "name": "Peck", + "value": "Peck", + "description": "Volume unit in pecks." + }, + { + "name": "Bushel", + "value": "Bushel", + "description": "Volume unit in bushels." + }, + { + "name": "Hogshead", + "value": "Hogshead", + "description": "Volume unit in hogsheads." + } + ] + } + }, + "WarningCodeValue": { + "type": "string", + "description": "Defines the list of the warning codes.", + "enum": [ + "LongWordsInDocument", + "DocumentTruncated" + ], + "x-ms-enum": { + "name": "WarningCodeValue", + "modelAsString": true, + "values": [ + { + "name": "LongWordsInDocument", + "value": "LongWordsInDocument", + "description": "Long words in document warning" + }, + { + "name": "DocumentTruncated", + "value": "DocumentTruncated", + "description": "Document truncated warning" + } + ] + } + }, + "WeightMetadata": { + "type": "object", + "description": "Represents the Weight ) entity Metadata model.", + "properties": { + "value": { + "type": "number", + "format": "double", + "description": "The numeric value that the extracted text denotes." + }, + "unit": { + "$ref": "#/definitions/WeightUnit", + "description": "Unit of measure for weight." + } + }, + "required": [ + "value", + "unit" + ], + "allOf": [ + { + "$ref": "#/definitions/BaseMetadata" + } + ], + "x-ms-discriminator-value": "WeightMetadata" + }, + "WeightUnit": { + "type": "string", + "description": "The weight Unit of measurement.", + "enum": [ + "Unspecified", + "Kilogram", + "Gram", + "Milligram", + "Gallon", + "MetricTon", + "Ton", + "Pound", + "Ounce", + "Grain", + "PennyWeight", + "LongTonBritish", + "ShortTonUS", + "ShortHundredWeightUS", + "Stone", + "Dram" + ], + "x-ms-enum": { + "name": "WeightUnit", + "modelAsString": true, + "values": [ + { + "name": "Unspecified", + "value": "Unspecified", + "description": "Unspecified weight unit" + }, + { + "name": "Kilogram", + "value": "Kilogram", + "description": "Weight unit in kilograms" + }, + { + "name": "Gram", + "value": "Gram", + "description": "Weight unit in grams" + }, + { + "name": "Milligram", + "value": "Milligram", + "description": "Weight unit in milligrams" + }, + { + "name": "Gallon", + "value": "Gallon", + "description": "Volume unit in gallons" + }, + { + "name": "MetricTon", + "value": "MetricTon", + "description": "Weight unit in metric tons" + }, + { + "name": "Ton", + "value": "Ton", + "description": "Weight unit in tons" + }, + { + "name": "Pound", + "value": "Pound", + "description": "Weight unit in pounds" + }, + { + "name": "Ounce", + "value": "Ounce", + "description": "Weight unit in ounces" + }, + { + "name": "Grain", + "value": "Grain", + "description": "Weight unit in grains" + }, + { + "name": "PennyWeight", + "value": "PennyWeight", + "description": "Weight unit in pennyweights" + }, + { + "name": "LongTonBritish", + "value": "LongTonBritish", + "description": "Weight unit in long tons (British)" + }, + { + "name": "ShortTonUS", + "value": "ShortTonUS", + "description": "Weight unit in short tons (US)" + }, + { + "name": "ShortHundredWeightUS", + "value": "ShortHundredWeightUS", + "description": "Weight unit in short hundredweights (US)" + }, + { + "name": "Stone", + "value": "Stone", + "description": "Weight unit in stones" + }, + { + "name": "Dram", + "value": "Dram", + "description": "Weight unit in drams" + } + ] + } + }, + "fhirVersion": { + "type": "string", + "description": "The FHIR Spec version.", + "enum": [ + "4.0.1" + ], + "x-ms-enum": { + "name": "fhirVersion", + "modelAsString": true, + "values": [ + { + "name": "4.0.1", + "value": "4.0.1", + "description": "Version 4.0.1" + } + ] + } + }, + "healthcareDocumentType": { + "type": "string", + "description": "Document type.", + "enum": [ + "None", + "ClinicalTrial", + "DischargeSummary", + "ProgressNote", + "HistoryAndPhysical", + "Consult", + "Imaging", + "Pathology", + "ProcedureNote" + ], + "x-ms-enum": { + "name": "healthcareDocumentType", + "modelAsString": true, + "values": [ + { + "name": "None", + "value": "None", + "description": "None document type" + }, + { + "name": "ClinicalTrial", + "value": "ClinicalTrial", + "description": "Clinical trial document type" + }, + { + "name": "DischargeSummary", + "value": "DischargeSummary", + "description": "Discharge summary document type" + }, + { + "name": "ProgressNote", + "value": "ProgressNote", + "description": "Progress note document type" + }, + { + "name": "HistoryAndPhysical", + "value": "HistoryAndPhysical", + "description": "History and physical document type" + }, + { + "name": "Consult", + "value": "Consult", + "description": "Consult document type" + }, + { + "name": "Imaging", + "value": "Imaging", + "description": "Imaging document type" + }, + { + "name": "Pathology", + "value": "Pathology", + "description": "Pathology document type" + }, + { + "name": "ProcedureNote", + "value": "ProcedureNote", + "description": "Procedure note document type" + } + ] + } + }, + "healthcareEntityCategory": { + "type": "string", + "description": "Healthcare Entity Category.", + "enum": [ + "BodyStructure", + "Age", + "Gender", + "ExaminationName", + "Date", + "Direction", + "Frequency", + "MeasurementValue", + "MeasurementUnit", + "RelationalOperator", + "Time", + "GeneOrProtein", + "Variant", + "AdministrativeEvent", + "CareEnvironment", + "HealthcareProfession", + "Diagnosis", + "SymptomOrSign", + "ConditionQualifier", + "MedicationClass", + "MedicationName", + "Dosage", + "MedicationForm", + "MedicationRoute", + "FamilyRelation", + "TreatmentName", + "Ethnicity", + "Course", + "Expression", + "MutationType", + "ConditionScale", + "Allergen", + "Employment", + "LivingStatus", + "SubstanceUse", + "SubstanceUseAmount" + ], + "x-ms-enum": { + "name": "healthcareEntityCategory", + "modelAsString": true, + "values": [ + { + "name": "BodyStructure", + "value": "BodyStructure", + "description": "Body structure" + }, + { + "name": "Age", + "value": "Age", + "description": "Age" + }, + { + "name": "Gender", + "value": "Gender", + "description": "Gender" + }, + { + "name": "ExaminationName", + "value": "ExaminationName", + "description": "Examination name" + }, + { + "name": "Date", + "value": "Date", + "description": "Date" + }, + { + "name": "Direction", + "value": "Direction", + "description": "Direction" + }, + { + "name": "Frequency", + "value": "Frequency", + "description": "Frequency" + }, + { + "name": "MeasurementValue", + "value": "MeasurementValue", + "description": "Measurement value" + }, + { + "name": "MeasurementUnit", + "value": "MeasurementUnit", + "description": "Measurement unit" + }, + { + "name": "RelationalOperator", + "value": "RelationalOperator", + "description": "Relational operator" + }, + { + "name": "Time", + "value": "Time", + "description": "Time" + }, + { + "name": "GeneOrProtein", + "value": "GeneOrProtein", + "description": "Gene or protein" + }, + { + "name": "Variant", + "value": "Variant", + "description": "Variant" + }, + { + "name": "AdministrativeEvent", + "value": "AdministrativeEvent", + "description": "Administrative event" + }, + { + "name": "CareEnvironment", + "value": "CareEnvironment", + "description": "Care environment" + }, + { + "name": "HealthcareProfession", + "value": "HealthcareProfession", + "description": "Healthcare profession" + }, + { + "name": "Diagnosis", + "value": "Diagnosis", + "description": "Diagnosis" + }, + { + "name": "SymptomOrSign", + "value": "SymptomOrSign", + "description": "Symptom or sign" + }, + { + "name": "ConditionQualifier", + "value": "ConditionQualifier", + "description": "Condition qualifier" + }, + { + "name": "MedicationClass", + "value": "MedicationClass", + "description": "Medication class" + }, + { + "name": "MedicationName", + "value": "MedicationName", + "description": "Medication name" + }, + { + "name": "Dosage", + "value": "Dosage", + "description": "Dosage" + }, + { + "name": "MedicationForm", + "value": "MedicationForm", + "description": "Medication form" + }, + { + "name": "MedicationRoute", + "value": "MedicationRoute", + "description": "Medication route" + }, + { + "name": "FamilyRelation", + "value": "FamilyRelation", + "description": "Family relation" + }, + { + "name": "TreatmentName", + "value": "TreatmentName", + "description": "Treatment name" + }, + { + "name": "Ethnicity", + "value": "Ethnicity", + "description": "Ethnicity" + }, + { + "name": "Course", + "value": "Course", + "description": "Course" + }, + { + "name": "Expression", + "value": "Expression", + "description": "Expression" + }, + { + "name": "MutationType", + "value": "MutationType", + "description": "Mutation type" + }, + { + "name": "ConditionScale", + "value": "ConditionScale", + "description": "Condition scale" + }, + { + "name": "Allergen", + "value": "Allergen", + "description": "Allergen" + }, + { + "name": "Employment", + "value": "Employment", + "description": "Employment" + }, + { + "name": "LivingStatus", + "value": "LivingStatus", + "description": "Living status" + }, + { + "name": "SubstanceUse", + "value": "SubstanceUse", + "description": "Substance use" + }, + { + "name": "SubstanceUseAmount", + "value": "SubstanceUseAmount", + "description": "Substance use amount" + } + ] + } + }, + "relationType": { + "type": "string", + "description": "Type of relation. Examples include: `DosageOfMedication` or 'FrequencyOfMedication', etc.", + "enum": [ + "Abbreviation", + "DirectionOfBodyStructure", + "DirectionOfCondition", + "DirectionOfExamination", + "DirectionOfTreatment", + "DosageOfMedication", + "FormOfMedication", + "FrequencyOfMedication", + "FrequencyOfTreatment", + "QualifierOfCondition", + "RelationOfExamination", + "RouteOfMedication", + "TimeOfCondition", + "TimeOfEvent", + "TimeOfExamination", + "TimeOfMedication", + "TimeOfTreatment", + "UnitOfCondition", + "UnitOfExamination", + "ValueOfCondition", + "ValueOfExamination", + "BodySiteOfCondition", + "BodySiteOfTreatment", + "CourseOfCondition", + "CourseOfExamination", + "CourseOfMedication", + "CourseOfTreatment", + "ExaminationFindsCondition", + "ExpressionOfGene", + "ExpressionOfVariant", + "FrequencyOfCondition", + "MutationTypeOfGene", + "MutationTypeOfVariant", + "ScaleOfCondition", + "VariantOfGene" + ], + "x-ms-enum": { + "name": "relationType", + "modelAsString": true, + "values": [ + { + "name": "Abbreviation", + "value": "Abbreviation", + "description": "Abbreviation" + }, + { + "name": "DirectionOfBodyStructure", + "value": "DirectionOfBodyStructure", + "description": "Direction of body structure" + }, + { + "name": "DirectionOfCondition", + "value": "DirectionOfCondition", + "description": "Direction of condition" + }, + { + "name": "DirectionOfExamination", + "value": "DirectionOfExamination", + "description": "Direction of examination" + }, + { + "name": "DirectionOfTreatment", + "value": "DirectionOfTreatment", + "description": "Direction of treatment" + }, + { + "name": "DosageOfMedication", + "value": "DosageOfMedication", + "description": "Dosage of medication" + }, + { + "name": "FormOfMedication", + "value": "FormOfMedication", + "description": "Form of medication" + }, + { + "name": "FrequencyOfMedication", + "value": "FrequencyOfMedication", + "description": "Frequency of medication" + }, + { + "name": "FrequencyOfTreatment", + "value": "FrequencyOfTreatment", + "description": "Frequency of treatment" + }, + { + "name": "QualifierOfCondition", + "value": "QualifierOfCondition", + "description": "Qualifier of condition" + }, + { + "name": "RelationOfExamination", + "value": "RelationOfExamination", + "description": "Relation of examination" + }, + { + "name": "RouteOfMedication", + "value": "RouteOfMedication", + "description": "Route of medication" + }, + { + "name": "TimeOfCondition", + "value": "TimeOfCondition", + "description": "Time of condition" + }, + { + "name": "TimeOfEvent", + "value": "TimeOfEvent", + "description": "Time of event" + }, + { + "name": "TimeOfExamination", + "value": "TimeOfExamination", + "description": "Time of examination" + }, + { + "name": "TimeOfMedication", + "value": "TimeOfMedication", + "description": "Time of medication" + }, + { + "name": "TimeOfTreatment", + "value": "TimeOfTreatment", + "description": "Time of treatment" + }, + { + "name": "UnitOfCondition", + "value": "UnitOfCondition", + "description": "Unit of condition" + }, + { + "name": "UnitOfExamination", + "value": "UnitOfExamination", + "description": "Unit of examination" + }, + { + "name": "ValueOfCondition", + "value": "ValueOfCondition", + "description": "Value of condition" + }, + { + "name": "ValueOfExamination", + "value": "ValueOfExamination", + "description": "Value of examination" + }, + { + "name": "BodySiteOfCondition", + "value": "BodySiteOfCondition", + "description": "Body site of condition" + }, + { + "name": "BodySiteOfTreatment", + "value": "BodySiteOfTreatment", + "description": "Body site of treatment" + }, + { + "name": "CourseOfCondition", + "value": "CourseOfCondition", + "description": "Course of condition" + }, + { + "name": "CourseOfExamination", + "value": "CourseOfExamination", + "description": "Course of examination" + }, + { + "name": "CourseOfMedication", + "value": "CourseOfMedication", + "description": "Course of medication" + }, + { + "name": "CourseOfTreatment", + "value": "CourseOfTreatment", + "description": "Course of treatment" + }, + { + "name": "ExaminationFindsCondition", + "value": "ExaminationFindsCondition", + "description": "Examination finds condition" + }, + { + "name": "ExpressionOfGene", + "value": "ExpressionOfGene", + "description": "Expression of gene" + }, + { + "name": "ExpressionOfVariant", + "value": "ExpressionOfVariant", + "description": "Expression of variant" + }, + { + "name": "FrequencyOfCondition", + "value": "FrequencyOfCondition", + "description": "Frequency of condition" + }, + { + "name": "MutationTypeOfGene", + "value": "MutationTypeOfGene", + "description": "Mutation type of gene" + }, + { + "name": "MutationTypeOfVariant", + "value": "MutationTypeOfVariant", + "description": "Mutation type of variant" + }, + { + "name": "ScaleOfCondition", + "value": "ScaleOfCondition", + "description": "Scale of condition" + }, + { + "name": "VariantOfGene", + "value": "VariantOfGene", + "description": "Variant of gene" + } + ] + } + } + }, + "parameters": { + "Azure.Core.Foundations.ApiVersionParameter": { + "name": "api-version", + "in": "query", + "description": "The API version to use for this operation.", + "required": true, + "type": "string", + "minLength": 1, + "x-ms-parameter-location": "method", + "x-ms-client-name": "apiVersion" + } + } +} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeText/preview/2025-05-15-preview/examples/SuccessfulAbstractiveSummarizationSummaryLengthPromptTaskResult.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeText/preview/2025-05-15-preview/examples/SuccessfulAbstractiveSummarizationSummaryLengthPromptTaskResult.json new file mode 100644 index 000000000000..0aa480cacbde --- /dev/null +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeText/preview/2025-05-15-preview/examples/SuccessfulAbstractiveSummarizationSummaryLengthPromptTaskResult.json @@ -0,0 +1,58 @@ +{ + "operationId": "AnalyzeTextJobStatus", + "title": "SuccessfulAbstractiveSummarizationSummaryLengthPromptTaskResult", + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2025-05-15-preview", + "Endpoint": "{Endpoint}", + "jobId": "c0f2a446-05d9-48fc-ba8f-3ef4af8d0b18" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "createdDateTime": "2020-10-01T15:00:45Z", + "displayName": "Document Abstractive Summarization Task Example", + "expirationDateTime": "2020-10-03T15:01:03Z", + "jobId": "c0f2a446-05d9-48fc-ba8f-3ef4af8d0b18", + "lastUpdatedDateTime": "2020-10-01T15:01:03Z", + "status": "succeeded", + "tasks": { + "completed": 1, + "failed": 0, + "inProgress": 0, + "total": 1, + "items": [ + { + "kind": "AbstractiveSummarizationLROResults", + "taskName": "Document Abstractive Summarization Task 1", + "lastUpdateDateTime": "2020-10-01T15:01:03Z", + "status": "succeeded", + "results": { + "documents": [ + { + "summaries": [ + { + "text": "XYZ-code is a joint representation of human cognition and language, which Microsoft aims to develop for cross-domain transfer learning. Learn how XYz-code can help Microsoft achieve cross-sensory and multilingual learning with human-centric approach.", + "contexts": [ + { + "offset": 0, + "length": 1619 + } + ] + } + ], + "id": "1", + "warnings": [] + } + ], + "errors": [], + "modelVersion": "latest" + } + } + ] + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeText/preview/2025-05-15-preview/examples/SuccessfulAbstractiveSummarizationSummaryLengthPromptTaskSubmit.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeText/preview/2025-05-15-preview/examples/SuccessfulAbstractiveSummarizationSummaryLengthPromptTaskSubmit.json new file mode 100644 index 000000000000..754dee836340 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeText/preview/2025-05-15-preview/examples/SuccessfulAbstractiveSummarizationSummaryLengthPromptTaskSubmit.json @@ -0,0 +1,39 @@ +{ + "operationId": "AnalyzeTextSubmitJob", + "title": "SuccessfulAbstractiveSummarizationSummaryLengthPromptTaskSubmit", + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2025-05-15-preview", + "Endpoint": "{Endpoint}", + "jobId": "{Job ID}", + "body": { + "displayName": "Document Abstractive Summarization Task Example", + "analysisInput": { + "documents": [ + { + "id": "1", + "language": "en", + "text": "At Microsoft, we have been on a quest to advance AI beyond existing techniques, by taking a more holistic, human-centric approach to learning and understanding. As Chief Technology Officer of Azure AI Cognitive Services, I have been working with a team of amazing scientists and engineers to turn this quest into a reality. In my role, I enjoy a unique perspective in viewing the relationship among three attributes of human cognition: monolingual text (X), audio or visual sensory signals, (Y) and multilingual (Z). At the intersection of all three, there is magic—what we call XYZ-code as illustrated in Figure 1—a joint representation to create more powerful AI that can speak, hear, see, and understand humans better. We believe XYZ-code will enable us to fulfill our long-term vision: cross-domain transfer learning, spanning modalities and languages. The goal is to have pre-trained models that can jointly learn representations to support a broad range of downstream AI tasks, much in the way humans do today. Over the past five years, we have achieved human performance on benchmarks in conversational speech recognition, machine translation, conversational question answering, machine reading comprehension, and image captioning. These five breakthroughs provided us with strong signals toward our more ambitious aspiration to produce a leap in AI capabilities, achieving multi-sensory and multilingual learning that is closer in line with how humans learn and understand. I believe the joint XYZ-code is a foundational component of this aspiration, if grounded with external knowledge sources in the downstream AI tasks." + } + ] + }, + "tasks": [ + { + "kind": "AbstractiveSummarization", + "taskName": "Document Abstractive Summarization Task 1", + "parameters": { + "summaryLength": "medium", + "instruction": "XYZ-code" + } + } + ] + } + }, + "responses": { + "202": { + "headers": { + "Operation-Location": "{endpoint}/language/analyze-text/jobs/{jobId}?api-version=2025-05-15-preview" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeText/preview/2025-05-15-preview/examples/SuccessfulAbstractiveSummarizationTaskResult.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeText/preview/2025-05-15-preview/examples/SuccessfulAbstractiveSummarizationTaskResult.json new file mode 100644 index 000000000000..41581ae7d7d8 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeText/preview/2025-05-15-preview/examples/SuccessfulAbstractiveSummarizationTaskResult.json @@ -0,0 +1,58 @@ +{ + "operationId": "AnalyzeTextJobStatus", + "title": "SuccessfulAbstractiveSummarizationTaskResult", + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2025-05-15-preview", + "Endpoint": "{Endpoint}", + "jobId": "c0f2a446-05d9-48fc-ba8f-3ef4af8d0b18" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "createdDateTime": "2020-10-01T15:00:45Z", + "displayName": "Document Abstractive Summarization Task Example", + "expirationDateTime": "2020-10-03T15:01:03Z", + "jobId": "c0f2a446-05d9-48fc-ba8f-3ef4af8d0b18", + "lastUpdatedDateTime": "2020-10-01T15:01:03Z", + "status": "succeeded", + "tasks": { + "completed": 1, + "failed": 0, + "inProgress": 0, + "total": 1, + "items": [ + { + "kind": "AbstractiveSummarizationLROResults", + "taskName": "Document Abstractive Summarization Task 1", + "lastUpdateDateTime": "2020-10-01T15:01:03Z", + "status": "succeeded", + "results": { + "documents": [ + { + "summaries": [ + { + "text": "Microsoft have been on a quest to advance AI beyond existing techniques.", + "contexts": [ + { + "offset": 0, + "length": 1629 + } + ] + } + ], + "id": "1", + "warnings": [] + } + ], + "errors": [], + "modelVersion": "latest" + } + } + ] + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeText/preview/2025-05-15-preview/examples/SuccessfulAbstractiveSummarizationTaskSubmit.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeText/preview/2025-05-15-preview/examples/SuccessfulAbstractiveSummarizationTaskSubmit.json new file mode 100644 index 000000000000..74cf057dcbc1 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeText/preview/2025-05-15-preview/examples/SuccessfulAbstractiveSummarizationTaskSubmit.json @@ -0,0 +1,38 @@ +{ + "operationId": "AnalyzeTextSubmitJob", + "title": "SuccessfulAbstractiveSummarizationTaskSubmit", + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2025-05-15-preview", + "Endpoint": "{Endpoint}", + "jobId": "{Job ID}", + "body": { + "displayName": "Document Abstractive Summarization Task Example", + "analysisInput": { + "documents": [ + { + "id": "1", + "language": "en", + "text": "At Microsoft, we have been on a quest to advance AI beyond existing techniques, by taking a more holistic, human-centric approach to learning and understanding. As Chief Technology Officer of Azure AI Cognitive Services, I have been working with a team of amazing scientists and engineers to turn this quest into a reality. In my role, I enjoy a unique perspective in viewing the relationship among three attributes of human cognition: monolingual text (X), audio or visual sensory signals, (Y) and multilingual (Z). At the intersection of all three, there is magic—what we call XYZ-code as illustrated in Figure 1—a joint representation to create more powerful AI that can speak, hear, see, and understand humans better. We believe XYZ-code will enable us to fulfill our long-term vision: cross-domain transfer learning, spanning modalities and languages. The goal is to have pre-trained models that can jointly learn representations to support a broad range of downstream AI tasks, much in the way humans do today. Over the past five years, we have achieved human performance on benchmarks in conversational speech recognition, machine translation, conversational question answering, machine reading comprehension, and image captioning. These five breakthroughs provided us with strong signals toward our more ambitious aspiration to produce a leap in AI capabilities, achieving multi-sensory and multilingual learning that is closer in line with how humans learn and understand. I believe the joint XYZ-code is a foundational component of this aspiration, if grounded with external knowledge sources in the downstream AI tasks." + } + ] + }, + "tasks": [ + { + "kind": "AbstractiveSummarization", + "taskName": "Document Abstractive Summarization Task 1", + "parameters": { + "sentenceCount": 1 + } + } + ] + } + }, + "responses": { + "202": { + "headers": { + "Operation-Location": "{endpoint}/language/analyze-text/jobs/{jobId}?api-version=2025-05-15-preview" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeText/preview/2025-05-15-preview/examples/SuccessfulAnalyzeTextJobsCancelRequest.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeText/preview/2025-05-15-preview/examples/SuccessfulAnalyzeTextJobsCancelRequest.json new file mode 100644 index 000000000000..13ad6a087245 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeText/preview/2025-05-15-preview/examples/SuccessfulAnalyzeTextJobsCancelRequest.json @@ -0,0 +1,17 @@ +{ + "operationId": "AnalyzeTextCancelJob", + "title": "SuccessfulAnalyzeTextJobsCancelRequest", + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2025-05-15-preview", + "Endpoint": "{Endpoint}", + "jobId": "c0f2a446-05d9-48fc-ba8f-3ef4af8d0b18" + }, + "responses": { + "202": { + "headers": { + "Operation-Location": "{Endpoint}/language/analyze-text/jobs/{jobId}?api-version=2023-11-15-preview" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeText/preview/2025-05-15-preview/examples/SuccessfulAnalyzeTextJobsMultipleTaskStatusRequest.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeText/preview/2025-05-15-preview/examples/SuccessfulAnalyzeTextJobsMultipleTaskStatusRequest.json new file mode 100644 index 000000000000..eec46a940eaa --- /dev/null +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeText/preview/2025-05-15-preview/examples/SuccessfulAnalyzeTextJobsMultipleTaskStatusRequest.json @@ -0,0 +1,180 @@ +{ + "operationId": "AnalyzeTextJobStatus", + "title": "SuccessfulAnalyzeTextJobsMultipleTaskStatusRequest", + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2025-05-15-preview", + "Endpoint": "{Endpoint}", + "jobId": "c0f2a446-05d9-48fc-ba8f-3ef4af8d0b18" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "createdDateTime": "2020-10-01T15:00:45Z", + "displayName": "Extracting Location & US Region", + "expirationDateTime": "2020-10-03T15:01:03Z", + "jobId": "c0f2a446-05d9-48fc-ba8f-3ef4af8d0b18", + "lastUpdatedDateTime": "2020-10-01T15:01:03Z", + "status": "succeeded", + "tasks": { + "completed": 2, + "failed": 0, + "inProgress": 0, + "total": 2, + "items": [ + { + "kind": "EntityRecognitionLROResults", + "taskName": "Recognize Entities", + "lastUpdateDateTime": "2020-10-01T15:01:03Z", + "status": "succeeded", + "results": { + "documents": [ + { + "entities": [ + { + "category": "Event", + "type": "Event", + "confidenceScore": 0.61, + "length": 4, + "offset": 18, + "text": "trip", + "tags": [ + { + "name": "Event", + "confidenceScore": 0.61 + } + ] + }, + { + "category": "Location", + "type": "GPE", + "confidenceScore": 0.82, + "length": 7, + "offset": 26, + "tags": [ + { + "name": "Location", + "confidenceScore": 0.82 + }, + { + "name": "GPE", + "confidenceScore": 0.82 + } + ], + "text": "Seattle" + }, + { + "category": "Temporal", + "type": "DateRange", + "confidenceScore": 0.8, + "length": 9, + "offset": 34, + "text": "last week", + "tags": [ + { + "name": "DateRange", + "confidenceScore": 0.8 + }, + { + "name": "Temporal", + "confidenceScore": 0.8 + } + ] + } + ], + "id": "1", + "warnings": [] + }, + { + "entities": [ + { + "category": "Location", + "type": "GPE", + "confidenceScore": 0.52, + "length": 3, + "offset": 14, + "text": "NYC", + "tags": [ + { + "name": "Location", + "confidenceScore": 0.82 + }, + { + "name": "GPE", + "confidenceScore": 0.82 + } + ] + }, + { + "category": "Temporal", + "type": "Date", + "confidenceScore": 0.8, + "length": 8, + "offset": 18, + "text": "tomorrow", + "tags": [ + { + "name": "Date", + "confidenceScore": 0.8 + }, + { + "name": "Temporal", + "confidenceScore": 0.8 + } + ] + } + ], + "id": "2", + "warnings": [] + } + ], + "errors": [], + "modelVersion": "2020-04-01" + } + }, + { + "kind": "CustomEntityRecognitionLROResults", + "taskName": "Recognize US Regions", + "lastUpdateDateTime": "2020-10-01T15:01:03Z", + "status": "succeeded", + "results": { + "documents": [ + { + "entities": [ + { + "category": "USRegion", + "confidenceScore": 0.85, + "length": 17, + "offset": 45, + "text": "Pacific Northwest" + } + ], + "id": "1", + "warnings": [] + }, + { + "entities": [ + { + "category": "USRegion", + "confidenceScore": 0.88, + "length": 10, + "offset": 63, + "text": "East Coast" + } + ], + "id": "2", + "warnings": [] + } + ], + "errors": [], + "projectName": "MyProject", + "deploymentName": "MyDeployment" + } + } + ] + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeText/preview/2025-05-15-preview/examples/SuccessfulAnalyzeTextJobsMultipleTaskSubmitRequest.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeText/preview/2025-05-15-preview/examples/SuccessfulAnalyzeTextJobsMultipleTaskSubmitRequest.json new file mode 100644 index 000000000000..8da4921853e8 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeText/preview/2025-05-15-preview/examples/SuccessfulAnalyzeTextJobsMultipleTaskSubmitRequest.json @@ -0,0 +1,51 @@ +{ + "operationId": "AnalyzeTextSubmitJob", + "title": "SuccessfulAnalyzeTextJobsMultipleTaskSubmitRequest", + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2025-05-15-preview", + "Endpoint": "{Endpoint}", + "jobId": "{Job ID}", + "body": { + "displayName": "Extracting Location & US Region", + "analysisInput": { + "documents": [ + { + "id": "1", + "language": "en", + "text": "I had a wonderful trip to Seattle last week." + }, + { + "id": "2", + "language": "en", + "text": "I'm flying to NYC tomorrow. See you there." + } + ] + }, + "tasks": [ + { + "kind": "EntityRecognition", + "taskName": "Recognize Entities", + "parameters": { + "modelVersion": "latest" + } + }, + { + "kind": "CustomEntityRecognition", + "taskName": "Recognize US Regions", + "parameters": { + "projectName": "MyProject", + "deploymentName": "MyDeployment" + } + } + ] + } + }, + "responses": { + "202": { + "headers": { + "Operation-Location": "{endpoint}/language/analyze-text/jobs/{jobId}?api-version=2025-05-15-preview" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeText/preview/2025-05-15-preview/examples/SuccessfulEntityLinkingRequest.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeText/preview/2025-05-15-preview/examples/SuccessfulEntityLinkingRequest.json new file mode 100644 index 000000000000..12939588e3d8 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeText/preview/2025-05-15-preview/examples/SuccessfulEntityLinkingRequest.json @@ -0,0 +1,130 @@ +{ + "operationId": "AnalyzeText", + "title": "SuccessfulEntityLinkingRequest", + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2025-05-15-preview", + "Endpoint": "{Endpoint}", + "body": { + "kind": "EntityLinking", + "parameters": { + "modelVersion": "latest" + }, + "analysisInput": { + "documents": [ + { + "id": "1", + "language": "en", + "text": "Microsoft was founded by Bill Gates and Paul Allen." + }, + { + "id": "2", + "language": "en", + "text": "Pike place market is my favorite Seattle attraction." + } + ] + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "kind": "EntityLinkingResults", + "results": { + "documents": [ + { + "entities": [ + { + "dataSource": "Wikipedia", + "id": "Bill Gates", + "language": "en", + "matches": [ + { + "confidenceScore": 0.52, + "length": 10, + "offset": 25, + "text": "Bill Gates" + } + ], + "name": "Bill Gates", + "url": "https://en.wikipedia.org/wiki/Bill_Gates" + }, + { + "dataSource": "Wikipedia", + "id": "Paul Allen", + "language": "en", + "matches": [ + { + "confidenceScore": 0.54, + "length": 10, + "offset": 40, + "text": "Paul Allen" + } + ], + "name": "Paul Allen", + "url": "https://en.wikipedia.org/wiki/Paul_Allen" + }, + { + "dataSource": "Wikipedia", + "id": "Microsoft", + "language": "en", + "matches": [ + { + "confidenceScore": 0.49, + "length": 9, + "offset": 0, + "text": "Microsoft" + } + ], + "name": "Microsoft", + "url": "https://en.wikipedia.org/wiki/Microsoft" + } + ], + "id": "1", + "warnings": [] + }, + { + "entities": [ + { + "dataSource": "Wikipedia", + "id": "Pike Place Market", + "language": "en", + "matches": [ + { + "confidenceScore": 0.86, + "length": 17, + "offset": 0, + "text": "Pike place market" + } + ], + "name": "Pike Place Market", + "url": "https://en.wikipedia.org/wiki/Pike_Place_Market" + }, + { + "dataSource": "Wikipedia", + "id": "Seattle", + "language": "en", + "matches": [ + { + "confidenceScore": 0.27, + "length": 7, + "offset": 33, + "text": "Seattle" + } + ], + "name": "Seattle", + "url": "https://en.wikipedia.org/wiki/Seattle" + } + ], + "id": "2", + "warnings": [] + } + ], + "errors": [], + "modelVersion": "2020-02-01" + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeText/preview/2025-05-15-preview/examples/SuccessfulEntityRecognitionExclusionRequest.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeText/preview/2025-05-15-preview/examples/SuccessfulEntityRecognitionExclusionRequest.json new file mode 100644 index 000000000000..a0a0464c9ad4 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeText/preview/2025-05-15-preview/examples/SuccessfulEntityRecognitionExclusionRequest.json @@ -0,0 +1,136 @@ +{ + "operationId": "AnalyzeText", + "title": "SuccessfulEntityRecognitionExclusionRequest", + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2025-05-15-preview", + "Endpoint": "{Endpoint}", + "body": { + "kind": "EntityRecognition", + "parameters": { + "modelVersion": "latest", + "exclusionList": [ + "Numeric" + ], + "overlapPolicy": { + "policyKind": "allowOverlap" + } + }, + "analysisInput": { + "documents": [ + { + "id": "2", + "language": "en", + "text": "When I was 5 years old I had $90.00 dollars to my name." + }, + { + "id": "3", + "language": "en", + "text": "When we flew from LAX it seemed like we were moving at 10 meters per second. I was lucky to see Amsterdam, Effile Tower, and the Nile." + } + ] + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "kind": "EntityRecognitionResults", + "results": { + "documents": [ + { + "entities": [], + "id": "2", + "warnings": [] + }, + { + "entities": [ + { + "text": "LAX", + "category": "Location", + "type": "Airport", + "offset": 18, + "length": 3, + "confidenceScore": 0.72, + "tags": [ + { + "name": "Location", + "confidenceScore": 0.9 + }, + { + "name": "Structural", + "confidenceScore": 0.72 + } + ] + }, + { + "text": "Amsterdam", + "category": "Location", + "type": "City", + "offset": 96, + "length": 9, + "confidenceScore": 0.8, + "tags": [ + { + "name": "Location", + "confidenceScore": 0.84 + }, + { + "name": "GPE", + "confidenceScore": 0.84 + }, + { + "name": "City", + "confidenceScore": 0.8 + } + ] + }, + { + "text": "Eiffel Tower", + "category": "Location", + "type": "Structural", + "offset": 107, + "length": 12, + "confidenceScore": 0.9, + "tags": [ + { + "name": "Location", + "confidenceScore": 0.9 + }, + { + "name": "Structural", + "confidenceScore": 0.9 + } + ] + }, + { + "text": "Nile", + "category": "Location", + "type": "Geological", + "offset": 129, + "length": 4, + "confidenceScore": 0.63, + "tags": [ + { + "name": "Location", + "confidenceScore": 0.9 + }, + { + "name": "Geological", + "confidenceScore": 0.63 + } + ] + } + ], + "id": "3", + "warnings": [] + } + ], + "errors": [], + "modelVersion": "2021-06-01" + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeText/preview/2025-05-15-preview/examples/SuccessfulEntityRecognitionInclusionRequest.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeText/preview/2025-05-15-preview/examples/SuccessfulEntityRecognitionInclusionRequest.json new file mode 100644 index 000000000000..d9ac4bd22910 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeText/preview/2025-05-15-preview/examples/SuccessfulEntityRecognitionInclusionRequest.json @@ -0,0 +1,133 @@ +{ + "operationId": "AnalyzeText", + "title": "SuccessfulEntityRecognitionInclusionRequest", + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2025-05-15-preview", + "Endpoint": "{Endpoint}", + "body": { + "kind": "EntityRecognition", + "parameters": { + "modelVersion": "latest", + "inclusionList": [ + "Location" + ] + }, + "analysisInput": { + "documents": [ + { + "id": "2", + "language": "en", + "text": "When I was 5 years old I had $90.00 dollars to my name." + }, + { + "id": "3", + "language": "en", + "text": "When we flew from LAX it seemed like we were moving at 10 meters per second. I was lucky to see Amsterdam, Effile Tower, and the Nile." + } + ] + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "kind": "EntityRecognitionResults", + "results": { + "documents": [ + { + "entities": [], + "id": "2", + "warnings": [] + }, + { + "entities": [ + { + "text": "LAX", + "category": "Location", + "type": "Structural", + "offset": 18, + "length": 3, + "confidenceScore": 0.72, + "tags": [ + { + "name": "Location", + "confidenceScore": 0.9 + }, + { + "name": "Structural", + "confidenceScore": 0.72 + } + ] + }, + { + "text": "Amsterdam", + "category": "Location", + "type": "City", + "offset": 96, + "length": 9, + "confidenceScore": 0.8, + "tags": [ + { + "name": "Location", + "confidenceScore": 0.84 + }, + { + "name": "GPE", + "confidenceScore": 0.84 + }, + { + "name": "City", + "confidenceScore": 0.8 + } + ] + }, + { + "text": "Eiffel Tower", + "category": "Location", + "type": "Structural", + "offset": 107, + "length": 12, + "confidenceScore": 0.9, + "tags": [ + { + "name": "Location", + "confidenceScore": 0.9 + }, + { + "name": "Structural", + "confidenceScore": 0.9 + } + ] + }, + { + "text": "Nile", + "category": "Location", + "type": "Geological", + "offset": 129, + "length": 4, + "confidenceScore": 0.63, + "tags": [ + { + "name": "Location", + "confidenceScore": 0.9 + }, + { + "name": "Geological", + "confidenceScore": 0.63 + } + ] + } + ], + "id": "3", + "warnings": [] + } + ], + "errors": [], + "modelVersion": "2021-06-01" + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeText/preview/2025-05-15-preview/examples/SuccessfulEntityRecognitionInferenceOptionsRequest.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeText/preview/2025-05-15-preview/examples/SuccessfulEntityRecognitionInferenceOptionsRequest.json new file mode 100644 index 000000000000..03f9e9c7d832 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeText/preview/2025-05-15-preview/examples/SuccessfulEntityRecognitionInferenceOptionsRequest.json @@ -0,0 +1,83 @@ +{ + "operationId": "AnalyzeText", + "title": "SuccessfulEntityRecognitionInferenceOptionsRequest", + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2025-05-15-preview", + "Endpoint": "{Endpoint}", + "body": { + "kind": "EntityRecognition", + "parameters": { + "modelVersion": "latest", + "inferenceOptions": { + "excludeNormalizedValues": true + } + }, + "analysisInput": { + "documents": [ + { + "id": "1", + "language": "en", + "text": "When I was 5 years old I had $90.00 dollars to my name." + } + ] + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "kind": "EntityRecognitionResults", + "results": { + "documents": [ + { + "entities": [ + { + "text": "5 years old", + "category": "Numeric", + "type": "Age", + "offset": 11, + "length": 11, + "confidenceScore": 0.99, + "tags": [ + { + "name": "Numeric", + "confidenceScore": 0.99 + }, + { + "name": "Age", + "confidenceScore": 0.99 + } + ] + }, + { + "text": "$90.00", + "category": "Numeric", + "type": "Currency", + "offset": 29, + "length": 14, + "confidenceScore": 0.99, + "tags": [ + { + "name": "Numeric", + "confidenceScore": 0.99 + }, + { + "name": "Currency", + "confidenceScore": 0.99 + } + ] + } + ], + "id": "1", + "warnings": [] + } + ], + "errors": [], + "modelVersion": "2023-09-01" + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeText/preview/2025-05-15-preview/examples/SuccessfulEntityRecognitionOverlapPolicy.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeText/preview/2025-05-15-preview/examples/SuccessfulEntityRecognitionOverlapPolicy.json new file mode 100644 index 000000000000..a266f02e7e6b --- /dev/null +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeText/preview/2025-05-15-preview/examples/SuccessfulEntityRecognitionOverlapPolicy.json @@ -0,0 +1,79 @@ +{ + "operationId": "AnalyzeText", + "title": "SuccessfulEntityRecognitionOverlapPolicy", + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2025-05-15-preview", + "Endpoint": "{Endpoint}", + "body": { + "kind": "EntityRecognition", + "parameters": { + "modelVersion": "latest", + "overlapPolicy": { + "policyKind": "matchLongest" + } + }, + "analysisInput": { + "documents": [ + { + "id": "4", + "language": "en", + "text": "25th April Meeting was an intresting one. At least we gont to experience the WorldCup" + } + ] + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "kind": "EntityRecognitionResults", + "results": { + "documents": [ + { + "entities": [ + { + "text": "25th April Meeting", + "category": "Event", + "type": "Event", + "offset": 0, + "length": 18, + "confidenceScore": 0.59, + "tags": [ + { + "name": "Event", + "confidenceScore": 0.59 + } + ] + }, + { + "text": "Worldcup", + "category": "Event", + "type": "SportsEvent", + "offset": 0, + "length": 8, + "confidenceScore": 0.51, + "tags": [ + { + "name": "Event", + "confidenceScore": 0.55 + }, + { + "name": "SportsEvent", + "confidenceScore": 0.51 + } + ] + } + ], + "id": "4", + "warnings": [] + } + ], + "errors": [], + "modelVersion": "2021-06-01" + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeText/preview/2025-05-15-preview/examples/SuccessfulEntityRecognitionRequest.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeText/preview/2025-05-15-preview/examples/SuccessfulEntityRecognitionRequest.json new file mode 100644 index 000000000000..6b8d169d0594 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeText/preview/2025-05-15-preview/examples/SuccessfulEntityRecognitionRequest.json @@ -0,0 +1,339 @@ +{ + "operationId": "AnalyzeText", + "title": "SuccessfulEntityRecognitionRequest", + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2025-05-15-preview", + "Endpoint": "{Endpoint}", + "body": { + "kind": "EntityRecognition", + "parameters": { + "modelVersion": "latest", + "overlapPolicy": { + "policyKind": "allowOverlap" + } + }, + "analysisInput": { + "documents": [ + { + "id": "2", + "language": "en", + "text": "When I was 5 years old I had $90.00 dollars to my name." + }, + { + "id": "3", + "language": "en", + "text": "When we flew from LAX it seemed like we were moving at 10 meters per second. I was lucky to see Amsterdam, Effile Tower, and the Nile." + }, + { + "id": "4", + "language": "en", + "text": "25th April Meeting was an intresting one. At least we gont to experience the WorldCup" + }, + { + "id": "5", + "language": "en", + "text": "My IP is 127.12.1.1 and my phone number is 5555555555" + } + ] + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "kind": "EntityRecognitionResults", + "results": { + "documents": [ + { + "entities": [ + { + "text": "5 years old", + "category": "Numeric", + "type": "Age", + "offset": 11, + "length": 11, + "confidenceScore": 0.99, + "tags": [ + { + "name": "Numeric", + "confidenceScore": 0.99 + }, + { + "name": "Age", + "confidenceScore": 0.99 + } + ], + "metadata": { + "metadataKind": "AgeMetadata", + "unit": "Year", + "value": 5.0 + } + }, + { + "text": "$90.00", + "category": "Numeric", + "type": "Currency", + "offset": 29, + "length": 14, + "confidenceScore": 0.99, + "tags": [ + { + "name": "Numeric", + "confidenceScore": 0.99 + }, + { + "name": "Currency", + "confidenceScore": 0.99 + } + ], + "metadata": { + "metadataKind": "CurrencyMetadata", + "unit": "Dollar", + "iso4217": "USD", + "value": 90.0 + } + } + ], + "id": "2", + "warnings": [] + }, + { + "entities": [ + { + "text": "LAX", + "category": "Location", + "type": "Structural", + "offset": 18, + "length": 3, + "confidenceScore": 0.72, + "tags": [ + { + "name": "Location", + "confidenceScore": 0.9 + }, + { + "name": "Structural", + "confidenceScore": 0.72 + } + ] + }, + { + "text": "10 meters per second", + "category": "Numeric", + "type": "Speed", + "offset": 55, + "length": 20, + "confidenceScore": 0.8, + "tags": [ + { + "name": "Dimension", + "confidenceScore": 0.84 + }, + { + "name": "Numeric", + "confidenceScore": 0.84 + }, + { + "name": "Speed", + "confidenceScore": 0.8 + } + ], + "metadata": { + "metadataKind": "SpeedMetadata", + "unit": "MetersPerSecond", + "value": 10.0 + } + }, + { + "text": "Amsterdam", + "category": "Location", + "type": "City", + "offset": 96, + "length": 9, + "confidenceScore": 0.8, + "tags": [ + { + "name": "Location", + "confidenceScore": 0.84 + }, + { + "name": "GPE", + "confidenceScore": 0.84 + }, + { + "name": "City", + "confidenceScore": 0.8 + } + ] + }, + { + "text": "Eiffel Tower", + "category": "Location", + "type": "Structural", + "offset": 107, + "length": 12, + "confidenceScore": 0.9, + "tags": [ + { + "name": "Location", + "confidenceScore": 0.9 + }, + { + "name": "Structural", + "confidenceScore": 0.9 + } + ] + }, + { + "text": "Nile", + "category": "Location", + "type": "Geological", + "offset": 129, + "length": 4, + "confidenceScore": 0.63, + "tags": [ + { + "name": "Location", + "confidenceScore": 0.9 + }, + { + "name": "Geological", + "confidenceScore": 0.63 + } + ] + } + ], + "id": "3", + "warnings": [] + }, + { + "entities": [ + { + "text": "25th April", + "category": "Temporal", + "type": "Date", + "offset": 0, + "length": 10, + "confidenceScore": 0.58, + "tags": [ + { + "name": "Temporal", + "confidenceScore": 0.9 + }, + { + "name": "Date", + "confidenceScore": 0.58 + } + ], + "metadata": { + "metadataKind": "DateMetadata", + "dateValues": [ + { + "timex": "XXXX-04-25", + "value": "2022-04-25" + }, + { + "timex": "XXXX-04-25", + "value": "2023-04-25" + } + ] + } + }, + { + "text": "25th April Meeting", + "category": "Event", + "type": "Event", + "offset": 0, + "length": 18, + "confidenceScore": 0.55, + "tags": [ + { + "name": "Event", + "confidenceScore": 0.55 + } + ] + }, + { + "text": "25th April Meeting", + "category": "Event", + "type": "CulturalEvent", + "offset": 0, + "length": 18, + "confidenceScore": 0.55, + "tags": [ + { + "name": "Event", + "confidenceScore": 0.55 + }, + { + "name": "CulturalEvent", + "confidenceScore": 0.55 + } + ] + }, + { + "text": "Worldcup", + "category": "Event", + "type": "SportsEvent", + "offset": 0, + "length": 8, + "confidenceScore": 0.51, + "tags": [ + { + "name": "Event", + "confidenceScore": 0.55 + }, + { + "name": "SportsEvent", + "confidenceScore": 0.51 + } + ] + } + ], + "id": "4", + "warnings": [] + }, + { + "entities": [ + { + "text": "127.12.1.1", + "category": "IP", + "type": "IP", + "offset": 9, + "length": 10, + "confidenceScore": 0.8, + "tags": [ + { + "name": "IP", + "confidenceScore": 0.8 + } + ] + }, + { + "text": "5555555555", + "category": "PhoneNumber", + "type": "PhoneNumber", + "offset": 45, + "length": 9, + "confidenceScore": 0.8, + "tags": [ + { + "name": "PhoneNumber", + "confidenceScore": 0.8 + } + ] + } + ], + "id": "5", + "warnings": [] + } + ], + "errors": [], + "modelVersion": "2021-06-01" + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeText/preview/2025-05-15-preview/examples/SuccessfulHealthcareDocumentTypePostRequest.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeText/preview/2025-05-15-preview/examples/SuccessfulHealthcareDocumentTypePostRequest.json new file mode 100644 index 000000000000..3c7aff2de00f --- /dev/null +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeText/preview/2025-05-15-preview/examples/SuccessfulHealthcareDocumentTypePostRequest.json @@ -0,0 +1,38 @@ +{ + "operationId": "AnalyzeTextSubmitJob", + "title": "SuccessfulHealthcareDocumentTypePostRequest", + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2025-05-15-preview", + "Endpoint": "{Endpoint}", + "jobId": "{Job ID}", + "body": { + "analysisInput": { + "documents": [ + { + "text": "Prescribed 100mg ibuprofen, taken twice daily.", + "id": "1", + "language": "en" + } + ] + }, + "tasks": [ + { + "kind": "Healthcare", + "parameters": { + "modelVersion": "latest", + "fhirVersion": "4.0.1", + "documentType": "DischargeSummary" + } + } + ] + } + }, + "responses": { + "202": { + "headers": { + "Operation-Location": "{Endpoint}/language/analyze-text/jobs/{jobId}?api-version=2025-05-15-preview" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeText/preview/2025-05-15-preview/examples/SuccessfulHealthcareDocumentTypeTaskStatusRequest.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeText/preview/2025-05-15-preview/examples/SuccessfulHealthcareDocumentTypeTaskStatusRequest.json new file mode 100644 index 000000000000..5121c8443744 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeText/preview/2025-05-15-preview/examples/SuccessfulHealthcareDocumentTypeTaskStatusRequest.json @@ -0,0 +1,554 @@ +{ + "operationId": "AnalyzeTextJobStatus", + "title": "SuccessfulHealthcareDocumentTypeTaskStatusRequest", + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2025-05-15-preview", + "Endpoint": "{Endpoint}", + "jobId": "15e4a46b-62e2-4386-8d36-9c2a92bb45dd" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "createdDateTime": "2022-09-06T23:47:43Z", + "displayName": "Providing Document Type", + "expirationDateTime": "2022-09-07T23:47:43Z", + "jobId": "15e4a46b-62e2-4386-8d36-9c2a92bb45dd", + "lastUpdatedDateTime": "2022-09-06T23:48:10Z", + "status": "succeeded", + "errors": [], + "tasks": { + "completed": 1, + "failed": 0, + "inProgress": 0, + "total": 1, + "items": [ + { + "kind": "HealthcareLROResults", + "lastUpdateDateTime": "2022-09-06T23:48:10.1762027Z", + "status": "succeeded", + "results": { + "documents": [ + { + "id": "a", + "entities": [ + { + "offset": 11, + "length": 5, + "text": "100mg", + "category": "Dosage", + "confidenceScore": 0.98 + }, + { + "offset": 17, + "length": 9, + "text": "ibuprofen", + "category": "MedicationName", + "confidenceScore": 1.0, + "name": "ibuprofen", + "links": [ + { + "dataSource": "UMLS", + "id": "C0020740" + }, + { + "dataSource": "AOD", + "id": "0000019879" + }, + { + "dataSource": "ATC", + "id": "M01AE01" + }, + { + "dataSource": "CCPSS", + "id": "0046165" + }, + { + "dataSource": "CHV", + "id": "0000006519" + }, + { + "dataSource": "CSP", + "id": "2270-2077" + }, + { + "dataSource": "DRUGBANK", + "id": "DB01050" + }, + { + "dataSource": "GS", + "id": "1611" + }, + { + "dataSource": "LCH_NW", + "id": "sh97005926" + }, + { + "dataSource": "LNC", + "id": "LP16165-0" + }, + { + "dataSource": "MEDCIN", + "id": "40458" + }, + { + "dataSource": "MMSL", + "id": "d00015" + }, + { + "dataSource": "MSH", + "id": "D007052" + }, + { + "dataSource": "MTHSPL", + "id": "WK2XYI10QM" + }, + { + "dataSource": "NCI", + "id": "C561" + }, + { + "dataSource": "NCI_CTRP", + "id": "C561" + }, + { + "dataSource": "NCI_DCP", + "id": "00803" + }, + { + "dataSource": "NCI_DTP", + "id": "NSC0256857" + }, + { + "dataSource": "NCI_FDA", + "id": "WK2XYI10QM" + }, + { + "dataSource": "NCI_NCI-GLOSS", + "id": "CDR0000613511" + }, + { + "dataSource": "NDDF", + "id": "002377" + }, + { + "dataSource": "PDQ", + "id": "CDR0000040475" + }, + { + "dataSource": "RCD", + "id": "x02MO" + }, + { + "dataSource": "RXNORM", + "id": "5640" + }, + { + "dataSource": "SNM", + "id": "E-7772" + }, + { + "dataSource": "SNMI", + "id": "C-603C0" + }, + { + "dataSource": "SNOMEDCT_US", + "id": "387207008" + }, + { + "dataSource": "USP", + "id": "m39860" + }, + { + "dataSource": "USPMG", + "id": "MTHU000060" + }, + { + "dataSource": "VANDF", + "id": "4017840" + } + ] + }, + { + "offset": 34, + "length": 11, + "text": "twice daily", + "category": "Frequency", + "confidenceScore": 1.0 + } + ], + "relations": [ + { + "confidenceScore": 1.0, + "relationType": "DosageOfMedication", + "entities": [ + { + "ref": "#/results/documents/0/entities/0", + "role": "Dosage" + }, + { + "ref": "#/results/documents/0/entities/1", + "role": "Medication" + } + ] + }, + { + "confidenceScore": 1.0, + "relationType": "FrequencyOfMedication", + "entities": [ + { + "ref": "#/results/documents/0/entities/1", + "role": "Medication" + }, + { + "ref": "#/results/documents/0/entities/2", + "role": "Frequency" + } + ] + } + ], + "warnings": [], + "fhirBundle": { + "resourceType": "Bundle", + "id": "6ee4a7c0-5911-4c4b-bea2-3c2a1fe5c65f", + "meta": { + "profile": [ + "http://hl7.org/fhir/4.0.1/StructureDefinition/Bundle" + ] + }, + "identifier": { + "system": "urn:ietf:rfc:3986", + "value": "urn:uuid:6ee4a7c0-5911-4c4b-bea2-3c2a1fe5c65f" + }, + "type": "document", + "entry": [ + { + "fullUrl": "Composition/5bd33290-b92e-4aa5-becf-535578207946", + "resource": { + "resourceType": "Composition", + "id": "5bd33290-b92e-4aa5-becf-535578207946", + "status": "final", + "type": { + "coding": [ + { + "system": "http://loinc.org", + "code": "18842-5", + "display": "Discharge summary" + } + ], + "text": "Discharge summary" + }, + "subject": { + "reference": "Patient/efcccdf7-87f0-4061-b553-09fc11734594", + "type": "Patient" + }, + "encounter": { + "reference": "Encounter/76214457-f94c-4ccf-95ef-ab31e7232d63", + "type": "Encounter", + "display": "unknown" + }, + "date": "2022-09-06", + "author": [ + { + "reference": "Practitioner/bba2dee3-2eb3-4973-b4b9-62d498b17046", + "type": "Practitioner", + "display": "Unknown" + } + ], + "title": "Discharge summary", + "section": [ + { + "title": "General", + "code": { + "coding": [ + { + "system": "", + "display": "Unrecognized Section" + } + ], + "text": "General" + }, + "text": { + "status": "additional", + "div": "
\r\n\t\t\t\t\t\t\t

General

\r\n\t\t\t\t\t\t\t

Prescribed 100mg ibuprofen, taken twice daily.

\r\n\t\t\t\t\t
" + }, + "entry": [ + { + "reference": "List/6d743a3e-e7a2-4cee-a0b5-64361b6c93ad", + "type": "List", + "display": "General" + } + ] + } + ] + } + }, + { + "fullUrl": "Practitioner/bba2dee3-2eb3-4973-b4b9-62d498b17046", + "resource": { + "resourceType": "Practitioner", + "id": "bba2dee3-2eb3-4973-b4b9-62d498b17046", + "name": [ + { + "text": "Unknown", + "family": "Unknown" + } + ] + } + }, + { + "fullUrl": "Patient/efcccdf7-87f0-4061-b553-09fc11734594", + "resource": { + "resourceType": "Patient", + "id": "efcccdf7-87f0-4061-b553-09fc11734594", + "gender": "unknown" + } + }, + { + "fullUrl": "Encounter/76214457-f94c-4ccf-95ef-ab31e7232d63", + "resource": { + "resourceType": "Encounter", + "id": "76214457-f94c-4ccf-95ef-ab31e7232d63", + "meta": { + "profile": [ + "http://hl7.org/fhir/us/core/StructureDefinition/us-core-encounter" + ] + }, + "status": "finished", + "class": { + "system": "http://terminology.hl7.org/CodeSystem/v3-ActCode", + "display": "unknown" + }, + "subject": { + "reference": "Patient/efcccdf7-87f0-4061-b553-09fc11734594", + "type": "Patient" + }, + "period": { + "start": "2022-09-06", + "end": "2022-09-06" + } + } + }, + { + "fullUrl": "MedicationStatement/ac0264b6-63b7-4cf2-a7c3-f7340788aca7", + "resource": { + "resourceType": "MedicationStatement", + "id": "ac0264b6-63b7-4cf2-a7c3-f7340788aca7", + "extension": [ + { + "extension": [ + { + "url": "offset", + "valueInteger": 17 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "status": "active", + "medicationCodeableConcept": { + "coding": [ + { + "system": "http://www.nlm.nih.gov/research/umls", + "code": "C0020740", + "display": "ibuprofen" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/aod", + "code": "0000019879" + }, + { + "system": "http://www.whocc.no/atc", + "code": "M01AE01" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/ccpss", + "code": "0046165" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/chv", + "code": "0000006519" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/csp", + "code": "2270-2077" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/drugbank", + "code": "DB01050" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/gs", + "code": "1611" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/lch_nw", + "code": "sh97005926" + }, + { + "system": "http://loinc.org", + "code": "LP16165-0" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/medcin", + "code": "40458" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/mmsl", + "code": "d00015" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/msh", + "code": "D007052" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/mthspl", + "code": "WK2XYI10QM" + }, + { + "system": "http://ncimeta.nci.nih.gov", + "code": "C561" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nci_ctrp", + "code": "C561" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nci_dcp", + "code": "00803" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nci_dtp", + "code": "NSC0256857" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nci_fda", + "code": "WK2XYI10QM" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nci_nci-gloss", + "code": "CDR0000613511" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nddf", + "code": "002377" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/pdq", + "code": "CDR0000040475" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/rcd", + "code": "x02MO" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/rxnorm", + "code": "5640" + }, + { + "system": "http://snomed.info/sct", + "code": "E-7772" + }, + { + "system": "http://snomed.info/sct", + "code": "C-603C0" + }, + { + "system": "http://snomed.info/sct", + "code": "387207008" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/usp", + "code": "m39860" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/uspmg", + "code": "MTHU000060" + }, + { + "system": "http://hl7.org/fhir/ndfrt", + "code": "4017840" + } + ], + "text": "ibuprofen" + }, + "subject": { + "reference": "Patient/efcccdf7-87f0-4061-b553-09fc11734594", + "type": "Patient" + }, + "context": { + "reference": "Encounter/76214457-f94c-4ccf-95ef-ab31e7232d63", + "type": "Encounter", + "display": "unknown" + }, + "dosage": [ + { + "text": "100mg", + "timing": { + "repeat": { + "frequency": 2, + "period": 1, + "periodUnit": "d" + }, + "code": { + "text": "twice daily" + } + }, + "doseAndRate": [ + { + "doseQuantity": { + "value": 100 + } + } + ] + } + ] + } + }, + { + "fullUrl": "List/6d743a3e-e7a2-4cee-a0b5-64361b6c93ad", + "resource": { + "resourceType": "List", + "id": "6d743a3e-e7a2-4cee-a0b5-64361b6c93ad", + "status": "current", + "mode": "snapshot", + "title": "General", + "subject": { + "reference": "Patient/efcccdf7-87f0-4061-b553-09fc11734594", + "type": "Patient" + }, + "encounter": { + "reference": "Encounter/76214457-f94c-4ccf-95ef-ab31e7232d63", + "type": "Encounter", + "display": "unknown" + }, + "entry": [ + { + "item": { + "reference": "MedicationStatement/ac0264b6-63b7-4cf2-a7c3-f7340788aca7", + "type": "MedicationStatement", + "display": "ibuprofen" + } + } + ] + } + } + ] + } + } + ], + "errors": [], + "modelVersion": "2022-03-01" + } + } + ] + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeText/preview/2025-05-15-preview/examples/SuccessfulHealthcarePostRequest.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeText/preview/2025-05-15-preview/examples/SuccessfulHealthcarePostRequest.json new file mode 100644 index 000000000000..30793bfedaf2 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeText/preview/2025-05-15-preview/examples/SuccessfulHealthcarePostRequest.json @@ -0,0 +1,36 @@ +{ + "operationId": "AnalyzeTextSubmitJob", + "title": "SuccessfulHealthcarePostRequest", + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2025-05-15-preview", + "Endpoint": "{Endpoint}", + "jobId": "{Job ID}", + "body": { + "analysisInput": { + "documents": [ + { + "text": "Prescribed 100mg ibuprofen, taken twice daily.", + "id": "1", + "language": "en" + } + ] + }, + "tasks": [ + { + "kind": "Healthcare", + "parameters": { + "modelVersion": "latest" + } + } + ] + } + }, + "responses": { + "202": { + "headers": { + "Operation-Location": "{Endpoint}/language/analyze-text/jobs/{jobId}?api-version=2025-05-15-preview" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeText/preview/2025-05-15-preview/examples/SuccessfulHealthcareTaskStatusRequest.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeText/preview/2025-05-15-preview/examples/SuccessfulHealthcareTaskStatusRequest.json new file mode 100644 index 000000000000..c6c7999f9355 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeText/preview/2025-05-15-preview/examples/SuccessfulHealthcareTaskStatusRequest.json @@ -0,0 +1,222 @@ +{ + "operationId": "AnalyzeTextJobStatus", + "title": "SuccessfulHealthcareTaskStatusRequest", + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2025-05-15-preview", + "Endpoint": "{Endpoint}", + "jobId": "1780194a-e9c1-4298-b0d4-fdc59ba818a0" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "createdDateTime": "2022-07-20T18:43:35Z", + "displayName": "Extracting Location & US Region", + "expirationDateTime": "2022-07-21T18:43:35Z", + "jobId": "1780194a-e9c1-4298-b0d4-fdc59ba818a0", + "lastUpdatedDateTime": "2022-07-20T18:43:36Z", + "status": "succeeded", + "tasks": { + "completed": 1, + "failed": 0, + "inProgress": 0, + "total": 1, + "items": [ + { + "kind": "HealthcareLROResults", + "lastUpdateDateTime": "2022-07-20T18:43:36.7159045Z", + "status": "succeeded", + "results": { + "documents": [ + { + "id": "1", + "entities": [ + { + "offset": 11, + "length": 5, + "text": "100mg", + "category": "Dosage", + "confidenceScore": 0.98 + }, + { + "offset": 17, + "length": 9, + "text": "ibuprofen", + "category": "MedicationName", + "confidenceScore": 1, + "name": "ibuprofen", + "links": [ + { + "dataSource": "UMLS", + "id": "C0020740" + }, + { + "dataSource": "AOD", + "id": "0000019879" + }, + { + "dataSource": "ATC", + "id": "M01AE01" + }, + { + "dataSource": "CCPSS", + "id": "0046165" + }, + { + "dataSource": "CHV", + "id": "0000006519" + }, + { + "dataSource": "CSP", + "id": "2270-2077" + }, + { + "dataSource": "DRUGBANK", + "id": "DB01050" + }, + { + "dataSource": "GS", + "id": "1611" + }, + { + "dataSource": "LCH_NW", + "id": "sh97005926" + }, + { + "dataSource": "LNC", + "id": "LP16165-0" + }, + { + "dataSource": "MEDCIN", + "id": "40458" + }, + { + "dataSource": "MMSL", + "id": "d00015" + }, + { + "dataSource": "MSH", + "id": "D007052" + }, + { + "dataSource": "MTHSPL", + "id": "WK2XYI10QM" + }, + { + "dataSource": "NCI", + "id": "C561" + }, + { + "dataSource": "NCI_CTRP", + "id": "C561" + }, + { + "dataSource": "NCI_DCP", + "id": "00803" + }, + { + "dataSource": "NCI_DTP", + "id": "NSC0256857" + }, + { + "dataSource": "NCI_FDA", + "id": "WK2XYI10QM" + }, + { + "dataSource": "NCI_NCI-GLOSS", + "id": "CDR0000613511" + }, + { + "dataSource": "NDDF", + "id": "002377" + }, + { + "dataSource": "PDQ", + "id": "CDR0000040475" + }, + { + "dataSource": "RCD", + "id": "x02MO" + }, + { + "dataSource": "RXNORM", + "id": "5640" + }, + { + "dataSource": "SNM", + "id": "E-7772" + }, + { + "dataSource": "SNMI", + "id": "C-603C0" + }, + { + "dataSource": "SNOMEDCT_US", + "id": "387207008" + }, + { + "dataSource": "USP", + "id": "m39860" + }, + { + "dataSource": "USPMG", + "id": "MTHU000060" + }, + { + "dataSource": "VANDF", + "id": "4017840" + } + ] + }, + { + "offset": 34, + "length": 11, + "text": "twice daily", + "category": "Frequency", + "confidenceScore": 1 + } + ], + "relations": [ + { + "confidenceScore": 1, + "relationType": "DosageOfMedication", + "entities": [ + { + "ref": "#/results/documents/0/entities/0", + "role": "Dosage" + }, + { + "ref": "#/results/documents/0/entities/1", + "role": "Medication" + } + ] + }, + { + "confidenceScore": 1, + "relationType": "FrequencyOfMedication", + "entities": [ + { + "ref": "#/results/documents/0/entities/1", + "role": "Medication" + }, + { + "ref": "#/results/documents/0/entities/2", + "role": "Frequency" + } + ] + } + ], + "warnings": [] + } + ], + "errors": [], + "modelVersion": "2022-03-01" + } + } + ] + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeText/preview/2025-05-15-preview/examples/SuccessfulKeyPhraseExtractionRequest.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeText/preview/2025-05-15-preview/examples/SuccessfulKeyPhraseExtractionRequest.json new file mode 100644 index 000000000000..1ce055cfabbf --- /dev/null +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeText/preview/2025-05-15-preview/examples/SuccessfulKeyPhraseExtractionRequest.json @@ -0,0 +1,73 @@ +{ + "operationId": "AnalyzeText", + "title": "SuccessfulKeyPhraseExtractionRequest", + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2025-05-15-preview", + "Endpoint": "{Endpoint}", + "body": { + "kind": "KeyPhraseExtraction", + "parameters": { + "modelVersion": "latest" + }, + "analysisInput": { + "documents": [ + { + "id": "1", + "language": "en", + "text": "Microsoft was founded by Bill Gates and Paul Allen." + }, + { + "id": "2", + "language": "en", + "text": "Text Analytics is one of the Azure Cognitive Services." + }, + { + "id": "3", + "language": "en", + "text": "My cat might need to see a veterinarian." + } + ] + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "kind": "KeyPhraseExtractionResults", + "results": { + "documents": [ + { + "id": "1", + "keyPhrases": [ + "Bill Gates", + "Paul Allen", + "Microsoft" + ], + "warnings": [] + }, + { + "id": "2", + "keyPhrases": [ + "Azure Cognitive Services", + "Text Analytics" + ], + "warnings": [] + }, + { + "id": "3", + "keyPhrases": [ + "cat", + "veterinarian" + ], + "warnings": [] + } + ], + "errors": [], + "modelVersion": "2021-06-01" + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeText/preview/2025-05-15-preview/examples/SuccessfulLanguageDetectionRequest.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeText/preview/2025-05-15-preview/examples/SuccessfulLanguageDetectionRequest.json new file mode 100644 index 000000000000..c1de4b0e4cec --- /dev/null +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeText/preview/2025-05-15-preview/examples/SuccessfulLanguageDetectionRequest.json @@ -0,0 +1,93 @@ +{ + "operationId": "AnalyzeText", + "title": "SuccessfulLanguageDetectionRequest", + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2025-05-15-preview", + "Endpoint": "{Endpoint}", + "body": { + "kind": "LanguageDetection", + "parameters": { + "modelVersion": "latest" + }, + "analysisInput": { + "documents": [ + { + "id": "1", + "text": "Hello world" + }, + { + "id": "2", + "text": "Bonjour tout le monde" + }, + { + "id": "3", + "text": "Hola mundo" + }, + { + "id": "4", + "text": "Tumhara naam kya hai?" + } + ] + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "kind": "LanguageDetectionResults", + "results": { + "documents": [ + { + "detectedLanguage": { + "confidenceScore": 1, + "iso6391Name": "en", + "name": "English", + "scriptName": "Latin", + "scriptIso15924Code": "Latn" + }, + "id": "1", + "warnings": [] + }, + { + "detectedLanguage": { + "confidenceScore": 1, + "iso6391Name": "fr", + "name": "French", + "scriptName": "Latin", + "scriptIso15924Code": "Latn" + }, + "id": "2", + "warnings": [] + }, + { + "detectedLanguage": { + "confidenceScore": 1, + "iso6391Name": "es", + "name": "Spanish", + "scriptName": "Latin", + "scriptIso15924Code": "Latn" + }, + "id": "3", + "warnings": [] + }, + { + "detectedLanguage": { + "confidenceScore": 1, + "iso6391Name": "hi", + "name": "Hindi", + "scriptName": "Latin", + "scriptIso15924Code": "Latn" + }, + "id": "4", + "warnings": [] + } + ], + "errors": [], + "modelVersion": "2023-12-01" + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeText/preview/2025-05-15-preview/examples/SuccessfulPiiEntityRecognitionExclusionRequest.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeText/preview/2025-05-15-preview/examples/SuccessfulPiiEntityRecognitionExclusionRequest.json new file mode 100644 index 000000000000..0aee08e7cbe8 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeText/preview/2025-05-15-preview/examples/SuccessfulPiiEntityRecognitionExclusionRequest.json @@ -0,0 +1,101 @@ +{ + "operationId": "AnalyzeText", + "title": "SuccessfulPiiEntityRecognitionExclusionRequest", + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2025-05-15-preview", + "Endpoint": "{Endpoint}", + "body": { + "kind": "PiiEntityRecognition", + "parameters": { + "modelVersion": "latest", + "excludePiiCategories": [ + "USSocialSecurityNumber" + ] + }, + "analysisInput": { + "documents": [ + { + "id": "1", + "language": "en", + "text": "My SSN is 859-98-0987" + }, + { + "id": "2", + "language": "en", + "text": "Your ABA number - 111000025 - is the first 9 digits in the lower left hand corner of your personal check." + }, + { + "id": "3", + "language": "en", + "text": "Is 998.214.865-68 your Brazilian CPF number?" + } + ] + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "kind": "PiiEntityRecognitionResults", + "results": { + "documents": [ + { + "id": "2", + "redactedText": "Your ABA number - ********* - is the first 9 digits in the lower left hand corner of your personal check.", + "entities": [ + { + "category": "ABARoutingNumber", + "type": "ABARoutingNumber", + "confidenceScore": 0.75, + "length": 9, + "offset": 18, + "text": "111000025", + "tags": [ + { + "name": "Number", + "confidenceScore": 0.8 + }, + { + "name": "Numeric", + "confidenceScore": 0.8 + } + ] + } + ], + "warnings": [] + }, + { + "id": "3", + "redactedText": "Is ************** your Brazilian CPF number?", + "entities": [ + { + "category": "BRCPFNumber", + "type": "BRCPFNumber", + "confidenceScore": 0.85, + "length": 14, + "offset": 3, + "text": "998.214.865-68", + "tags": [ + { + "name": "Number", + "confidenceScore": 0.8 + }, + { + "name": "Numeric", + "confidenceScore": 0.8 + } + ] + } + ], + "warnings": [] + } + ], + "errors": [], + "modelVersion": "2021-01-15" + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeText/preview/2025-05-15-preview/examples/SuccessfulPiiEntityRecognitionMaskedEntities.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeText/preview/2025-05-15-preview/examples/SuccessfulPiiEntityRecognitionMaskedEntities.json new file mode 100644 index 000000000000..e4ef9df573d8 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeText/preview/2025-05-15-preview/examples/SuccessfulPiiEntityRecognitionMaskedEntities.json @@ -0,0 +1,82 @@ +{ + "operationId": "AnalyzeText", + "title": "SuccessfulPiiEntityRecognitionMaskedEntitiesRequest", + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2025-05-15-preview", + "Endpoint": "{Endpoint}", + "body": { + "kind": "PiiEntityRecognition", + "parameters": { + "modelVersion": "latest", + "redactionPolicy": { + "policyKind": "entityMask" + } + }, + "analysisInput": { + "documents": [ + { + "id": "1", + "language": "en", + "text": "My name is John Doe My phone number is 424 878 9192" + } + ] + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "kind": "PiiEntityRecognitionResults", + "results": { + "documents": [ + { + "id": "1", + "redactedText": "My name is [PERSON_1] My phone number is [PHONENUMBER_1]", + "entities": [ + { + "category": "Person", + "type": "Person", + "tags": [ + { + "name": "Person", + "confidenceScore": 0.65 + } + ], + "length": 8, + "offset": 11, + "mask": "[Person_1]", + "maskOffset": 11, + "maskLength": 9, + "text": "John Doe", + "confidenceScore": 0.65 + }, + { + "category": "PhoneNumber", + "type": "PhoneNumber", + "tags": [ + { + "name": "PhoneNumber", + "confidenceScore": 0.8 + } + ], + "length": 12, + "offset": 36, + "mask": "[PHONENUMBER_1]", + "maskOffset": 41, + "maskLength": 13, + "text": "424 878 9192", + "confidenceScore": 0.8 + } + ], + "warnings": [] + } + ], + "errors": [], + "modelVersion": "2021-01-15" + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeText/preview/2025-05-15-preview/examples/SuccessfulPiiEntityRecognitionRedactionPolicyRequest.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeText/preview/2025-05-15-preview/examples/SuccessfulPiiEntityRecognitionRedactionPolicyRequest.json new file mode 100644 index 000000000000..a9e6150507c8 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeText/preview/2025-05-15-preview/examples/SuccessfulPiiEntityRecognitionRedactionPolicyRequest.json @@ -0,0 +1,127 @@ +{ + "operationId": "AnalyzeText", + "title": "SuccessfulPiiEntityRecognitionRedactionPolicyRequest", + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2025-05-15-preview", + "Endpoint": "{Endpoint}", + "body": { + "kind": "PiiEntityRecognition", + "parameters": { + "modelVersion": "latest", + "redactionPolicy": { + "policyKind": "characterMask", + "redactionCharacter": "-" + } + }, + "analysisInput": { + "documents": [ + { + "id": "1", + "language": "en", + "text": "My SSN is 859-98-0987" + }, + { + "id": "2", + "language": "en", + "text": "Your ABA number - 111000025 - is the first 9 digits in the lower left hand corner of your personal check." + }, + { + "id": "3", + "language": "en", + "text": "Is 998.214.865-68 your Brazilian CPF number?" + } + ] + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "kind": "PiiEntityRecognitionResults", + "results": { + "documents": [ + { + "id": "1", + "redactedText": "My SSN is -----------", + "entities": [ + { + "category": "USSocialSecurityNumber", + "type": "USSocialSecurityNumber", + "confidenceScore": 0.65, + "length": 11, + "offset": 28, + "text": "859-98-0987", + "tags": [ + { + "name": "Number", + "confidenceScore": 0.8 + }, + { + "name": "Numeric", + "confidenceScore": 0.8 + } + ] + } + ], + "warnings": [] + }, + { + "id": "2", + "redactedText": "Your ABA number - --------- - is the first 9 digits in the lower left hand corner of your personal check.", + "entities": [ + { + "category": "ABARoutingNumber", + "type": "ABARoutingNumber", + "confidenceScore": 0.75, + "length": 9, + "offset": 18, + "text": "111000025", + "tags": [ + { + "name": "Number", + "confidenceScore": 0.8 + }, + { + "name": "Numeric", + "confidenceScore": 0.8 + } + ] + } + ], + "warnings": [] + }, + { + "id": "3", + "redactedText": "Is -------------- your Brazilian CPF number?", + "entities": [ + { + "category": "BRCPFNumber", + "type": "", + "confidenceScore": 0.85, + "length": 14, + "offset": 3, + "text": "998.214.865-68", + "tags": [ + { + "name": "Number", + "confidenceScore": 0.8 + }, + { + "name": "Numeric", + "confidenceScore": 0.8 + } + ] + } + ], + "warnings": [] + } + ], + "errors": [], + "modelVersion": "2021-01-15" + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeText/preview/2025-05-15-preview/examples/SuccessfulPiiEntityRecognitionRequest.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeText/preview/2025-05-15-preview/examples/SuccessfulPiiEntityRecognitionRequest.json new file mode 100644 index 000000000000..a293143bcfaa --- /dev/null +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeText/preview/2025-05-15-preview/examples/SuccessfulPiiEntityRecognitionRequest.json @@ -0,0 +1,123 @@ +{ + "operationId": "AnalyzeText", + "title": "SuccessfulPiiEntityRecognitionRequest", + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2025-05-15-preview", + "Endpoint": "{Endpoint}", + "body": { + "kind": "PiiEntityRecognition", + "parameters": { + "modelVersion": "latest" + }, + "analysisInput": { + "documents": [ + { + "id": "1", + "language": "en", + "text": "My SSN is 859-98-0987" + }, + { + "id": "2", + "language": "en", + "text": "Your ABA number - 111000025 - is the first 9 digits in the lower left hand corner of your personal check." + }, + { + "id": "3", + "language": "en", + "text": "Is 998.214.865-68 your Brazilian CPF number?" + } + ] + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "kind": "PiiEntityRecognitionResults", + "results": { + "documents": [ + { + "id": "1", + "redactedText": "My SSN is ***********", + "entities": [ + { + "category": "USSocialSecurityNumber", + "type": "USSocialSecurityNumber", + "confidenceScore": 0.65, + "length": 11, + "offset": 28, + "text": "859-98-0987", + "tags": [ + { + "name": "Number", + "confidenceScore": 0.8 + }, + { + "name": "Numeric", + "confidenceScore": 0.8 + } + ] + } + ], + "warnings": [] + }, + { + "id": "2", + "redactedText": "Your ABA number - ********* - is the first 9 digits in the lower left hand corner of your personal check.", + "entities": [ + { + "category": "ABARoutingNumber", + "type": "ABARoutingNumber", + "confidenceScore": 0.75, + "length": 9, + "offset": 18, + "text": "111000025", + "tags": [ + { + "name": "Number", + "confidenceScore": 0.8 + }, + { + "name": "Numeric", + "confidenceScore": 0.8 + } + ] + } + ], + "warnings": [] + }, + { + "id": "3", + "redactedText": "Is ************** your Brazilian CPF number?", + "entities": [ + { + "category": "BRCPFNumber", + "type": "BRCPFNumber", + "confidenceScore": 0.85, + "length": 14, + "offset": 3, + "text": "998.214.865-68", + "tags": [ + { + "name": "Number", + "confidenceScore": 0.8 + }, + { + "name": "Numeric", + "confidenceScore": 0.8 + } + ] + } + ], + "warnings": [] + } + ], + "errors": [], + "modelVersion": "2021-01-15" + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeText/preview/2025-05-15-preview/examples/SuccessfulSentimentAnalysisRequest.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeText/preview/2025-05-15-preview/examples/SuccessfulSentimentAnalysisRequest.json new file mode 100644 index 000000000000..e64a31f70ffd --- /dev/null +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeText/preview/2025-05-15-preview/examples/SuccessfulSentimentAnalysisRequest.json @@ -0,0 +1,150 @@ +{ + "operationId": "AnalyzeText", + "title": "SuccessfulSentimentAnalysisRequest", + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2025-05-15-preview", + "Endpoint": "{Endpoint}", + "body": { + "kind": "SentimentAnalysis", + "parameters": { + "modelVersion": "latest" + }, + "analysisInput": { + "documents": [ + { + "id": "1", + "language": "en", + "text": "Great atmosphere. Close to plenty of restaurants, hotels, and transit! Staff are friendly and helpful." + } + ] + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "kind": "SentimentAnalysisResults", + "results": { + "documents": [ + { + "confidenceScores": { + "negative": 0, + "neutral": 0, + "positive": 1 + }, + "id": "1", + "sentences": [ + { + "targets": [ + { + "confidenceScores": { + "negative": 0, + "positive": 1 + }, + "length": 10, + "offset": 6, + "relations": [ + { + "ref": "#/documents/0/sentences/0/assessments/0", + "relationType": "assessment" + } + ], + "sentiment": "positive", + "text": "atmosphere" + } + ], + "confidenceScores": { + "negative": 0, + "neutral": 0, + "positive": 1 + }, + "length": 17, + "offset": 0, + "assessments": [ + { + "confidenceScores": { + "negative": 0, + "positive": 1 + }, + "isNegated": false, + "length": 5, + "offset": 0, + "sentiment": "positive", + "text": "great" + } + ], + "sentiment": "positive", + "text": "Great atmosphere." + }, + { + "targets": [ + { + "confidenceScores": { + "negative": 0.01, + "positive": 0.99 + }, + "length": 11, + "offset": 37, + "relations": [ + { + "ref": "#/documents/0/sentences/1/assessments/0", + "relationType": "assessment" + } + ], + "sentiment": "positive", + "text": "restaurants" + }, + { + "confidenceScores": { + "negative": 0.01, + "positive": 0.99 + }, + "length": 6, + "offset": 50, + "relations": [ + { + "ref": "#/documents/0/sentences/1/assessments/0", + "relationType": "assessment" + } + ], + "sentiment": "positive", + "text": "hotels" + } + ], + "confidenceScores": { + "negative": 0.01, + "neutral": 0.86, + "positive": 0.13 + }, + "length": 52, + "offset": 18, + "assessments": [ + { + "confidenceScores": { + "negative": 0.01, + "positive": 0.99 + }, + "isNegated": false, + "length": 15, + "offset": 18, + "sentiment": "positive", + "text": "Close to plenty" + } + ], + "sentiment": "neutral", + "text": "Close to plenty of restaurants, hotels, and transit!" + } + ], + "sentiment": "positive", + "warnings": [] + } + ], + "errors": [], + "modelVersion": "2021-10-01" + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeText/readme.md b/specification/cognitiveservices/data-plane/LanguageAnalyzeText/readme.md index 6686bbb96412..c8bb4f1a12fd 100644 --- a/specification/cognitiveservices/data-plane/LanguageAnalyzeText/readme.md +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeText/readme.md @@ -49,6 +49,19 @@ modelerfour: lenient-model-deduplication: true ``` +### Release 2025-05-15-preview + +These settings apply only when `--tag=release_2025_05_15_preview` is specified on the command line. + +``` yaml $(tag) == 'release_2025-05-15-preview' +input-file: + - preview/2025-05-15-preview/analyzetext.json +title: + Microsoft Cognitive Language Service - Text +modelerfour: + lenient-model-deduplication: true +``` + ### Release 2024-11-01 These settings apply only when `--tag=release_2024-11-01` is specified on the command line.