Skip to main content

ML-API Document AI

API docs by Redocly

Document.ai Annotation Sets API (ALPHA)

Download OpenAPI specification:Download

Document.ai Annotation Sets management.

Additional Documentation

AnnotationSetService

DocumentSetService

ImageSetService

JobService

ModelService

ProjectOverviewService

ResultSetService

Create

Creates a new AnnotationSet and a new collection.

Creates a new AnnotationSet and a new collection. For larger AnnotationSets consider CreateAnnotationSetMultipartUpload method.

Authorizations:
oidc
path Parameters
project
required
string
Request Body schema: application/json
required
object (v1alphaFileInput)

FileInput represents an input file. It can define either base64 encoded content or a URL where to get the content. Different URL schemes are supported, such as http:// or xs://.

mime
string

Required. MIME type of this resource, for example application/json.

object (v1alphaAnnotationSet)

AnnotationSet represents document annotations in VIA format. It references Images in ImageSet, possibly ImageSets.

Responses

Request samples

Content type
application/json
{
  • "annotationSetVia": {
    },
  • "mime": "string",
  • "annotationSet": {
    }
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "parent": "string",
  • "isLatest": true,
  • "filename": "string",
  • "jobName": "string",
  • "displayName": "string",
  • "description": "string",
  • "createTime": "2019-08-24T14:15:22Z",
  • "updateTime": "2019-08-24T14:15:22Z",
  • "annotations": {
    },
  • "downloadUrl": "string",
  • "status": "ARTIFACT_STATUS_NOT_YET_READY",
  • "attributes": null,
  • "documentCount": 0,
  • "pageCount": 0,
  • "metricsReport": null,
  • "sizeInStorage": "string"
}

Creates a new version in previously created AnnotationSet collection.

Creates a new version in previously created AnnotationSet collection. For larger AnnotationSets consider CreateAnnotationSetVersionMultipartUpload method.

Authorizations:
oidc
path Parameters
project
required
string
annotationSet
required
string
Request Body schema: application/json
required
object (v1alphaFileInput)

FileInput represents an input file. It can define either base64 encoded content or a URL where to get the content. Different URL schemes are supported, such as http:// or xs://.

mime
string

Required. MIME type of this resource, for example application/json.

object (v1alphaAnnotationSet)

AnnotationSet represents document annotations in VIA format. It references Images in ImageSet, possibly ImageSets.

sourceAnnotationSetName
string (Required. Name of the annotation set of the source)

Responses

Request samples

Content type
application/json
{
  • "annotationSetVia": {
    },
  • "mime": "string",
  • "annotationSet": {
    },
  • "sourceAnnotationSetName": "string"
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "parent": "string",
  • "isLatest": true,
  • "filename": "string",
  • "jobName": "string",
  • "displayName": "string",
  • "description": "string",
  • "createTime": "2019-08-24T14:15:22Z",
  • "updateTime": "2019-08-24T14:15:22Z",
  • "annotations": {
    },
  • "downloadUrl": "string",
  • "status": "ARTIFACT_STATUS_NOT_YET_READY",
  • "attributes": null,
  • "documentCount": 0,
  • "pageCount": 0,
  • "metricsReport": null,
  • "sizeInStorage": "string"
}

Completes the multipart upload.

Completes the multipart upload. No parts can be uploaded after this call and the content is considered complete and ready to be accessed. If there are any validations to be executed regarding the AnnotationSet upload, they are executed now.

Authorizations:
oidc
path Parameters
project
required
string
annotationSet
required
string
version
required
string

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "parent": "string",
  • "displayName": "string",
  • "description": "string",
  • "createTime": "2019-08-24T14:15:22Z",
  • "lastUpdateTime": "2019-08-24T14:15:22Z",
  • "status": "JOB_STATUS_PENDING",
  • "error": {
    },
  • "totalSteps": 0,
  • "currentStep": 0,
  • "jobType": "JOB_TYPE_OCR",
  • "annotations": {
    },
  • "logsUrl": "string",
  • "warningsUrl": "string",
  • "ocrInputs": {
    },
  • "concatInputs": {
    },
  • "splitInputs": {
    },
  • "filterInputs": {
    },
  • "trainInputs": {
    },
  • "predictInputs": {
    },
  • "postProcessDocumentSetInputs": {
    },
  • "exportAnnotationSetInputs": {
    },
  • "exportImagesInputs": {
    },
  • "postProcessModelInputs": {
    },
  • "postProcessAnnotationSetInput": {
    },
  • "postProcessImageSetInputs": {
    },
  • "engageInputs": {
    },
  • "publishInputs": {
    },
  • "ocrOutputs": {
    },
  • "concatOutputs": {
    },
  • "splitOutputs": {
    },
  • "filterOutputs": {
    },
  • "trainOutputs": {
    },
  • "predictOutputs": {
    },
  • "postProcessDocumentSetOutputs": {
    },
  • "exportAnnotationSetOutputs": {
    },
  • "exportImagesOutputs": {
    },
  • "postProcessModelOutputs": {
    },
  • "postProcessAnnotationSetOutputs": {
    },
  • "postProcessImageSetOutputs": {
    },
  • "engageOutputs": {
    },
  • "publishOutputs": {
    }
}

Completes the multipart upload, if there are duplicate filenames in the uploaded annotations set, the post process will not be started

Completes the multipart upload. No parts can be uploaded after this call and the content is considered complete and ready to be accessed. If there are any validations to be executed regarding the AnnotationSet upload, they are executed now.BUT, if there are duplicate filenames in the uploaded annotations set, the post process will not be started

Authorizations:
oidc
path Parameters
project
required
string
annotationSet
required
string
version
required
string

Responses

Response samples

Content type
application/json
{
  • "jobId": "string",
  • "duplicates": {
    }
}

Submits the chosen document sets from the duplicates and start the post processing job.

This endpoint should be used, after completing the multipart uploading. If there are duplicate filenames, this endpoint should be called with the user inputs for the relevant filenames

Authorizations:
oidc
path Parameters
project
required
string
annotationSet
required
string
version
required
string
Request Body schema: application/json
required
object (Required. key - filename, value - name of the selected image set in format `projects/<UUID>/documentAI/imageSets/<UUID>/versions/<INT>`)
property name*
additional property
string

Responses

Request samples

Content type
application/json
{
  • "duplicates": {
    }
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "parent": "string",
  • "displayName": "string",
  • "description": "string",
  • "createTime": "2019-08-24T14:15:22Z",
  • "lastUpdateTime": "2019-08-24T14:15:22Z",
  • "status": "JOB_STATUS_PENDING",
  • "error": {
    },
  • "totalSteps": 0,
  • "currentStep": 0,
  • "jobType": "JOB_TYPE_OCR",
  • "annotations": {
    },
  • "logsUrl": "string",
  • "warningsUrl": "string",
  • "ocrInputs": {
    },
  • "concatInputs": {
    },
  • "splitInputs": {
    },
  • "filterInputs": {
    },
  • "trainInputs": {
    },
  • "predictInputs": {
    },
  • "postProcessDocumentSetInputs": {
    },
  • "exportAnnotationSetInputs": {
    },
  • "exportImagesInputs": {
    },
  • "postProcessModelInputs": {
    },
  • "postProcessAnnotationSetInput": {
    },
  • "postProcessImageSetInputs": {
    },
  • "engageInputs": {
    },
  • "publishInputs": {
    },
  • "ocrOutputs": {
    },
  • "concatOutputs": {
    },
  • "splitOutputs": {
    },
  • "filterOutputs": {
    },
  • "trainOutputs": {
    },
  • "predictOutputs": {
    },
  • "postProcessDocumentSetOutputs": {
    },
  • "exportAnnotationSetOutputs": {
    },
  • "exportImagesOutputs": {
    },
  • "postProcessModelOutputs": {
    },
  • "postProcessAnnotationSetOutputs": {
    },
  • "postProcessImageSetOutputs": {
    },
  • "engageOutputs": {
    },
  • "publishOutputs": {
    }
}

Creates a new version in previously created AnnotationSet collection. Content is uploaded in multiple subsequent requests.

Creates a new version in previously created AnnotationSet collection. Content (archive of PDFs) is uploaded in multiple subsequent requests to UploadAnnotationSetVersionPart. Use CompleteAnnotationSetVersionMultipartUpload to complete the multipart upload. The UploadAnnotationSetVersionPart is defined as follows:

  • POST /v1alpha/{name=projects/*/documentAI/annotationSets/*/versions/*}:uploadPart

  • Headers:

    • Part-Number: Part number of part being uploaded. This is a positive integer between 1 and 10,000.

  • Body: content of the part All validations, if any, are executed during CompleteAnnotationSetVersionMultipartUpload call.

Authorizations:
oidc
path Parameters
project
required
string
annotationSet
required
string
Request Body schema: application/json
required
mime
string

Required. MIME type of this resource, for example application/json.

object (v1alphaAnnotationSet)

AnnotationSet represents document annotations in VIA format. It references Images in ImageSet, possibly ImageSets.

sourceAnnotationSetName
string (Required. Name of the annotation set of the source)

Responses

Request samples

Content type
application/json
{
  • "mime": "string",
  • "annotationSet": {
    },
  • "sourceAnnotationSetName": "string"
}

Response samples

Content type
application/json
{
  • "name": "string"
}

Creates a new version in previously created AnnotationSet collection.

Creates a new version in previously created AnnotationSet collection. For larger AnnotationSets consider CreateAnnotationSetVersionMultipartUpload method.

Authorizations:
oidc
path Parameters
project
required
string
annotationSet
required
string
Request Body schema: application/json
required
object (v1alphaFileInput)

FileInput represents an input file. It can define either base64 encoded content or a URL where to get the content. Different URL schemes are supported, such as http:// or xs://.

mime
string

Required. MIME type of this resource, for example application/json.

object (v1alphaAnnotationSet)

AnnotationSet represents document annotations in VIA format. It references Images in ImageSet, possibly ImageSets.

sourceAnnotationSetName
string (Required. Name of the annotation set of the source)

Responses

Request samples

Content type
application/json
{
  • "annotationSetVia": {
    },
  • "mime": "string",
  • "annotationSet": {
    },
  • "sourceAnnotationSetName": "string"
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "parent": "string",
  • "displayName": "string",
  • "description": "string",
  • "createTime": "2019-08-24T14:15:22Z",
  • "lastUpdateTime": "2019-08-24T14:15:22Z",
  • "status": "JOB_STATUS_PENDING",
  • "error": {
    },
  • "totalSteps": 0,
  • "currentStep": 0,
  • "jobType": "JOB_TYPE_OCR",
  • "annotations": {
    },
  • "logsUrl": "string",
  • "warningsUrl": "string",
  • "ocrInputs": {
    },
  • "concatInputs": {
    },
  • "splitInputs": {
    },
  • "filterInputs": {
    },
  • "trainInputs": {
    },
  • "predictInputs": {
    },
  • "postProcessDocumentSetInputs": {
    },
  • "exportAnnotationSetInputs": {
    },
  • "exportImagesInputs": {
    },
  • "postProcessModelInputs": {
    },
  • "postProcessAnnotationSetInput": {
    },
  • "postProcessImageSetInputs": {
    },
  • "engageInputs": {
    },
  • "publishInputs": {
    },
  • "ocrOutputs": {
    },
  • "concatOutputs": {
    },
  • "splitOutputs": {
    },
  • "filterOutputs": {
    },
  • "trainOutputs": {
    },
  • "predictOutputs": {
    },
  • "postProcessDocumentSetOutputs": {
    },
  • "exportAnnotationSetOutputs": {
    },
  • "exportImagesOutputs": {
    },
  • "postProcessModelOutputs": {
    },
  • "postProcessAnnotationSetOutputs": {
    },
  • "postProcessImageSetOutputs": {
    },
  • "engageOutputs": {
    },
  • "publishOutputs": {
    }
}

Creates a new AnnotationSet and a new collection. Content is uploaded in multiple subsequent requests.

Creates a new AnnotationSet and a new collection. Content (VIA JSON) is uploaded in multiple subsequent requests to UploadAnnotationSetVersionPart. Use CompleteAnnotationSetVersionMultipartUpload to complete the multipart upload. The UploadAnnotationSetVersionPart is defined as follows:

  • POST /v1alpha/{name=projects/*/documentAI/annotationSets/*/versions/*}:uploadPart

  • Headers:

    • Part-Number: Part number of part being uploaded. This is a positive integer between 1 and 10,000.

  • Body: content of the part All validations, if any, are executed during CompleteAnnotationSetVersionMultipartUpload call.

Authorizations:
oidc
path Parameters
project
required
string
Request Body schema: application/json
required
mime
string

Required. MIME type of this resource, for example application/json.

object (v1alphaAnnotationSet)

AnnotationSet represents document annotations in VIA format. It references Images in ImageSet, possibly ImageSets.

Responses

Request samples

Content type
application/json
{
  • "mime": "string",
  • "annotationSet": {
    }
}

Response samples

Content type
application/json
{
  • "name": "string"
}

Creates a new AnnotationSet and a new collection.

Creates a new AnnotationSet and a new collection. For larger AnnotationSets consider CreateAnnotationSetMultipartUpload method.

Authorizations:
oidc
path Parameters
project
required
string
Request Body schema: application/json
required
object (v1alphaFileInput)

FileInput represents an input file. It can define either base64 encoded content or a URL where to get the content. Different URL schemes are supported, such as http:// or xs://.

mime
string

Required. MIME type of this resource, for example application/json.

object (v1alphaAnnotationSet)

AnnotationSet represents document annotations in VIA format. It references Images in ImageSet, possibly ImageSets.

Responses

Request samples

Content type
application/json
{
  • "annotationSetVia": {
    },
  • "mime": "string",
  • "annotationSet": {
    }
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "parent": "string",
  • "displayName": "string",
  • "description": "string",
  • "createTime": "2019-08-24T14:15:22Z",
  • "lastUpdateTime": "2019-08-24T14:15:22Z",
  • "status": "JOB_STATUS_PENDING",
  • "error": {
    },
  • "totalSteps": 0,
  • "currentStep": 0,
  • "jobType": "JOB_TYPE_OCR",
  • "annotations": {
    },
  • "logsUrl": "string",
  • "warningsUrl": "string",
  • "ocrInputs": {
    },
  • "concatInputs": {
    },
  • "splitInputs": {
    },
  • "filterInputs": {
    },
  • "trainInputs": {
    },
  • "predictInputs": {
    },
  • "postProcessDocumentSetInputs": {
    },
  • "exportAnnotationSetInputs": {
    },
  • "exportImagesInputs": {
    },
  • "postProcessModelInputs": {
    },
  • "postProcessAnnotationSetInput": {
    },
  • "postProcessImageSetInputs": {
    },
  • "engageInputs": {
    },
  • "publishInputs": {
    },
  • "ocrOutputs": {
    },
  • "concatOutputs": {
    },
  • "splitOutputs": {
    },
  • "filterOutputs": {
    },
  • "trainOutputs": {
    },
  • "predictOutputs": {
    },
  • "postProcessDocumentSetOutputs": {
    },
  • "exportAnnotationSetOutputs": {
    },
  • "exportImagesOutputs": {
    },
  • "postProcessModelOutputs": {
    },
  • "postProcessAnnotationSetOutputs": {
    },
  • "postProcessImageSetOutputs": {
    },
  • "engageOutputs": {
    },
  • "publishOutputs": {
    }
}

Completes the multipart upload and schedules a postprocessing job.

Completes the multipart upload. No parts can be uploaded after this call and the content is considered complete and ready to be accessed. Schedules a postprocessing job. The job is of type JOB_TYPE_POSTPROCESS_DOCUMENT_SET. The DocumentSet is available only after the job finishes. The generated ImageSet is present in the job outputs.

Authorizations:
oidc
path Parameters
project
required
string
documentSet
required
string
version
required
string

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "parent": "string",
  • "displayName": "string",
  • "description": "string",
  • "createTime": "2019-08-24T14:15:22Z",
  • "lastUpdateTime": "2019-08-24T14:15:22Z",
  • "status": "JOB_STATUS_PENDING",
  • "error": {
    },
  • "totalSteps": 0,
  • "currentStep": 0,
  • "jobType": "JOB_TYPE_OCR",
  • "annotations": {
    },
  • "logsUrl": "string",
  • "warningsUrl": "string",
  • "ocrInputs": {
    },
  • "concatInputs": {
    },
  • "splitInputs": {
    },
  • "filterInputs": {
    },
  • "trainInputs": {
    },
  • "predictInputs": {
    },
  • "postProcessDocumentSetInputs": {
    },
  • "exportAnnotationSetInputs": {
    },
  • "exportImagesInputs": {
    },
  • "postProcessModelInputs": {
    },
  • "postProcessAnnotationSetInput": {
    },
  • "postProcessImageSetInputs": {
    },
  • "engageInputs": {
    },
  • "publishInputs": {
    },
  • "ocrOutputs": {
    },
  • "concatOutputs": {
    },
  • "splitOutputs": {
    },
  • "filterOutputs": {
    },
  • "trainOutputs": {
    },
  • "predictOutputs": {
    },
  • "postProcessDocumentSetOutputs": {
    },
  • "exportAnnotationSetOutputs": {
    },
  • "exportImagesOutputs": {
    },
  • "postProcessModelOutputs": {
    },
  • "postProcessAnnotationSetOutputs": {
    },
  • "postProcessImageSetOutputs": {
    },
  • "engageOutputs": {
    },
  • "publishOutputs": {
    }
}

Creates a new DocumentSet and a new collection. Content is uploaded in multiple subsequent requests.

Creates a new DocumentSet and a new collection. Content (archive of PDFs) is uploaded in multiple subsequent requests to UploadDocumentSetVersionPart. Use CompleteDocumentSetMultipartUpload to complete the multipart upload. The UploadDocumentSetVersionPart is defined as follows:

  • POST /v1alpha/{name=projects/*/documentAI/documentSets/*/versions/*}:uploadPart

  • Headers:

    • Part-Number: Part number of part being uploaded. This is a positive integer between 1 and 10,000.

  • Body: content of the part All validations, if any, are executed during CompleteDocumentSetMultipartUpload call.

Authorizations:
oidc
path Parameters
project
required
string
Request Body schema: application/json
required
mime
string

Required. MIME type of this resource, for example application/pdf. Allowed values are: - application/pdf - for importing a single PDF document - application/zip - for importing multiple PDF documents

object (v1alphaDocumentSet)

DocumentSet represents a set of PDF documents.

attributesSourceAnnotationSetName
string

Optional. Immutable. If set, attributes of this Annotation Set are copied.

Responses

Request samples

Content type
application/json
{
  • "mime": "string",
  • "documentSet": {
    },
  • "attributesSourceAnnotationSetName": "string"
}

Response samples

Content type
application/json
{
  • "name": "string"
}

Creates a new DocumentSet and a new collection and schedules a postprocessing job.

Creates a new DocumentSet and a new collection. For larger DocumentSets consider CreateDocumentSetMultipartUpload method. Schedules a postprocessing job. The job is of type JOB_TYPE_POSTPROCESS_DOCUMENT_SET. The DocumentSet is available only after the job finishes. The generated ImageSet is present in the job outputs.

Authorizations:
oidc
path Parameters
project
required
string
Request Body schema: application/json
required
object (v1alphaFileInput)

FileInput represents an input file. It can define either base64 encoded content or a URL where to get the content. Different URL schemes are supported, such as http:// or xs://.

mime
string

Required. MIME type of this resource, for example application/pdf. Allowed values are: - application/pdf - for importing a single PDF document - application/zip - for importing multiple PDF documents

object (v1alphaDocumentSet)

DocumentSet represents a set of PDF documents.

attributesSourceAnnotationSetName
string

Optional. Immutable. If set, attributes of this Annotation Set are copied.

Responses

Request samples

Content type
application/json
{
  • "pdfs": {
    },
  • "mime": "string",
  • "documentSet": {
    },
  • "attributesSourceAnnotationSetName": "string"
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "parent": "string",
  • "displayName": "string",
  • "description": "string",
  • "createTime": "2019-08-24T14:15:22Z",
  • "lastUpdateTime": "2019-08-24T14:15:22Z",
  • "status": "JOB_STATUS_PENDING",
  • "error": {
    },
  • "totalSteps": 0,
  • "currentStep": 0,
  • "jobType": "JOB_TYPE_OCR",
  • "annotations": {
    },
  • "logsUrl": "string",
  • "warningsUrl": "string",
  • "ocrInputs": {
    },
  • "concatInputs": {
    },
  • "splitInputs": {
    },
  • "filterInputs": {
    },
  • "trainInputs": {
    },
  • "predictInputs": {
    },
  • "postProcessDocumentSetInputs": {
    },
  • "exportAnnotationSetInputs": {
    },
  • "exportImagesInputs": {
    },
  • "postProcessModelInputs": {
    },
  • "postProcessAnnotationSetInput": {
    },
  • "postProcessImageSetInputs": {
    },
  • "engageInputs": {
    },
  • "publishInputs": {
    },
  • "ocrOutputs": {
    },
  • "concatOutputs": {
    },
  • "splitOutputs": {
    },
  • "filterOutputs": {
    },
  • "trainOutputs": {
    },
  • "predictOutputs": {
    },
  • "postProcessDocumentSetOutputs": {
    },
  • "exportAnnotationSetOutputs": {
    },
  • "exportImagesOutputs": {
    },
  • "postProcessModelOutputs": {
    },
  • "postProcessAnnotationSetOutputs": {
    },
  • "postProcessImageSetOutputs": {
    },
  • "engageOutputs": {
    },
  • "publishOutputs": {
    }
}

Completes the multipart upload.

Completes the multipart upload. No parts can be uploaded after this call and the content is considered complete and ready to be accessed. If there are any validations to be executed regarding the ImageSet upload, they are executed now.

Authorizations:
oidc
path Parameters
project
required
string
imageSet
required
string
version
required
string

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "parent": "string",
  • "displayName": "string",
  • "description": "string",
  • "createTime": "2019-08-24T14:15:22Z",
  • "lastUpdateTime": "2019-08-24T14:15:22Z",
  • "status": "JOB_STATUS_PENDING",
  • "error": {
    },
  • "totalSteps": 0,
  • "currentStep": 0,
  • "jobType": "JOB_TYPE_OCR",
  • "annotations": {
    },
  • "logsUrl": "string",
  • "warningsUrl": "string",
  • "ocrInputs": {
    },
  • "concatInputs": {
    },
  • "splitInputs": {
    },
  • "filterInputs": {
    },
  • "trainInputs": {
    },
  • "predictInputs": {
    },
  • "postProcessDocumentSetInputs": {
    },
  • "exportAnnotationSetInputs": {
    },
  • "exportImagesInputs": {
    },
  • "postProcessModelInputs": {
    },
  • "postProcessAnnotationSetInput": {
    },
  • "postProcessImageSetInputs": {
    },
  • "engageInputs": {
    },
  • "publishInputs": {
    },
  • "ocrOutputs": {
    },
  • "concatOutputs": {
    },
  • "splitOutputs": {
    },
  • "filterOutputs": {
    },
  • "trainOutputs": {
    },
  • "predictOutputs": {
    },
  • "postProcessDocumentSetOutputs": {
    },
  • "exportAnnotationSetOutputs": {
    },
  • "exportImagesOutputs": {
    },
  • "postProcessModelOutputs": {
    },
  • "postProcessAnnotationSetOutputs": {
    },
  • "postProcessImageSetOutputs": {
    },
  • "engageOutputs": {
    },
  • "publishOutputs": {
    }
}

Creates a new ImageSet and a new collection. Content is uploaded in multiple subsequent requests.

Creates a new ImageSet and a new collection. Content (archive of images) is uploaded in multiple subsequent requests to UploadImageSetPart. Use CompleteImageSetVersionMultipartUpload to complete the multipart upload. The UploadImageSetPart is defined as follows:

  • POST /v1alpha/{parent=projects/*}/documentAI/{name=imageSets/*/}:uploadPart

  • Headers:

    • Part-Number: Part number of part being uploaded. This is a positive integer between 1 and 10,000.

  • Body: content of the part All validations, if any, are executed during CompleteImageSetVersionMultipartUpload call.

Authorizations:
oidc
path Parameters
project
required
string
Request Body schema: application/json
required
mime
string

Required. MIME type of this resource, for example application/zip.

object (v1alphaImageSet)

ImageSet represents a set of images.

Responses

Request samples

Content type
application/json
{
  • "mime": "string",
  • "imageSet": {
    }
}

Response samples

Content type
application/json
{
  • "name": "string"
}

Creates a new ImageSet and a new collection.

Creates a new ImageSet and a new collection. For larger ImageSets consider CreateImageSetMultipartUpload method.

Authorizations:
oidc
path Parameters
project
required
string
Request Body schema: application/json
required
object (v1alphaFileInput)

FileInput represents an input file. It can define either base64 encoded content or a URL where to get the content. Different URL schemes are supported, such as http:// or xs://.

mime
string

Required. MIME type of this resource, for example application/zip.

object (v1alphaImageSet)

ImageSet represents a set of images.

Responses

Request samples

Content type
application/json
{
  • "images": {
    },
  • "mime": "string",
  • "imageSet": {
    }
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "parent": "string",
  • "displayName": "string",
  • "description": "string",
  • "createTime": "2019-08-24T14:15:22Z",
  • "lastUpdateTime": "2019-08-24T14:15:22Z",
  • "status": "JOB_STATUS_PENDING",
  • "error": {
    },
  • "totalSteps": 0,
  • "currentStep": 0,
  • "jobType": "JOB_TYPE_OCR",
  • "annotations": {
    },
  • "logsUrl": "string",
  • "warningsUrl": "string",
  • "ocrInputs": {
    },
  • "concatInputs": {
    },
  • "splitInputs": {
    },
  • "filterInputs": {
    },
  • "trainInputs": {
    },
  • "predictInputs": {
    },
  • "postProcessDocumentSetInputs": {
    },
  • "exportAnnotationSetInputs": {
    },
  • "exportImagesInputs": {
    },
  • "postProcessModelInputs": {
    },
  • "postProcessAnnotationSetInput": {
    },
  • "postProcessImageSetInputs": {
    },
  • "engageInputs": {
    },
  • "publishInputs": {
    },
  • "ocrOutputs": {
    },
  • "concatOutputs": {
    },
  • "splitOutputs": {
    },
  • "filterOutputs": {
    },
  • "trainOutputs": {
    },
  • "predictOutputs": {
    },
  • "postProcessDocumentSetOutputs": {
    },
  • "exportAnnotationSetOutputs": {
    },
  • "exportImagesOutputs": {
    },
  • "postProcessModelOutputs": {
    },
  • "postProcessAnnotationSetOutputs": {
    },
  • "postProcessImageSetOutputs": {
    },
  • "engageOutputs": {
    },
  • "publishOutputs": {
    }
}

Creates a new Job.

Creates a new Job.

Authorizations:
oidc
path Parameters
project
required
string
Request Body schema: application/json
required
object (v1alphaJob)

Job represents a long-running background operation.

displayName
string

Required. Immutable. Human readable description.

description
string

Optional. Immutable. Human readable description.

jobType
string (v1alphaJobType)
Enum: "JOB_TYPE_OCR" "JOB_TYPE_CONCAT" "JOB_TYPE_SPLIT" "JOB_TYPE_FILTER" "JOB_TYPE_TRAIN" "JOB_TYPE_PREDICT" "JOB_TYPE_POSTPROCESS_DOCUMENT_SET" "JOB_TYPE_EXPORT_ANNOTATION_SET" "JOB_TYPE_EXPORT_IMAGES" "JOB_TYPE_POSTPROCESS_MODEL" "JOB_TYPE_POSTPROCESS_IMAGE_SET" "JOB_TYPE_POSTPROCESS_ANNOTATION_SET" "JOB_TYPE_ENGAGE" "JOB_TYPE_PUBLISH"

Required. Immutable. Specifies the type of the Job.

  • JOB_TYPE_OCR: Runs OCR on given DocumentSet.
  • JOB_TYPE_CONCAT: Concatenates two or more AnnotationSets, producing a new AnnotationSet collection.
  • JOB_TYPE_SPLIT: Splits on AnnotationSet, producing one or more AnnotationSet collection.
  • JOB_TYPE_FILTER: TODO: add comment.
  • JOB_TYPE_TRAIN: Trains a model.
  • JOB_TYPE_PREDICT: Predicts using specified model.
  • JOB_TYPE_POSTPROCESS_DOCUMENT_SET: Post-processes the given DocumentSet. Runs automatically on DocumentSet import.
  • JOB_TYPE_EXPORT_ANNOTATION_SET: Creates Annotations set, which is suitable for exporting.
  • JOB_TYPE_EXPORT_IMAGES: Creates ZIP archive containing all the supplied AnnotationSets and the referenced images.
  • JOB_TYPE_POSTPROCESS_MODEL: Post-processes the given Model. Runs automatically on Model import.
  • JOB_TYPE_POSTPROCESS_IMAGE_SET: Post-processes the given ImageSet. Runs automatically on ImageSet import.
  • JOB_TYPE_POSTPROCESS_ANNOTATION_SET: Post-processes the given AnnotationSet. Runs automatically on AnnotationSet import.
  • JOB_TYPE_ENGAGE: Runs the whole Document.ai pipeline end-to-end.
  • JOB_TYPE_PUBLISH: Publish the given Models to the Scoring Service
object

Optional. Annotations assigned.

object (v1alphaOCRInputs)

Required if job_type is JOB_TYPE_OCR. Immutable.

object (v1alphaConcatInputs)

Required if job_type is JOB_TYPE_CONCAT. Immutable.

object (v1alphaSplitInputs)

Required if job_type is JOB_TYPE_SPLIT. Immutable.

object (v1alphaFilterInputs)

Required if job_type is JOB_TYPE_FILTER. Immutable.

object (v1alphaTrainInputs)

Required if job_type is JOB_TYPE_TRAIN. Immutable.

object (v1alphaPredictInputs)

Required if job_type is JOB_TYPE_PREDICT. Immutable.

object (v1alphaPostProcessDocumentSetInputs)
object (v1alphaExportAnnotationSetInputs)
object (v1alphaExportImagesInputs)
object (v1alphaPostProcessModelInputs)
object (v1alphaPostProcessAnnotationSetInputs)
object (v1alphaPostProcessImageSetInputs)
object (v1alphaEngageInputs)
object (Required if job_type is JOB_TYPE_PUBLISH. Immutable. Required one of classification_model_name or labelling_model_name)
object (v1alphaOCROutputs)

Set if job_type is JOB_TYPE_OCR and the Job is DONE.

object (v1alphaConcatOutputs)

Set if job_type is JOB_TYPE_CONCAT and the Job is DONE.

object (v1alphaSplitOutputs)

Set if job_type is JOB_TYPE_SPLIT and the Job is DONE.

object (v1alphaFilterOutputs)

Set if job_type is JOB_TYPE_FILTER and the Job is DONE.

object (v1alphaTrainOutputs)

Set if job_type is JOB_TYPE_TRAIN and the Job is DONE.

object (v1alphaPredictOutputs)

Set if job_type is JOB_TYPE_PREDICT and the Job is DONE.

object (v1alphaPostProcessDocumentSetOutputs)
object (v1alphaExportAnnotationSetOutputs)
object (v1alphaExportImagesOutputs)
object (v1alphaPostProcessModelOutputs)
object (v1alphaPostProcessAnnotationSetOutputs)
object (v1alphaPostProcessImageSetOutputs)
object (v1alphaEngageOutputs)
object (v1alphaPublishOutputs)

Set if job_type is JOB_TYPE_PUBLISH and the Job is DONE.

Responses

Request samples

Content type
application/json
{
  • "job": {
    }
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "parent": "string",
  • "displayName": "string",
  • "description": "string",
  • "createTime": "2019-08-24T14:15:22Z",
  • "lastUpdateTime": "2019-08-24T14:15:22Z",
  • "status": "JOB_STATUS_PENDING",
  • "error": {
    },
  • "totalSteps": 0,
  • "currentStep": 0,
  • "jobType": "JOB_TYPE_OCR",
  • "annotations": {
    },
  • "logsUrl": "string",
  • "warningsUrl": "string",
  • "ocrInputs": {
    },
  • "concatInputs": {
    },
  • "splitInputs": {
    },
  • "filterInputs": {
    },
  • "trainInputs": {
    },
  • "predictInputs": {
    },
  • "postProcessDocumentSetInputs": {
    },
  • "exportAnnotationSetInputs": {
    },
  • "exportImagesInputs": {
    },
  • "postProcessModelInputs": {
    },
  • "postProcessAnnotationSetInput": {
    },
  • "postProcessImageSetInputs": {
    },
  • "engageInputs": {
    },
  • "publishInputs": {
    },
  • "ocrOutputs": {
    },
  • "concatOutputs": {
    },
  • "splitOutputs": {
    },
  • "filterOutputs": {
    },
  • "trainOutputs": {
    },
  • "predictOutputs": {
    },
  • "postProcessDocumentSetOutputs": {
    },
  • "exportAnnotationSetOutputs": {
    },
  • "exportImagesOutputs": {
    },
  • "postProcessModelOutputs": {
    },
  • "postProcessAnnotationSetOutputs": {
    },
  • "postProcessImageSetOutputs": {
    },
  • "engageOutputs": {
    },
  • "publishOutputs": {
    }
}

Completes the multipart upload.

Completes the multipart upload. No parts can be uploaded after this call and the content is considered complete and ready to be accessed. If there are any validations to be executed regarding the Model upload, they are executed now.

Authorizations:
oidc
path Parameters
project
required
string
model
required
string
version
required
string

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "parent": "string",
  • "displayName": "string",
  • "description": "string",
  • "createTime": "2019-08-24T14:15:22Z",
  • "lastUpdateTime": "2019-08-24T14:15:22Z",
  • "status": "JOB_STATUS_PENDING",
  • "error": {
    },
  • "totalSteps": 0,
  • "currentStep": 0,
  • "jobType": "JOB_TYPE_OCR",
  • "annotations": {
    },
  • "logsUrl": "string",
  • "warningsUrl": "string",
  • "ocrInputs": {
    },
  • "concatInputs": {
    },
  • "splitInputs": {
    },
  • "filterInputs": {
    },
  • "trainInputs": {
    },
  • "predictInputs": {
    },
  • "postProcessDocumentSetInputs": {
    },
  • "exportAnnotationSetInputs": {
    },
  • "exportImagesInputs": {
    },
  • "postProcessModelInputs": {
    },
  • "postProcessAnnotationSetInput": {
    },
  • "postProcessImageSetInputs": {
    },
  • "engageInputs": {
    },
  • "publishInputs": {
    },
  • "ocrOutputs": {
    },
  • "concatOutputs": {
    },
  • "splitOutputs": {
    },
  • "filterOutputs": {
    },
  • "trainOutputs": {
    },
  • "predictOutputs": {
    },
  • "postProcessDocumentSetOutputs": {
    },
  • "exportAnnotationSetOutputs": {
    },
  • "exportImagesOutputs": {
    },
  • "postProcessModelOutputs": {
    },
  • "postProcessAnnotationSetOutputs": {
    },
  • "postProcessImageSetOutputs": {
    },
  • "engageOutputs": {
    },
  • "publishOutputs": {
    }
}

Copies resource into another collection.

Copies resource into another, potentially new, collection.

Authorizations:
oidc
path Parameters
project
required
string
model
required
string
version
required
string
Request Body schema: application/json
required
target
string

Optional. Target collection name in format projects/<UUID>/documentAI/models/<UUID>. New collection will be created if not set.

Responses

Request samples

Content type
application/json
{
  • "target": "string"
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "parent": "string",
  • "isLatest": true,
  • "filename": "string",
  • "jobName": "string",
  • "displayName": "string",
  • "description": "string",
  • "createTime": "2019-08-24T14:15:22Z",
  • "updateTime": "2019-08-24T14:15:22Z",
  • "annotations": {
    },
  • "downloadUrl": "string",
  • "modelType": "MODEL_TYPE_TOKEN_LABELING",
  • "status": "ARTIFACT_STATUS_NOT_YET_READY",
  • "sizeInStorage": "string",
  • "acl": [
    ]
}

Creates a new version in previously created Model collection. Content is uploaded in multiple subsequent requests.

Creates a new version in previously created Model collection. Content (model archive) is uploaded in multiple subsequent requests to UploadModelVersionPart. Use CompleteModelVersionMultipartUpload to complete the multipart upload. The UploadModelVersionPart is defined as follows:

  • POST /v1alpha/{name=projects/*/documentAI/models/*/versions/*}:uploadPart

  • Headers:

    • Part-Number: Part number of part being uploaded. This is a positive integer between 1 and 10,000.

  • Body: content of the part All validations, if any, are executed during CompleteModelVersionMultipartUpload call.

Authorizations:
oidc
path Parameters
project
required
string
model
required
string
Request Body schema: application/json
required
mime
string

Required. MIME type of this resource, for example application/zip.

object (v1alphaModel)

Model represents a model.

Responses

Request samples

Content type
application/json
{
  • "mime": "string",
  • "model": {
    }
}

Response samples

Content type
application/json
{
  • "name": "string"
}

Creates a new version in previously created Model collection.

Creates a new version in previously created Model collection. For larger Models consider CreateModelVersionMultipartUpload method.

Authorizations:
oidc
path Parameters
project
required
string
model
required
string
Request Body schema: application/json
required
object (v1alphaFileInput)

FileInput represents an input file. It can define either base64 encoded content or a URL where to get the content. Different URL schemes are supported, such as http:// or xs://.

mime
string

Required. MIME type of this resource, for example application/zip.

object (v1alphaModel)

Model represents a model.

Responses

Request samples

Content type
application/json
{
  • "modelArchive": {
    },
  • "mime": "string",
  • "model": {
    }
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "parent": "string",
  • "displayName": "string",
  • "description": "string",
  • "createTime": "2019-08-24T14:15:22Z",
  • "lastUpdateTime": "2019-08-24T14:15:22Z",
  • "status": "JOB_STATUS_PENDING",
  • "error": {
    },
  • "totalSteps": 0,
  • "currentStep": 0,
  • "jobType": "JOB_TYPE_OCR",
  • "annotations": {
    },
  • "logsUrl": "string",
  • "warningsUrl": "string",
  • "ocrInputs": {
    },
  • "concatInputs": {
    },
  • "splitInputs": {
    },
  • "filterInputs": {
    },
  • "trainInputs": {
    },
  • "predictInputs": {
    },
  • "postProcessDocumentSetInputs": {
    },
  • "exportAnnotationSetInputs": {
    },
  • "exportImagesInputs": {
    },
  • "postProcessModelInputs": {
    },
  • "postProcessAnnotationSetInput": {
    },
  • "postProcessImageSetInputs": {
    },
  • "engageInputs": {
    },
  • "publishInputs": {
    },
  • "ocrOutputs": {
    },
  • "concatOutputs": {
    },
  • "splitOutputs": {
    },
  • "filterOutputs": {
    },
  • "trainOutputs": {
    },
  • "predictOutputs": {
    },
  • "postProcessDocumentSetOutputs": {
    },
  • "exportAnnotationSetOutputs": {
    },
  • "exportImagesOutputs": {
    },
  • "postProcessModelOutputs": {
    },
  • "postProcessAnnotationSetOutputs": {
    },
  • "postProcessImageSetOutputs": {
    },
  • "engageOutputs": {
    },
  • "publishOutputs": {
    }
}

Creates a new Model and a new collection. Content is uploaded in multiple subsequent requests.

Creates a new Model and a new collection. Content (model archive) is uploaded in multiple subsequent requests to UploadModelVersionPart. Use CompleteModelVersionMultipartUpload to complete the multipart upload. The UploadModelVersionPart is defined as follows:

  • POST /v1alpha/{name=projects/*/documentAI/models/*/versions/*}:uploadPart

  • Headers:

    • Part-Number: Part number of part being uploaded. This is a positive integer between 1 and 10,000.

  • Body: content of the part All validations, if any, are executed during CompleteModelVersionMultipartUpload call.

Authorizations:
oidc
path Parameters
project
required
string
Request Body schema: application/json
required
mime
string

Required. MIME type of this resource, for example application/zip.

object (v1alphaModel)

Model represents a model.

Responses

Request samples

Content type
application/json
{
  • "mime": "string",
  • "model": {
    }
}

Response samples

Content type
application/json
{
  • "name": "string"
}

Creates a new Model and a new collection.

Creates a new Model and a new collection. For larger Models consider CreateModelMultipartUpload method.

Authorizations:
oidc
path Parameters
project
required
string
Request Body schema: application/json
required
object (v1alphaFileInput)

FileInput represents an input file. It can define either base64 encoded content or a URL where to get the content. Different URL schemes are supported, such as http:// or xs://.

mime
string

Required. MIME type of this resource, for example application/zip.

object (v1alphaModel)

Model represents a model.

Responses

Request samples

Content type
application/json
{
  • "modelArchive": {
    },
  • "mime": "string",
  • "model": {
    }
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "parent": "string",
  • "displayName": "string",
  • "description": "string",
  • "createTime": "2019-08-24T14:15:22Z",
  • "lastUpdateTime": "2019-08-24T14:15:22Z",
  • "status": "JOB_STATUS_PENDING",
  • "error": {
    },
  • "totalSteps": 0,
  • "currentStep": 0,
  • "jobType": "JOB_TYPE_OCR",
  • "annotations": {
    },
  • "logsUrl": "string",
  • "warningsUrl": "string",
  • "ocrInputs": {
    },
  • "concatInputs": {
    },
  • "splitInputs": {
    },
  • "filterInputs": {
    },
  • "trainInputs": {
    },
  • "predictInputs": {
    },
  • "postProcessDocumentSetInputs": {
    },
  • "exportAnnotationSetInputs": {
    },
  • "exportImagesInputs": {
    },
  • "postProcessModelInputs": {
    },
  • "postProcessAnnotationSetInput": {
    },
  • "postProcessImageSetInputs": {
    },
  • "engageInputs": {
    },
  • "publishInputs": {
    },
  • "ocrOutputs": {
    },
  • "concatOutputs": {
    },
  • "splitOutputs": {
    },
  • "filterOutputs": {
    },
  • "trainOutputs": {
    },
  • "predictOutputs": {
    },
  • "postProcessDocumentSetOutputs": {
    },
  • "exportAnnotationSetOutputs": {
    },
  • "exportImagesOutputs": {
    },
  • "postProcessModelOutputs": {
    },
  • "postProcessAnnotationSetOutputs": {
    },
  • "postProcessImageSetOutputs": {
    },
  • "engageOutputs": {
    },
  • "publishOutputs": {
    }
}

PENDING - Delete

PENDING - Deletes ALL versions of the resource. This operation is irreversible.

Deletes ALL versions of the resource. This operation is irreversible.

Authorizations:
oidc
path Parameters
project
required
string
annotationSet
required
string
query Parameters
force
boolean

Optional. If set, children will be deleted as well. If not set and children are present, request fails.

Responses

Response samples

Content type
application/json
{
  • "versions": [
    ]
}

PENDING - Deletes the specified version of the resource. This operation is irreversible.

Deletes the specified version of the resource. This operation is irreversible. If there's no other version of the resource after this call, the resource is removed.

Authorizations:
oidc
path Parameters
project
required
string
annotationSet
required
string
version
required
string

Responses

Response samples

Content type
application/json
{ }

PENDING - Deletes the specified version of the resource. This operation is irreversible.

Deletes the specified version of the resource. This operation is irreversible.

Authorizations:
oidc
path Parameters
project
required
string
documentSet
required
string
version
required
string

Responses

Response samples

Content type
application/json
{ }

PENDING - Deletes the specified version of the resource. This operation is irreversible.

Deletes the specified version of the resource. This operation is irreversible.

Authorizations:
oidc
path Parameters
project
required
string
imageSet
required
string
version
required
string

Responses

Response samples

Content type
application/json
{ }

PENDING - Deletes a Job.

Deletes a Job. If results of this job are not deleted already, an error is returned.

Authorizations:
oidc
path Parameters
project
required
string
job
required
string

Responses

Response samples

Content type
application/json
{ }

PENDING - Deletes ALL versions of the resource. This operation is irreversible.

Deletes ALL versions of the resource. This operation is irreversible.

Authorizations:
oidc
path Parameters
project
required
string
model
required
string
query Parameters
force
boolean

Optional. If set, children will be deleted as well. If not set and children are present, request fails.

Responses

Response samples

Content type
application/json
{
  • "versions": [
    ]
}

PENDING - Deletes the specified version of the resource. This operation is irreversible.

Deletes the specified version of the resource. This operation is irreversible. If there's no other version of the resource after this call, the resource is removed.

Authorizations:
oidc
path Parameters
project
required
string
model
required
string
version
required
string

Responses

Response samples

Content type
application/json
{ }

PENDING - Deletes the specified version of the resource. This operation is irreversible.

Deletes the specified version of the resource. This operation is irreversible. If there's no other version of the resource after this call, the resource is removed.

Authorizations:
oidc
path Parameters
project
required
string
resultSet
required
string
version
required
string

Responses

Response samples

Content type
application/json
{ }

Read

Returns metadata of the specified AnnotationSet.

Returns metadata of the specified Annotation Set.

Authorizations:
oidc
path Parameters
project
required
string
annotationSet
required
string
version
required
string

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "parent": "string",
  • "isLatest": true,
  • "filename": "string",
  • "jobName": "string",
  • "displayName": "string",
  • "description": "string",
  • "createTime": "2019-08-24T14:15:22Z",
  • "updateTime": "2019-08-24T14:15:22Z",
  • "annotations": {
    },
  • "downloadUrl": "string",
  • "status": "ARTIFACT_STATUS_NOT_YET_READY",
  • "attributes": null,
  • "documentCount": 0,
  • "pageCount": 0,
  • "metricsReport": null,
  • "sizeInStorage": "string"
}

Returns dependencies of the AnnotationSet.

Returns dependencies of the AnnotationSet.

Authorizations:
oidc
path Parameters
project
required
string
annotationSet
required
string
version
required
string

Responses

Response samples

Content type
application/json
{
  • "dependencies": [
    ]
}

Returns metadata of the latest AnnotationSet in the specified collection.

Returns metadata of the latest AnnotationSet in the specified collection.

Authorizations:
oidc
path Parameters
project
required
string
annotationSet
required
string

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "parent": "string",
  • "isLatest": true,
  • "filename": "string",
  • "jobName": "string",
  • "displayName": "string",
  • "description": "string",
  • "createTime": "2019-08-24T14:15:22Z",
  • "updateTime": "2019-08-24T14:15:22Z",
  • "annotations": {
    },
  • "downloadUrl": "string",
  • "status": "ARTIFACT_STATUS_NOT_YET_READY",
  • "attributes": null,
  • "documentCount": 0,
  • "pageCount": 0,
  • "metricsReport": null,
  • "sizeInStorage": "string"
}

Searches AnnotationSets based on specified criteria.

Searches AnnotationSets based on specified criteria. Multiple versions from one collection might be returned.

Authorizations:
oidc
path Parameters
project
required
string
query Parameters
pageSize
integer <int32>

Optional. Specifies the maximum number of results to be returned by the server. The server may further constrain the maximum number of results returned in a single page.

pageToken
string

Optional. The pagination token (returned in list response). If empty, first page is returned.

annotations
string

This is a request variable of the map type. The query format is "map_name[key]=value", e.g. If the map name is Age, the key type is string, and the value type is integer, the query parameter is expressed as Age["bob"]=18

allVersions
boolean

Optional. Flag indicating whether to return all version in a collection or just the latest one.

Responses

Response samples

Content type
application/json
{
  • "totalSize": 0,
  • "nextPageToken": "string",
  • "annotationSets": [
    ]
}

Returns metadata of the specified DocumentSet.

Returns metadata of the specified DocumentSet.

Authorizations:
oidc
path Parameters
project
required
string
documentSet
required
string
version
required
string

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "parent": "string",
  • "filename": "string",
  • "jobName": "string",
  • "displayName": "string",
  • "description": "string",
  • "createTime": "2019-08-24T14:15:22Z",
  • "updateTime": "2019-08-24T14:15:22Z",
  • "annotations": {
    },
  • "downloadUrl": "string",
  • "status": "ARTIFACT_STATUS_NOT_YET_READY",
  • "documentCount": 0,
  • "pageCount": 0,
  • "ocrStatus": "OCR_STATUS_NONE_SCHEDULED",
  • "sizeInStorage": "string"
}

Returns dependencies of the DocumentSet.

Returns dependencies of the DocumentSet.

Authorizations:
oidc
path Parameters
project
required
string
documentSet
required
string
version
required
string

Responses

Response samples

Content type
application/json
{
  • "dependencies": [
    ]
}

Searches DocumentSets based on specified criteria.

Searches DocumentSets based on specified criteria. Multiple versions from one collection might be returned.

Authorizations:
oidc
path Parameters
project
required
string
query Parameters
pageSize
integer <int32>

Optional. Specifies the maximum number of results to be returned by the server. The server may further constrain the maximum number of results returned in a single page.

pageToken
string

Optional. The pagination token (returned in list response). If empty, first page is returned.

annotations
string

This is a request variable of the map type. The query format is "map_name[key]=value", e.g. If the map name is Age, the key type is string, and the value type is integer, the query parameter is expressed as Age["bob"]=18

Responses

Response samples

Content type
application/json
{
  • "totalSize": 0,
  • "nextPageToken": "string",
  • "documentSets": [
    ]
}

Returns metadata of the specified ImageSet.

Returns metadata of the specified ImageSet.

Authorizations:
oidc
path Parameters
project
required
string
imageSet
required
string
version
required
string

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "parent": "string",
  • "documentSetParent": "string",
  • "filename": "string",
  • "jobName": "string",
  • "displayName": "string",
  • "description": "string",
  • "createTime": "2019-08-24T14:15:22Z",
  • "updateTime": "2019-08-24T14:15:22Z",
  • "annotations": {
    },
  • "downloadUrls": [
    ],
  • "status": "ARTIFACT_STATUS_NOT_YET_READY",
  • "sizeInStorage": "string"
}

Searches ImageSets based on specified criteria.

Searches ImageSets based on specified criteria. Multiple versions from one collection might be returned.

Authorizations:
oidc
path Parameters
project
required
string
query Parameters
pageSize
integer <int32>

Optional. Specifies the maximum number of results to be returned by the server. The server may further constrain the maximum number of results returned in a single page.

pageToken
string

Optional. The pagination token (returned in list response). If empty, first page is returned.

annotations
string

This is a request variable of the map type. The query format is "map_name[key]=value", e.g. If the map name is Age, the key type is string, and the value type is integer, the query parameter is expressed as Age["bob"]=18

Responses

Response samples

Content type
application/json
{
  • "totalSize": 0,
  • "nextPageToken": "string",
  • "imageSets": [
    ]
}

Returns a Job.

Returns a Job.

Authorizations:
oidc
path Parameters
project
required
string
job
required
string

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "parent": "string",
  • "displayName": "string",
  • "description": "string",
  • "createTime": "2019-08-24T14:15:22Z",
  • "lastUpdateTime": "2019-08-24T14:15:22Z",
  • "status": "JOB_STATUS_PENDING",
  • "error": {
    },
  • "totalSteps": 0,
  • "currentStep": 0,
  • "jobType": "JOB_TYPE_OCR",
  • "annotations": {
    },
  • "logsUrl": "string",
  • "warningsUrl": "string",
  • "ocrInputs": {
    },
  • "concatInputs": {
    },
  • "splitInputs": {
    },
  • "filterInputs": {
    },
  • "trainInputs": {
    },
  • "predictInputs": {
    },
  • "postProcessDocumentSetInputs": {
    },
  • "exportAnnotationSetInputs": {
    },
  • "exportImagesInputs": {
    },
  • "postProcessModelInputs": {
    },
  • "postProcessAnnotationSetInput": {
    },
  • "postProcessImageSetInputs": {
    },
  • "engageInputs": {
    },
  • "publishInputs": {
    },
  • "ocrOutputs": {
    },
  • "concatOutputs": {
    },
  • "splitOutputs": {
    },
  • "filterOutputs": {
    },
  • "trainOutputs": {
    },
  • "predictOutputs": {
    },
  • "postProcessDocumentSetOutputs": {
    },
  • "exportAnnotationSetOutputs": {
    },
  • "exportImagesOutputs": {
    },
  • "postProcessModelOutputs": {
    },
  • "postProcessAnnotationSetOutputs": {
    },
  • "postProcessImageSetOutputs": {
    },
  • "engageOutputs": {
    },
  • "publishOutputs": {
    }
}

Searches Jobs based on specified criteria.

Searches Jobs based on specified criteria.

Authorizations:
oidc
path Parameters
project
required
string
query Parameters
pageSize
integer <int32>

Optional. Specifies the maximum number of results to be returned by the server. The server may further constrain the maximum number of results returned in a single page.

pageToken
string

Optional. The pagination token (returned in list response). If empty, first page is returned.

Responses

Response samples

Content type
application/json
{
  • "totalSize": 0,
  • "nextPageToken": "string",
  • "jobs": [
    ]
}

Returns metadata of the specified Model.

Returns metadata of the specified Model.

Authorizations:
oidc
path Parameters
project
required
string
model
required
string
version
required
string

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "parent": "string",
  • "isLatest": true,
  • "filename": "string",
  • "jobName": "string",
  • "displayName": "string",
  • "description": "string",
  • "createTime": "2019-08-24T14:15:22Z",
  • "updateTime": "2019-08-24T14:15:22Z",
  • "annotations": {
    },
  • "downloadUrl": "string",
  • "modelType": "MODEL_TYPE_TOKEN_LABELING",
  • "status": "ARTIFACT_STATUS_NOT_YET_READY",
  • "sizeInStorage": "string",
  • "acl": [
    ]
}

Returns metadata of the latest Model in the specified collection.

Returns metadata of the latest Model in the specified collection.

Authorizations:
oidc
path Parameters
project
required
string
model
required
string

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "parent": "string",
  • "isLatest": true,
  • "filename": "string",
  • "jobName": "string",
  • "displayName": "string",
  • "description": "string",
  • "createTime": "2019-08-24T14:15:22Z",
  • "updateTime": "2019-08-24T14:15:22Z",
  • "annotations": {
    },
  • "downloadUrl": "string",
  • "modelType": "MODEL_TYPE_TOKEN_LABELING",
  • "status": "ARTIFACT_STATUS_NOT_YET_READY",
  • "sizeInStorage": "string",
  • "acl": [
    ]
}

Searches Models based on specified criteria.

Searches Models based on specified criteria. Multiple versions from one collection might be returned.

Authorizations:
oidc
path Parameters
project
required
string
query Parameters
pageSize
integer <int32>

Optional. Specifies the maximum number of results to be returned by the server. The server may further constrain the maximum number of results returned in a single page.

pageToken
string

Optional. The pagination token (returned in list response). If empty, first page is returned.

annotations
string

This is a request variable of the map type. The query format is "map_name[key]=value", e.g. If the map name is Age, the key type is string, and the value type is integer, the query parameter is expressed as Age["bob"]=18

allVersions
boolean

Optional. Flag indicating whether to return all version in a collection or just the latest one.

Responses

Response samples

Content type
application/json
{
  • "totalSize": 0,
  • "nextPageToken": "string",
  • "models": [
    ]
}

Returns overview of a specified Project.

Return overview of a specified Project, which contains information like how many DocumentSets, ImageSets and other resources are in the specified Project.

Authorizations:
oidc
path Parameters
project
required
string

Responses

Response samples

Content type
application/json
{
  • "documentSetsCount": 0,
  • "annotationSetsCount": 0,
  • "modelsCount": 0,
  • "resultSetsCount": 0,
  • "jobsCount": 0
}

Returns metadata of the specified ResultSet.

Returns metadata of the specified ResultSet.

Authorizations:
oidc
path Parameters
project
required
string
resultSet
required
string
version
required
string

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "parent": "string",
  • "isLatest": true,
  • "filename": "string",
  • "jobName": "string",
  • "displayName": "string",
  • "description": "string",
  • "createTime": "2019-08-24T14:15:22Z",
  • "updateTime": "2019-08-24T14:15:22Z",
  • "annotations": {
    },
  • "downloadUrl": "string",
  • "status": "ARTIFACT_STATUS_NOT_YET_READY"
}

Searches ResultSets based on specified criteria.

Searches ResultSets based on specified criteria. Multiple versions from one collection might be returned.

Authorizations:
oidc
path Parameters
project
required
string
query Parameters
pageSize
integer <int32>

Optional. Specifies the maximum number of results to be returned by the server. The server may further constrain the maximum number of results returned in a single page.

pageToken
string

Optional. The pagination token (returned in list response). If empty, first page is returned.

annotations
string

This is a request variable of the map type. The query format is "map_name[key]=value", e.g. If the map name is Age, the key type is string, and the value type is integer, the query parameter is expressed as Age["bob"]=18

allVersions
boolean

Optional. Flag indicating whether to return all version in a collection or just the latest one.

Responses

Response samples

Content type
application/json
{
  • "totalSize": 0,
  • "nextPageToken": "string",
  • "resultSets": [
    ]
}

Update

Updates metadata.

Updates metadata.

Authorizations:
oidc
path Parameters
project
required
string
annotationSet
required
string
version
required
string
Request Body schema: application/json
required

AnnotationSet being updated.

filename
string (Required. File name;)
displayName
string

Required. Immutable. Human readable name of the resource.

description
string

Optional. Immutable. Human readable description.

object

Optional. Annotations assigned.

status
string (mlapidocument_aiv1alphaArtifactStatus)
Enum: "ARTIFACT_STATUS_NOT_YET_READY" "ARTIFACT_STATUS_AVAILABLE" "ARTIFACT_STATUS_DELETED" "ARTIFACT_STATUS_FAILED"
attributes
any

Optional. Attributes of this annotation set.

Responses

Request samples

Content type
application/json
{
  • "filename": "string",
  • "displayName": "string",
  • "description": "string",
  • "annotations": {
    },
  • "status": "ARTIFACT_STATUS_NOT_YET_READY",
  • "attributes": null
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "parent": "string",
  • "isLatest": true,
  • "filename": "string",
  • "jobName": "string",
  • "displayName": "string",
  • "description": "string",
  • "createTime": "2019-08-24T14:15:22Z",
  • "updateTime": "2019-08-24T14:15:22Z",
  • "annotations": {
    },
  • "downloadUrl": "string",
  • "status": "ARTIFACT_STATUS_NOT_YET_READY",
  • "attributes": null,
  • "documentCount": 0,
  • "pageCount": 0,
  • "metricsReport": null,
  • "sizeInStorage": "string"
}

Updates metadata.

Updates metadata.

Authorizations:
oidc
path Parameters
project
required
string
documentSet
required
string
version
required
string
Request Body schema: application/json
required

DocumentSet being updated.

filename
string

Required. Immutable. The file name. In case of an application/pdf upload, this name has to be unique across all other documents in given parent. In case of an application/zip upload, the names of the extracted documents must be unique across all other documents in the specified parent.

displayName
string

Required. Immutable. Human readable name of the resource.

description
string

Optional. Immutable. Human readable description.

object

Optional. Annotations assigned.

status
string (mlapidocument_aiv1alphaArtifactStatus)
Enum: "ARTIFACT_STATUS_NOT_YET_READY" "ARTIFACT_STATUS_AVAILABLE" "ARTIFACT_STATUS_DELETED" "ARTIFACT_STATUS_FAILED"
ocrStatus
string (v1alphaOCRStatus)
Enum: "OCR_STATUS_NONE_SCHEDULED" "OCR_STATUS_PROCESSING" "OCR_STATUS_FINISHED" "OCR_STATUS_FAILED"
  • OCR_STATUS_NONE_SCHEDULED: No OCR job has been scheduled yet.
  • OCR_STATUS_PROCESSING: There is at least one job which is in progress.
  • OCR_STATUS_FINISHED: There are no jobs in progress and at least one job was successful.
  • OCR_STATUS_FAILED: There are no jobs in progress and all of the existing jobs are either failed or cancelled.

Responses

Request samples

Content type
application/json
{
  • "filename": "string",
  • "displayName": "string",
  • "description": "string",
  • "annotations": {
    },
  • "status": "ARTIFACT_STATUS_NOT_YET_READY",
  • "ocrStatus": "OCR_STATUS_NONE_SCHEDULED"
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "parent": "string",
  • "filename": "string",
  • "jobName": "string",
  • "displayName": "string",
  • "description": "string",
  • "createTime": "2019-08-24T14:15:22Z",
  • "updateTime": "2019-08-24T14:15:22Z",
  • "annotations": {
    },
  • "downloadUrl": "string",
  • "status": "ARTIFACT_STATUS_NOT_YET_READY",
  • "documentCount": 0,
  • "pageCount": 0,
  • "ocrStatus": "OCR_STATUS_NONE_SCHEDULED",
  • "sizeInStorage": "string"
}

Updates metadata.

Updates metadata.

Authorizations:
oidc
path Parameters
project
required
string
imageSet
required
string
version
required
string
Request Body schema: application/json
required

ImageSet being updated.

documentSetParent
string

Optional. Immutable. The name of the parent DocumentSet in format documentSets/<UUID>/versions/<INT>. Can be omitted if there's no parent DocumentSet.

filename
string (Required. File name;)
displayName
string

Required. Immutable. Human readable name of the resource.

description
string

Optional. Immutable. Human readable description.

object

Optional. Annotations assigned.

status
string (mlapidocument_aiv1alphaArtifactStatus)
Enum: "ARTIFACT_STATUS_NOT_YET_READY" "ARTIFACT_STATUS_AVAILABLE" "ARTIFACT_STATUS_DELETED" "ARTIFACT_STATUS_FAILED"

Responses

Request samples

Content type
application/json
{
  • "documentSetParent": "string",
  • "filename": "string",
  • "displayName": "string",
  • "description": "string",
  • "annotations": {
    },
  • "status": "ARTIFACT_STATUS_NOT_YET_READY"
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "parent": "string",
  • "documentSetParent": "string",
  • "filename": "string",
  • "jobName": "string",
  • "displayName": "string",
  • "description": "string",
  • "createTime": "2019-08-24T14:15:22Z",
  • "updateTime": "2019-08-24T14:15:22Z",
  • "annotations": {
    },
  • "downloadUrls": [
    ],
  • "status": "ARTIFACT_STATUS_NOT_YET_READY",
  • "sizeInStorage": "string"
}

Updates metadata.

Updates metadata.

Authorizations:
oidc
path Parameters
project
required
string
model
required
string
version
required
string
Request Body schema: application/json
required

Model being updated.

filename
string (Required. File name;)
displayName
string

Required. Immutable. Human readable name of the resource.

description
string

Optional. Immutable. Human readable description.

object

Optional. Annotations assigned.

modelType
string (v1alphaModelType)
Enum: "MODEL_TYPE_TOKEN_LABELING" "MODEL_TYPE_PAGE_CLASSIFICATION"
  • MODEL_TYPE_TOKEN_LABELING: Model usable for token labeling problems.
  • MODEL_TYPE_PAGE_CLASSIFICATION: Model usable for page classification problems.
status
string (mlapidocument_aiv1alphaArtifactStatus)
Enum: "ARTIFACT_STATUS_NOT_YET_READY" "ARTIFACT_STATUS_AVAILABLE" "ARTIFACT_STATUS_DELETED" "ARTIFACT_STATUS_FAILED"
acl
Array of strings (Required. Model's ACL)

Responses

Request samples

Content type
application/json
{
  • "filename": "string",
  • "displayName": "string",
  • "description": "string",
  • "annotations": {
    },
  • "modelType": "MODEL_TYPE_TOKEN_LABELING",
  • "status": "ARTIFACT_STATUS_NOT_YET_READY",
  • "acl": [
    ]
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "parent": "string",
  • "isLatest": true,
  • "filename": "string",
  • "jobName": "string",
  • "displayName": "string",
  • "description": "string",
  • "createTime": "2019-08-24T14:15:22Z",
  • "updateTime": "2019-08-24T14:15:22Z",
  • "annotations": {
    },
  • "downloadUrl": "string",
  • "modelType": "MODEL_TYPE_TOKEN_LABELING",
  • "status": "ARTIFACT_STATUS_NOT_YET_READY",
  • "sizeInStorage": "string",
  • "acl": [
    ]
}

Updates metadata.

Updates metadata.

Authorizations:
oidc
path Parameters
project
required
string
resultSet
required
string
version
required
string
Request Body schema: application/json
required

ResultSet being updated.

filename
string (Required. File name;)
displayName
string

Required. Immutable. Human readable name of the resource.

description
string

Optional. Immutable. Human readable description.

object

Optional. Annotations assigned.

status
string (mlapidocument_aiv1alphaArtifactStatus)
Enum: "ARTIFACT_STATUS_NOT_YET_READY" "ARTIFACT_STATUS_AVAILABLE" "ARTIFACT_STATUS_DELETED" "ARTIFACT_STATUS_FAILED"

Responses

Request samples

Content type
application/json
{
  • "filename": "string",
  • "displayName": "string",
  • "description": "string",
  • "annotations": {
    },
  • "status": "ARTIFACT_STATUS_NOT_YET_READY"
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "parent": "string",
  • "isLatest": true,
  • "filename": "string",
  • "jobName": "string",
  • "displayName": "string",
  • "description": "string",
  • "createTime": "2019-08-24T14:15:22Z",
  • "updateTime": "2019-08-24T14:15:22Z",
  • "annotations": {
    },
  • "downloadUrl": "string",
  • "status": "ARTIFACT_STATUS_NOT_YET_READY"
}

Delete

Deletes the specified version of the resource. Deletes also the dependents. The allow_list field in the request can be used to control what is going to be deleted.

Deletes the specified version of the resource and deletes the dependents as well. If the allow_list field is set in the request, then only artifacts with the listed resource names are allowed to be deleted. If other dependents not present in the list are found, the process is aborted. This is used by clients to ensure that only approved artifacts are going to be deleted. Automated scripts and similar clients should omit this field, in that case all dependents are removed.

Authorizations:
oidc
path Parameters
project
required
string
annotationSet
required
string
version
required
string
query Parameters
allowList
Array of strings

Optional. Resource names of the dependents to delete. If there are additional dependents not mentioned in this list the operation is aborted. If not set, all the dependents are deleted.

Responses

Response samples

Content type
application/json
{ }

Deletes the specified version of the resource. Deletes also the dependents. The allow_list field in the request can be used to control what is going to be deleted.

Deletes the specified version of the resource and deletes the dependents as well. If the allow_list field is set in the request, then only artifacts with the listed resource names are allowed to be deleted. If other dependents not present in the list are found, the process is aborted. This is used by clients to ensure that only approved artifacts are going to be deleted. Automated scripts and similar clients should omit this field, in that case all dependents are removed.

Authorizations:
oidc
path Parameters
project
required
string
documentSet
required
string
version
required
string
query Parameters
allowList
Array of strings

Optional. Resource names of the dependents to delete. If there are additional dependents not mentioned in this list the operation is aborted. If not set, all the dependents are deleted.

Responses

Response samples

Content type
application/json
{ }

Deletes ALL versions of the resource. This operation is irreversible.

Deletes ALL versions of the resource. This operation is irreversible.

Authorizations:
oidc
path Parameters
project
required
string
resultSet
required
string
query Parameters
force
boolean

Optional. If set, children will be deleted as well. If not set and children are present, request fails.

Responses

Response samples

Content type
application/json
{
  • "versions": [
    ]
}

PENDING - Create

PENDING - Copies resource into another collection.

Copies resource into another, potentially new, collection.

Authorizations:
oidc
path Parameters
project
required
string
annotationSet
required
string
version
required
string
Request Body schema: application/json
required
target
string

Optional. Target collection name in format projects/<UUID>/documentAI/annotationSets/<UUID>. New collection will be created if not set.

Responses

Request samples

Content type
application/json
{
  • "target": "string"
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "parent": "string",
  • "isLatest": true,
  • "filename": "string",
  • "jobName": "string",
  • "displayName": "string",
  • "description": "string",
  • "createTime": "2019-08-24T14:15:22Z",
  • "updateTime": "2019-08-24T14:15:22Z",
  • "annotations": {
    },
  • "downloadUrl": "string",
  • "status": "ARTIFACT_STATUS_NOT_YET_READY",
  • "attributes": null,
  • "documentCount": 0,
  • "pageCount": 0,
  • "metricsReport": null,
  • "sizeInStorage": "string"
}

PENDING - Copies resource into another collection.

Copies resource into another, potentially new, collection.

Authorizations:
oidc
path Parameters
project
required
string
documentSet
required
string
version
required
string
Request Body schema: application/json
required
target
string

Optional. Target collection name in format projects/<UUID>/documentAI/documentSets/<UUID>. New collection will be created if not set.

Responses

Request samples

Content type
application/json
{
  • "target": "string"
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "parent": "string",
  • "displayName": "string",
  • "description": "string",
  • "createTime": "2019-08-24T14:15:22Z",
  • "lastUpdateTime": "2019-08-24T14:15:22Z",
  • "status": "JOB_STATUS_PENDING",
  • "error": {
    },
  • "totalSteps": 0,
  • "currentStep": 0,
  • "jobType": "JOB_TYPE_OCR",
  • "annotations": {
    },
  • "logsUrl": "string",
  • "warningsUrl": "string",
  • "ocrInputs": {
    },
  • "concatInputs": {
    },
  • "splitInputs": {
    },
  • "filterInputs": {
    },
  • "trainInputs": {
    },
  • "predictInputs": {
    },
  • "postProcessDocumentSetInputs": {
    },
  • "exportAnnotationSetInputs": {
    },
  • "exportImagesInputs": {
    },
  • "postProcessModelInputs": {
    },
  • "postProcessAnnotationSetInput": {
    },
  • "postProcessImageSetInputs": {
    },
  • "engageInputs": {
    },
  • "publishInputs": {
    },
  • "ocrOutputs": {
    },
  • "concatOutputs": {
    },
  • "splitOutputs": {
    },
  • "filterOutputs": {
    },
  • "trainOutputs": {
    },
  • "predictOutputs": {
    },
  • "postProcessDocumentSetOutputs": {
    },
  • "exportAnnotationSetOutputs": {
    },
  • "exportImagesOutputs": {
    },
  • "postProcessModelOutputs": {
    },
  • "postProcessAnnotationSetOutputs": {
    },
  • "postProcessImageSetOutputs": {
    },
  • "engageOutputs": {
    },
  • "publishOutputs": {
    }
}

PENDING - Copies resource into another collection.

Copies resource into another, potentially new, collection.

Authorizations:
oidc
path Parameters
project
required
string
imageSet
required
string
version
required
string
Request Body schema: application/json
required
target
string

Optional. Target collection name in format projects/<UUID>/documentAI/imageSets/<UUID>. New collection will be created if not set.

Responses

Request samples

Content type
application/json
{
  • "target": "string"
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "parent": "string",
  • "documentSetParent": "string",
  • "filename": "string",
  • "jobName": "string",
  • "displayName": "string",
  • "description": "string",
  • "createTime": "2019-08-24T14:15:22Z",
  • "updateTime": "2019-08-24T14:15:22Z",
  • "annotations": {
    },
  • "downloadUrls": [
    ],
  • "status": "ARTIFACT_STATUS_NOT_YET_READY",
  • "sizeInStorage": "string"
}

PENDING - Copies resource into another collection.

Copies resource into another, potentially new, collection.

Authorizations:
oidc
path Parameters
project
required
string
resultSet
required
string
version
required
string
Request Body schema: application/json
required
target
string

Optional. Target collection name in format projects/<UUID>/documentAI/resultSets/<UUID>. New collection will be created if not set.

Responses

Request samples

Content type
application/json
{
  • "target": "string"
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "parent": "string",
  • "isLatest": true,
  • "filename": "string",
  • "jobName": "string",
  • "displayName": "string",
  • "description": "string",
  • "createTime": "2019-08-24T14:15:22Z",
  • "updateTime": "2019-08-24T14:15:22Z",
  • "annotations": {
    },
  • "downloadUrl": "string",
  • "status": "ARTIFACT_STATUS_NOT_YET_READY"
}

Manage

Cancels a running Job.

Cancels a running Job. If the job is not running an error is returned.

Authorizations:
oidc
path Parameters
project
required
string
job
required
string

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "parent": "string",
  • "displayName": "string",
  • "description": "string",
  • "createTime": "2019-08-24T14:15:22Z",
  • "lastUpdateTime": "2019-08-24T14:15:22Z",
  • "status": "JOB_STATUS_PENDING",
  • "error": {
    },
  • "totalSteps": 0,
  • "currentStep": 0,
  • "jobType": "JOB_TYPE_OCR",
  • "annotations": {
    },
  • "logsUrl": "string",
  • "warningsUrl": "string",
  • "ocrInputs": {
    },
  • "concatInputs": {
    },
  • "splitInputs": {
    },
  • "filterInputs": {
    },
  • "trainInputs": {
    },
  • "predictInputs": {
    },
  • "postProcessDocumentSetInputs": {
    },
  • "exportAnnotationSetInputs": {
    },
  • "exportImagesInputs": {
    },
  • "postProcessModelInputs": {
    },
  • "postProcessAnnotationSetInput": {
    },
  • "postProcessImageSetInputs": {
    },
  • "engageInputs": {
    },
  • "publishInputs": {
    },
  • "ocrOutputs": {
    },
  • "concatOutputs": {
    },
  • "splitOutputs": {
    },
  • "filterOutputs": {
    },
  • "trainOutputs": {
    },
  • "predictOutputs": {
    },
  • "postProcessDocumentSetOutputs": {
    },
  • "exportAnnotationSetOutputs": {
    },
  • "exportImagesOutputs": {
    },
  • "postProcessModelOutputs": {
    },
  • "postProcessAnnotationSetOutputs": {
    },
  • "postProcessImageSetOutputs": {
    },
  • "engageOutputs": {
    },
  • "publishOutputs": {
    }
}

Internal

Finalizes a pending Job.

Finalizes a pending Job. This is an internal endpoint, invoked by the Job Finalizer, there's no need to invoke this from clients. The underlying compute resource, such as Argo Workflow, must be completed when invoking this.

Authorizations:
oidc
path Parameters
project
required
string
job
required
string

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "parent": "string",
  • "displayName": "string",
  • "description": "string",
  • "createTime": "2019-08-24T14:15:22Z",
  • "lastUpdateTime": "2019-08-24T14:15:22Z",
  • "status": "JOB_STATUS_PENDING",
  • "error": {
    },
  • "totalSteps": 0,
  • "currentStep": 0,
  • "jobType": "JOB_TYPE_OCR",
  • "annotations": {
    },
  • "logsUrl": "string",
  • "warningsUrl": "string",
  • "ocrInputs": {
    },
  • "concatInputs": {
    },
  • "splitInputs": {
    },
  • "filterInputs": {
    },
  • "trainInputs": {
    },
  • "predictInputs": {
    },
  • "postProcessDocumentSetInputs": {
    },
  • "exportAnnotationSetInputs": {
    },
  • "exportImagesInputs": {
    },
  • "postProcessModelInputs": {
    },
  • "postProcessAnnotationSetInput": {
    },
  • "postProcessImageSetInputs": {
    },
  • "engageInputs": {
    },
  • "publishInputs": {
    },
  • "ocrOutputs": {
    },
  • "concatOutputs": {
    },
  • "splitOutputs": {
    },
  • "filterOutputs": {
    },
  • "trainOutputs": {
    },
  • "predictOutputs": {
    },
  • "postProcessDocumentSetOutputs": {
    },
  • "exportAnnotationSetOutputs": {
    },
  • "exportImagesOutputs": {
    },
  • "postProcessModelOutputs": {
    },
  • "postProcessAnnotationSetOutputs": {
    },
  • "postProcessImageSetOutputs": {
    },
  • "engageOutputs": {
    },
  • "publishOutputs": {
    }
}
Feedback