openapi: 3.2.0 info: description: Use Data Labeling Management API to create, list, edit & delete datasets. title: Data Labeling Management API version: '20211001' x-provenance: method: harvested first_party: true publisher: Oracle source: https://docs.oracle.com/en-us/iaas/api/specs/a595c62dbbef0595235745dd826e59437d410e04914007447c8d6414cabfd57b.yaml harvested: '2026-08-04' note: Published by Oracle as the contract for the Data Labeling Management API OCI service and stored verbatim; API Evangelist added only this provenance block. x-evidence: - url: https://docs.oracle.com/en-us/iaas/api/specs/index.json what: Oracle's own index of every OCI service specification - url: https://docs.oracle.com/en-us/iaas/api/specs/a595c62dbbef0595235745dd826e59437d410e04914007447c8d6414cabfd57b.yaml what: the harvested document for Data Labeling Management API servers: - url: http://127.0.0.1/20211001 - url: https://127.0.0.1/20211001 tags: - name: dataLabelingManagement paths: /annotationFormats: get: description: These are a static list in a given region. operationId: ListAnnotationFormats parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: A page of AnnoatationFormatSummary objects. headers: opc-next-page: description: 'For the pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/AnnotationFormatCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Gets a list of all annotation formats available to the data labeling service. tags: - dataLabelingManagement x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/AnnotationFormat' /datasets: get: description: 'Returns a list of Datasets. ' operationId: ListDatasets parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/DatasetIdentifierQueryParam' - $ref: '#/components/parameters/AnnotationFormatQueryParam' - $ref: '#/components/parameters/LifecycleStateQueryParam' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: A page of DatasetSummary objects. headers: opc-next-page: description: 'For the pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/DatasetCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Gets a list of all Datasets in a compartment tags: - dataLabelingManagement x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/DatasetCollection' post: description: 'Creates a new Dataset. ' operationId: CreateDataset parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 201: description: The request was successfully received and the Dataset creation is in progress. headers: Content-Location: description: 'The URI that identifies the entity described in the response body. ' schema: type: string etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string location: description: 'The URI that identifies the entity described in the response body. ' schema: type: string opc-request-id: description: 'A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'A unique Oracle-assigned identifier for the asynchronous request. You can use this to query the status of the asynchronous operation. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Dataset' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Creates a new Dataset tags: - dataLabelingManagement x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/Dataset' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateDatasetDetails' description: Details for the new Dataset. required: true /datasets/{datasetId}: delete: description: Deletes a Dataset resource by identifier operationId: DeleteDataset parameters: - $ref: '#/components/parameters/DatasetIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Accepted the request. The Dataset will be deleted. headers: opc-request-id: description: 'A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'A unique Oracle-assigned identifier for the asynchronous request. You can use this to query the status of the asynchronous operation. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Delete a provisioned Dataset tags: - dataLabelingManagement x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/Dataset' get: description: Gets a Dataset by identifier operationId: GetDataset parameters: - $ref: '#/components/parameters/DatasetIdentifierPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Retrieves the Dataset with the given id headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Dataset' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Get Dataset tags: - dataLabelingManagement x-obmcs-client-retries-enabled: true put: description: Updates the Dataset operationId: UpdateDataset parameters: - $ref: '#/components/parameters/DatasetIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The dataset is updated. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Dataset' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 405: $ref: '#/components/responses/405' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Update the Dataset identified by the id tags: - dataLabelingManagement x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/Dataset' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateDatasetDetails' description: Details for updating a Dataset. required: true /datasets/{datasetId}/actions/addLabels: post: description: 'Add Labels to the Dataset LabelSet until the maximum number of Labels has been reached. ' operationId: AddDatasetLabels parameters: - $ref: '#/components/parameters/DatasetIdentifierPathParam' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Accepted the request. Labels will be added to the LabelSet for the Dataset. headers: opc-request-id: description: 'A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'A unique Oracle-assigned identifier for the asynchronous request. You can use this to query the status of the asynchronous operation. ' schema: type: string 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' summary: Add Labels to the Dataset LabelSet tags: - dataLabelingManagement x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/Dataset' requestBody: content: application/json: schema: $ref: '#/components/schemas/AddDatasetLabelsDetails' description: Details for adding Labels to the LabelSet of the Dataset. required: true /datasets/{datasetId}/actions/changeCompartment: post: description: Moves a Dataset resource from one compartment identifier to another. When provided, If-Match is checked against ETag values of the resource. operationId: ChangeDatasetCompartment parameters: - $ref: '#/components/parameters/DatasetIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Accepted the request. The Dataset resource will be moved into a different compartment. headers: opc-request-id: description: 'A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'A unique Oracle-assigned identifier for the asynchronous request. You can use this to query the status of the asynchronous operation. ' schema: type: string 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' summary: Moves a resource into a different compartment. tags: - dataLabelingManagement x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/Dataset' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeDatasetCompartmentDetails' description: Details for changing the compartment of a Dataset required: true /datasets/{datasetId}/actions/generateDatasetRecords: post: description: Generates Record resources from the Dataset's data source operationId: GenerateDatasetRecords parameters: - $ref: '#/components/parameters/DatasetIdentifierPathParam' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Accepted the request. Records will be generated for the Dataset. headers: opc-request-id: description: 'A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'A unique Oracle-assigned identifier for the asynchronous request. You can use this to query the status of the asynchronous operation. ' schema: type: string 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' summary: Crawl data source and generate dataset records tags: - dataLabelingManagement x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/Dataset' requestBody: content: application/json: schema: $ref: '#/components/schemas/GenerateDatasetRecordsDetails' description: Details for generating Dataset records. required: true /datasets/{datasetId}/actions/removeLabels: post: description: 'Removes the labels from the Dataset Labelset. Labels can only be removed if there are no Annotations associated with the Dataset that reference the Label names. ' operationId: RemoveDatasetLabels parameters: - $ref: '#/components/parameters/DatasetIdentifierPathParam' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Accepted the request. Labels will be added to the LabelSet for the Dataset. headers: opc-request-id: description: 'A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'A unique Oracle-assigned identifier for the asynchronous request. You can use this to query the status of the asynchronous operation. ' schema: type: string 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' summary: Remove Labels from the Dataset LabelSet tags: - dataLabelingManagement x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/Dataset' requestBody: content: application/json: schema: $ref: '#/components/schemas/RemoveDatasetLabelsDetails' description: Details for removing Labels from the LabelSet of the Dataset. required: true /datasets/{datasetId}/actions/renameLabels: post: description: 'Renames the labels from the Dataset Labelset. Labels that are renamed will be reflected in Annotations associated with the Dataset that reference the Label names. ' operationId: RenameDatasetLabels parameters: - $ref: '#/components/parameters/DatasetIdentifierPathParam' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Accepted the request. Labels will be added to the LabelSet for the Dataset. headers: opc-request-id: description: 'A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'A unique Oracle-assigned identifier for the asynchronous request. You can use this to query the status of the asynchronous operation. ' schema: type: string 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' summary: Rename Labels in the Dataset LabelSet tags: - dataLabelingManagement x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/Dataset' requestBody: content: application/json: schema: $ref: '#/components/schemas/RenameDatasetLabelsDetails' description: Details for renaming Labels in the LabelSet of the Dataset. required: true /datasets/{datasetId}/actions/snapshot: post: description: 'Writes the dataset records and annotations in a consolidated format out to an object storage reference for consumption. While the snapshot takes place, there may be a time while records and annotations cannot be created to ensure the snapshot is a point in time. ' operationId: SnapshotDataset parameters: - $ref: '#/components/parameters/DatasetIdentifierPathParam' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Accepted the request. The Dataset snapshot will be saved into object storage. headers: opc-request-id: description: 'A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'A unique Oracle-assigned identifier for the asynchronous request. You can use this to query the status of the asynchronous operation. ' schema: type: string 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' summary: Snapshot dataset to object storage. tags: - dataLabelingManagement x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/Dataset' requestBody: content: application/json: schema: $ref: '#/components/schemas/SnapshotDatasetDetails' description: Details of creating a snapshot of the Dataset's Records and Annotations required: true /workRequests: get: description: 'Lists the work requests in a compartment. ' operationId: ListWorkRequests parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/WorkRequestIdQueryParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' responses: 200: description: The list is being retrieved. headers: opc-next-page: description: 'For the pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/WorkRequestSummaryCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: List Work Requests tags: - dataLabelingManagement x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/WorkRequest' /workRequests/{workRequestId}: get: description: Gets the status of the work request with the given ID. operationId: GetWorkRequest parameters: - $ref: '#/components/parameters/WorkRequestIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The detail of the work request. headers: opc-request-id: description: 'A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string retry-after: description: A decimal number representing the number of seconds the client should wait before polling this endpoint again. schema: type: integer content: application/json: schema: $ref: '#/components/schemas/WorkRequest' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: GET Work Request Status tags: - dataLabelingManagement x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/WorkRequest' /workRequests/{workRequestId}/errors: get: description: 'Return a (paginated) list of errors for a given work request. ' operationId: ListWorkRequestErrors parameters: - $ref: '#/components/parameters/WorkRequestIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' responses: 200: description: List of work request errors. headers: opc-next-page: description: 'For the pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/WorkRequestErrorCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Lists work request errors tags: - dataLabelingManagement x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/WorkRequest' /workRequests/{workRequestId}/logs: get: description: 'Return a (paginated) list of logs for a given work request. ' operationId: ListWorkRequestLogs parameters: - $ref: '#/components/parameters/WorkRequestIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' responses: 200: description: List of work request logs. headers: opc-next-page: description: 'For the pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/WorkRequestLogEntryCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Lists work request logs tags: - dataLabelingManagement x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/WorkRequest' components: schemas: ChangeDatasetCompartmentDetails: description: The payload sent to the Change Dataset compartment operation. properties: compartmentId: description: The OCID of the compartment where the resource should be moved. maxLength: 255 minLength: 1 type: string required: - compartmentId type: object DatasetSummary: description: A dataset summary is the representation returned in list views. It is usually a subset of the full dataset entity and should not contain any potentially sensitive information. properties: annotationFormat: description: The annotation format name required for labeling records. maxLength: 255 minLength: 1 type: string compartmentId: description: Compartment Identifier maxLength: 255 minLength: 1 type: string datasetFormatDetails: $ref: '#/components/schemas/DatasetFormatDetails' definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer, and boolean types are supported. ' type: object description: 'A key-value pair representing predefined tags'' keys and values scoped to a namespace. For example: `{"bar-key": "value"}` ' type: object description: 'The defined tags for this resource. Each key is predefined and scoped to a namespace. For example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object displayName: description: A user-friendly display name for the resource. maxLength: 255 type: string freeformTags: additionalProperties: type: string description: 'A simple key-value pair that is applied without any predefined name, type, or scope. It exists for cross-compatibility only. For example: `{"bar-key": "value"}` ' type: object id: description: The OCID of the Dataset maxLength: 255 minLength: 1 type: string lifecycleDetails: description: A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. type: string lifecycleState: description: The state of a Dataset. type: string x-obmcs-enumref: '#/definitions/Dataset/lifecycleState' systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer, and boolean types are supported. ' type: object description: 'A key-value pair representing system tags'' keys and values scoped to a namespace. For example: `{"bar-key": "value"}` ' type: object description: 'The usage of system tag keys. These predefined keys are scoped to namespaces. For example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: The time the the Dataset was created. An RFC3339 formatted datetime string format: date-time type: string timeUpdated: description: The date and time the resource was last updated, in the timestamp format defined by RFC3339. format: date-time type: string required: - id - compartmentId - timeCreated - timeUpdated - lifecycleState - annotationFormat - datasetFormatDetails type: object UpdateDatasetDetails: description: 'Once the Dataset is defined, it''s largely immutable from a metadata perspective. The records found in the data source itself, may change over time. ' properties: definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer, and boolean types are supported. ' type: object description: 'A key-value pair representing predefined tags'' keys and values scoped to a namespace. For example: `{"bar-key": "value"}` ' type: object description: 'The defined tags for this resource. Each key is predefined and scoped to a namespace. For example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object description: description: A user provided description of the dataset maxLength: 1024 type: string x-default-description: 'null' displayName: description: A user-friendly display name for the resource. maxLength: 255 type: string freeformTags: additionalProperties: type: string description: 'A simple key-value pair that is applied without any predefined name, type, or scope. It exists for cross-compatibility only. For example: `{"bar-key": "value"}` ' type: object labelingInstructions: description: The labeling instructions for human labelers in rich text format maxLength: 32767 minLength: 0 type: string type: object AnnotationFormatCollection: description: Collection of annotation formats. properties: items: description: List of annotation formats. items: $ref: '#/components/schemas/AnnotationFormatSummary' type: array required: - items type: object Error: description: Error Information. properties: code: description: A short error code that defines the error, meant for programmatic parsing. type: string message: description: A human-readable error string. type: string required: - code - message CreateDatasetDetails: description: Parameters needed to create a new Dataset. A Dataset allows a user to describe the data source that provides the Records and how Annotations should be applied to the Records. properties: annotationFormat: description: The annotation format name required for labeling records. maxLength: 255 minLength: 1 type: string compartmentId: description: The OCID of the compartment of the resource. maxLength: 255 minLength: 1 type: string datasetFormatDetails: $ref: '#/components/schemas/DatasetFormatDetails' datasetSourceDetails: $ref: '#/components/schemas/DatasetSourceDetails' definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer, and boolean types are supported. ' type: object description: 'A key-value pair representing predefined tags'' keys and values scoped to a namespace. For example: `{"bar-key": "value"}` ' type: object description: 'The defined tags for this resource. Each key is predefined and scoped to a namespace. For example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object description: description: A user provided description of the dataset maxLength: 1024 type: string x-default-description: 'null' displayName: description: A user-friendly display name for the resource. maxLength: 255 type: string x-default-description: dataset- freeformTags: additionalProperties: type: string description: 'A simple key-value pair that is applied without any predefined name, type, or scope. It exists for cross-compatibility only. For example: `{"bar-key": "value"}` ' type: object initialRecordGenerationConfiguration: $ref: '#/components/schemas/InitialRecordGenerationConfiguration' labelSet: $ref: '#/components/schemas/LabelSet' labelingInstructions: description: The labeling instructions for human labelers in rich text format maxLength: 32767 minLength: 0 type: string required: - compartmentId - annotationFormat - datasetSourceDetails - datasetFormatDetails - labelSet type: object RenameDatasetLabelsDetails: description: 'Renames a subset of Labels in the Dataset''s LabelSet. The Labels in the source LabelSet will be replaced with the Labels in the target LabelSet. Labels are correlated by index, i.e. the first Label in the source LabelSet will be replaced by the first Label in the target LabelSet. If the size of the source and target LabelSets are not equal, the request will be rejected. ' properties: sourceLabelSet: $ref: '#/components/schemas/LabelSet' targetLabelSet: $ref: '#/components/schemas/LabelSet' type: object DatasetCollection: description: Results of a dataset list operation. Contains DatasetSummary items. properties: items: description: List of datasets. items: $ref: '#/components/schemas/DatasetSummary' type: array required: - items type: object Label: description: It represents a label. properties: name: description: An unique name for a label within its dataset. maxLength: 255 type: string type: object AnnotationFormatSummary: description: annotation format summary properties: name: description: 'A unique name for the target AnnotationFormat for the Dataset. ' maxLength: 255 minLength: 1 type: string required: - name type: object ObjectStorageSnapshotExportDetails: allOf: - $ref: '#/components/schemas/SnapshotExportDetails' - discriminator: propertyName: OBJECT_STORAGE properties: bucket: description: Bucket name maxLength: 256 minLength: 1 type: string namespace: description: Bucket namespace name maxLength: 255 minLength: 1 type: string prefix: description: Object path prefix to put snapshot file(s) maxLength: 1024 type: string required: - namespace - bucket type: object description: Specifies where to output the export in Object Storage. WorkRequestResource: description: A resource created or operated on by a work request. properties: actionType: description: 'The way in which this resource is affected by the work tracked in the work request. A resource being created, updated, or deleted will remain in the IN_PROGRESS state until work is complete for that resource at which point it will transition to CREATED, UPDATED, or DELETED, respectively. ' enum: - CREATED - UPDATED - DELETED - IN_PROGRESS - WRITTEN - RELATED type: string x-obmcs-top-level-enum: '#/definitions/ActionType' entityType: description: The resource type the work request affects. type: string entityUri: description: The URI path that the user can do a GET on to access the resource metadata type: string identifier: description: The identifier of the resource the work request affects. type: string metadata: additionalProperties: type: string description: Additional information that helps to explain the resource. enum: - NAMESPACE - BUCKET - OBJECT - SNAPSHOT_VERSION type: object x-obmcs-top-level-enum: '#/definitions/WorkRequestResourceMetadataKey' required: - actionType - entityType - identifier ExportFormat: description: Specifies the export format to be used for exporting snapshot. properties: name: description: Name of export format. enum: - JSONL - JSONL_CONSOLIDATED - CONLL - SPACY - COCO - YOLO - PASCAL_VOC - JSONL_COMPACT_PLUS_CONTENT type: string version: description: Version of export format. enum: - V2003 - V5 type: string type: object WorkRequestSummaryCollection: description: Results of a workRequest search. Contains both WorkRequest items and other information, such as metadata. properties: items: description: List of workRequestSummary objects. items: $ref: '#/components/schemas/WorkRequestSummary' type: array required: - items type: object LabelSet: description: 'An ordered collection of labels that are unique by name. ' properties: items: description: An ordered collection of labels that are unique by name. items: $ref: '#/components/schemas/Label' maxItems: 250 minItems: 0 type: array type: object WorkRequest: description: A description of workrequest status properties: compartmentId: description: 'The ocid of the compartment that contains the work request. Work requests should be scoped to the same compartment as the resource the work request affects. If the work request affects multiple resources, and those resources are not in the same compartment, it is up to the service team to pick the primary resource whose compartment should be used ' maxLength: 255 minLength: 1 type: string id: description: The id of the work request. maxLength: 255 minLength: 1 type: string operationType: description: Type of the work request enum: - CREATE_DATASET - DELETE_DATASET - MOVE_DATASET - GENERATE_DATASET_RECORDS - SNAPSHOT_DATASET - ADD_DATASET_LABELS - REMOVE_DATASET_LABELS - RENAME_DATASET_LABELS type: string x-obmcs-top-level-enum: '#/definitions/OperationType' percentComplete: description: Percentage of the request completed. format: float type: number resources: description: The resources affected by this work request. items: $ref: '#/components/schemas/WorkRequestResource' type: array status: description: Status of current work request. enum: - ACCEPTED - IN_PROGRESS - WAITING - SUCCEEDED - CANCELING - CANCELED - FAILED type: string x-obmcs-top-level-enum: '#/definitions/OperationStatus' timeAccepted: description: 'The date and time the request was created, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339), section 14.29. ' format: date-time type: string timeFinished: description: 'The date and time the request was finished, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339). ' format: date-time type: string timeStarted: description: 'The date and time the request was started, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339), section 14.29. ' format: date-time type: string required: - operationType - status - id - compartmentId - resources - percentComplete - timeAccepted SnapshotExportDetails: description: Specifies where to output the export. discriminator: propertyName: exportType properties: exportType: description: The target destination for the snapshot. Using OBJECT_STORAGE means the snapshot will be written to Object Storage. enum: - OBJECT_STORAGE type: string required: - exportType type: object WorkRequestErrorCollection: description: Results of a workRequestError search. Contains both WorkRequestError items and other information, such as metadata. properties: items: description: List of workRequestError objects. items: $ref: '#/components/schemas/WorkRequestError' type: array required: - items type: object GenerateDatasetRecordsDetails: description: Generate Records from the Dataset's source. properties: limit: description: the maximum number of records to generate. format: integer type: number type: object RemoveDatasetLabelsDetails: description: 'Removes a subset of Labels from the Dataset''s LabelSet. This LabelSet will be subtracted from the current Dataset''s LabelSet. Requests with non-existent Labels will be rejected. ' properties: labelSet: $ref: '#/components/schemas/LabelSet' type: object WorkRequestSummary: description: A summary of the status of a work request. properties: compartmentId: description: 'The ocid of the compartment that contains the work request. Work requests should be scoped to the same compartment as the resource the work request affects. If the work request affects multiple resources, and those resources are not in the same compartment, it is up to the service team to pick the primary resource whose compartment should be used ' maxLength: 255 minLength: 1 type: string id: description: The id of the work request. maxLength: 255 minLength: 1 type: string operationType: description: Type of the work request enum: - CREATE_DATASET - DELETE_DATASET - MOVE_DATASET - GENERATE_DATASET_RECORDS - SNAPSHOT_DATASET - ADD_DATASET_LABELS - REMOVE_DATASET_LABELS - RENAME_DATASET_LABELS type: string x-obmcs-top-level-enum: '#/definitions/OperationType' percentComplete: description: Percentage of the request completed. format: float type: number resources: description: The resources affected by this work request. items: $ref: '#/components/schemas/WorkRequestResource' type: array status: description: Status of current work request. enum: - ACCEPTED - IN_PROGRESS - WAITING - SUCCEEDED - CANCELING - CANCELED - FAILED type: string x-obmcs-top-level-enum: '#/definitions/OperationStatus' timeAccepted: description: 'The date and time the request was created, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339), section 14.29. ' format: date-time type: string timeFinished: description: 'The date and time the object was finished, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339). ' format: date-time type: string timeStarted: description: 'The date and time the request was started, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339), section 14.29. ' format: date-time type: string required: - operationType - status - id - compartmentId - resources - percentComplete - timeAccepted WorkRequestError: description: An error encountered while executing a work request. properties: code: description: 'A machine-usable code for the error that occured. Error codes are listed on (https://docs.cloud.oracle.com/Content/API/References/apierrors.htm) ' type: string message: description: A human readable description of the issue encountered. type: string timestamp: description: The time the error occured. An RFC3339 formatted datetime string. format: date-time type: string required: - code - message - timestamp InitialRecordGenerationConfiguration: description: The initial generate records configuration. It generates records from the dataset's source. properties: limit: description: The maximum number of records to generate. format: integer type: number type: object DatasetSourceDetails: description: This allows the customer to specify the source of the dataset. discriminator: propertyName: sourceType properties: sourceType: description: The source type. OBJECT_STORAGE allows the user to describe where in object storage the dataset is. enum: - OBJECT_STORAGE type: string required: - sourceType type: object DatasetFormatDetails: description: It specifies how to process the data. Supported formats include DOCUMENT, IMAGE, and TEXT. discriminator: propertyName: formatType properties: formatType: description: The format type. DOCUMENT format is for record contents that are PDFs or TIFFs. IMAGE format is for record contents that are JPEGs or PNGs. TEXT format is for record contents that are TXT files. enum: - DOCUMENT - IMAGE - TEXT type: string required: - formatType AddDatasetLabelsDetails: description: 'Adds a subset of Labels to the Dataset''s LabelSet. This LabelSet will be merged with the current Dataset''s LabelSet. Requests with duplicate Labels will be rejected. ' properties: labelSet: $ref: '#/components/schemas/LabelSet' type: object WorkRequestLogEntry: description: A log message from the execution of a work request. properties: message: description: Human-readable log message. type: string timestamp: description: The time the log message was written. An RFC3339 formatted datetime string format: date-time type: string required: - message - timestamp SnapshotDatasetDetails: description: Allows outputting the latest records paired with annotations and write them to object storage. properties: areAnnotationsIncluded: description: Whether annotations are to be included in the export dataset digest. type: boolean areUnannotatedRecordsIncluded: description: Whether to include records that have yet to be annotated in the export dataset digest. type: boolean exportDetails: $ref: '#/components/schemas/ObjectStorageSnapshotExportDetails' exportFormat: $ref: '#/components/schemas/ExportFormat' required: - areAnnotationsIncluded - areUnannotatedRecordsIncluded - exportDetails type: object Dataset: description: 'A dataset is a logical collection of records. The dataset contains all the information necessary to describe a record''s source, format, type of annotations allowed on these records, and labels allowed on annotations. ' properties: annotationFormat: description: The annotation format name required for labeling records. maxLength: 255 minLength: 1 type: string compartmentId: description: The OCID of the compartment of the resource. maxLength: 255 minLength: 1 type: string datasetFormatDetails: $ref: '#/components/schemas/DatasetFormatDetails' datasetSourceDetails: $ref: '#/components/schemas/DatasetSourceDetails' definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer, and boolean types are supported. ' type: object description: 'A key-value pair representing predefined tags'' keys and values scoped to a namespace. For example: `{"bar-key": "value"}` ' type: object description: 'The defined tags for this resource. Each key is predefined and scoped to a namespace. For example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object description: description: A user provided description of the dataset maxLength: 1024 type: string displayName: description: A user-friendly display name for the resource. maxLength: 255 type: string freeformTags: additionalProperties: type: string description: 'A simple key-value pair that is applied without any predefined name, type, or scope. It exists for cross-compatibility only. For example: `{"bar-key": "value"}` ' type: object id: description: The OCID of the Dataset. maxLength: 255 minLength: 1 type: string initialRecordGenerationConfiguration: $ref: '#/components/schemas/InitialRecordGenerationConfiguration' labelSet: $ref: '#/components/schemas/LabelSet' labelingInstructions: description: The labeling instructions for human labelers in rich text format maxLength: 32767 minLength: 0 type: string lifecycleDetails: description: A message describing the current state in more detail. For example, it can be used to provide actionable information for a resource in FAILED or NEEDS_ATTENTION state. type: string lifecycleState: description: 'The state of a dataset. CREATING - The dataset is being created. It will transition to ACTIVE when it is ready for labeling. ACTIVE - The dataset is ready for labeling. UPDATING - The dataset is being updated. It and its related resources may be unavailable for other updates until it returns to ACTIVE. NEEDS_ATTENTION - A dataset updation operation has failed due to validation or other errors and needs attention. DELETING - The dataset and its related resources are being deleted. DELETED - The dataset has been deleted and is no longer available. FAILED - The dataset has failed due to validation or other errors. ' enum: - CREATING - UPDATING - ACTIVE - NEEDS_ATTENTION - DELETING - DELETED - FAILED type: string systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer, and boolean types are supported. ' type: object description: 'A key-value pair representing system tags'' keys and values scoped to a namespace. For example: `{"bar-key": "value"}` ' type: object description: 'The usage of system tag keys. These predefined keys are scoped to namespaces. For example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: The date and time the resource was created, in the timestamp format defined by RFC3339. format: date-time type: string timeUpdated: description: The date and time the resource was last updated, in the timestamp format defined by RFC3339. format: date-time type: string required: - id - compartmentId - timeCreated - timeUpdated - lifecycleState - annotationFormat - datasetSourceDetails - datasetFormatDetails - labelSet type: object WorkRequestLogEntryCollection: description: Results of a workRequestLog search. Contains both workRequestLog items and other information, such as metadata. properties: items: description: List of workRequestLogEntries. items: $ref: '#/components/schemas/WorkRequestLogEntry' type: array required: - items type: object parameters: AnnotationFormatQueryParam: description: A filter to return only resources that match the entire annotation format given. in: query name: annotationFormat x-default-description: 'null' schema: type: string maxLength: 255 minLength: 1 PaginationTokenQueryParam: description: The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. in: query name: page schema: type: string minLength: 1 SortByQueryParam: description: 'The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. If no value is specified timeCreated is default. ' in: query name: sortBy schema: type: string enum: - timeCreated - displayName default: timeCreated DatasetIdentifierQueryParam: description: Unique Dataset OCID in: query name: id x-default-description: 'null' schema: type: string maxLength: 255 CompartmentIdQueryParam: description: The ID of the compartment in which to list resources. in: query name: compartmentId required: true schema: type: string IfMatchHeader: description: 'For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource''s current etag value. ' in: header name: if-match required: false schema: type: string DatasetIdentifierPathParam: description: Unique Dataset OCID in: path name: datasetId required: true schema: type: string maxLength: 255 minLength: 1 PaginationLimitQueryParam: description: The maximum number of items to return. in: query name: limit schema: type: integer default: 10 maximum: 1000 minimum: 1 WorkRequestIdPathParam: description: The ID of the asynchronous request. in: path name: workRequestId required: true schema: type: string maxLength: 255 WorkRequestIdQueryParam: description: The ID of the asynchronous work request. in: query name: workRequestId x-default-description: 'null' schema: type: string SortOrderQueryParam: description: The sort order to use, either 'asc' or 'desc'. in: query name: sortOrder x-obmcs-top-level-enum: '#/definitions/SortOrder' schema: type: string enum: - ASC - DESC default: ASC RetryTokenHeader: description: 'A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected. ' in: header name: opc-retry-token required: false schema: type: string maxLength: 64 minLength: 1 DisplayNameQueryParam: description: A filter to return only resources that match the entire display name given. in: query name: displayName x-default-description: 'null' schema: type: string maxLength: 255 RequestIdHeader: description: The client request ID for tracing. in: header name: opc-request-id schema: type: string LifecycleStateQueryParam: description: A filter to return only resources whose lifecycleState matches this query param. in: query name: lifecycleState required: false x-default-description: 'null' x-obmcs-enumref: '#/definitions/Dataset/lifecycleState' schema: type: string responses: default: description: Unknown Error headers: opc-request-id: description: 'A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' x-anchors: x-headers: Content-Location: description: 'The URI that identifies the entity described in the response body. ' type: string etag: description: 'For optimistic concurrency control. See `if-match`. ' type: string location: description: 'The URI that identifies the entity described in the response body. ' type: string opc-next-page: description: 'For the pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' type: string opc-request-id: description: 'A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' type: string opc-work-request-id: description: 'A unique Oracle-assigned identifier for the asynchronous request. You can use this to query the status of the asynchronous operation. ' type: string retry-after: description: A decimal number representing the number of seconds the client should wait before polling this endpoint again. type: integer x-properties: definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer, and boolean types are supported. ' type: object description: 'A key-value pair representing predefined tags'' keys and values scoped to a namespace. For example: `{"bar-key": "value"}` ' type: object description: 'The defined tags for this resource. Each key is predefined and scoped to a namespace. For example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object existingResourceExpression: downstream.invoke('data-labeling-service-api', 'GetDataset', request.resourceId) existingTags: downstream.invoke('data-labeling-service-api','GetDataset',request.resourceId).freeformTags.'.splatAuthorizedTagSlug' freeformTags: additionalProperties: type: string description: 'A simple key-value pair that is applied without any predefined name, type, or scope. It exists for cross-compatibility only. For example: `{"bar-key": "value"}` ' type: object resourceIdExpression: downstream.invoke('data-labeling-service-api', 'GetDataset', request.resourceId).displayName resourceIdExpressionAsync: downstream.invoke('data-labeling-service-api', 'GetWorkRequest', response.headers['opc-work-request-id']).resources[0].identifier resourceNameExpression: downstream.invoke('data-labeling-service-api', 'GetDataset', request.resourceId).displayName resourceNameExpressionAsync: downstream.invoke('data-labeling-service-api','GetDataset', downstream.invoke('data-labeling-service-api', 'GetWorkRequest', response.headers['opc-work-request-id']).resources[0].identifier)['displayName'] serviceList: - data-labeling-service-api systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer, and boolean types are supported. ' type: object description: 'A key-value pair representing system tags'' keys and values scoped to a namespace. For example: `{"bar-key": "value"}` ' type: object description: 'The usage of system tag keys. These predefined keys are scoped to namespaces. For example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object targetCompartmentIdBucketCreateDataset: namespace=splat.getOrThrow(request.body?.datasetSourceDetails?.namespace, 'InvalidParameter', 'namespace must not be null');bucket=splat.getOrThrow(request.body.datasetSourceDetails?.bucket, 'InvalidParameter', 'bucket must not be null');downstream.getOr400('data-labeling-service-api', 'GetBucket', namespace, bucket).compartmentId targetCompartmentIdBucketSnapshot: namespace=splat.getOrThrow(request.body?.exportDetails?.namespace, 'InvalidParameter', 'namespace must not be null');bucket=splat.getOrThrow(request.body.exportDetails?.bucket, 'InvalidParameter', 'bucket must not be null');downstream.getOr400('data-labeling-service-api', 'GetBucket', namespace, bucket).compartmentId targetCompartmentIdDataset: downstream.invoke('data-labeling-service-api', 'GetDataset', request.resourceId).compartmentId targetCompartmentIdWorkRequest: downstream.invoke('data-labeling-service-api', 'GetWorkRequest', request.resourceId).compartmentId x-oracle-package: com.oracle.dls.cp.dataset