Skip to content

[Language] Remove duplication for PreBuiltResult and InputError #23788

New issue

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

Sign up for GitHub

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

Already on GitHub? Sign in to your account

Merged
heaths merged 4 commits into from
May 4, 2023
Merged

[Language] Remove duplication for PreBuiltResult and InputError #23788

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
b3866e0
Remove duplication for PreBuiltResult and InputError
minhanh-phan May 2, 2023
6998006
Remove RequestStatistics in analyzetext.json
minhanh-phan May 2, 2023
19c7e45
Remove additionalProperties
minhanh-phan May 2, 2023
94e1528
Add object type for PreBuiltResult
minhanh-phan May 2, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
93 changes: 10 additions & 83 deletions dev/cognitiveservices/data-plane/Language/analyzetext.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -545,29 +545,6 @@
}
]
},
"PreBuiltResult": {
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "Errors by document id.",
"items": {
"$ref": "#/definitions/DocumentError"
}
},
"statistics": {
"$ref": "#/definitions/RequestStatistics"
},
"modelVersion": {
"type": "string",
"description": "This field indicates which model is used for scoring."
}
},
"required": [
"errors",
"modelVersion"
]
},
"CustomTaskParameters": {
"type": "object",
"description": "Parameters object for a text analysis task using custom models.",
Expand Down Expand Up @@ -598,11 +575,11 @@
"type": "array",
"description": "Errors by document id.",
"items": {
"$ref": "#/definitions/DocumentError"
"$ref": "common.json#/definitions/DocumentError"
}
},
"statistics": {
"$ref": "#/definitions/RequestStatistics"
"$ref": "common.json#/definitions/RequestStatistics"
},
"projectName": {
"type": "string",
Expand Down Expand Up @@ -825,7 +802,7 @@
},
"allOf": [
{
"$ref": "#/definitions/PreBuiltResult"
"$ref": "common.json#/definitions/PreBuiltResult"
}
],
"required": [
Expand Down Expand Up @@ -1168,7 +1145,7 @@
},
"allOf": [
{
"$ref": "#/definitions/PreBuiltResult"
"$ref": "common.json#/definitions/PreBuiltResult"
}
],
"required": [
Expand Down Expand Up @@ -1505,7 +1482,7 @@
},
"allOf": [
{
"$ref": "#/definitions/PreBuiltResult"
"$ref": "common.json#/definitions/PreBuiltResult"
}
],
"required": [
Expand Down Expand Up @@ -1634,7 +1611,7 @@
},
"allOf": [
{
"$ref": "#/definitions/PreBuiltResult"
"$ref": "common.json#/definitions/PreBuiltResult"
}
],
"required": [
Expand Down Expand Up @@ -1803,7 +1780,7 @@
},
"allOf": [
{
"$ref": "#/definitions/PreBuiltResult"
"$ref": "common.json#/definitions/PreBuiltResult"
}
],
"required": [
Expand Down Expand Up @@ -2247,7 +2224,7 @@
},
"allOf": [
{
"$ref": "#/definitions/PreBuiltResult"
"$ref": "common.json#/definitions/PreBuiltResult"
}
],
"required": [
Expand Down Expand Up @@ -2313,7 +2290,7 @@
},
"allOf": [
{
"$ref": "#/definitions/PreBuiltResult"
"$ref": "common.json#/definitions/PreBuiltResult"
}
],
"required": [
Expand Down Expand Up @@ -2395,7 +2372,7 @@
"AnalyzeTextJobStatistics": {
"properties": {
"statistics": {
"$ref": "#/definitions/RequestStatistics"
"$ref": "common.json#/definitions/RequestStatistics"
}
},
"type": "object"
Expand Down Expand Up @@ -2692,24 +2669,6 @@
}
}
},
"DocumentError": {
"type": "object",
"required": [
"id",
"error"
],
"properties": {
"id": {
"type": "string",
"description": "Document Id."
},
"error": {
"type": "object",
"description": "Document Error.",
"$ref": "common.json#/definitions/Error"
}
}
},
"DocumentWarning": {
"type": "object",
"required": [
Expand Down Expand Up @@ -2759,38 +2718,6 @@
},
"description": "if showStats=true was specified in the request this field will contain information about the document payload."
},
"RequestStatistics": {
"type": "object",
"required": [
"documentsCount",
"validDocumentsCount",
"erroneousDocumentsCount",
"transactionsCount"
],
"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."
}
},
"description": "if showStats=true was specified in the request this field will contain information about the request payload."
},
"MultiLanguageInput": {
"type": "object",
"description": "Contains an input document to be analyzed by the service.",
Expand Down
8 changes: 4 additions & 4 deletions dev/cognitiveservices/data-plane/Language/common.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -301,7 +301,7 @@
},
"type": "object"
},
"InputError": {
"DocumentError": {
"type": "object",
"description": "Contains details of errors encountered during a job execution.",
"required": [
Expand All @@ -311,7 +311,7 @@
"properties": {
"id": {
"type": "string",
"description": "The ID of the input."
"description": "The ID of the input document."
},
"error": {
"type": "object",
Expand Down Expand Up @@ -372,16 +372,16 @@
"description": "Number of transactions for the request."
}
},
"additionalProperties": true,
"description": "if showStats=true was specified in the request this field will contain information about the request payload."
},
"PreBuiltResult": {
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "Errors by document id.",
"items": {
"$ref": "#/definitions/InputError"
"$ref": "#/definitions/DocumentError"
}
},
"statistics": {
Expand Down
93 changes: 10 additions & 83 deletions specification/cognitiveservices/data-plane/Language/stable/2023-04-01/analyzetext.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -545,29 +545,6 @@
}
]
},
"PreBuiltResult": {
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "Errors by document id.",
"items": {
"$ref": "#/definitions/DocumentError"
}
},
"statistics": {
"$ref": "#/definitions/RequestStatistics"
},
"modelVersion": {
"type": "string",
"description": "This field indicates which model is used for scoring."
}
},
"required": [
"errors",
"modelVersion"
]
},
"CustomTaskParameters": {
"type": "object",
"description": "Parameters object for a text analysis task using custom models.",
Expand Down Expand Up @@ -598,11 +575,11 @@
"type": "array",
"description": "Errors by document id.",
"items": {
"$ref": "#/definitions/DocumentError"
"$ref": "common.json#/definitions/DocumentError"
}
},
"statistics": {
"$ref": "#/definitions/RequestStatistics"
"$ref": "common.json#/definitions/RequestStatistics"
},
"projectName": {
"type": "string",
Expand Down Expand Up @@ -825,7 +802,7 @@
},
"allOf": [
{
"$ref": "#/definitions/PreBuiltResult"
"$ref": "common.json#/definitions/PreBuiltResult"
}
],
"required": [
Expand Down Expand Up @@ -1168,7 +1145,7 @@
},
"allOf": [
{
"$ref": "#/definitions/PreBuiltResult"
"$ref": "common.json#/definitions/PreBuiltResult"
}
],
"required": [
Expand Down Expand Up @@ -1505,7 +1482,7 @@
},
"allOf": [
{
"$ref": "#/definitions/PreBuiltResult"
"$ref": "common.json#/definitions/PreBuiltResult"
}
],
"required": [
Expand Down Expand Up @@ -1634,7 +1611,7 @@
},
"allOf": [
{
"$ref": "#/definitions/PreBuiltResult"
"$ref": "common.json#/definitions/PreBuiltResult"
}
],
"required": [
Expand Down Expand Up @@ -1803,7 +1780,7 @@
},
"allOf": [
{
"$ref": "#/definitions/PreBuiltResult"
"$ref": "common.json#/definitions/PreBuiltResult"
}
],
"required": [
Expand Down Expand Up @@ -2247,7 +2224,7 @@
},
"allOf": [
{
"$ref": "#/definitions/PreBuiltResult"
"$ref": "common.json#/definitions/PreBuiltResult"
}
],
"required": [
Expand Down Expand Up @@ -2313,7 +2290,7 @@
},
"allOf": [
{
"$ref": "#/definitions/PreBuiltResult"
"$ref": "common.json#/definitions/PreBuiltResult"
}
],
"required": [
Expand Down Expand Up @@ -2395,7 +2372,7 @@
"AnalyzeTextJobStatistics": {
"properties": {
"statistics": {
"$ref": "#/definitions/RequestStatistics"
"$ref": "common.json#/definitions/RequestStatistics"
}
},
"type": "object"
Expand Down Expand Up @@ -2692,24 +2669,6 @@
}
}
},
"DocumentError": {
"type": "object",
"required": [
"id",
"error"
],
"properties": {
"id": {
"type": "string",
"description": "Document Id."
},
"error": {
"type": "object",
"description": "Document Error.",
"$ref": "common.json#/definitions/Error"
}
}
},
"DocumentWarning": {
"type": "object",
"required": [
Expand Down Expand Up @@ -2759,38 +2718,6 @@
},
"description": "if showStats=true was specified in the request this field will contain information about the document payload."
},
"RequestStatistics": {
"type": "object",
"required": [
"documentsCount",
"validDocumentsCount",
"erroneousDocumentsCount",
"transactionsCount"
],
"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."
}
},
"description": "if showStats=true was specified in the request this field will contain information about the request payload."
},
"MultiLanguageInput": {
"type": "object",
"description": "Contains an input document to be analyzed by the service.",
Expand Down
Loading