Get job - Reality Analysis

Reality Analysis

Download API definition:

This API is a Technical Preview and is available for testing purposes only. Do not use in production.

Get job

GET https://dev-api.bentley.com/reality-analysis/jobs/{id}

Retrieve job details.

Authentication

Requires Authorization header with valid Bearer token for scope itwin-platform.

For more documentation on authorization and how to get access token visit OAUTH2 Authorization page.

Request parameters

Yes

Job id

Request headers

Authorization

Yes

OAuth access token with itwin-platform scope

Yes

Setting to application/vnd.bentley.itwin-platform.v2+json is recommended.

Response 200 OK

json

{
    "job": {
        "id": "8ee1aeca-1b3c-4063-a298-042681febcda",
        "state": "Active",
        "userId": "8791f3ca-3313-4c50-b0e7-76b32d0bab9e",
        "executionInfo": {
            "createdDateTime": "2025-08-05T12:38:12Z"
        },
        "specifications": {
            "inputs": {
                "photos": "cf90403c-5d86-4844-85da-66c4aac64572",
                "photoSegmentationDetector": "47c121b3-0b0b-4510-8f9a-d93803de18ab"
            },
            "outputs": {
                "segmentation2D": "a5a0356c-bb72-4149-87ff-8f22908534ee",
                "segmentedPhotos": "4c0e3562-fbbd-4683-987e-b149b8488e4d"
            },
            "options": {
                "computeLineWidth": true,
                "minPhotos": 10
            }
        },
        "name": "Segmentation2D Job",
        "type": "Segmentation2D",
        "iTwinId": "5ad3c614-83aa-41e2-b3f8-fbd6d18b93b9"
    }
}

This response indicates that request lacks valid authentication credentials. Access token might not been provided, issued by the wrong issuer, does not have required scopes or request headers were malformed.

json

{
    "error": {
        "code": "HeaderNotFound",
        "message": "Header Authorization was not found in the request. Access denied."
    }
}

Response 404 Not Found

This response indicates that the specified job was not found.

json

{
    "error": {
        "code": "JobNotFound",
        "message": "Requested job is not available."
    }
}

Response 429 Too many requests

This response indicates that the client sent more requests than allowed by this API for the current tier of the client.

json

{
    "error": {
        "code": "RateLimitExceeded",
        "message": "The client sent more requests than allowed by this API for the current tier of the client."
    }
}

Response headers

retry-after

Number of seconds to wait until client is allowed to make more requests.

Definitions

Job type

Supported job types

Objects2D

String

Segmentation2D

String

Segmentation3D

String

SegmentationOrthophoto

String

ChangeDetection

String

EvalO2D

String

EvalO3D

String

EvalS2D

String

EvalS3D

String

EvalSOrtho

String

TrainingO2D

String

TrainingS3D

String

json

{
    "title": "Job type",
    "description": "Supported job types",
    "enum": [
        "Objects2D",
        "Segmentation2D",
        "Segmentation3D",
        "SegmentationOrthophoto",
        "ChangeDetection",
        "EvalO2D",
        "EvalO3D",
        "EvalS2D",
        "EvalS3D",
        "EvalSOrtho",
        "TrainingO2D",
        "TrainingS3D"
    ]
}

Job State

Job current state.

Queued

String

Active

String

Terminating

String

Cancelled

String

Failed

String

Success

String

json

{
    "title": "Job State",
    "description": "Job current state.",
    "enum": [
        "Queued",
        "Active",
        "Terminating",
        "Cancelled",
        "Failed",
        "Success"
    ],
    "type": "string"
}

Job Response

job

Job

json

{
    "title": "Job Response",
    "type": "object",
    "properties": {
        "job": {
            "$ref": "#/components/schemas/Job"
        }
    },
    "required": [
        "job"
    ],
    "additionalProperties": false
}

Job

Job information.

String

Unique id of the job.

state

JobState

Current state of the job.

userId

String

Identifier of the user that created the job.

executionInfo

ExecutionInformation

Known execution information for the job.

specifications

Any of: Objects2DSpecifications Segmentation2DSpecifications Segmentation3DSpecifications SegmentationOrthophotoSpecifications ChangeDetectionSpecifications EvalO2DSpecifications EvalO3DSpecifications EvalS2DSpecifications EvalS3DSpecifications EvalSOrthoSpecifications TrainingO2DSpecifications TrainingS3DSpecifications

List of inputs, outputs and options for the job, must be in sync with the type.

name

String

Name of the job.

type

JobTypes

Type of the job.

iTwinId

String

iTwin Id for the job.

json

{
    "title": "Job",
    "description": "Job information.",
    "type": "object",
    "properties": {
        "id": {
            "type": "string",
            "description": "Unique id of the job."
        },
        "state": {
            "$ref": "#/components/schemas/JobState",
            "description": "Current state of the job."
        },
        "userId": {
            "type": "string",
            "description": "Identifier of the user that created the job."
        },
        "executionInfo": {
            "$ref": "#/components/schemas/ExecutionInformation",
            "description": "Known execution information for the job."
        },
        "specifications": {
            "anyOf": [
                {
                    "$ref": "#/components/schemas/Objects2DSpecifications"
                },
                {
                    "$ref": "#/components/schemas/Segmentation2DSpecifications"
                },
                {
                    "$ref": "#/components/schemas/Segmentation3DSpecifications"
                },
                {
                    "$ref": "#/components/schemas/SegmentationOrthophotoSpecifications"
                },
                {
                    "$ref": "#/components/schemas/ChangeDetectionSpecifications"
                },
                {
                    "$ref": "#/components/schemas/EvalO2DSpecifications"
                },
                {
                    "$ref": "#/components/schemas/EvalO3DSpecifications"
                },
                {
                    "$ref": "#/components/schemas/EvalS2DSpecifications"
                },
                {
                    "$ref": "#/components/schemas/EvalS3DSpecifications"
                },
                {
                    "$ref": "#/components/schemas/EvalSOrthoSpecifications"
                },
                {
                    "$ref": "#/components/schemas/TrainingO2DSpecifications"
                },
                {
                    "$ref": "#/components/schemas/TrainingS3DSpecifications"
                }
            ],
            "description": "List of inputs, outputs and options for the job, must be in sync with the type."
        },
        "name": {
            "maxLength": 256,
            "minLength": 3,
            "pattern": "^([^\"<>|:*?\\\\/\\u0000-\\u001f])+$",
            "type": "string",
            "description": "Name of the job."
        },
        "type": {
            "$ref": "#/components/schemas/JobTypes",
            "description": "Type of the job."
        },
        "iTwinId": {
            "type": "string",
            "description": "iTwin Id for the job."
        }
    },
    "required": [
        "iTwinId",
        "specifications",
        "type",
        "executionInfo",
        "id",
        "state",
        "userId"
    ],
    "additionalProperties": false
}

Execution Information

Execution information of a job.

startedDateTime

Date-time

Start time of the job.

endedDateTime

Date-time

End time of the job.

createdDateTime

Date-time

Creation time of the job.

estimatedUnits

Number

Estimated number of units consumed by the job.

json

{
    "title": "Execution Information",
    "description": "Execution information of a job.",
    "type": "object",
    "properties": {
        "startedDateTime": {
            "type": "string",
            "format": "date-time",
            "description": "Start time of the job."
        },
        "endedDateTime": {
            "type": "string",
            "format": "date-time",
            "description": "End time of the job."
        },
        "createdDateTime": {
            "type": "string",
            "format": "date-time",
            "description": "Creation time of the job."
        },
        "estimatedUnits": {
            "type": "number",
            "description": "Estimated number of units consumed by the job."
        }
    },
    "required": [
        "createdDateTime"
    ],
    "additionalProperties": false
}

Objects2D Specifications

Specifications for Objects2D job.

inputs

Objects2DInputs

Inputs for the job.

outputs

Objects2DOutputs

Outputs for the job.

options

Objects2DOptions

Options for the job.

json

{
    "title": "Objects2D Specifications",
    "description": "Specifications for Objects2D job.",
    "type": "object",
    "properties": {
        "inputs": {
            "$ref": "#/components/schemas/Objects2DInputs",
            "description": "Inputs for the job."
        },
        "outputs": {
            "$ref": "#/components/schemas/Objects2DOutputs",
            "description": "Outputs for the job."
        },
        "options": {
            "$ref": "#/components/schemas/Objects2DOptions",
            "description": "Options for the job."
        }
    },
    "required": [
        "inputs",
        "outputs"
    ],
    "additionalProperties": false
}

Objects2D Inputs

Following are the different inputs for the job.

model3D

String

Reality data id of ContextScene pointing to a collection of point clouds/meshes to process, or a point cloud, or a mesh.

objects2D

String

Reality data id of ContextScene annotated with embedded 2D objects. This input replaces the photoObjectDetector input.

photoObjectDetector

String

Reality data id of photo object detector or photo object detector identifier from the Detector Library.

photos

String

Reality data id of ContextScene pointing to the photos to process.

json

{
    "title": "Objects2D Inputs",
    "description": "Following are the different inputs for the job.",
    "type": "object",
    "properties": {
        "model3D": {
            "type": "string",
            "description": "Reality data id of ContextScene pointing to a collection of point clouds/meshes to process, or a point cloud, or a mesh."
        },
        "objects2D": {
            "type": "string",
            "description": "Reality data id of ContextScene annotated with embedded 2D objects. This input replaces the `photoObjectDetector` input."
        },
        "photoObjectDetector": {
            "type": "string",
            "description": "Reality data id of photo object detector or photo object detector identifier from the Detector Library."
        },
        "photos": {
            "type": "string",
            "description": "Reality data id of ContextScene pointing to the photos to process."
        }
    },
    "required": [
        "photos"
    ],
    "additionalProperties": false
}

Objects2D Outputs

Following are the different output types for the job.

locations3DAsGeoJSON

String

Reality data id of 3D objects locations as GeoJSON file, objects3d output must be defined.

locations3DAsSHP

String

Reality data id of 3D objects locations as SHP file, objects3d output must be defined.

objects2D

String

Reality data id of ContextScene, annotated with embedded 2D objects.

objects3D

String

Reality data id of ContextScene, annotated with embedded 3D objects.

objects3DAs3DTiles

String

Reality data id of 3D objects as 3D Tiles file, objects3d output must be defined.

objects3DAsGeoJSON

String

Reality data id of 3D objects as GeoJSON file, objects3d output must be defined.

json

{
    "title": "Objects2D Outputs",
    "description": "Following are the different output types for the job.",
    "type": "object",
    "properties": {
        "locations3DAsGeoJSON": {
            "description": "Reality data id of 3D objects locations as GeoJSON file, `objects3d` output must be defined.",
            "type": "string"
        },
        "locations3DAsSHP": {
            "description": "Reality data id of 3D objects locations as SHP file, `objects3d` output must be defined.",
            "type": "string"
        },
        "objects2D": {
            "description": "Reality data id of ContextScene, annotated with embedded 2D objects.",
            "type": "string"
        },
        "objects3D": {
            "description": "Reality data id of ContextScene, annotated with embedded 3D objects.",
            "type": "string"
        },
        "objects3DAs3DTiles": {
            "description": "Reality data id of 3D objects as 3D Tiles file, `objects3d` output must be defined.",
            "type": "string"
        },
        "objects3DAsGeoJSON": {
            "description": "Reality data id of 3D objects as GeoJSON file, `objects3d` output must be defined.",
            "type": "string"
        }
    },
    "additionalProperties": false
}

Objects2D Options

Options for Objects2D job.

crs

String

CRS used by locations3DAsSHP outputs.

maxDist

Number

Maximum distance between photos and 3D objects.

minPhotos

Integer

Minimum number of 2D objects to generate a 3D object.

useTiePoints

Boolean

Improve detection using tie points in oriented photos.

json

{
    "title": "Objects2D Options",
    "description": "Options for Objects2D job.",
    "type": "object",
    "properties": {
        "crs": {
            "description": "CRS used by `locations3DAsSHP` outputs.",
            "type": "string"
        },
        "maxDist": {
            "description": "Maximum distance between photos and 3D objects.",
            "type": "number"
        },
        "minPhotos": {
            "description": "Minimum number of 2D objects to generate a 3D object.",
            "type": "integer"
        },
        "useTiePoints": {
            "description": "Improve detection using tie points in oriented photos.",
            "type": "boolean"
        }
    },
    "additionalProperties": false
}

Segmentation2D Inputs

Following are the different inputs for the job.

model3D

String

Reality data id of ContextScene pointing to a collection of point clouds/meshes to process, or a point cloud, or a mesh.

segmentation2D

String

Reality data id of ContextScene pointing to segmented photos. This input replaces photoSegmentationDetector input.

photoSegmentationDetector

String

Either reality data id of photo segmentation detector or photo segmentation detector identifier from the Detectors Library.

photos

String

Reality data id of the ContextScene pointing to the photos to process.

json

{
    "title": "Segmentation2D Inputs",
    "description": "Following are the different inputs for the job.",
    "type": "object",
    "properties": {
        "model3D": {
            "description": "Reality data id of ContextScene pointing to a collection of point clouds/meshes to process, or a point cloud, or a mesh.",
            "type": "string"
        },
        "segmentation2D": {
            "description": "Reality data id of ContextScene pointing to segmented photos. This input replaces `photoSegmentationDetector` input.",
            "type": "string"
        },
        "photoSegmentationDetector": {
            "description": "Either reality data id of photo segmentation detector or photo segmentation detector identifier from the Detectors Library.",
            "type": "string"
        },
        "photos": {
            "type": "string",
            "description": "Reality data id of the ContextScene pointing to the photos to process."
        }
    },
    "required": [
        "photos"
    ],
    "additionalProperties": false
}

Segmentation2D Options

Options for Segmentation2D job.

computeLineWidth

Boolean

Estimation 3D line width at each vertex.

removeSmallLines

Number

Remove 3D lines with total length smaller than this value.

minPhotos

Integer

Minimum number of 2D detection to generate a 3D detection.

json

{
    "title": "Segmentation2D Options",
    "description": "Options for Segmentation2D job.",
    "type": "object",
    "properties": {
        "computeLineWidth": {
            "description": "Estimation 3D line width at each vertex.",
            "type": "boolean"
        },
        "removeSmallLines": {
            "description": "Remove 3D lines with total length smaller than this value.",
            "type": "number"
        },
        "minPhotos": {
            "description": "Minimum number of 2D detection to generate a 3D detection.",
            "type": "integer"
        }
    },
    "additionalProperties": false
}

Segmentation2D Specifications

Specifications for Segmentation2D job.

inputs

Segmentation2DInputs

Inputs for the job.

outputs

Segmentation2DOutputs

Outputs for the job.

options

Segmentation2DOptions

Options for the job.

json

{
    "title": "Segmentation2D Specifications",
    "description": "Specifications for Segmentation2D job.",
    "type": "object",
    "properties": {
        "inputs": {
            "$ref": "#/components/schemas/Segmentation2DInputs",
            "description": "Inputs for the job."
        },
        "outputs": {
            "$ref": "#/components/schemas/Segmentation2DOutputs",
            "description": "Outputs for the job."
        },
        "options": {
            "$ref": "#/components/schemas/Segmentation2DOptions",
            "description": "Options for the job."
        }
    },
    "required": [
        "inputs",
        "outputs"
    ],
    "additionalProperties": false
}

Segmentation2D Outputs

Following are the different output types.

segmentation2D

String

Reality data id of ContextScene pointing to segmented photos.

segmentedPhotos

String

Reality data id of segmented photos.

lines3D

String

Reality data id of ContextScene annotated with embedded 3D lines.

lines3DAs3DTiles

String

Reality data id of 3D lines as 3D Tiles file, lines3d output must be defined.

lines3DAsGeoJSON

String

Reality data id of 3D lines as GeoJSON file, lines3d output must be defined.

polygons3D

String

Reality data id of ContextScene annotated with embedded 3D polygons.

polygons3DAs3DTiles

String

Reality data id of 3D polygons as 3D Tiles file, polygons3d output must be defined.

polygons3DAsGeoJSON

String

Reality data id of 3D polygons as GeoJSON file, polygons3d output must be defined.

json

{
    "title": "Segmentation2D Outputs",
    "description": "Following are the different output types.",
    "type": "object",
    "properties": {
        "segmentation2D": {
            "description": "Reality data id of ContextScene pointing to segmented photos.",
            "type": "string"
        },
        "segmentedPhotos": {
            "description": "Reality data id of segmented photos.",
            "type": "string"
        },
        "lines3D": {
            "description": "Reality data id of ContextScene annotated with embedded 3D lines.",
            "type": "string"
        },
        "lines3DAs3DTiles": {
            "description": "Reality data id of 3D lines as 3D Tiles file, `lines3d` output must be defined.",
            "type": "string"
        },
        "lines3DAsGeoJSON": {
            "description": "Reality data id of 3D lines as GeoJSON file, `lines3d` output must be defined.",
            "type": "string"
        },
        "polygons3D": {
            "description": "Reality data id of ContextScene annotated with embedded 3D polygons.",
            "type": "string"
        },
        "polygons3DAs3DTiles": {
            "description": "Reality data id of 3D polygons as 3D Tiles file, `polygons3d` output must be defined.",
            "type": "string"
        },
        "polygons3DAsGeoJSON": {
            "description": "Reality data id of 3D polygons as GeoJSON file, `polygons3d` output must be defined.",
            "type": "string"
        }
    },
    "additionalProperties": false
}

SegmentationOrthophoto Inputs

Following are the different inputs for job.

orthophoto

String

Reality data id of ContextScene pointing to orthophotos to process.

orthophotoSegmentationDetector

String

Either reality data id of orthophoto segmentation detector or orthophoto segmentation detector identifier from the Detectors Library.

json

{
    "title": "SegmentationOrthophoto Inputs",
    "description": "Following are the different inputs for job.",
    "type": "object",
    "properties": {
        "orthophoto": {
            "description": "Reality data id of ContextScene pointing to orthophotos to process.",
            "type": "string"
        },
        "orthophotoSegmentationDetector": {
            "type": "string",
            "description": "Either reality data id of orthophoto segmentation detector or orthophoto segmentation detector identifier from the Detectors Library."
        }
    },
    "required": [
        "orthophoto",
        "orthophotoSegmentationDetector"
    ],
    "additionalProperties": false
}

SegmentationOrthophoto Specifications

Specifications for SegmentationOrthophoto job.

inputs

SegmentationOrthophotoInputs

Inputs for the job.

outputs

SegmentationOrthophotoOutputs

Outputs for the job.

json

{
    "title": "SegmentationOrthophoto Specifications",
    "description": "Specifications for SegmentationOrthophoto job.",
    "type": "object",
    "properties": {
        "inputs": {
            "$ref": "#/components/schemas/SegmentationOrthophotoInputs",
            "description": "Inputs for the job."
        },
        "outputs": {
            "$ref": "#/components/schemas/SegmentationOrthophotoOutputs",
            "description": "Outputs for the job."
        }
    },
    "required": [
        "inputs",
        "outputs"
    ],
    "additionalProperties": false
}

SegmentationOrthophoto Outputs

Following are the different output types.

segmentation2D

String

Reality data id of ContextScene pointing to segmented orthophotos.

segmentedPhotos

String

Reality data id of segmented orthophotos.

polygons2D

String

Reality data id of ContextScene annotated with embedded 2D polygons.

polygons2DAsSHP

String

Reality data id of 2D polygons as SHP file, polygons2d output must be defined.

polygons2DAsGeoJSON

String

Reality data id of 2D polygons as GeoJSON file, polygons2d output must be defined.

lines2D

String

Reality data id of ContextScene annotated with embedded 2D lines.

lines2DAsSHP

String

Reality data id of 2D lines as SHP file, lines2d output must be defined.

lines2DAsGeoJSON

String

Reality data id of 2D lines as GeoJSON file, lines2d output must be defined.

json

{
    "title": "SegmentationOrthophoto Outputs",
    "description": "Following are the different output types.",
    "type": "object",
    "properties": {
        "segmentation2D": {
            "description": "Reality data id of ContextScene pointing to segmented orthophotos.",
            "type": "string"
        },
        "segmentedPhotos": {
            "description": "Reality data id of segmented orthophotos.",
            "type": "string"
        },
        "polygons2D": {
            "description": "Reality data id of ContextScene annotated with embedded 2D polygons.",
            "type": "string"
        },
        "polygons2DAsSHP": {
            "description": "Reality data id of 2D polygons as SHP file, `polygons2d` output must be defined.",
            "type": "string"
        },
        "polygons2DAsGeoJSON": {
            "description": "Reality data id of 2D polygons as GeoJSON file, `polygons2d` output must be defined.",
            "type": "string"
        },
        "lines2D": {
            "description": "Reality data id of ContextScene annotated with embedded 2D lines.",
            "type": "string"
        },
        "lines2DAsSHP": {
            "description": "Reality data id of 2D lines as SHP file, `lines2d` output must be defined.",
            "type": "string"
        },
        "lines2DAsGeoJSON": {
            "description": "Reality data id of 2D lines as GeoJSON file, `lines2d` output must be defined.",
            "type": "string"
        }
    },
    "additionalProperties": false
}

ChangeDetection Inputs

Following are the different inputs for the job.

reference

String

Reality data id of ContextScene, point cloud or mesh.

toCompare

String

Reality data id of ContextScene, point cloud or mesh.

json

{
    "title": "ChangeDetection Inputs",
    "description": "Following are the different inputs for the job.",
    "type": "object",
    "properties": {
        "reference": {
            "description": "Reality data id of ContextScene, point cloud or mesh.",
            "type": "string"
        },
        "toCompare": {
            "description": "Reality data id of ContextScene, point cloud or mesh.",
            "type": "string"
        }
    },
    "required": [
        "reference",
        "toCompare"
    ],
    "additionalProperties": false
}

ChangeDetection Options

Options for ChangeDetection job.

filterThreshold

Number

Low threshold to detect spatial changes (hysteresis detection).

meshSamplingResolution

Number

Target point cloud resolution when starting from meshes.

minPointsPerChange

Integer

Minimum number of points in a region to be considered as a change.

outputCrs

String

CRS used by locations3DAsSHP output.

threshold

Number

High threshold to detect spatial changes (hysteresis detection).

json

{
    "title": "ChangeDetection Options",
    "description": "Options for ChangeDetection job.",
    "type": "object",
    "properties": {
        "filterThreshold": {
            "description": "Low threshold to detect spatial changes (hysteresis detection).",
            "type": "number"
        },
        "meshSamplingResolution": {
            "description": "Target point cloud resolution when starting from meshes.",
            "type": "number"
        },
        "minPointsPerChange": {
            "description": "Minimum number of points in a region to be considered as a change.",
            "type": "integer"
        },
        "outputCrs": {
            "description": "CRS used by `locations3DAsSHP` output.",
            "type": "string"
        },
        "threshold": {
            "description": "High threshold to detect spatial changes (hysteresis detection).",
            "type": "number"
        }
    },
    "additionalProperties": false
}

ChangeDetection Specifications

Specifications for ChangeDetection job.

inputs

ChangeDetectionInputs

Inputs for the job.

outputs

ChangeDetectionOutputs

Outputs for the job.

options

ChangeDetectionOptions

Options for the job.

json

{
    "title": "ChangeDetection Specifications",
    "description": "Specifications for ChangeDetection job.",
    "type": "object",
    "properties": {
        "inputs": {
            "$ref": "#/components/schemas/ChangeDetectionInputs",
            "description": "Inputs for the job."
        },
        "outputs": {
            "$ref": "#/components/schemas/ChangeDetectionOutputs",
            "description": "Outputs for the job."
        },
        "options": {
            "$ref": "#/components/schemas/ChangeDetectionOptions",
            "description": "Options for the job."
        }
    },
    "required": [
        "inputs",
        "outputs"
    ],
    "additionalProperties": false
}

ChangeDetection Outputs

Following are the different output types for the job.

added

String

Points in toCompare not in reference as OPC.

removed

String

Points in reference not in toCompare as OPC.

locations3DAsGeoJSON

String

Reality data id of 3D objects locations as GeoJSON file.

locations3DAsSHP

String

Reality data id of 3D objects locations as SHP format.

objects3D

String

Reality data id of ContextScene annotated with embedded 3D objects.

json

{
    "title": "ChangeDetection Outputs",
    "description": "Following are the different output types for the job.",
    "type": "object",
    "properties": {
        "added": {
            "description": "Points in toCompare not in reference as OPC.",
            "type": "string"
        },
        "removed": {
            "description": "Points in reference not in toCompare as OPC.",
            "type": "string"
        },
        "locations3DAsGeoJSON": {
            "description": "Reality data id of 3D objects locations as GeoJSON file.",
            "type": "string"
        },
        "locations3DAsSHP": {
            "description": "Reality data id of 3D objects locations as SHP format.",
            "type": "string"
        },
        "objects3D": {
            "description": "Reality data id of ContextScene annotated with embedded 3D objects.",
            "type": "string"
        }
    },
    "additionalProperties": false
}

Segmentation3D Options

Options for Segmentation3D job.

computeLineWidth

Boolean

Estimation 3D line width at each vertex.

crs

String

CRS used by POD, LAS, LAZ, PLY and SHP outputs.

keepInputResolution

Boolean

To make segmentation 3D output exact same point input.

removeSmallComponents

Number

Remove 3D lines with total length smaller than this value.

saveConfidence

Boolean

Save confidence in 3D segmentation.

json

{
    "title": "Segmentation3D Options",
    "description": "Options for Segmentation3D job.",
    "type": "object",
    "properties": {
        "computeLineWidth": {
            "description": "Estimation 3D line width at each vertex.",
            "type": "boolean"
        },
        "crs": {
            "description": "CRS used by POD, LAS, LAZ, PLY and SHP outputs.",
            "type": "string"
        },
        "keepInputResolution": {
            "description": "To make segmentation 3D output exact same point input.",
            "type": "boolean"
        },
        "removeSmallComponents": {
            "description": "Remove 3D lines with total length smaller than this value.",
            "type": "number"
        },
        "saveConfidence": {
            "description": "Save confidence in 3D segmentation.",
            "type": "boolean"
        }
    },
    "additionalProperties": false
}

Segmentation3D Inputs

Following are the different inputs for the job.

extent

String

Path in the bucket of the clipping polygon to apply.

model3D

String

Reality data id of ContextScene pointing to a collection of point clouds/meshes to process, or a point cloud, or a mesh.

pointCloudSegmentationDetector

String

Either reality data id of point cloud segmentation detector or point cloud segmentation detector identifier from the Detectors Library.

segmentation3D

String

Reality data id of ContextScene pointing to a segmented point cloud, this input replaces pointCloudSegmentationDetector and model3D inputs.

json

{
    "title": "Segmentation3D Inputs",
    "description": "Following are the different inputs for the job.",
    "type": "object",
    "properties": {
        "extent": {
            "description": "Path in the bucket of the clipping polygon to apply.",
            "type": "string",
            "pattern": "^bkt:.+"
        },
        "model3D": {
            "type": "string",
            "description": "Reality data id of ContextScene pointing to a collection of point clouds/meshes to process, or a point cloud, or a mesh."
        },
        "pointCloudSegmentationDetector": {
            "type": "string",
            "description": "Either reality data id of point cloud segmentation detector or point cloud segmentation detector identifier from the Detectors Library."
        },
        "segmentation3D": {
            "type": "string",
            "description": "Reality data id of ContextScene pointing to a segmented point cloud, this input replaces `pointCloudSegmentationDetector` and `model3D` inputs."
        }
    },
    "additionalProperties": false
}

Segmentation3D Specifications

Specifications for Segmentation3D job.

inputs

Segmentation3DInputs

Inputs for the job.

options

Segmentation3DOptions

Options for the job.

outputs

Segmentation3DOutputs

Outputs for the job.

json

{
    "title": "Segmentation3D Specifications",
    "description": "Specifications for Segmentation3D job.",
    "type": "object",
    "properties": {
        "inputs": {
            "$ref": "#/components/schemas/Segmentation3DInputs",
            "description": "Inputs for the job."
        },
        "options": {
            "$ref": "#/components/schemas/Segmentation3DOptions",
            "description": "Options for the job."
        },
        "outputs": {
            "$ref": "#/components/schemas/Segmentation3DOutputs",
            "description": "Outputs for the job."
        }
    },
    "required": [
        "inputs",
        "outputs"
    ],
    "additionalProperties": false
}

Segmentation3D Outputs

Following are the different output types for the job.

lines3D

String

Reality data id of ContextScene annotated with embedded 3D lines.

lines3DAs3DTiles

String

Reality data id of 3D lines as 3D Tiles file, lines3d output must be defined.

lines3DAsGeoJSON

String

Reality data id of 3D lines as GeoJSON file, lines3d output must be defined.

locations3DAsGeoJSON

String

Reality data id of 3D objects locations as GeoJSON file, objects3d output must be defined.

locations3DAsSHP

String

Reality data id of 3D objects locations as SHP file, objects3d output must be defined.

objects3D

String

Reality data id of ContextScene annotated with embedded 3D objects.

objects3DAs3DTiles

String

Reality data id of 3D objects as 3D Tiles file, objects3d output must be defined.

objects3DAsGeoJSON

String

Reality data id of 3D objects as GeoJSON file, objects3d output must be defined.

polygons3D

String

Reality data id of ContextScene annotated with embedded 3D polygons.

polygons3DAs3DTiles

String

Reality data id of 3D polygons as 3D Tiles file, polygons3d output must be defined.

polygons3DAsGeoJSON

String

Reality data id of 3D polygons as GeoJSON file, polygons3d output must be defined.

segmentation3D

String

Reality data id of ContextScene pointing to the segmented point cloud.

segmentation3DAsLAS

String

Reality data id of the segmented point cloud as LAS file, segmentation3D output must be defined.

segmentation3DAsLAZ

String

Reality data id of the segmented point cloud as LAZ file, segmentation3D output must be defined.

segmentation3DAsPLY

String

Reality data id of the segmented point cloud as PLY file, segmentation3D output must be defined.

segmentation3DAsPOD

String

Reality data id of the segmented point cloud as POD file, segmentation3D output must be defined.

segmentedPointCloud

String

Reality data id of the 3D segmentation as OPC file.

json

{
    "title": "Segmentation3D Outputs",
    "description": "Following are the different output types for the job.",
    "type": "object",
    "properties": {
        "lines3D": {
            "description": "Reality data id of ContextScene annotated with embedded 3D lines.",
            "type": "string"
        },
        "lines3DAs3DTiles": {
            "description": "Reality data id of 3D lines as 3D Tiles file, `lines3d` output must be defined.",
            "type": "string"
        },
        "lines3DAsGeoJSON": {
            "description": "Reality data id of 3D lines as GeoJSON file, `lines3d` output must be defined.",
            "type": "string"
        },
        "locations3DAsGeoJSON": {
            "description": "Reality data id of 3D objects locations as GeoJSON file, `objects3d` output must be defined.",
            "type": "string"
        },
        "locations3DAsSHP": {
            "description": "Reality data id of 3D objects locations as SHP file, `objects3d` output must be defined.",
            "type": "string"
        },
        "objects3D": {
            "description": "Reality data id of ContextScene annotated with embedded 3D objects.",
            "type": "string"
        },
        "objects3DAs3DTiles": {
            "description": "Reality data id of 3D objects as 3D Tiles file, `objects3d` output must be defined.",
            "type": "string"
        },
        "objects3DAsGeoJSON": {
            "description": "Reality data id of 3D objects as GeoJSON file, `objects3d` output must be defined.",
            "type": "string"
        },
        "polygons3D": {
            "description": "Reality data id of ContextScene annotated with embedded 3D polygons.",
            "type": "string"
        },
        "polygons3DAs3DTiles": {
            "description": "Reality data id of 3D polygons as 3D Tiles file, `polygons3d` output must be defined.",
            "type": "string"
        },
        "polygons3DAsGeoJSON": {
            "description": "Reality data id of 3D polygons as GeoJSON file, `polygons3d` output must be defined.",
            "type": "string"
        },
        "segmentation3D": {
            "description": "Reality data id of ContextScene pointing to the segmented point cloud.",
            "type": "string"
        },
        "segmentation3DAsLAS": {
            "description": "Reality data id of the segmented point cloud as LAS file, `segmentation3D` output must be defined.",
            "type": "string"
        },
        "segmentation3DAsLAZ": {
            "description": "Reality data id of the segmented point cloud as LAZ file, `segmentation3D` output must be defined.",
            "type": "string"
        },
        "segmentation3DAsPLY": {
            "description": "Reality data id of the segmented point cloud as PLY file, `segmentation3D` output must be defined.",
            "type": "string"
        },
        "segmentation3DAsPOD": {
            "description": "Reality data id of the segmented point cloud as POD file, `segmentation3D` output must be defined.",
            "type": "string"
        },
        "segmentedPointCloud": {
            "description": "Reality data id of the 3D segmentation as OPC file.",
            "type": "string"
        }
    },
    "additionalProperties": false
}

Eval Objects 2D Inputs

Following are the different inputs for the job.

prediction

String

Reality data id of ContextScene annotated with embedded 2D object predictions.

reference

String

Reality data id of ContextScene annotated with embedded 2D object references.

json

{
    "title": "Eval Objects 2D Inputs",
    "description": "Following are the different inputs for the job.",
    "type": "object",
    "properties": {
        "prediction": {
            "type": "string",
            "description": "Reality data id of ContextScene annotated with embedded 2D object predictions."
        },
        "reference": {
            "type": "string",
            "description": "Reality data id of ContextScene annotated with embedded 2D object references."
        }
    },
    "required": [
        "prediction",
        "reference"
    ],
    "additionalProperties": false
}

Eval Objects 2D Options

Options for Eval Objects 2D job.

thresholdIOU

Number

Intersection over union threshold.

json

{
    "title": "Eval Objects 2D Options",
    "description": "Options for Eval Objects 2D job.",
    "type": "object",
    "properties": {
        "thresholdIOU": {
            "type": "number",
            "description": "Intersection over union threshold."
        }
    },
    "additionalProperties": false
}

Eval Objects 2D Specifications

Specifications for Eval Objects 2D job.

inputs

EvalO2DInputs

Inputs for the job.

outputs

EvalO2DOutputs

Outputs for the job.

options

EvalO2DOptions

Options for the job.

json

{
    "title": "Eval Objects 2D Specifications",
    "description": "Specifications for Eval Objects 2D job.",
    "type": "object",
    "properties": {
        "inputs": {
            "$ref": "#/components/schemas/EvalO2DInputs",
            "description": "Inputs for the job."
        },
        "outputs": {
            "$ref": "#/components/schemas/EvalO2DOutputs",
            "description": "Outputs for the job."
        },
        "options": {
            "$ref": "#/components/schemas/EvalO2DOptions",
            "description": "Options for the job."
        }
    },
    "required": [
        "inputs",
        "outputs"
    ],
    "additionalProperties": false
}

Eval Objects 2D Outputs

Following are the different output types for the job.

objects2d

String

Reality data id of ContextScene annotated with classified embedded 2D objects.

report

String

Path in Bucket of json report with binary classification.

json

{
    "title": "Eval Objects 2D Outputs",
    "description": "Following are the different output types for the job.",
    "type": "object",
    "properties": {
        "objects2d": {
            "description": "Reality data id of ContextScene annotated with classified embedded 2D objects.",
            "type": "string"
        },
        "report": {
            "description": "Path in Bucket of json report with binary classification.",
            "type": "string",
            "pattern": "^bkt:.+"
        }
    },
    "additionalProperties": false
}

Eval Objects 3D Inputs

Following are the different inputs for the job.

prediction

String

Reality data id of ContextScene annotated with embedded 3D object predictions.

reference

String

Reality data id of ContextScene annotated with embedded 3D object references.

json

{
    "title": "Eval Objects 3D Inputs",
    "description": "Following are the different inputs for the job.",
    "type": "object",
    "properties": {
        "prediction": {
            "type": "string",
            "description": "Reality data id of ContextScene annotated with embedded 3D object predictions."
        },
        "reference": {
            "type": "string",
            "description": "Reality data id of ContextScene annotated with embedded 3D object references."
        }
    },
    "required": [
        "prediction",
        "reference"
    ],
    "additionalProperties": false
}

Eval Objects 3D Options

Options for Eval Objects 3D job.

thresholdIOU

Number

Intersection over union threshold.

json

{
    "title": "Eval Objects 3D Options",
    "description": "Options for Eval Objects 3D job.",
    "type": "object",
    "properties": {
        "thresholdIOU": {
            "type": "number",
            "description": "Intersection over union threshold."
        }
    },
    "additionalProperties": false
}

Eval Objects 3D Specifications

Specifications for Eval Objects 3D job.

inputs

EvalO3DInputs

Inputs for the job.

outputs

EvalO3DOutputs

Outputs for the job.

options

EvalO3DOptions

Options for the job.

json

{
    "title": "Eval Objects 3D Specifications",
    "description": "Specifications for Eval Objects 3D job.",
    "type": "object",
    "properties": {
        "inputs": {
            "$ref": "#/components/schemas/EvalO3DInputs",
            "description": "Inputs for the job."
        },
        "outputs": {
            "$ref": "#/components/schemas/EvalO3DOutputs",
            "description": "Outputs for the job."
        },
        "options": {
            "$ref": "#/components/schemas/EvalO3DOptions",
            "description": "Options for the job."
        }
    },
    "required": [
        "inputs",
        "outputs"
    ],
    "additionalProperties": false
}

Eval Objects 3D Outputs

Following are the different output types for the job.

objects3d

String

Reality data id of ContextScene annotated with classified embedded 3D objects.

report

String

Path in Bucket of json report with binary classification.

json

{
    "title": "Eval Objects 3D Outputs",
    "description": "Following are the different output types for the job.",
    "type": "object",
    "properties": {
        "objects3d": {
            "description": "Reality data id of ContextScene annotated with classified embedded 3D objects.",
            "type": "string"
        },
        "report": {
            "description": "Path in Bucket of json report with binary classification.",
            "type": "string",
            "pattern": "^bkt:.+"
        }
    },
    "additionalProperties": false
}

Eval Segmentation 2D Inputs

Following are the different inputs for the job.

prediction

String

Reality data id of ContextScene pointing to segmented photos prediction.

reference

String

Reality data id of ContextScene, pointing to segmented photos reference.

json

{
    "title": "Eval Segmentation 2D Inputs",
    "description": "Following are the different inputs for the job.",
    "type": "object",
    "properties": {
        "prediction": {
            "type": "string",
            "description": "Reality data id of ContextScene pointing to segmented photos prediction."
        },
        "reference": {
            "type": "string",
            "description": "Reality data id of ContextScene, pointing to segmented photos reference."
        }
    },
    "required": [
        "prediction",
        "reference"
    ],
    "additionalProperties": false
}

Eval Segmentation 2D Specifications

Specifications for Eval Segmentation 2D job.

inputs

EvalS2DInputs

Inputs for the job.

outputs

EvalS2DOutputs

Outputs for the job.

json

{
    "title": "Eval Segmentation 2D Specifications",
    "description": "Specifications for Eval Segmentation 2D job.",
    "type": "object",
    "properties": {
        "inputs": {
            "$ref": "#/components/schemas/EvalS2DInputs",
            "description": "Inputs for the job."
        },
        "outputs": {
            "$ref": "#/components/schemas/EvalS2DOutputs",
            "description": "Outputs for the job."
        }
    },
    "required": [
        "inputs",
        "outputs"
    ],
    "additionalProperties": false
}

Eval Segmentation 2D Outputs

Following are the different output types for the job.

segmentation2D

String

Reality data id of ContextScene pointing to segmented photos.

report

String

Path in Bucket of json report with confusion matrix.

segmentedPhotos

String

Reality data id of segmented photos annotated with confusion matrix index.

json

{
    "title": "Eval Segmentation 2D Outputs",
    "description": "Following are the different output types for the job.",
    "type": "object",
    "properties": {
        "segmentation2D": {
            "description": "Reality data id of ContextScene pointing to segmented photos.",
            "type": "string"
        },
        "report": {
            "description": "Path in Bucket of json report with confusion matrix.",
            "type": "string",
            "pattern": "^bkt:.+"
        },
        "segmentedPhotos": {
            "description": "Reality data id of segmented photos annotated with confusion matrix index.",
            "type": "string"
        }
    },
    "additionalProperties": false
}

Eval Segmentation 3D Inputs

Following are the different inputs for the job.

prediction

String

Reality data id of ContextScene pointing to segmented point cloud prediction.

reference

String

Reality data id of ContextScene, pointing to segmented point cloud reference.

json

{
    "title": "Eval Segmentation 3D Inputs",
    "description": "Following are the different inputs for the job.",
    "type": "object",
    "properties": {
        "prediction": {
            "type": "string",
            "description": "Reality data id of ContextScene pointing to segmented point cloud prediction."
        },
        "reference": {
            "type": "string",
            "description": "Reality data id of ContextScene, pointing to segmented point cloud reference."
        }
    },
    "required": [
        "prediction",
        "reference"
    ],
    "additionalProperties": false
}

Eval Segmentation 3D Specifications

Specifications for Eval Segmentation 3D job.

inputs

EvalS3DInputs

Inputs for the job.

outputs

EvalS3DOutputs

Outputs for the job.

json

{
    "title": "Eval Segmentation 3D Specifications",
    "description": "Specifications for Eval Segmentation 3D job.",
    "type": "object",
    "properties": {
        "inputs": {
            "$ref": "#/components/schemas/EvalS3DInputs",
            "description": "Inputs for the job."
        },
        "outputs": {
            "$ref": "#/components/schemas/EvalS3DOutputs",
            "description": "Outputs for the job."
        }
    },
    "required": [
        "inputs",
        "outputs"
    ],
    "additionalProperties": false
}

Eval Segmentation 3D Outputs

Following are the different output types for the job.

segmentation3D

String

Reality data id of ContextScene pointing to segmented point cloud.

report

String

Path in Bucket of json report with confusion matrix.

segmentedPointCloud

String

Reality data id of segmented point cloud annotated with confusion matrix index.

json

{
    "title": "Eval Segmentation 3D Outputs",
    "description": "Following are the different output types for the job.",
    "type": "object",
    "properties": {
        "segmentation3D": {
            "description": "Reality data id of ContextScene pointing to segmented point cloud.",
            "type": "string"
        },
        "report": {
            "description": "Path in Bucket of json report with confusion matrix.",
            "type": "string",
            "pattern": "^bkt:.+"
        },
        "segmentedPointCloud": {
            "description": "Reality data id of segmented point cloud annotated with confusion matrix index.",
            "type": "string"
        }
    },
    "additionalProperties": false
}

Eval Segmentation Orthophoto Inputs

Following are the different inputs for the job.

prediction

String

Reality data id of ContextScene pointing to segmented photos prediction.

reference

String

Reality data id of ContextScene pointing to segmented photos reference.

json

{
    "title": "Eval Segmentation Orthophoto Inputs",
    "description": "Following are the different inputs for the job.",
    "type": "object",
    "properties": {
        "prediction": {
            "type": "string",
            "description": "Reality data id of ContextScene pointing to segmented photos prediction."
        },
        "reference": {
            "type": "string",
            "description": "Reality data id of ContextScene pointing to segmented photos reference."
        }
    },
    "required": [
        "prediction",
        "reference"
    ],
    "additionalProperties": false
}

Eval Segmentation Orthophoto Specifications

Specifications for Eval Segmentation Orthophoto job.

inputs

EvalSOrthoInputs

Inputs for the job.

outputs

EvalSOrthoOutputs

Outputs for the job.

json

{
    "title": "Eval Segmentation Orthophoto Specifications",
    "description": "Specifications for Eval Segmentation Orthophoto job.",
    "type": "object",
    "properties": {
        "inputs": {
            "$ref": "#/components/schemas/EvalSOrthoInputs",
            "description": "Inputs for the job."
        },
        "outputs": {
            "$ref": "#/components/schemas/EvalSOrthoOutputs",
            "description": "Outputs for the job."
        }
    },
    "required": [
        "inputs",
        "outputs"
    ],
    "additionalProperties": false
}

Eval Segmentation Orthophoto Outputs

Following are the different output types.

segmentation2D

String

Reality data id of ContextScene pointing to segmented photos.

report

String

Path in Bucket of json report with confusion matrix.

segmentedPhotos

String

Reality data id of segmented photos annotated with confusion matrix index.

json

{
    "title": "Eval Segmentation Orthophoto Outputs",
    "description": "Following are the different output types.",
    "type": "object",
    "properties": {
        "segmentation2D": {
            "description": "Reality data id of ContextScene pointing to segmented photos.",
            "type": "string"
        },
        "report": {
            "description": "Path in Bucket of json report with confusion matrix.",
            "type": "string",
            "pattern": "^bkt:.+"
        },
        "segmentedPhotos": {
            "description": "Reality data id of segmented photos annotated with confusion matrix index.",
            "type": "string"
        }
    },
    "additionalProperties": false
}

TrainingO2D Inputs

Following are the inputs for the job.

scene

String

Reality data id of a ContextScene pointing to photos with annotations (in the contextscene file).

json

{
    "title": "TrainingO2D Inputs",
    "description": "Following are the inputs for the job.",
    "type": "object",
    "properties": {
        "scene": {
            "description": "Reality data id of a ContextScene pointing to photos with annotations (in the contextscene file).",
            "type": "string"
        }
    },
    "required": [
        "scene"
    ],
    "additionalProperties": false
}

TrainingO2D Options

Options for TrainingO2D job.

epochs

Integer

Number of time to iterate over the entire dataset.

maxTrainingSplit

Number

Ratio (between 0.0 excluded and 1.0 included) of training data used to train the detector, the rest will be used to evaluate the model after each epoch and compute extra evaluation metrics. Set it to 1.0 for no evaluation and use everything for training.

json

{
    "title": "TrainingO2D Options",
    "description": "Options for TrainingO2D job.",
    "type": "object",
    "properties": {
        "epochs": {
            "description": "Number of time to iterate over the entire dataset.",
            "type": "integer"
        },
        "maxTrainingSplit": {
            "description": "Ratio (between 0.0 excluded and 1.0 included) of training data used to train the detector, the rest will be used to evaluate the model after each epoch and compute extra evaluation metrics. Set it to 1.0 for no evaluation and use everything for training.",
            "type": "number"
        }
    },
    "additionalProperties": false
}

TrainingO2D Specifications

Specifications for TrainingO2D job.

inputs

TrainingO2DInputs

Inputs for the job.

outputs

TrainingO2DOutputs

Outputs for the job.

options

TrainingO2DOptions

Options for the job.

json

{
    "title": "TrainingO2D Specifications",
    "description": "Specifications for TrainingO2D job.",
    "type": "object",
    "properties": {
        "inputs": {
            "$ref": "#/components/schemas/TrainingO2DInputs",
            "description": "Inputs for the job."
        },
        "outputs": {
            "$ref": "#/components/schemas/TrainingO2DOutputs",
            "description": "Outputs for the job."
        },
        "options": {
            "$ref": "#/components/schemas/TrainingO2DOptions",
            "description": "Options for the job."
        }
    },
    "required": [
        "inputs",
        "outputs"
    ],
    "additionalProperties": false
}

TrainingO2D Outputs

Following are the different output types for the job.

detector

String

Reality data id of the detector.

metrics

String

Path in the bucket of the training metrics.

json

{
    "title": "TrainingO2D Outputs",
    "description": "Following are the different output types for the job.",
    "type": "object",
    "properties": {
        "detector": {
            "description": "Reality data id of the detector.",
            "type": "string"
        },
        "metrics": {
            "description": "Path in the bucket of the training metrics.",
            "type": "string",
            "pattern": "^bkt:.+"
        }
    },
    "required": [
        "detector"
    ],
    "additionalProperties": false
}

TrainingS3D Inputs

Following are the inputs for TrainingS3D job.

scene

String

Reality data id of a ContextScene pointing to photos with annotations (in the contextscene file).

json

{
    "title": "TrainingS3D Inputs",
    "description": "Following are the inputs for TrainingS3D job.",
    "type": "object",
    "properties": {
        "scene": {
            "description": "Reality data id of a ContextScene pointing to photos with annotations (in the contextscene file).",
            "type": "string"
        }
    },
    "required": [
        "scene"
    ],
    "additionalProperties": false
}

TrainingS3D Options

Options for TrainingS3D job.

epochs

Integer

Number of time to iterate over the entire dataset.

maxTrainingSplit

Number

spacing

Number

Spacing of the pointcloud seen by the detector.

json

{
    "title": "TrainingS3D Options",
    "description": "Options for TrainingS3D job.",
    "type": "object",
    "properties": {
        "epochs": {
            "description": "Number of time to iterate over the entire dataset.",
            "type": "integer"
        },
        "maxTrainingSplit": {
            "description": "Ratio (between 0.0 excluded and 1.0 included) of training data used to train the detector, the rest will be used to evaluate the model after each epoch and compute extra evaluation metrics. Set it to 1.0 for no evaluation and use everything for training.",
            "type": "number"
        },
        "spacing": {
            "description": "Spacing of the pointcloud seen by the detector.",
            "type": "number"
        }
    },
    "additionalProperties": false
}

TrainingS3D Specifications

Specifications for TrainingS3D job.

inputs

TrainingS3DInputs

Inputs for the job.

outputs

TrainingS3DOutputs

Outputs for the job.

options

TrainingS3DOptions

Options for the job.

json

{
    "title": "TrainingS3D Specifications",
    "description": "Specifications for TrainingS3D job.",
    "type": "object",
    "properties": {
        "inputs": {
            "$ref": "#/components/schemas/TrainingS3DInputs",
            "description": "Inputs for the job."
        },
        "outputs": {
            "$ref": "#/components/schemas/TrainingS3DOutputs",
            "description": "Outputs for the job."
        },
        "options": {
            "$ref": "#/components/schemas/TrainingS3DOptions",
            "description": "Options for the job."
        }
    },
    "required": [
        "inputs",
        "outputs"
    ],
    "additionalProperties": false
}

TrainingS3D Outputs

Following are the outputs for the job.

detector

String

Reality data id of the detector.

json

{
    "title": "TrainingS3D Outputs",
    "description": "Following are the outputs for the job.",
    "type": "object",
    "properties": {
        "detector": {
            "description": "Reality data id of the detector.",
            "type": "string"
        }
    },
    "required": [
        "detector"
    ],
    "additionalProperties": false
}

Error

Contains error information.

code

String

One of a server-defined set of error codes.

message

String

A human-readable representation of the error.

target

String, null

The target of the error.

json

{
    "type": "object",
    "description": "Contains error information.",
    "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.",
            "nullable": true
        }
    },
    "required": [
        "code",
        "message"
    ],
    "additionalProperties": true
}

Error Response

Gives details for an error that occurred while handling the request. Note that clients MUST NOT assume that every failed request will produce an object of this schema, or that all of the properties in the response will be non-null, as the error may have prevented this response from being constructed.

error

Error

Error information.

json

{
    "type": "object",
    "title": "Error Response",
    "description": "Gives details for an error that occurred while handling the request. Note that clients MUST NOT assume that every failed request will produce an object of this schema, or that all of the properties in the response will be non-null, as the error may have prevented this response from being constructed.",
    "properties": {
        "error": {
            "description": "Error information.",
            "$ref": "#/components/schemas/Error"
        }
    },
    "required": [
        "error"
    ],
    "additionalProperties": false
}

Was this page helpful?