BatchDetectLanguageSentimentsResult

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/oracle/main/json-schema/oracle-batch-detect-language-sentiments-result-schema.json",
  "title": "BatchDetectLanguageSentimentsResult",
  "description": "Result of sentiments detect call.",
  "x-generated": "2026-10-03",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/oracle-aiservicelanguage-api-openapi.yml#/components/schemas/BatchDetectLanguageSentimentsResult",
  "properties": {
    "documents": {
      "description": "List of succeeded document response.",
      "items": {
        "$ref": "#/$defs/SentimentDocumentResult"
      },
      "type": "array"
    },
    "errors": {
      "description": "List of failed document response.",
      "items": {
        "$ref": "#/$defs/DocumentError"
      },
      "type": "array"
    }
  },
  "required": [
    "documents"
  ],
  "type": "object",
  "x-example": "{\n   \"documents\":[\n      {\n         \"key\":\"doc1\",\n         \"documentSentiment\":\"positive\",\n         \"documentScores\":{\n            \"negative\":0.26855493,\n            \"positive\":0.5751328,\n            \"mixed\":0.09402271,\n            \"neutral\":0.062289584\n         },\n         \"sentences\":[\n            {\n               \"text\":\"Zoom interface is really simple and easy to conduct virtual meetings.\",\n               \"sentiment\":\"positive\",\n               \"scores\":{\n                  \"negative\":0.23868282,\n                  \"mixed\":0.09472137,\n                  \"neutral\":0.06964111,\n                  \"positive\":0.5969547\n               }\n            },\n            {\n               \"text\":\"It is very easy to share the Zoom link to join the video conference.\",\n               \"sentiment\":\"positive\",\n               \"scores\":{\n                  \"neutral\":0.05493805,\n                  \"mixed\":0.09332405,\n                  \"positive\":0.5533109,\n                  \"negative\":0.29842702\n               }\n            }\n         ],\n         \"aspects\":[\n            {\n               \"offset\":0,\n               \"length\":14,\n               \"text\":\"Zoom interface\",\n               \"sentiment\":\"Positive\",\n               \"scores\":{\n                  \"Positive\":0.9999999995248146,\n                  \"Negative\":2.817161593827863E-10,\n                  \"Neutral\":0.0,\n                  \"Mixed\":1.934692218890011E-10\n               }\n            },\n            {\n               \"offset\":89,\n               \"length\":5,\n               \"text\":\"share\",\n               \"sentiment\":\"Positive\",\n               \"scores\":{\n                  \"Positive\":0.999999993683772,\n                  \"Negative\":6.183472706922923E-9,\n                  \"Neutral\":1.327550304715308E-10,\n                  \"Mixed\":0.0\n               }\n            },\n            {\n               \"offset\":99,\n               \"length\":9,\n               \"text\":\"Zoom link\",\n               \"sentiment\":\"Positive\",\n               \"scores\":{\n                  \"Positive\":0.9999999308450377,\n                  \"Negative\":6.643560728745649E-8,\n                  \"Neutral\":2.719355103288736E-9,\n                  \"Mixed\":0.0\n               }\n            }\n         ],\n         \"languageCode\":\"en\"\n      },\n      {\n         \"key\":\"doc2\",\n         \"documentSentiment\":\"negative\",\n         \"documentScores\":{\n            \"negative\":0.6570408,\n            \"neutral\":0.043848336,\n            \"positive\":0.24361026,\n            \"mixed\":0.055500623\n         },\n         \"sentences\":[\n            {\n               \"text\":\"In 2020 people worldwide moved to working remotely because of the COVID-19 pandemic.\",\n               \"sentiment\":\"negative\",\n               \"scores\":{\n                  \"neutral\":0.043848336,\n                  \"mixed\":0.055500623,\n                  \"positive\":0.24361026,\n                  \"negative\":0.6570408\n               }\n            }\n         ],\n         \"aspects\":[\n\n         ],\n         \"languageCode\":\"en\"\n      }\n   ],\n   \"errors\":[\n\n   ]\n}\n",
  "$defs": {
    "DocumentError": {
      "description": "Error response for document.",
      "properties": {
        "error": {
          "$ref": "#/$defs/ErrorDetails"
        },
        "key": {
          "description": "Document unique identifier defined by the user.",
          "maxLength": 255,
          "minLength": 1,
          "type": "string"
        }
      },
      "required": [
        "key",
        "error"
      ],
      "type": "object"
    },
    "ErrorDetails": {
      "description": "Error Information.",
      "properties": {
        "code": {
          "description": "A short error code that defines the error, meant for programmatic parsing.",
          "type": "string"
        },
        "message": {
          "description": "A human-readable error string.",
          "type": "string"
        }
      },
      "required": [
        "code",
        "message"
      ]
    },
    "SentimentAspect": {
      "description": "Sentiment aspect object.",
      "properties": {
        "length": {
          "description": "Length of aspect text.",
          "type": "integer"
        },
        "offset": {
          "description": "The number of Unicode code points preceding this entity in the submitted text.",
          "type": "integer"
        },
        "scores": {
          "additionalProperties": {
            "format": "double",
            "type": "number"
          },
          "description": "Scores or confidences for each sentiment.\nExample: `{\"positive\": 1.0, \"negative\": 0.0}`\n",
          "type": "object"
        },
        "sentiment": {
          "description": "The highest-score sentiment for the aspect text.",
          "type": "string"
        },
        "text": {
          "description": "Aspect text.",
          "type": "string"
        }
      },
      "type": "object"
    },
    "SentimentDocumentResult": {
      "description": "The document response for sentiment detect call.",
      "properties": {
        "aspects": {
          "description": "List of detected aspects sentiment.",
          "items": {
            "$ref": "#/$defs/SentimentAspect"
          },
          "type": "array"
        },
        "documentScores": {
          "additionalProperties": {
            "format": "double",
            "type": "number"
          },
          "description": "Scores for each sentiment.\nExample: {\"positive\": 1.0, \"negative\": 0.0}\n",
          "type": "object"
        },
        "documentSentiment": {
          "description": "Document level sentiment.",
          "type": "string"
        },
        "key": {
          "description": "Document unique identifier defined by the user.",
          "type": "string"
        },
        "languageCode": {
          "description": "Language code supported\n- auto : Automatically detect language\n- ar : Arabic\n- pt-BR : Brazilian Portuguese   \n- cs : Czech\n- da : Danish\n- nl : Dutch\n- en : English\n- fi : Finnish\n- fr : French\n- fr-CA : Canadian French     \n- de : German\n- it : Italian\n- ja : Japanese\n- ko : Korean\n- no : Norwegian\n- pl : Polish\n- ro : Romanian\n- zh-CN : Simplified Chinese\n- es : Spanish\n- sv : Swedish\n- zh-TW : Traditional Chinese\n- tr : Turkish\n- el : Greek\n- he : Hebrew\n",
          "maxLength": 5,
          "type": "string"
        },
        "sentences": {
          "description": "List of detected sentences sentiment.",
          "items": {
            "$ref": "#/$defs/SentimentSentence"
          },
          "type": "array"
        }
      },
      "required": [
        "key",
        "aspects",
        "languageCode"
      ],
      "type": "object"
    },
    "SentimentSentence": {
      "description": "Sentiment sentence object.",
      "properties": {
        "length": {
          "description": "Length of sentence text.",
          "type": "integer"
        },
        "offset": {
          "description": "The number of Unicode code points preceding this entity in the submitted text.",
          "type": "integer"
        },
        "scores": {
          "additionalProperties": {
            "format": "double",
            "type": "number"
          },
          "description": "Scores or confidences for each sentiment.\nExample: `{\"positive\": 1.0, \"negative\": 0.0}`\n",
          "type": "object"
        },
        "sentiment": {
          "description": "The highest-score sentiment for the sentence text.",
          "type": "string"
        },
        "text": {
          "description": "Sentence text.",
          "type": "string"
        }
      },
      "type": "object"
    }
  }
}