CreateImageAnalysisBody

Fields

Field	Type	Required	Description and constraints
image	EncodedImageBody	Yes
naturalLanguageQueries	array of string	No	maximum items 8. default []
similarityReference	EncodedImageBody or null	No
recognizeFaces	boolean	No	default false
faceMinimumScore	number	No	minimum -1.0. maximum 1.0. default 0.4
faceMatchesPerFace	integer	No	minimum 1.0. maximum 10.0. default 1
maximumObjects	integer	No	minimum 1.0. maximum 64.0. default 16
maximumFaces	integer	No	minimum 1.0. maximum 32.0. default 8

Additional properties are rejected by this schema.

JSON schema

{
  "properties": {
    "image": {
      "$ref": "#/components/schemas/EncodedImageBody"
    },
    "naturalLanguageQueries": {
      "items": {
        "type": "string"
      },
      "type": "array",
      "maxItems": 8,
      "title": "Naturallanguagequeries",
      "default": []
    },
    "similarityReference": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/EncodedImageBody"
        },
        {
          "type": "null"
        }
      ]
    },
    "recognizeFaces": {
      "type": "boolean",
      "title": "Recognizefaces",
      "default": false
    },
    "faceMinimumScore": {
      "type": "number",
      "maximum": 1.0,
      "minimum": -1.0,
      "title": "Faceminimumscore",
      "default": 0.4
    },
    "faceMatchesPerFace": {
      "type": "integer",
      "maximum": 10.0,
      "minimum": 1.0,
      "title": "Facematchesperface",
      "default": 1
    },
    "maximumObjects": {
      "type": "integer",
      "maximum": 64.0,
      "minimum": 1.0,
      "title": "Maximumobjects",
      "default": 16
    },
    "maximumFaces": {
      "type": "integer",
      "maximum": 32.0,
      "minimum": 1.0,
      "title": "Maximumfaces",
      "default": 8
    }
  },
  "additionalProperties": false,
  "type": "object",
  "required": [
    "image"
  ],
  "title": "CreateImageAnalysisBody"
}

Related models

• EncodedImageBody