{"components": {"examples": {}, "headers": {}, "parameters": {}, "requestBodies": {}, "responses": {}, "schemas": {"ItemSpecType": {"enum": ["MasterItemSpec", "ClonedItemSpec"], "type": "string"}, "RefType": {"type": "string", "enum": ["url", "id"]}, "ModalityType": {"type": "string", "enum": ["overlay", "replace", "preview", "related"]}, "APIModality": {"properties": {"ref": {"type": "string"}, "refType": {"$ref": "#/components/schemas/RefType"}, "type": {"$ref": "#/components/schemas/ModalityType"}, "timestamp": {"type": "string", "format": "date-time"}, "name": {"type": "string"}, "mimetype": {"type": "string"}, "stream": {"type": "string", "description": "stream url of modality item"}}, "required": ["ref", "refType", "type", "timestamp"], "type": "object", "additionalProperties": true}, "APISystemMetadata": {"properties": {"system": {"properties": {"modalities": {"items": {"$ref": "#/components/schemas/APIModality"}, "type": "array"}, "width": {"type": "number", "format": "double"}, "height": {"type": "number", "format": "double"}, "originalPath": {"type": "string"}, "encoding": {"type": "string"}, "size": {"type": "number", "format": "double"}, "mimetype": {"type": "string"}, "originalname": {"type": "string"}}, "required": ["originalPath", "encoding", "size", "mimetype", "originalname"], "type": "object"}}, "required": ["system"], "type": "object", "additionalProperties": true}, "APIDatasetFileItem": {"properties": {"id": {"type": "string"}, "url": {"type": "string"}, "datasetId": {"type": "string"}, "dir": {"type": "string"}, "filename": {"type": "string"}, "name": {"type": "string"}, "type": {"type": "string", "enum": ["file", "dir"]}, "spec": {"$ref": "#/components/schemas/ItemSpecType"}, "hidden": {"type": "boolean"}, "metadata": {"$ref": "#/components/schemas/APISystemMetadata"}, "createdAt": {"type": "string", "format": "date-time"}, "dataset": {"type": "string"}, "creator": {"type": "string"}, "description": {"type": "string"}, "signedStream": {"type": "string"}, "updatedAt": {"type": "string", "format": "date-time"}, "updatedBy": {"type": "string"}, "annotationsCount": {"type": "number", "format": "double"}, "annotated": {"anyOf": [{"type": "boolean"}, {"type": "string", "enum": ["discarded"]}]}, "stream": {"type": "string"}, "thumbnail": {"type": "string"}, "annotations": {"type": "string"}, "srcItem": {"type": "string"}, "srcDataset": {"type": "string"}}, "required": ["id", "url", "datasetId", "dir", "filename", "name", "type", "spec", "hidden", "metadata", "createdAt", "dataset", "creator", "updatedAt", "updatedBy", "annotationsCount", "annotated", "stream", "thumbnail", "annotations", "srcItem", "srcDataset"], "type": "object", "additionalProperties": true}, "APIDatasetDirectoryItem": {"properties": {"id": {"type": "string"}, "url": {"type": "string"}, "datasetId": {"type": "string"}, "dir": {"type": "string"}, "filename": {"type": "string"}, "name": {"type": "string"}, "type": {"type": "string", "enum": ["file", "dir"]}, "spec": {"$ref": "#/components/schemas/ItemSpecType"}, "hidden": {"type": "boolean"}, "metadata": {"$ref": "#/components/schemas/APISystemMetadata"}, "createdAt": {"type": "string", "format": "date-time"}, "dataset": {"type": "string"}, "creator": {"type": "string"}, "description": {"type": "string"}, "signedStream": {"type": "string"}, "updatedAt": {"type": "string", "format": "date-time"}, "updatedBy": {"type": "string"}, "items": {"type": "string"}, "export": {"properties": {"json": {"type": "string"}, "zip": {"anyOf": [{"type": "string"}, {"properties": {"chunks": {"items": {"type": "string"}, "type": "array"}}, "required": ["chunks"], "type": "object"}]}}, "required": ["json", "zip"], "type": "object"}}, "required": ["id", "url", "datasetId", "dir", "filename", "name", "type", "spec", "hidden", "metadata", "createdAt", "dataset", "creator", "updatedAt", "updatedBy", "items", "export"], "type": "object", "additionalProperties": true}, "PartialAPIDatasetItem": {"properties": {"filename": {"type": "string"}, "description": {"type": "string"}, "metadata": {"$ref": "#/components/schemas/APISystemMetadata"}}, "type": "object", "additionalProperties": true}, "APIDatasetItemCursor": {"description": "For documentation purposes - swagger gen does not handle generics so well...", "properties": {"totalItemsCount": {"type": "number", "format": "double"}, "items": {"anyOf": [{"items": {"$ref": "#/components/schemas/APIDatasetFileItem"}, "type": "array"}, {"items": {"$ref": "#/components/schemas/APIDatasetDirectoryItem"}, "type": "array"}]}, "totalPagesCount": {"type": "number", "format": "double"}, "hasNextPage": {"type": "boolean"}}, "required": ["totalItemsCount", "items", "totalPagesCount", "hasNextPage"], "type": "object", "additionalProperties": true}, "Dictionary": {"properties": {}, "additionalProperties": {}, "type": "object"}, "APICommand": {"properties": {"id": {"type": "string"}, "url": {"type": "string"}, "status": {"type": "string"}, "createdAt": {"type": "string", "format": "date-time"}, "updatedAt": {"type": "string", "format": "date-time", "nullable": true}, "type": {"type": "string"}, "error": {"type": "string", "nullable": true}, "progress": {"type": "number", "format": "double"}, "spec": {"$ref": "#/components/schemas/Dictionary"}, "report": {"$ref": "#/components/schemas/Dictionary", "allOf": [{"$ref": "#/components/schemas/Dictionary"}], "nullable": true}}, "required": ["id", "url", "status", "createdAt", "type", "progress", "spec", "id", "url", "status", "createdAt", "type", "progress", "spec", "id", "url", "status", "createdAt", "type", "progress", "spec", "id", "url", "status", "createdAt", "type", "progress", "spec", "id", "url", "status", "createdAt", "type", "progress", "spec", "id", "url", "status", "createdAt", "type", "progress", "spec"], "type": "object", "additionalProperties": true}, "DatasetIndexDrivers": {"type": "string", "enum": ["mongo", "sql"]}, "CloneDatasetParams": {"properties": {"withItemsAnnotations": {"type": "boolean"}, "withMetadata": {"type": "boolean"}, "stripItemsFolders": {"type": "boolean"}, "targetDirectory": {"type": "string"}, "targetDatasetId": {"type": "string"}, "allowMany": {"type": "boolean"}, "newDatasetName": {"type": "string"}, "indexDriver": {"$ref": "#/components/schemas/DatasetIndexDrivers", "description": "Cloned dataset will use the specified indexDriver. only super-user can specify this option"}, "ignoreSizeLimit": {"type": "boolean", "description": "Clone the dataset event if it has more items then allowed limit. only super-user can specify this option"}}, "required": ["withItemsAnnotations", "withMetadata"], "type": "object", "additionalProperties": true}, "ItemCloneRequest": {"properties": {"targetDatasetId": {"type": "string", "description": "Target dataset id"}, "remoteFileName": {"type": "string", "description": "path at target dataset"}, "metadata": {"$ref": "#/components/schemas/Dictionary", "description": "override metadata"}, "cloneDatasetParams": {"$ref": "#/components/schemas/CloneDatasetParams", "description": "clone params"}, "allowMany": {"type": "boolean", "description": "allow multiple copies of the same source item", "default": "false"}}, "required": ["targetDatasetId", "cloneDatasetParams"], "type": "object", "additionalProperties": true}, "ItemMergeRequest": {"properties": {"sourceItemIds": {"items": {"type": "string"}, "type": "array"}}, "required": ["sourceItemIds"], "type": "object", "additionalProperties": true}, "TaskItemStatus": {"properties": {"taskId": {"type": "string"}, "assignmentId": {"type": "string"}, "status": {"type": "string"}, "creator": {"type": "string"}, "timestamp": {"type": "string", "format": "date-time"}}, "required": ["taskId", "assignmentId", "status", "creator", "timestamp"], "type": "object", "additionalProperties": true}, "ItemRefOperation": {"enum": ["create", "delete", "create", "delete"], "type": "string"}, "ItemRefsUpdateRequest": {"properties": {"action": {"$ref": "#/components/schemas/TaskItemStatus"}, "operation": {"$ref": "#/components/schemas/ItemRefOperation"}, "pipelineId": {"type": "string"}, "nodeId": {"type": "string"}}, "required": ["action", "operation"], "type": "object", "additionalProperties": true}, "ItemRefsUpdateBulkRequest": {"properties": {"action": {"$ref": "#/components/schemas/TaskItemStatus"}, "operation": {"$ref": "#/components/schemas/ItemRefOperation"}, "pipelineId": {"type": "string"}, "nodeId": {"type": "string"}, "itemIds": {"items": {"type": "string"}, "type": "array"}, "asynced": {"type": "boolean"}}, "required": ["action", "operation", "itemIds"], "type": "object", "additionalProperties": true}, "QueryResource": {"enum": ["items", "annotations", "datasets", "tasks", "assignments", "feature_sets", "feature_vectors", "items", "annotations", "datasets", "tasks", "assignments", "feature_sets", "feature_vectors", "models", "metrics", "executions", "services", "apps", "triggers", "executions", "services", "packages", "annotations", "items", "labels", "tasks", "datasets", "assignments", "directory", "pipeline", "pipelineState", "pipelineTemplate", "setting", "composition", "resourceExecution", "apps", "dpks", "compute", "serviceDrivers", "settings", "setting"], "type": "string"}, "JoinQuery": {"properties": {"on": {"properties": {"forigen": {"type": "string"}, "local": {"type": "string"}, "resource": {"$ref": "#/components/schemas/QueryResource"}}, "required": ["forigen", "local", "resource"], "type": "object"}}, "required": ["on"], "type": "object", "additionalProperties": true}, "ReferenceQuery": {"properties": {"operation": {"type": "string", "enum": ["create", "delete"]}, "refs": {"items": {"properties": {"id": {"type": "string"}, "type": {"type": "string"}}, "required": ["id", "type"], "type": "object"}, "type": "array"}, "index": {"type": "number", "format": "double"}}, "required": ["operation", "refs"], "type": "object", "additionalProperties": true}, "Pick_DQLQuery.Exclude_keyofDQLQuery.intersect-or-except-or-limit-or-sort-or-select__": {"properties": {"filter": {"$ref": "#/components/schemas/Dictionary"}, "join": {"$ref": "#/components/schemas/JoinQuery"}, "references": {"$ref": "#/components/schemas/ReferenceQuery"}, "update": {"$ref": "#/components/schemas/Dictionary"}, "delete": {"type": "boolean"}, "user": {"type": "string"}, "systemSpace": {"type": "boolean"}, "queryEngine": {"type": "string", "enum": ["mongo", "elasticsearch", "sql", "json"]}}, "required": ["filter"], "type": "object", "description": "From T, pick a set of properties whose keys are in the union K"}, "Omit_DQLQuery.intersect-or-except-or-limit-or-sort-or-select_": {"$ref": "#/components/schemas/Pick_DQLQuery.Exclude_keyofDQLQuery.intersect-or-except-or-limit-or-sort-or-select__", "description": "Construct a type with the properties of T except for those in type K."}, "IntersectQuery": {"properties": {"query": {"$ref": "#/components/schemas/Omit_DQLQuery.intersect-or-except-or-limit-or-sort-or-select_"}}, "required": ["query"], "type": "object", "additionalProperties": true}, "OrderBy": {"type": "string", "enum": ["ascending", "descending"]}, "SortQuery": {"properties": {}, "type": "object", "additionalProperties": {"anyOf": [{"$ref": "#/components/schemas/OrderBy"}, {"$ref": "#/components/schemas/SortQuery"}]}}, "SelectQuery": {"properties": {}, "type": "object", "additionalProperties": {"type": "number", "enum": [0, 1]}}, "DQLResourceQuery": {"properties": {"filter": {"$ref": "#/components/schemas/Dictionary"}, "limit": {"type": "number", "format": "double"}, "join": {"$ref": "#/components/schemas/JoinQuery"}, "intersect": {"$ref": "#/components/schemas/IntersectQuery"}, "except": {"$ref": "#/components/schemas/IntersectQuery"}, "references": {"$ref": "#/components/schemas/ReferenceQuery"}, "sort": {"$ref": "#/components/schemas/SortQuery"}, "select": {"$ref": "#/components/schemas/SelectQuery"}, "update": {"$ref": "#/components/schemas/Dictionary"}, "delete": {"type": "boolean"}, "user": {"type": "string"}, "systemSpace": {"type": "boolean"}, "queryEngine": {"type": "string", "enum": ["mongo", "elasticsearch", "sql", "json"]}, "resource": {"$ref": "#/components/schemas/QueryResource"}, "skip": {"type": "number", "format": "double"}, "datasets": {"items": {"type": "string"}, "type": "array"}, "projects": {"items": {"type": "string"}, "type": "array"}, "page": {"type": "number", "format": "double"}, "pageSize": {"type": "number", "format": "double"}, "collectMetrics": {"type": "boolean"}, "countTotal": {"type": "boolean"}, "sign": {"properties": {"exp": {"type": "number", "format": "double", "description": "expiration in seconds", "default": "1 hour from now"}}, "type": "object"}}, "required": ["filter"], "type": "object", "additionalProperties": true}, "AddItemMode": {"enum": ["skip", "overwrite"], "type": "string"}, "Partial_any_": {"properties": {}, "type": "object", "description": "Make all properties in T optional"}, "ResourceReference": {"properties": {"id": {"type": "string"}, "type": {"type": "string"}, "metadata": {"allOf": [{"properties": {"creator": {"type": "string"}, "timestamp": {"type": "string", "format": "date-time"}, "status": {"type": "string"}}, "type": "object"}, {"$ref": "#/components/schemas/Partial_any_"}]}}, "required": ["id", "type"], "type": "object", "additionalProperties": true}, "ItemLink": {"properties": {"type": {"type": "string"}, "itemId": {"type": "string"}, "frame": {"type": "number", "format": "double"}, "time": {"type": "number", "format": "double"}}, "required": ["type", "itemId", "frame", "time"], "type": "object", "additionalProperties": true}, "Modality": {"properties": {"ref": {"type": "string"}, "refType": {"$ref": "#/components/schemas/RefType"}, "type": {"$ref": "#/components/schemas/ModalityType"}, "timestamp": {"type": "string", "format": "date-time"}, "name": {"type": "string"}, "mimetype": {"type": "string"}}, "required": ["ref", "refType", "type", "timestamp"], "type": "object", "additionalProperties": true}, "SystemDatasetType": {"enum": ["binaries"], "type": "string"}, "Record_string.string_": {"properties": {}, "type": "object", "description": "Construct a type with a set of properties K of type T"}, "AnnotationQueryThumbnailIdMap": {"$ref": "#/components/schemas/Record_string.string_"}, "Record_CollectionKeys.boolean_": {"properties": {"c0": {"type": "boolean"}, "c1": {"type": "boolean"}, "c2": {"type": "boolean"}, "c3": {"type": "boolean"}, "c4": {"type": "boolean"}, "c5": {"type": "boolean"}, "c6": {"type": "boolean"}, "c7": {"type": "boolean"}, "c8": {"type": "boolean"}, "c9": {"type": "boolean"}}, "type": "object", "description": "Construct a type with a set of properties K of type T"}, "Record_MLSplitListKeys.boolean_": {"properties": {"train": {"type": "boolean"}, "test": {"type": "boolean"}, "validation": {"type": "boolean"}}, "type": "object", "description": "Construct a type with a set of properties K of type T"}, "ItemSystemMetadata": {"properties": {"originalname": {"type": "string", "description": "Original name of the item (usually the name of the file on the device it was uploaded from)"}, "mimetype": {"type": "string"}, "size": {"type": "number", "format": "double"}, "encoding": {"type": "string"}, "taskStatusLog": {"items": {"properties": {"action": {"$ref": "#/components/schemas/ItemRefOperation"}, "status": {"$ref": "#/components/schemas/TaskItemStatus"}}, "required": ["action", "status"], "type": "object"}, "type": "array"}, "refs": {"items": {"$ref": "#/components/schemas/ResourceReference"}, "type": "array", "description": "References to other resources (i.e tasks, assignments, etc...)"}, "isBinary": {"type": "boolean", "description": "Determines if item content is textual of binary"}, "thumbnailId": {"type": "string", "description": "Thumbnail item id"}, "thumbnailAnnotationsId": {"type": "string", "description": "Thumbnail (with annotations embedded) item id"}, "itemLinks": {"items": {"$ref": "#/components/schemas/ItemLink"}, "type": "array"}, "modalities": {"items": {"$ref": "#/components/schemas/Modality"}, "type": "array"}, "systemDatasetType": {"$ref": "#/components/schemas/SystemDatasetType", "description": "Determines if item belongs to a platform system dataset, specifies which type of system dataset"}, "annotationQueryThumbnailIdMap": {"$ref": "#/components/schemas/AnnotationQueryThumbnailIdMap", "description": "A map that determines the thumbnail item id for an annotations query. The key is the hash of the query that was requested"}, "annotationThumbnailParentId": {"type": "string", "description": "Id of the parent it of this annotation thumbnail"}, "collections": {"$ref": "#/components/schemas/Record_CollectionKeys.boolean_", "description": "A map of dataset items collection ids"}, "tags": {"$ref": "#/components/schemas/Record_MLSplitListKeys.boolean_", "description": "A map of sets in ml split"}}, "required": ["originalname", "mimetype", "size", "encoding", "isBinary"], "type": "object", "additionalProperties": true}, "Partial_ItemMetadata_": {"properties": {"system": {"$ref": "#/components/schemas/ItemSystemMetadata"}}, "type": "object", "description": "Make all properties in T optional"}, "UpdateItemMetadataOptions": {"properties": {"update": {"properties": {"metadata": {"$ref": "#/components/schemas/Partial_ItemMetadata_"}}, "required": ["metadata"], "type": "object"}, "systemSpace": {"type": "boolean"}}, "required": ["update"], "type": "object", "additionalProperties": true}, "AnnotationType": {"enum": ["class", "point", "line", "box", "cube", "segment", "ellipse", "binary", "note", "polyline", "comparison", "recording", "subtitle", "item_description", "text_mark", "pose", "cube_3d", "semantic_3d", "polyline_3d", "pdf_text", "text", "ref_image", "ref_semantic_3d", "gis", "class", "point", "line", "box", "cube", "segment", "ellipse", "binary", "note", "polyline", "comparison", "recording", "subtitle", "item_description", "text_mark", "pose", "cube_3d", "semantic_3d", "polyline_3d", "pdf_text", "text", "ref_image", "ref_semantic_3d", "gis", "polygon", "class", "point", "line", "box", "cube", "segment", "ellipse", "binary", "note", "polyline", "comparison", "recording", "subtitle", "item_description", "text_mark", "pose", "cube_3d", "semantic_3d", "polyline_3d", "pdf_text", "text", "ref_image", "ref_semantic_3d", "gis", "class", "point", "line", "box", "cube", "segment", "ellipse", "binary", "note", "polyline", "comparison", "recording", "subtitle", "item_description", "text_mark", "pose", "cube_3d", "semantic_3d", "polyline_3d", "pdf_text", "text", "ref_image", "ref_semantic_3d", "gis"], "type": "string"}, "Point": {"properties": {"x": {"type": "number", "format": "double"}, "y": {"type": "number", "format": "double"}, "z": {"type": "number", "format": "double"}}, "required": ["x", "y"], "type": "object", "additionalProperties": true}, "APIBoxCoordinates": {"items": {}, "type": "array"}, "NoteMessage": {"properties": {"id": {"type": "string"}, "creator": {"type": "string"}, "time": {"type": "number", "format": "double"}, "body": {"type": "string"}}, "required": ["id", "creator", "time", "body"], "type": "object", "additionalProperties": true}, "CoordinatesNote": {"properties": {"messages": {"items": {"$ref": "#/components/schemas/NoteMessage"}, "type": "array"}, "status": {"type": "string"}, "createTime": {"type": "number", "format": "double"}, "creator": {"type": "string"}, "asignee": {"type": "string"}}, "required": ["messages", "status", "createTime", "creator", "asignee"], "type": "object", "additionalProperties": true}, "APINoteAnnotationCoordinates_V1": {"properties": {"box": {"$ref": "#/components/schemas/APIBoxCoordinates"}, "note": {"$ref": "#/components/schemas/CoordinatesNote"}, "updatedAt": {"type": "string", "format": "date-time"}, "updatedBy": {"type": "string"}}, "required": ["note", "updatedAt", "updatedBy"], "type": "object", "additionalProperties": true}, "PoseCoordinates": {"properties": {"templateId": {"type": "string"}, "instanceId": {"type": "string"}}, "required": ["templateId", "instanceId"], "type": "object", "additionalProperties": true}, "PolygonCoordinates_V1": {"items": {"items": {"$ref": "#/components/schemas/Point"}, "type": "array"}, "type": "array"}, "PolylineCoordinates_V3": {"items": {"items": {"$ref": "#/components/schemas/Point"}, "type": "array"}, "type": "array"}, "EllipseCoordinates_V1": {"properties": {"center": {"$ref": "#/components/schemas/Point"}, "rx": {"type": "number", "format": "double"}, "ry": {"type": "number", "format": "double"}, "angle": {"type": "number", "format": "double"}}, "required": ["center", "rx", "ry"], "type": "object", "additionalProperties": true}, "CubeCoordinates_V1": {"properties": {"front_bl": {"$ref": "#/components/schemas/Point"}, "front_br": {"$ref": "#/components/schemas/Point"}, "front_tl": {"$ref": "#/components/schemas/Point"}, "front_tr": {"$ref": "#/components/schemas/Point"}, "back_bl": {"$ref": "#/components/schemas/Point"}, "back_br": {"$ref": "#/components/schemas/Point"}, "back_tl": {"$ref": "#/components/schemas/Point"}, "back_tr": {"$ref": "#/components/schemas/Point"}, "angle": {"type": "number", "format": "double"}}, "required": ["front_bl", "front_br", "front_tl", "front_tr", "back_bl", "back_br", "back_tl", "back_tr"], "type": "object", "additionalProperties": true}, "ItemDescriptionCoordinates": {"properties": {"text": {"type": "string"}}, "required": ["text"], "type": "object", "additionalProperties": true}, "ObjectId": {"type": "string", "description": "A class representation of the BSON ObjectId type."}, "RefAnnotationsRefType": {"enum": ["id", "url"], "type": "string"}, "IBaseRefAnnotationCoordinates": {"properties": {"ref": {"anyOf": [{"$ref": "#/components/schemas/ObjectId"}, {"type": "string"}]}, "refType": {"$ref": "#/components/schemas/RefAnnotationsRefType"}, "mimetype": {"type": "string"}}, "required": ["ref", "refType"], "type": "object", "additionalProperties": true}, "IRefImageAnnotationsType": {"allOf": [{"properties": {}, "type": "object"}, {"$ref": "#/components/schemas/IBaseRefAnnotationCoordinates"}]}, "APIAnnotationCoordinateTypes": {"anyOf": [{"$ref": "#/components/schemas/Point"}, {"items": {"$ref": "#/components/schemas/Point"}, "type": "array"}, {"items": {"items": {"$ref": "#/components/schemas/Point"}, "type": "array"}, "type": "array"}, {"$ref": "#/components/schemas/APINoteAnnotationCoordinates_V1"}, {"type": "string"}, {"$ref": "#/components/schemas/PoseCoordinates"}, {"$ref": "#/components/schemas/PolygonCoordinates_V1"}, {"$ref": "#/components/schemas/PolylineCoordinates_V3"}, {"$ref": "#/components/schemas/EllipseCoordinates_V1"}, {"$ref": "#/components/schemas/CubeCoordinates_V1"}, {"$ref": "#/components/schemas/APIBoxCoordinates"}, {"$ref": "#/components/schemas/ItemDescriptionCoordinates"}, {"$ref": "#/components/schemas/IRefImageAnnotationsType"}]}, "LabelSuggestions": {"properties": {}, "type": "object", "additionalProperties": {"type": "number", "format": "double"}}, "RequestSource": {"enum": ["ui", "sdk", "other", "system", "unknown", "ui", "sdk", "other", "system", "unknown"], "type": "string"}, "APIAnnotation": {"properties": {"id": {"type": "string"}, "url": {"type": "string"}, "type": {"$ref": "#/components/schemas/AnnotationType"}, "label": {"type": "string"}, "attributes": {"items": {"type": "string"}, "type": "array"}, "coordinates": {"$ref": "#/components/schemas/APIAnnotationCoordinateTypes"}, "metadata": {"$ref": "#/components/schemas/Dictionary"}, "creator": {"type": "string"}, "createdAt": {"type": "string", "format": "date-time"}, "updatedAt": {"type": "string", "format": "date-time"}, "updatedBy": {"type": "string"}, "itemId": {"type": "string"}, "item": {"type": "string"}, "datasetId": {"type": "string"}, "dataset": {"type": "string"}, "hash": {"type": "string"}, "labelSuggestions": {"$ref": "#/components/schemas/LabelSuggestions"}, "source": {"$ref": "#/components/schemas/RequestSource"}, "description": {"type": "string"}, "srcAnnotation": {"type": "string"}}, "required": ["id", "url", "type", "label", "creator", "createdAt", "updatedAt", "updatedBy", "itemId", "item", "datasetId", "dataset", "hash", "labelSuggestions"], "type": "object", "additionalProperties": true}, "APIMetadata": {"properties": {"system": {"$ref": "#/components/schemas/Dictionary", "allOf": [{"$ref": "#/components/schemas/Dictionary"}], "nullable": true}}, "required": ["system"], "type": "object", "additionalProperties": true}, "UpdateAnnotationRequest": {"properties": {"creator": {"type": "string"}, "type": {"$ref": "#/components/schemas/AnnotationType"}, "label": {"type": "string"}, "coordinates": {}, "attributes": {"items": {"type": "string"}, "type": "array"}, "metadata": {"$ref": "#/components/schemas/APIMetadata"}}, "required": ["creator", "type", "label"], "type": "object", "additionalProperties": true}, "SetupReport": {"properties": {}, "type": "object"}, "S2SetupOptions": {"properties": {"createUsers": {"type": "boolean"}, "grantUserPermissions": {"type": "boolean"}, "createDbs": {"type": "boolean"}, "setGlobalVars": {"type": "boolean"}, "createFunctions": {"type": "boolean"}, "createTables": {"type": "boolean"}, "createIndexes": {"type": "boolean"}}, "type": "object", "additionalProperties": true}, "BootstrapSetupInput": {"properties": {"createMongoIndexes": {"type": "boolean"}, "createDefaultStorageDrivers": {"type": "boolean"}, "setupCloneQueues": {"type": "boolean"}, "setupDefaultFeatureFlags": {"type": "boolean"}, "setupS2": {"anyOf": [{"type": "boolean"}, {"$ref": "#/components/schemas/S2SetupOptions"}]}}, "required": ["createMongoIndexes", "createDefaultStorageDrivers", "setupCloneQueues", "setupDefaultFeatureFlags", "setupS2"], "type": "object", "additionalProperties": true}, "APIAnnotationRequest": {"properties": {"id": {"type": "string"}, "creator": {"type": "string"}, "type": {"$ref": "#/components/schemas/AnnotationType"}, "label": {"type": "string"}, "coordinates": {"$ref": "#/components/schemas/APIAnnotationCoordinateTypes"}, "attributes": {"items": {"type": "string"}, "type": "array"}, "metadata": {"$ref": "#/components/schemas/APIMetadata"}, "parent": {"$ref": "#/components/schemas/APIAnnotationRequest"}, "children": {"items": {"$ref": "#/components/schemas/APIAnnotationRequest"}, "type": "array"}, "existingChildrenIds": {"items": {"type": "string"}, "type": "array"}, "source": {"$ref": "#/components/schemas/RequestSource"}}, "type": "object", "additionalProperties": true}, "Partial_APIAnnotation_": {"properties": {"id": {"type": "string"}, "url": {"type": "string"}, "type": {"$ref": "#/components/schemas/AnnotationType"}, "label": {"type": "string"}, "attributes": {"items": {"type": "string"}, "type": "array"}, "coordinates": {"$ref": "#/components/schemas/APIAnnotationCoordinateTypes"}, "metadata": {"$ref": "#/components/schemas/Dictionary"}, "creator": {"type": "string"}, "createdAt": {"type": "string", "format": "date-time"}, "updatedAt": {"type": "string", "format": "date-time"}, "updatedBy": {"type": "string"}, "itemId": {"type": "string"}, "item": {"type": "string"}, "datasetId": {"type": "string"}, "dataset": {"type": "string"}, "hash": {"type": "string"}, "labelSuggestions": {"$ref": "#/components/schemas/LabelSuggestions"}, "source": {"$ref": "#/components/schemas/RequestSource"}, "description": {"type": "string"}, "srcAnnotation": {"type": "string"}}, "type": "object", "description": "Make all properties in T optional"}, "APIAnnotationEvent": {"properties": {"id": {"$ref": "#/components/schemas/ObjectId"}, "annotationId": {"$ref": "#/components/schemas/ObjectId"}, "user": {"type": "string"}, "timestamp": {"type": "string", "format": "date-time"}, "changes": {"$ref": "#/components/schemas/Partial_APIAnnotation_"}, "deleted": {"anyOf": [{"type": "boolean"}, {"type": "string", "enum": ["discarded"]}]}}, "required": ["id", "annotationId", "user", "timestamp"], "type": "object", "additionalProperties": true}, "Dictionary_APIAnnotationEvent-Array_": {"properties": {}, "type": "object", "additionalProperties": {"items": {"$ref": "#/components/schemas/APIAnnotationEvent"}, "type": "array"}}, "ExpirationOptions": {"properties": {"itemMaxDays": {"type": "number", "format": "double", "description": "Specifies the number of days after which each item becomes expired and should be deleted"}}, "required": ["itemMaxDays"], "type": "object", "additionalProperties": true}, "IndexDriver": {"type": "string", "enum": ["v1", "v2"]}, "APIDataset": {"properties": {"id": {"type": "string"}, "url": {"type": "string"}, "name": {"type": "string"}, "annotated": {"type": "number", "format": "double"}, "itemsCount": {"type": "number", "format": "double"}, "items": {"type": "string"}, "directoryTree": {"type": "string"}, "creator": {"type": "string"}, "projects": {"items": {"type": "string"}, "type": "array"}, "metadata": {"$ref": "#/components/schemas/APIMetadata"}, "createdAt": {"type": "string", "format": "date-time"}, "updatedAt": {"type": "string", "format": "date-time"}, "updatedBy": {"type": "string"}, "readableType": {"type": "string"}, "accessLevel": {"type": "string", "enum": ["private", "project"]}, "driver": {"type": "string"}, "readonly": {"type": "boolean"}, "error": {}, "expirationOptions": {"$ref": "#/components/schemas/ExpirationOptions"}, "indexDriver": {"$ref": "#/components/schemas/IndexDriver"}, "enableSyncWithCloned": {"type": "boolean"}, "srcDataset": {"type": "string"}, "annotationsCount": {"type": "number", "format": "double"}, "lockProcessCommandId": {"type": "string"}, "lastStorageSyncDate": {"type": "string", "format": "date-time"}, "isSyncing": {"type": "boolean"}}, "required": ["id", "url", "name", "annotated", "itemsCount", "items", "directoryTree", "creator", "projects", "createdAt", "readableType", "accessLevel", "driver", "readonly", "indexDriver", "annotationsCount"], "type": "object", "additionalProperties": true}, "DatasetEtlOptions": {"properties": {"skipVideoEtl": {"type": "boolean"}, "skipImageEtl": {"type": "boolean"}}, "type": "object"}, "DatasetScope": {"enum": ["system"], "type": "string"}, "CollectionEntry": {"properties": {"name": {"type": "string"}}, "required": ["name"], "type": "object", "additionalProperties": true}, "ItemCollections": {"properties": {}, "type": "object", "additionalProperties": {"$ref": "#/components/schemas/CollectionEntry"}}, "DatasetSystemMetadata": {"properties": {"datasetType": {"allOf": [{"type": "string"}, {"$ref": "#/components/schemas/SystemDatasetType"}]}, "etlOptions": {"$ref": "#/components/schemas/DatasetEtlOptions"}, "scope": {"$ref": "#/components/schemas/DatasetScope"}, "itemCollectionsVersion": {"type": "number", "format": "double"}, "collections": {"$ref": "#/components/schemas/ItemCollections"}, "itemCollectionsDeleteCommandId": {"type": "string"}, "recipes": {"items": {"type": "string"}, "type": "array"}}, "type": "object", "additionalProperties": true}, "DatasetMetadata": {"properties": {"system": {"$ref": "#/components/schemas/DatasetSystemMetadata"}}, "required": ["system"], "type": "object", "additionalProperties": true}, "CreateDatasetRequest": {"properties": {"name": {"type": "string", "description": "Dataset name"}, "projects": {"items": {"type": "string"}, "type": "array", "description": "list of project ids related to the created dataset"}, "driver": {"type": "string", "enum": ["mongo", "gcs", "fs", "s3", "azureblob"], "description": "Driver type of an existing driver or new driver configuration"}, "driverId": {"type": "string", "description": "Driver id of an existing external driver"}, "accessLevel": {"type": "string", "enum": ["private", "project"], "description": "Share options, only user or all project members with the right role (default is project)"}, "createDefaultRecipe": {"type": "boolean"}, "expirationOptions": {"$ref": "#/components/schemas/ExpirationOptions", "description": "Specifies the parameters by which items are marked as expired"}, "indexDriver": {"$ref": "#/components/schemas/IndexDriver", "description": "Specifies which index driver should be used"}, "metadata": {"$ref": "#/components/schemas/DatasetMetadata"}}, "required": ["name", "projects"], "type": "object", "additionalProperties": true}, "DQLQuery": {"properties": {"filter": {"$ref": "#/components/schemas/Dictionary"}, "limit": {"type": "number", "format": "double"}, "join": {"$ref": "#/components/schemas/JoinQuery"}, "intersect": {"$ref": "#/components/schemas/IntersectQuery"}, "except": {"$ref": "#/components/schemas/IntersectQuery"}, "references": {"$ref": "#/components/schemas/ReferenceQuery"}, "sort": {"$ref": "#/components/schemas/SortQuery"}, "select": {"$ref": "#/components/schemas/SelectQuery"}, "update": {"$ref": "#/components/schemas/Dictionary"}, "delete": {"type": "boolean"}, "user": {"type": "string"}, "systemSpace": {"type": "boolean"}, "queryEngine": {"type": "string", "enum": ["mongo", "elasticsearch", "sql", "json"]}}, "required": ["filter"], "type": "object", "additionalProperties": true}, "CloneDatasetRequest": {"properties": {"name": {"type": "string", "description": "Dataset name"}, "filter": {"$ref": "#/components/schemas/DQLQuery", "description": "Items filter"}, "cloneDatasetParams": {"$ref": "#/components/schemas/CloneDatasetParams", "description": "clone params"}, "returnCmd": {"type": "boolean", "description": "run as async"}, "version": {"type": "number", "format": "double"}, "indexDriver": {"$ref": "#/components/schemas/DatasetIndexDrivers"}, "allowAnnotationDuplication": {"type": "boolean"}}, "required": ["name", "filter", "cloneDatasetParams"], "type": "object", "additionalProperties": true}, "MergeDatasetParams": {"properties": {"withItemsAnnotations": {"type": "boolean"}, "withMetadata": {"type": "boolean"}}, "required": ["withItemsAnnotations", "withMetadata"], "type": "object", "additionalProperties": true}, "MergeDatasetsRequest": {"properties": {"name": {"type": "string", "description": "Dataset name"}, "datasetsIds": {"items": {"type": "string"}, "type": "array", "description": "datasets id's"}, "mergeDatasetParams": {"$ref": "#/components/schemas/MergeDatasetParams"}}, "required": ["name", "datasetsIds", "mergeDatasetParams"], "type": "object", "additionalProperties": true}, "Partial_APIDatasetPayload_": {"properties": {"_id": {"type": "string"}, "name": {"type": "string"}, "creator": {"type": "string"}, "projects": {"items": {"type": "string"}, "type": "array"}, "driver": {"anyOf": [{"$ref": "#/components/schemas/ObjectId"}, {"type": "string"}]}, "metadata": {"$ref": "#/components/schemas/APIMetadata"}}, "type": "object", "description": "Make all properties in T optional"}, "DatasetDirectoryTree": {"properties": {"value": {"$ref": "#/components/schemas/APIDatasetDirectoryItem"}, "children": {"items": {"$ref": "#/components/schemas/DatasetDirectoryTree"}, "type": "array"}}, "required": ["value"], "type": "object", "additionalProperties": true}, "ExportType": {"type": "string", "enum": ["json", "zip", "lance"]}, "ExportDatasetOptions": {"description": "Export dataset as zip file.\nitems/annotations filters can be specified, only matching results will be included in zip.\nWhen specifying both items & annotations filters - they will be joined.", "properties": {"includeItemVectors": {"type": "boolean"}, "includeAnnotationVectors": {"type": "boolean"}, "itemsVectorQuery": {"$ref": "#/components/schemas/DQLResourceQuery", "description": "Export only item vectors matching specified query"}, "annotationsVectorQuery": {"$ref": "#/components/schemas/DQLResourceQuery", "description": "Export only annotation vectors matching specified query"}, "itemsQuery": {"$ref": "#/components/schemas/DQLResourceQuery", "description": "Export only items matching specified query"}, "annotationsQuery": {"$ref": "#/components/schemas/DQLResourceQuery", "description": "Export only annotations matching specified query"}, "featureSetsQuery": {"$ref": "#/components/schemas/DQLResourceQuery", "description": "Export only feature sets matching specified query"}, "annotations": {"properties": {"filter": {"type": "boolean", "description": "given an export by filter - determine if to filter out annotations", "default": "false (export will filter out items, but not annotations)", "deprecated": true}, "convertSemantic": {"type": "boolean", "description": "determine if semantic annotations should exported as png files", "default": "false"}, "include": {"type": "boolean", "description": "determine if export should contain annotations", "default": "true"}}, "required": ["include"], "type": "object", "description": "annotations export options"}, "exportVersion": {"type": "string", "enum": ["V1", "V2"], "description": "`V2` - exported items will have original extension in filename, `V1` - no original extension in filenames"}, "exportType": {"$ref": "#/components/schemas/ExportType", "description": "If this flag is set to json the dataset will be exported as a single JSON file instead of a zip file. This will be honoured only if convertSemantic is false"}, "zipJson": {"type": "boolean", "description": "This flag is only honoured when exportType is 'json'. If zipJson is set to true the final json file is minified and zipped to reduce size"}, "datasetLock": {"type": "boolean", "description": "Determines whether the dataset should be locked during export.", "default": "false"}, "datasetReadonlyInitialState": {"type": "boolean", "description": "Intial state of the dataset readonly"}, "lockTimeoutSec": {"type": "number", "format": "double", "description": "Determines the timeout seconds for dataset Lock*"}, "summary": {"type": "boolean", "description": "Determines whether summary file should be added to export", "default": "false"}}, "type": "object", "additionalProperties": true}, "ExportStatus": {"enum": ["in-progress", "success", "failed"], "type": "string"}, "ExportErrorType": {"enum": ["timeout", "cmd"], "type": "string"}, "APIExportHistory": {"properties": {"id": {"type": "string"}, "url": {"type": "string"}, "datasetId": {"type": "string"}, "exportId": {"type": "string"}, "dqlFilter": {"type": "string"}, "project": {"type": "string"}, "name": {"type": "string"}, "creator": {"type": "string"}, "createdAt": {"type": "string", "format": "date-time"}, "updatedAt": {"type": "string", "format": "date-time"}, "locked": {"type": "boolean"}, "status": {"$ref": "#/components/schemas/ExportStatus"}, "downloadLink": {"type": "string"}, "downloadSize": {"type": "number", "format": "double"}, "errorReason": {"type": "string"}, "errorType": {"$ref": "#/components/schemas/ExportErrorType"}, "downloadDisabled": {"type": "boolean"}}, "required": ["id", "url", "datasetId", "exportId", "project", "name", "creator", "createdAt", "updatedAt", "locked", "status"], "type": "object", "additionalProperties": true}, "ClassifyFilteredItems": {"properties": {"query": {"properties": {"join": {"$ref": "#/components/schemas/Dictionary"}, "filter": {"$ref": "#/components/schemas/Dictionary"}}, "required": ["filter"], "type": "object"}, "annotation": {"properties": {"metadata": {"$ref": "#/components/schemas/Dictionary"}, "attributes": {"items": {"type": "string"}, "type": "array"}, "label": {"type": "string"}}, "required": ["label"], "type": "object"}}, "required": ["query", "annotation"], "type": "object", "additionalProperties": true}, "CursorPage_APIAnnotation-or-APIDataset-or-APIDatasetFileItem-or-APIDatasetDirectoryItem_": {"properties": {"totalItemsCount": {"type": "number", "format": "double"}, "items": {"items": {"anyOf": [{"$ref": "#/components/schemas/APIAnnotation"}, {"$ref": "#/components/schemas/APIDataset"}, {"$ref": "#/components/schemas/APIDatasetFileItem"}, {"$ref": "#/components/schemas/APIDatasetDirectoryItem"}]}, "type": "array"}, "totalPagesCount": {"type": "number", "format": "double"}, "hasNextPage": {"type": "boolean"}}, "required": ["totalItemsCount", "items", "totalPagesCount", "hasNextPage"], "type": "object", "additionalProperties": true}, "QueryResource.items": {"enum": ["items"], "type": "string"}, "QueryResource.annotations": {"enum": ["annotations"], "type": "string"}, "QueryResource.datasets": {"enum": ["datasets"], "type": "string"}, "FilterQuery": {"properties": {"context": {"properties": {"projects": {"items": {"type": "string"}, "type": "array"}, "datasets": {"items": {"type": "string"}, "type": "array"}}, "type": "object"}, "page": {"type": "number", "format": "double"}, "pageSize": {"type": "number", "format": "double"}, "resource": {"anyOf": [{"$ref": "#/components/schemas/QueryResource.items"}, {"$ref": "#/components/schemas/QueryResource.annotations"}, {"$ref": "#/components/schemas/QueryResource.datasets"}]}, "filter": {"$ref": "#/components/schemas/Dictionary"}, "join": {"$ref": "#/components/schemas/JoinQuery"}, "sort": {"$ref": "#/components/schemas/Dictionary"}, "update": {"$ref": "#/components/schemas/Dictionary"}, "delete": {"type": "boolean"}, "select": {"$ref": "#/components/schemas/Dictionary"}, "limit": {"type": "number", "format": "double"}}, "required": ["context", "page", "resource", "filter"], "type": "object", "additionalProperties": true}, "UpdateQuery": {"properties": {"context": {"properties": {"projects": {"items": {"type": "string"}, "type": "array"}, "datasets": {"items": {"type": "string"}, "type": "array"}}, "type": "object"}, "page": {"type": "number", "format": "double"}, "pageSize": {"type": "number", "format": "double"}, "resource": {"anyOf": [{"$ref": "#/components/schemas/QueryResource.items"}, {"$ref": "#/components/schemas/QueryResource.annotations"}, {"$ref": "#/components/schemas/QueryResource.datasets"}]}, "filter": {"$ref": "#/components/schemas/Dictionary"}, "join": {"$ref": "#/components/schemas/JoinQuery"}, "sort": {"$ref": "#/components/schemas/Dictionary"}, "update": {"$ref": "#/components/schemas/Dictionary"}, "delete": {"type": "boolean"}, "select": {"$ref": "#/components/schemas/Dictionary"}, "limit": {"type": "number", "format": "double"}, "systemSpace": {"type": "boolean"}}, "required": ["context", "page", "resource", "filter", "update", "systemSpace"], "type": "object", "additionalProperties": true}, "DeleteQuery": {"properties": {"context": {"properties": {"projects": {"items": {"type": "string"}, "type": "array"}, "datasets": {"items": {"type": "string"}, "type": "array"}}, "type": "object"}, "page": {"type": "number", "format": "double"}, "pageSize": {"type": "number", "format": "double"}, "resource": {"anyOf": [{"$ref": "#/components/schemas/QueryResource.items"}, {"$ref": "#/components/schemas/QueryResource.annotations"}, {"$ref": "#/components/schemas/QueryResource.datasets"}]}, "filter": {"$ref": "#/components/schemas/Dictionary"}, "join": {"$ref": "#/components/schemas/JoinQuery"}, "sort": {"$ref": "#/components/schemas/Dictionary"}, "update": {"$ref": "#/components/schemas/Dictionary"}, "delete": {"type": "boolean"}, "select": {"$ref": "#/components/schemas/Dictionary"}, "limit": {"type": "number", "format": "double"}}, "required": ["context", "page", "resource", "filter", "delete"], "type": "object", "additionalProperties": true}, "Pick_TranslatedQuery.Exclude_keyofTranslatedQuery.intersect-or-except-or-sort-or-limit__": {"properties": {"select": {}, "filter": {}, "join": {}, "resource": {"type": "string"}, "withStatement": {}, "groupBy": {}}, "required": ["filter", "resource"], "type": "object", "description": "From T, pick a set of properties whose keys are in the union K"}, "Omit_TranslatedQuery.intersect-or-except-or-sort-or-limit_": {"$ref": "#/components/schemas/Pick_TranslatedQuery.Exclude_keyofTranslatedQuery.intersect-or-except-or-sort-or-limit__", "description": "Construct a type with the properties of T except for those in type K."}, "DqlLimit": {"properties": {"count": {"type": "number", "format": "double"}, "skip": {"type": "number", "format": "double"}}, "required": ["count"], "type": "object", "additionalProperties": true}, "TranslatedQuery": {"properties": {"resource": {"type": "string"}, "filter": {}, "join": {}, "intersect": {"$ref": "#/components/schemas/Omit_TranslatedQuery.intersect-or-except-or-sort-or-limit_"}, "except": {"$ref": "#/components/schemas/Omit_TranslatedQuery.intersect-or-except-or-sort-or-limit_"}, "sort": {}, "limit": {"$ref": "#/components/schemas/DqlLimit"}, "select": {}, "withStatement": {}, "groupBy": {}}, "required": ["resource", "filter"], "type": "object", "additionalProperties": true}, "RestoreAnnotationsRequest": {"properties": {"annotations": {"items": {"properties": {"itemId": {"type": "string"}, "annotationId": {"type": "string"}}, "required": ["itemId", "annotationId"], "type": "object"}, "type": "array"}}, "required": ["annotations"], "type": "object", "additionalProperties": true}, "ImportItemRequest": {"properties": {"filename": {"type": "string"}, "storageId": {"type": "string"}, "size": {"type": "number", "format": "double"}}, "required": ["filename", "storageId"], "type": "object", "additionalProperties": true}, "AllowedTypes": {"type": "string", "enum": ["string", "number", "boolean"]}, "SchemaEntry": {"properties": {"type": {"$ref": "#/components/schemas/AllowedTypes"}}, "required": ["type"], "type": "object", "additionalProperties": true}, "UnsearchableSchemaReasons": {"enum": ["path contains array", "manual"], "type": "string"}, "UnsearchableSchemaEntry": {"properties": {"reason": {"$ref": "#/components/schemas/UnsearchableSchemaReasons"}}, "required": ["reason"], "type": "object", "additionalProperties": true}, "SchemaMode": {"enum": ["inference", "manual"], "type": "string"}, "SchemaMap": {"properties": {"keys": {"properties": {}, "additionalProperties": {"$ref": "#/components/schemas/SchemaEntry"}, "type": "object"}, "unsearchablePaths": {"properties": {}, "additionalProperties": {"$ref": "#/components/schemas/UnsearchableSchemaEntry"}, "type": "object"}, "indexing": {"$ref": "#/components/schemas/ObjectId"}, "version": {"type": "number", "format": "double"}, "mode": {"$ref": "#/components/schemas/SchemaMode"}}, "required": ["keys", "version"], "type": "object", "additionalProperties": true}, "MigrateDatasetsIndexOperationInput": {"properties": {"targetItemsSchema": {"$ref": "#/components/schemas/SchemaMap", "description": "items schema to put on the migrated datasets before starting migrations"}, "annotationsBatchSize": {"type": "number", "format": "double", "description": "decides how many annotations can be migrated in a single batch"}, "itemsBatchSize": {"type": "number", "format": "double", "description": "decides how many items can be migrated in a single batch"}, "concurrency": {"type": "number", "format": "double", "description": "decides how many migrate dataset commands can run at a single time @default 10"}, "deleteTarget": {"type": "boolean", "description": "deletes data in a target index before index migration to prevent data duplicating issue"}, "deleteSource": {"type": "boolean", "description": "deletes data in a source index after index migration"}, "targetIndex": {"$ref": "#/components/schemas/DatasetIndexDrivers", "description": "Index of the target data set where the data needs to be transferred"}, "datasetQuery": {"$ref": "#/components/schemas/DQLResourceQuery"}}, "required": ["targetIndex", "datasetQuery"], "type": "object"}, "CleanDatasetsDataSpec": {"properties": {"indexDriver": {"$ref": "#/components/schemas/DatasetIndexDrivers"}, "datasetsQuery": {"$ref": "#/components/schemas/DQLResourceQuery"}}, "required": ["indexDriver", "datasetsQuery"], "type": "object"}, "Boolean": {"properties": {}, "type": "object", "additionalProperties": false}, "CreateGCSBucketsOperationInput": {"properties": {"waitToCompletion": {"$ref": "#/components/schemas/Boolean"}, "bucketCreationWaitTimeS": {"type": "number", "format": "double"}, "projects": {"items": {"type": "string"}, "type": "array"}}, "required": ["projects"], "type": "object"}, "ItemMetadata": {"properties": {"system": {"$ref": "#/components/schemas/ItemSystemMetadata"}}, "required": ["system"], "type": "object", "additionalProperties": true}, "ItemAnnotatedStatus": {"type": "boolean"}, "ItemRevision": {"properties": {"version": {"type": "number", "format": "double"}, "metadata": {"$ref": "#/components/schemas/ItemMetadata"}, "storageId": {"type": "string"}}, "required": ["version", "metadata", "storageId"], "type": "object", "additionalProperties": true}, "MasterItemSpec": {"properties": {"type": {"$ref": "#/components/schemas/ItemSpecType"}}, "required": ["type"], "type": "object", "additionalProperties": true}, "ClonedItemSpec": {"properties": {"type": {"$ref": "#/components/schemas/ItemSpecType"}, "masterDatasetItemId": {"$ref": "#/components/schemas/ObjectId"}, "parentDatasetItemId": {"$ref": "#/components/schemas/ObjectId"}, "datasetDriver": {"anyOf": [{"$ref": "#/components/schemas/ObjectId"}, {"type": "string"}]}, "parentDatasetId": {"anyOf": [{"$ref": "#/components/schemas/ObjectId"}, {"type": "string"}]}}, "required": ["type", "masterDatasetItemId", "parentDatasetItemId", "datasetDriver", "parentDatasetId"], "type": "object", "additionalProperties": true}, "Context": {"properties": {"org": {"type": "string", "nullable": true}, "project": {"type": "string", "nullable": true}, "creator": {"type": "string"}, "createdAt": {"type": "string", "format": "date-time"}, "updatedAt": {"type": "string", "format": "date-time"}}, "required": ["creator", "createdAt", "updatedAt", "creator", "createdAt", "updatedAt", "createdAt", "updatedAt", "org", "project", "creator"], "type": "object", "additionalProperties": false}, "ItemContext": {"properties": {"org": {"type": "string"}, "project": {"type": "string"}, "creator": {"type": "string"}, "createdAt": {"type": "string", "format": "date-time"}, "updatedAt": {"type": "string", "format": "date-time"}, "dataset": {"type": "string"}}, "required": ["creator", "createdAt", "updatedAt", "project", "dataset"], "type": "object", "additionalProperties": true}, "AuthZBlock_ItemContext_": {"properties": {"scope": {"type": "string"}, "context": {"allOf": [{"$ref": "#/components/schemas/Context"}, {"$ref": "#/components/schemas/ItemContext"}]}, "access": {"items": {}, "type": "array"}}, "required": ["context"], "type": "object", "additionalProperties": true}, "Record_string.ResourceReference_": {"properties": {}, "type": "object", "description": "Construct a type with a set of properties K of type T"}, "DatasetItem": {"properties": {"_id": {"$ref": "#/components/schemas/ObjectId"}, "createdAt": {"type": "string", "format": "date-time"}, "datasetId": {"type": "string"}, "storageId": {"type": "string"}, "dir": {"type": "string"}, "filename": {"type": "string"}, "filename_collated": {"type": "string"}, "name": {"type": "string"}, "type": {"type": "string", "enum": ["file", "dir"]}, "hidden": {"type": "boolean"}, "metadata": {"$ref": "#/components/schemas/ItemMetadata"}, "annotated": {"$ref": "#/components/schemas/ItemAnnotatedStatus"}, "revisions": {"items": {"$ref": "#/components/schemas/ItemRevision"}, "type": "array"}, "spec": {"anyOf": [{"$ref": "#/components/schemas/MasterItemSpec"}, {"$ref": "#/components/schemas/ClonedItemSpec"}]}, "annotationsCount": {"type": "number", "format": "double"}, "discardedCount": {"type": "number", "format": "double", "deprecated": true}, "authz": {"$ref": "#/components/schemas/AuthZBlock_ItemContext_"}, "creator": {"type": "string"}, "version": {"type": "number", "format": "double", "description": "item version - monotonic, integer, increased every item update"}, "updatedAt": {"type": "string", "format": "date-time", "description": "\"updatedAt\" is a timestamp indicating the most recent modification date of an item.\n doesn\u2019t get updated on counter inc."}, "updatedBy": {"type": "string", "description": "\"updatedBy\" refers to the identifier of the user who made the most recent update to an item.\n doesn\u2019t get updated on counter inc"}, "annotatedAt": {"type": "string", "format": "date-time", "description": "\"annotatedAt\" is a timestamp indicating the most recent modification(add / update / delete) in the annotations of an item."}, "description": {"type": "string", "description": "Item description - free text field"}, "described": {"type": "boolean", "description": "Flags if the item has a description - here for mongo search and indexing purposes"}, "refsMap": {"$ref": "#/components/schemas/Record_string.ResourceReference_", "description": "Internal map of references to query over"}}, "required": ["_id", "createdAt", "datasetId", "storageId", "dir", "filename", "filename_collated", "name", "type", "hidden", "metadata", "annotated", "spec", "annotationsCount", "discardedCount", "authz", "creator", "version", "updatedAt", "updatedBy"], "type": "object", "additionalProperties": true}, "SizeDistribution": {"properties": {}, "type": "object", "additionalProperties": {"type": "number", "format": "double"}}, "AnnotationType.BOX": {"enum": ["box"], "type": "string"}, "AnnotationType.CLASS": {"enum": ["class"], "type": "string"}, "AnnotationType.BINARY": {"enum": ["binary"], "type": "string"}, "Partial__ms-numberbytes%3Anumber__": {"properties": {"ms": {"type": "number", "format": "double"}, "bytes": {"type": "number", "format": "double"}}, "type": "object", "description": "Make all properties in T optional"}, "Pick_DataStreamConfig_any_.maxConcurrentReaders-or-retention-or-compression_": {"properties": {"maxConcurrentReaders": {"type": "number", "format": "double", "description": "max number of concurrent reader this stream allows"}, "retention": {"$ref": "#/components/schemas/Partial__ms-numberbytes%3Anumber__"}, "compression": {"type": "boolean", "description": "enables compression", "default": "true"}}, "type": "object", "description": "From T, pick a set of properties whose keys are in the union K"}, "GenerateDatasetOptions": {"properties": {"id": {"type": "string", "description": "config id - used to identify a specific dataset generator output"}, "topics": {"properties": {"annotations": {"type": "string"}, "items": {"type": "string"}}, "required": ["annotations", "items"], "type": "object", "description": "when specified - will be used for topic names, regardless of any conventions"}, "itemsCount": {"type": "number", "format": "double", "description": "number of items in generated dataset"}, "dirsCount": {"type": "number", "format": "double"}, "maxDirDepth": {"type": "number", "format": "double"}, "metadata": {"properties": {"sizeDistribution": {"$ref": "#/components/schemas/SizeDistribution", "description": "the dataset item size distribution"}, "searchable": {"type": "number", "format": "double", "description": "amount of metadata keys that will become searchable metadata keys"}, "nulls": {"type": "number", "format": "double", "description": "percent of the metadata values that will be removed from the generated items\nkey selection is random"}, "valuesDistribution": {"items": {"type": "number", "format": "double"}, "type": "array", "description": "list of numbers 0-1\neach number correlates to a key in the keys array\n1 means ALL items will have the same value for the corresponding key\n0 means NO items will have the same value for the corresponding key"}, "minBytes": {"type": "number", "format": "double", "description": "when specified - JSON size will be inflated into the specified size"}}, "required": ["searchable", "valuesDistribution"], "type": "object"}, "annotations": {"properties": {"metadata": {"properties": {"sizeDistribution": {"$ref": "#/components/schemas/SizeDistribution", "description": "the dataset item size distribution"}}, "type": "object"}, "labels": {"type": "number", "format": "double", "description": "number of distinct labels in dataset"}, "annotationsAttributesOptionsCount": {"type": "number", "format": "double"}, "countPerItem": {"type": "number", "format": "double", "description": "how many annotations per item"}, "types": {"items": {"anyOf": [{"$ref": "#/components/schemas/AnnotationType.BOX"}, {"$ref": "#/components/schemas/AnnotationType.CLASS"}, {"$ref": "#/components/schemas/AnnotationType.BINARY"}]}, "type": "array", "description": "which annotation types should be generated"}}, "required": ["labels", "countPerItem", "types"], "type": "object"}, "outputStream": {"properties": {"config": {"$ref": "#/components/schemas/Pick_DataStreamConfig_any_.maxConcurrentReaders-or-retention-or-compression_"}, "recreate": {"type": "boolean"}}, "type": "object"}}, "required": ["id", "itemsCount", "dirsCount", "maxDirDepth", "metadata"], "type": "object", "additionalProperties": true}, "GenerationStrategyType": {"enum": ["sequentially", "parallel"], "type": "string"}, "Pick_StartInput_any_.maxBytes-or-maxMessages_": {"properties": {"maxBytes": {"type": "number", "format": "double", "description": "limits number of messages in a batch by its size"}, "maxMessages": {"type": "number", "format": "double", "description": "determines how many messages will be processed at once", "default": "Infinity"}}, "type": "object", "description": "From T, pick a set of properties whose keys are in the union K"}, "GeneratedDatasetTypes": {"enum": ["simple1", "simple2", "simple3", "simple4", "simple5", "manyKeys1", "manyKeys2", "manyKeys3", "bigJSON1", "bigJSON2", "M_1", "M_1_NO_COMP", "M_2", "M_4", "M_6", "M_10", "M_25", "M_5_PRODUCTION_DIST", "M_25_PRODUCTION_DIST", "100K-bench"], "type": "string"}, "Record_string.Pick_GenerateDatasetCommand._id-or-status-or-error__": {"properties": {}, "type": "object", "description": "Construct a type with a set of properties K of type T"}, "Awaited_ReturnType_typeofgenerateDatasets__": {"$ref": "#/components/schemas/Record_string.Pick_GenerateDatasetCommand._id-or-status-or-error__", "description": "Recursively unwraps the \"awaited type\" of a type. Non-promise \"thenables\" should resolve to `never`. This emulates the behavior of `await`."}, "OneByOneLatencyBenchmarkMode": {"properties": {"type": {"type": "string", "enum": ["oneByOneLatency"], "nullable": false}, "count": {"type": "number", "format": "double", "description": "number of times to execute each query test case"}}, "required": ["type", "count"], "type": "object", "additionalProperties": true}, "ProfilingBenchmarkMode": {"properties": {"type": {"type": "string", "enum": ["profiling"], "nullable": false, "description": "command will execute query profile for each test case"}}, "required": ["type"], "type": "object", "additionalProperties": true}, "ConcurrencyBenchmarkMode": {"properties": {"type": {"type": "string", "enum": ["concurrency"], "nullable": false}, "concurrency": {"type": "number", "format": "double", "description": "max number of concurrent queries"}, "total": {"type": "number", "format": "double", "description": "total number of queries to execute"}}, "required": ["type", "concurrency", "total"], "type": "object", "additionalProperties": true}, "BenchmarkMode": {"anyOf": [{"$ref": "#/components/schemas/OneByOneLatencyBenchmarkMode"}, {"$ref": "#/components/schemas/ProfilingBenchmarkMode"}, {"$ref": "#/components/schemas/ConcurrencyBenchmarkMode"}]}, "QueryTestCases": {"enum": ["baseLine", "oneTerm", "fiveTerms", "tenTerms", "twentyTerms", "oneTermSortingOneCustomField", "oneTermSortingTwoCustomFields", "oneTermSortingThreeCustomFields", "oneTermSortingOneIndexedField", "fiveTermSortingOneIndexedField", "FiveTermsJoinOneTerm", "FiveTermsJoinTwoTerms", "FiveTermsJoinThreeTerms"], "type": "string"}, "IndexingStrategyType": {"enum": ["SeekableLZ4", "indexed", "SeekableJSON"], "type": "string"}, "ITermConfiguration": {"properties": {"key": {"type": "string"}, "value": {}, "valueDistribution": {"type": "number", "format": "double"}}, "required": ["key", "value", "valueDistribution"], "type": "object", "additionalProperties": true}, "Pick_QueryGeneratorInput.avoidDbCache-or-selectIdsOnly-or-joinTerms-or-pageSize_": {"properties": {"avoidDbCache": {"type": "boolean", "description": "When true - an arbitrary `$or` term will be added to the query to avoid DB cache", "default": "true"}, "selectIdsOnly": {"type": "boolean", "description": "Execute the same queries, but only return the ids of the items"}, "joinTerms": {"items": {"$ref": "#/components/schemas/ITermConfiguration"}, "type": "array"}, "pageSize": {"type": "number", "format": "double", "description": "Determines page size to use for the generated queries", "default": "1000"}}, "type": "object", "description": "From T, pick a set of properties whose keys are in the union K"}, "InferDatasetSchemaMode": {"enum": ["report", "update"], "type": "string"}, "FeatureFlagsSet": {"properties": {"defaultIndexDriver": {"$ref": "#/components/schemas/DatasetIndexDrivers"}, "disableDefaultDriver": {"type": "boolean"}, "_id": {"type": "string"}, "extends": {"items": {"type": "string"}, "type": "array"}, "context": {"anyOf": [{"properties": {"ids": {"items": {"type": "string"}, "type": "array"}, "type": {"type": "string", "enum": ["project", "org"]}}, "required": ["ids", "type"], "type": "object"}, {"properties": {"ids": {}, "type": {"type": "string", "enum": ["default"], "nullable": false}}, "required": ["type"], "type": "object"}]}}, "required": ["_id", "context"], "type": "object", "additionalProperties": true}, "DatasetType": {"enum": [0, 1, 2], "type": "number"}, "DatasetDeletionInformation": {"properties": {"markedForDeletionBy": {"type": "string", "description": "User that initiated the mark for deletion request"}, "markedForDeletionDate": {"type": "string", "format": "date-time", "description": "Date that the dataset was marked for deletion", "default": "TimeProvider.now"}, "targetDeleteDate": {"type": "string", "format": "date-time", "description": "Date that the dataset will actually be deleted on\n\nDefaults to `30 days` from the issuance of delete command if value is not provided", "default": "`now + 30 days`"}}, "required": ["markedForDeletionBy", "markedForDeletionDate", "targetDeleteDate"], "type": "object", "additionalProperties": true}, "DatasetContext": {"properties": {"org": {"type": "string"}, "project": {"type": "string"}, "creator": {"type": "string"}, "createdAt": {"type": "string", "format": "date-time"}, "updatedAt": {"type": "string", "format": "date-time"}}, "required": ["creator", "createdAt", "updatedAt", "project"], "type": "object", "additionalProperties": true}, "AuthZBlock_DatasetContext_": {"properties": {"scope": {"type": "string"}, "context": {"allOf": [{"$ref": "#/components/schemas/Context"}, {"$ref": "#/components/schemas/DatasetContext"}]}, "access": {"items": {}, "type": "array"}}, "required": ["context"], "type": "object", "additionalProperties": true}, "DatasetSchemaMap": {"properties": {"items": {"$ref": "#/components/schemas/SchemaMap"}}, "required": ["items"], "type": "object", "additionalProperties": true}, "S2ItemMetadataSchema": {"properties": {"datasetId": {"type": "string"}}, "required": ["datasetId"], "type": "object", "additionalProperties": true}, "Dataset": {"properties": {"_id": {"type": "string"}, "name": {"type": "string"}, "creator": {"type": "string"}, "projects": {"items": {"type": "string"}, "type": "array", "description": "currently datasets have only 1 project"}, "driver": {"anyOf": [{"$ref": "#/components/schemas/ObjectId"}, {"type": "string"}]}, "metadata": {"$ref": "#/components/schemas/DatasetMetadata"}, "type": {"$ref": "#/components/schemas/DatasetType"}, "readableType": {"type": "string"}, "createdAt": {"type": "string", "format": "date-time"}, "updatedAt": {"type": "string", "format": "date-time"}, "lastStorageSyncDate": {"type": "string", "format": "date-time", "description": "lastStorageSyncDate points to the time when storage was last synced"}, "updatedBy": {"type": "string"}, "accessLevel": {"type": "string", "enum": ["private", "project"]}, "itemsCount": {"type": "number", "format": "double", "description": "Count all 'file' type items in dataset"}, "annotatedCount": {"type": "number", "format": "double", "description": "Count all items that has annotations in the dataset"}, "annotationsCount": {"type": "number", "format": "double", "description": "Count the number of annotations In the dataset"}, "_indexed": {"type": "boolean", "description": "Determines if this dataset is indexed to elasticsearch"}, "_markForDeletion": {"type": "boolean", "description": "Determines if this dataset is marked for deletion"}, "deletionInformation": {"$ref": "#/components/schemas/DatasetDeletionInformation", "description": "Determines the deletion behavior of the dataset, it will be set only when deleting a dataset"}, "readonly": {"type": "boolean", "description": "Determines if this dataset is in readonly mode and cannot be modified"}, "expirationOptions": {"$ref": "#/components/schemas/ExpirationOptions", "description": "Specifies the parameters by which items are marked as expired"}, "authz": {"$ref": "#/components/schemas/AuthZBlock_DatasetContext_"}, "_syncStatus": {"type": "string", "enum": ["failed"], "nullable": false, "description": "determines status of S2 sync for this dataset"}, "indexDriver": {"$ref": "#/components/schemas/DatasetIndexDrivers", "description": "determines which index driver is used for this datasets"}, "enableSyncWithCloned": {"type": "boolean", "description": "Flag that determines if it is allowed to sync the specified dataset if it is"}, "_schema": {"$ref": "#/components/schemas/DatasetSchemaMap"}, "schema": {"$ref": "#/components/schemas/S2ItemMetadataSchema"}, "schemaCleanupDate": {"type": "string", "format": "date-time", "description": "Determines when the items in the dataset were last udpate of deleted. This flag is used in the SchemaCleanup command"}, "lockProcessCommandId": {"type": "string"}}, "required": ["_id", "name", "creator", "projects", "driver", "metadata", "type", "readableType", "accessLevel", "itemsCount", "annotatedCount", "annotationsCount", "_markForDeletion", "authz", "_schema"], "type": "object", "additionalProperties": true}, "APIDatasetSchema": {"properties": {"items": {"$ref": "#/components/schemas/SchemaMap"}, "annotations": {"$ref": "#/components/schemas/SchemaMap"}}, "required": ["items", "annotations"], "type": "object", "additionalProperties": true}, "SchemaEntryInput": {"allOf": [{"properties": {"skipUpdate": {"type": "boolean", "description": "when true, schema will NOT be persisted to db"}, "key": {"type": "string"}}, "required": ["key"], "type": "object"}, {"anyOf": [{"properties": {"type": {"$ref": "#/components/schemas/AllowedTypes"}, "value": {}}, "required": ["value"], "type": "object"}, {"properties": {"type": {"$ref": "#/components/schemas/AllowedTypes"}, "value": {}}, "required": ["type"], "type": "object"}]}]}, "UpdateItemsSchemaInput": {"properties": {"schemaKeys": {"properties": {"remove": {"items": {"type": "string"}, "type": "array"}, "add": {"items": {"$ref": "#/components/schemas/SchemaEntryInput"}, "type": "array"}}, "type": "object"}, "unsearchablePaths": {"properties": {"remove": {"items": {"type": "string"}, "type": "array"}, "add": {"items": {"type": "string"}, "type": "array"}}, "type": "object"}, "indexingOptions": {"properties": {"sampleSize": {"type": "number", "format": "double"}}, "type": "object"}}, "type": "object", "additionalProperties": true}, "EditItemsSchemaModeInput": {"properties": {"mode": {"$ref": "#/components/schemas/SchemaMode"}}, "required": ["mode"], "type": "object", "additionalProperties": true}, "MigrateStorageDriverOperationInput": {"properties": {"bucketCreatingWaitingTime": {"type": "number", "format": "double"}, "miniItemsBatchSize": {"type": "number", "format": "double"}, "projectsConcurrency": {"type": "number", "format": "double"}, "datasetsConcurrency": {"type": "number", "format": "double"}, "itemsBatchSize": {"type": "number", "format": "double"}, "deleteFromSource": {"type": "boolean"}, "waitToCompletion": {"type": "boolean"}, "filter": {"$ref": "#/components/schemas/DQLResourceQuery"}, "projects": {"items": {"type": "string"}, "type": "array"}, "targetDriverId": {"anyOf": [{"type": "string"}, {"$ref": "#/components/schemas/ObjectId"}]}, "sourceDriverId": {"anyOf": [{"type": "string"}, {"$ref": "#/components/schemas/ObjectId"}]}}, "required": ["projects", "targetDriverId", "sourceDriverId"], "type": "object"}, "Record_MLSplitListKeys.number_": {"properties": {"train": {"type": "number", "format": "double"}, "test": {"type": "number", "format": "double"}, "validation": {"type": "number", "format": "double"}}, "type": "object", "description": "Construct a type with a set of properties K of type T"}, "DriverType": {"type": "string", "enum": ["mongo", "gcs", "s3", "noop", "fs", "azureblob", "invalid", "azureDatalakeGen2", "fsExternal", "internalGcs", "proxy", "s3customerInternal"], "nullable": false}, "APIDriverConfiguration": {"properties": {"id": {"type": "string"}, "type": {"$ref": "#/components/schemas/DriverType"}, "creator": {"type": "string"}, "createdAt": {"type": "string", "format": "date-time"}, "name": {"type": "string"}, "isSyncable": {"type": "boolean"}, "projectId": {"type": "string"}, "orgId": {"type": "string"}, "allowExternalDelete": {"type": "boolean"}, "allowExternalModification": {"type": "boolean"}}, "required": ["id", "type", "creator", "createdAt", "name", "isSyncable"], "type": "object", "additionalProperties": true}, "S3IntegrationConfig": {"properties": {"key": {"type": "string"}, "secret": {"type": "string"}}, "required": ["key", "secret"], "type": "object", "additionalProperties": true}, "GcsIntegrationConfig": {"properties": {"privateKey": {}}, "required": ["privateKey"], "type": "object", "additionalProperties": true}, "AzureBlobIntegrationConfig": {"properties": {"accountName": {"type": "string"}, "clientId": {"type": "string"}, "tenantId": {"type": "string"}, "clientSecret": {"type": "string"}}, "required": ["accountName", "clientId", "tenantId", "clientSecret"], "type": "object", "additionalProperties": true}, "DriverMetadata": {"properties": {"system": {"properties": {"orgId": {"type": "string"}, "projectId": {"type": "string"}}, "type": "object"}}, "required": ["system"], "type": "object", "additionalProperties": true}, "DriverContext": {"properties": {"org": {"type": "string"}, "project": {"type": "string"}, "creator": {"type": "string"}, "createdAt": {"type": "string", "format": "date-time"}, "updatedAt": {"type": "string", "format": "date-time"}}, "required": ["creator", "createdAt", "updatedAt", "project"], "type": "object", "additionalProperties": true}, "AuthZBlock_DriverContext_": {"properties": {"scope": {"type": "string"}, "context": {"allOf": [{"$ref": "#/components/schemas/Context"}, {"$ref": "#/components/schemas/DriverContext"}]}, "access": {"items": {}, "type": "array"}}, "required": ["context"], "type": "object", "additionalProperties": true}, "IntegrationType": {"enum": ["mongo", "gcs", "s3", "azureblob", "fs", "aws-sts", "aws-cross", "gcp-cross", "gcp-workload-identity-federation", "key_value", "private-registry", "mongo", "gcs", "s3", "azureblob", "fs", "aws-sts", "aws-cross", "gcp-cross", "gcp-workload-identity-federation", "key_value", "private-registry"], "type": "string"}, "EnvUserPasswordAuthentication": {"description": "Represents a User/Password Authentication mechanism", "properties": {"username": {"type": "string"}, "password": {"type": "string"}}, "required": ["username", "password"], "type": "object", "additionalProperties": true}, "KeyFileAuthentication": {"description": "Represents an ssh key file Authentication mechanism", "properties": {"filepath": {"type": "string"}}, "required": ["filepath"], "type": "object", "additionalProperties": true}, "Pick_S3DriverPayload.Exclude_keyofS3DriverPayload.path__": {"properties": {"type": {"$ref": "#/components/schemas/DriverType"}, "metadata": {"$ref": "#/components/schemas/DriverMetadata"}, "creator": {"type": "string"}, "createdAt": {"type": "string", "format": "date-time"}, "_id": {"anyOf": [{"type": "string"}, {"$ref": "#/components/schemas/ObjectId"}]}, "name": {"type": "string"}, "authz": {"$ref": "#/components/schemas/AuthZBlock_DriverContext_"}, "region": {"type": "string"}, "bucketName": {"type": "string"}, "storageClass": {"type": "string"}, "endpoint": {"type": "string"}, "allowExternalDelete": {"type": "boolean"}, "allowExternalModification": {"type": "boolean"}, "integrationId": {"type": "string"}, "integrationType": {"$ref": "#/components/schemas/IntegrationType"}, "authentication": {"anyOf": [{"$ref": "#/components/schemas/EnvUserPasswordAuthentication"}, {"$ref": "#/components/schemas/KeyFileAuthentication"}]}}, "required": ["type", "creator", "createdAt", "_id", "name", "authz", "allowExternalDelete", "allowExternalModification", "integrationId", "integrationType"], "type": "object", "description": "From T, pick a set of properties whose keys are in the union K"}, "Omit_S3DriverPayload.path_": {"$ref": "#/components/schemas/Pick_S3DriverPayload.Exclude_keyofS3DriverPayload.path__", "description": "Construct a type with the properties of T except for those in type K."}, "S3UserInternalDriverPayload": {"$ref": "#/components/schemas/Omit_S3DriverPayload.path_"}, "S3DriverPayload": {"properties": {"type": {"$ref": "#/components/schemas/DriverType"}, "creator": {"type": "string"}, "authentication": {"anyOf": [{"$ref": "#/components/schemas/EnvUserPasswordAuthentication"}, {"$ref": "#/components/schemas/KeyFileAuthentication"}]}, "_id": {"anyOf": [{"type": "string"}, {"$ref": "#/components/schemas/ObjectId"}]}, "createdAt": {"type": "string", "format": "date-time"}, "name": {"type": "string"}, "authz": {"$ref": "#/components/schemas/AuthZBlock_DriverContext_"}, "metadata": {"$ref": "#/components/schemas/DriverMetadata"}, "integrationId": {"type": "string"}, "integrationType": {"$ref": "#/components/schemas/IntegrationType"}, "allowExternalDelete": {"type": "boolean"}, "allowExternalModification": {"type": "boolean"}, "region": {"type": "string"}, "bucketName": {"type": "string"}, "path": {"type": "string"}, "storageClass": {"type": "string"}, "endpoint": {"type": "string"}}, "required": ["type", "creator", "_id", "createdAt", "name", "authz", "integrationId", "integrationType", "allowExternalDelete", "allowExternalModification"], "type": "object", "additionalProperties": true}, "GcsDriverPayload": {"properties": {"type": {"$ref": "#/components/schemas/DriverType"}, "creator": {"type": "string"}, "authentication": {"anyOf": [{"$ref": "#/components/schemas/EnvUserPasswordAuthentication"}, {"$ref": "#/components/schemas/KeyFileAuthentication"}]}, "_id": {"anyOf": [{"type": "string"}, {"$ref": "#/components/schemas/ObjectId"}]}, "createdAt": {"type": "string", "format": "date-time"}, "name": {"type": "string"}, "authz": {"$ref": "#/components/schemas/AuthZBlock_DriverContext_"}, "metadata": {"$ref": "#/components/schemas/DriverMetadata"}, "integrationId": {"type": "string"}, "integrationType": {"$ref": "#/components/schemas/IntegrationType"}, "allowExternalDelete": {"type": "boolean"}, "allowExternalModification": {"type": "boolean"}, "bucket": {"type": "string"}}, "required": ["type", "creator", "_id", "createdAt", "name", "authz", "integrationId", "integrationType", "allowExternalDelete", "allowExternalModification", "bucket"], "type": "object", "additionalProperties": true}, "AzureBlobDriverPayload": {"properties": {"type": {"$ref": "#/components/schemas/DriverType"}, "creator": {"type": "string"}, "authentication": {"anyOf": [{"$ref": "#/components/schemas/EnvUserPasswordAuthentication"}, {"$ref": "#/components/schemas/KeyFileAuthentication"}]}, "_id": {"anyOf": [{"type": "string"}, {"$ref": "#/components/schemas/ObjectId"}]}, "createdAt": {"type": "string", "format": "date-time"}, "name": {"type": "string"}, "authz": {"$ref": "#/components/schemas/AuthZBlock_DriverContext_"}, "metadata": {"$ref": "#/components/schemas/DriverMetadata"}, "integrationId": {"type": "string"}, "integrationType": {"$ref": "#/components/schemas/IntegrationType"}, "allowExternalDelete": {"type": "boolean"}, "allowExternalModification": {"type": "boolean"}, "containerName": {"type": "string"}, "path": {"type": "string"}}, "required": ["type", "creator", "_id", "createdAt", "name", "authz", "integrationId", "integrationType", "allowExternalDelete", "allowExternalModification"], "type": "object", "additionalProperties": true}, "Pick_FilesystemDriverConfiguration.mountPath_": {"properties": {"mountPath": {"type": "string"}}, "required": ["mountPath"], "type": "object", "description": "From T, pick a set of properties whose keys are in the union K"}, "FSDriverPayload": {"$ref": "#/components/schemas/Pick_FilesystemDriverConfiguration.mountPath_"}, "DriverPayload": {"properties": {"type": {"$ref": "#/components/schemas/DriverType"}, "creator": {"type": "string"}, "integrationId": {"type": "string"}, "integrationConfig": {"anyOf": [{"$ref": "#/components/schemas/S3IntegrationConfig"}, {"$ref": "#/components/schemas/GcsIntegrationConfig"}, {"$ref": "#/components/schemas/AzureBlobIntegrationConfig"}, {"$ref": "#/components/schemas/S3UserInternalDriverPayload"}]}, "metadata": {"$ref": "#/components/schemas/DriverMetadata"}, "name": {"type": "string"}, "payload": {"anyOf": [{"$ref": "#/components/schemas/S3DriverPayload"}, {"$ref": "#/components/schemas/GcsDriverPayload"}, {"$ref": "#/components/schemas/AzureBlobDriverPayload"}, {"$ref": "#/components/schemas/FSDriverPayload"}]}}, "required": ["type", "creator", "metadata", "name", "payload"], "type": "object", "additionalProperties": true}, "Record_string._label-stringdrivers%3F%3AAPIDriverConfiguration-ArraydriverId%3F%3Astring__": {"properties": {}, "type": "object", "description": "Construct a type with a set of properties K of type T"}, "APIDriversByProviderResponse": {"$ref": "#/components/schemas/Record_string._label-stringdrivers%3F%3AAPIDriverConfiguration-ArraydriverId%3F%3Astring__"}, "Partial_S3DriverPayload_": {"properties": {"region": {"type": "string"}, "bucketName": {"type": "string"}, "path": {"type": "string"}, "storageClass": {"type": "string"}, "endpoint": {"type": "string"}, "allowExternalDelete": {"type": "boolean"}, "allowExternalModification": {"type": "boolean"}, "integrationId": {"type": "string"}, "integrationType": {"$ref": "#/components/schemas/IntegrationType"}, "type": {"$ref": "#/components/schemas/DriverType"}, "creator": {"type": "string"}, "authentication": {"anyOf": [{"$ref": "#/components/schemas/EnvUserPasswordAuthentication"}, {"$ref": "#/components/schemas/KeyFileAuthentication"}]}, "_id": {"anyOf": [{"type": "string"}, {"$ref": "#/components/schemas/ObjectId"}]}, "createdAt": {"type": "string", "format": "date-time"}, "name": {"type": "string"}, "authz": {"$ref": "#/components/schemas/AuthZBlock_DriverContext_"}, "metadata": {"$ref": "#/components/schemas/DriverMetadata"}}, "type": "object", "description": "Make all properties in T optional"}, "Partial_GcsDriverPayload_": {"properties": {"bucket": {"type": "string"}, "allowExternalDelete": {"type": "boolean"}, "allowExternalModification": {"type": "boolean"}, "integrationId": {"type": "string"}, "integrationType": {"$ref": "#/components/schemas/IntegrationType"}, "type": {"$ref": "#/components/schemas/DriverType"}, "creator": {"type": "string"}, "authentication": {"anyOf": [{"$ref": "#/components/schemas/EnvUserPasswordAuthentication"}, {"$ref": "#/components/schemas/KeyFileAuthentication"}]}, "_id": {"anyOf": [{"type": "string"}, {"$ref": "#/components/schemas/ObjectId"}]}, "createdAt": {"type": "string", "format": "date-time"}, "name": {"type": "string"}, "authz": {"$ref": "#/components/schemas/AuthZBlock_DriverContext_"}, "metadata": {"$ref": "#/components/schemas/DriverMetadata"}}, "type": "object", "description": "Make all properties in T optional"}, "Partial_AzureBlobDriverPayload_": {"properties": {"containerName": {"type": "string"}, "path": {"type": "string"}, "allowExternalDelete": {"type": "boolean"}, "allowExternalModification": {"type": "boolean"}, "integrationId": {"type": "string"}, "integrationType": {"$ref": "#/components/schemas/IntegrationType"}, "type": {"$ref": "#/components/schemas/DriverType"}, "creator": {"type": "string"}, "authentication": {"anyOf": [{"$ref": "#/components/schemas/EnvUserPasswordAuthentication"}, {"$ref": "#/components/schemas/KeyFileAuthentication"}]}, "_id": {"anyOf": [{"type": "string"}, {"$ref": "#/components/schemas/ObjectId"}]}, "createdAt": {"type": "string", "format": "date-time"}, "name": {"type": "string"}, "authz": {"$ref": "#/components/schemas/AuthZBlock_DriverContext_"}, "metadata": {"$ref": "#/components/schemas/DriverMetadata"}}, "type": "object", "description": "Make all properties in T optional"}, "PartialDriverPayload": {"properties": {"name": {"type": "string"}, "payload": {"anyOf": [{"$ref": "#/components/schemas/Partial_S3DriverPayload_"}, {"$ref": "#/components/schemas/Partial_GcsDriverPayload_"}, {"$ref": "#/components/schemas/Partial_AzureBlobDriverPayload_"}]}}, "required": ["payload"], "type": "object", "additionalProperties": true}, "APIFeatureSet": {"properties": {"id": {"type": "string"}, "url": {"type": "string"}, "type": {"type": "string"}, "entityType": {"type": "string"}, "org": {"type": "string"}, "modelId": {"type": "string"}, "project": {"type": "string"}, "creator": {"type": "string"}, "createdAt": {"type": "string", "format": "date-time"}, "updatedAt": {"type": "string", "format": "date-time"}, "updatedBy": {"type": "string"}, "name": {"type": "string"}, "size": {"type": "number", "format": "double", "description": "size - set size"}, "authz": {"$ref": "#/components/schemas/AuthZBlock_DatasetContext_"}}, "required": ["id", "url", "type", "entityType", "project", "creator", "createdAt", "updatedAt", "updatedBy", "name", "size", "authz"], "type": "object", "additionalProperties": true}, "CursorPage_APIFeatureSet_": {"properties": {"totalItemsCount": {"type": "number", "format": "double"}, "items": {"items": {"$ref": "#/components/schemas/APIFeatureSet"}, "type": "array"}, "totalPagesCount": {"type": "number", "format": "double"}, "hasNextPage": {"type": "boolean"}}, "required": ["totalItemsCount", "items", "totalPagesCount", "hasNextPage"], "type": "object", "additionalProperties": true}, "FeatureSetEntityType": {"enum": ["item", "annotation", "dataset"], "type": "string"}, "FeatureSet": {"properties": {"_id": {"type": "string"}, "type": {"type": "string", "description": "type - string of the feature type: 2d, 3d, modelFC, TSNE, PCA, FFT"}, "entityType": {"$ref": "#/components/schemas/FeatureSetEntityType"}, "project": {"type": "string"}, "org": {"type": "string"}, "modelId": {"type": "string"}, "creator": {"type": "string"}, "createdAt": {"type": "string", "format": "date-time"}, "updatedAt": {"type": "string", "format": "date-time"}, "updatedBy": {"type": "string"}, "name": {"type": "string"}, "size": {"type": "number", "format": "double", "description": "size - set size"}, "authz": {"$ref": "#/components/schemas/AuthZBlock_DatasetContext_"}}, "required": ["_id", "type", "entityType", "project", "createdAt", "updatedBy", "name", "size", "authz"], "type": "object", "additionalProperties": true}, "PartialFeatureSet": {"properties": {"_id": {"type": "string"}, "type": {"type": "string"}, "entityType": {"$ref": "#/components/schemas/FeatureSetEntityType"}, "project": {"type": "string"}, "org": {"type": "string"}, "modelId": {"type": "string"}, "creator": {"type": "string"}, "createdAt": {"type": "string", "format": "date-time"}, "updatedAt": {"type": "string", "format": "date-time"}, "updatedBy": {"type": "string"}, "name": {"type": "string"}, "size": {"type": "number", "format": "double"}, "authz": {"$ref": "#/components/schemas/AuthZBlock_DatasetContext_"}}, "type": "object", "additionalProperties": true}, "APIFeatureVector": {"properties": {"id": {"type": "string"}, "url": {"type": "string"}, "entityId": {"type": "string"}, "org": {"type": "string"}, "project": {"type": "string"}, "creator": {"type": "string"}, "createdAt": {"type": "string", "format": "date-time"}, "value": {"items": {"type": "number", "format": "double"}, "type": "array", "description": "value - actual vector - immutable"}, "featureSetId": {"type": "string", "description": "featureSetId - ref to a featureSet this vector is a part of"}, "datasetId": {"type": "string", "description": "datasetId - ref to a featureSet this vector is a part of"}, "version": {"type": "string", "description": "version - version of the feature set generator"}, "parentId": {"type": "string", "description": "parentId - used when FeatureVector is a subFeature"}, "authz": {"$ref": "#/components/schemas/AuthZBlock_DatasetContext_"}}, "required": ["id", "url", "entityId", "project", "creator", "createdAt", "value", "featureSetId", "datasetId", "version", "authz"], "type": "object", "additionalProperties": true}, "FeatureVector": {"properties": {"_id": {"type": "string"}, "entityId": {"type": "string"}, "createdAt": {"type": "string", "format": "date-time"}, "project": {"type": "string"}, "org": {"type": "string"}, "creator": {"type": "string"}, "authz": {"$ref": "#/components/schemas/AuthZBlock_DatasetContext_"}, "value_blob": {"type": "string", "format": "byte", "description": "value_blob\n\nvector as saved to the db\nwill not be fetched from the database\nnot readable or usable"}, "value": {"items": {"type": "number", "format": "double"}, "type": "array", "description": "value - actual readable vector"}, "featureSetId": {"type": "string", "description": "featureSetId - ref to a featureSet this vector is a part of"}, "datasetId": {"type": "string", "description": "datasetId - ref to a dataset this vector is a part of"}, "version": {"type": "string", "description": "version - version of the feature set generator"}, "parentId": {"type": "string", "description": "parentId - used when FeatureVector is a subFeature"}}, "required": ["_id", "entityId", "createdAt", "project", "creator", "authz", "value", "featureSetId", "datasetId", "version"], "type": "object", "additionalProperties": true}, "CursorPage_APIFeatureVector_": {"properties": {"totalItemsCount": {"type": "number", "format": "double"}, "items": {"items": {"$ref": "#/components/schemas/APIFeatureVector"}, "type": "array"}, "totalPagesCount": {"type": "number", "format": "double"}, "hasNextPage": {"type": "boolean"}}, "required": ["totalItemsCount", "items", "totalPagesCount", "hasNextPage"], "type": "object", "additionalProperties": true}, "AggregateProjectVectorsCountResult": {"items": {"properties": {"count": {"type": "number", "format": "double"}, "featureSetId": {"type": "string"}, "datasetId": {"type": "string"}}, "required": ["count", "featureSetId", "datasetId"], "type": "object"}, "type": "array"}, "AggregateProjectVectorsCountInput": {"properties": {"projectId": {"type": "string"}, "datasetIds": {"items": {"type": "string"}, "type": "array"}, "vectorsQuery": {"$ref": "#/components/schemas/DQLResourceQuery"}}, "required": ["projectId"], "type": "object", "additionalProperties": true}, "ProjectStorageRequest": {"properties": {"projectId": {"type": "string"}, "external": {"type": "boolean"}}, "required": ["projectId", "external"], "type": "object", "additionalProperties": true}, "EditItemsStressInput": {"properties": {"datasetName": {"type": "string", "description": "name of the dataset to be used"}, "projectId": {"type": "string", "description": "projectId to be used for testing"}, "itemsPerClient": {"type": "number", "format": "double", "description": "number of items each client will edit", "default": "1000, in composeStressTestEditItems()"}, "clients": {"type": "number", "format": "double", "description": "number of concurrent clients", "default": "1, in in composeStressTestEditItems()"}}, "required": ["datasetName", "projectId", "itemsPerClient", "clients"], "type": "object", "description": "Type for composing EditItem object"}, "IUploadItemsBenchmarkInput": {"properties": {"indexDrivers": {"items": {"$ref": "#/components/schemas/IndexDriver"}, "type": "array"}, "itemsCount": {"type": "number", "format": "double"}}, "required": ["indexDrivers", "itemsCount"], "type": "object", "additionalProperties": true}, "BenchmarkIngestionStrategyType": {"enum": ["sequentially", "batch"], "type": "string"}, "GeneratedDatasetConfig": {"properties": {"seed": {"$ref": "#/components/schemas/DatasetItem"}, "options": {"$ref": "#/components/schemas/GenerateDatasetOptions"}}, "required": ["seed", "options"], "type": "object", "additionalProperties": true}, "AddItemsOperationInput": {"properties": {"consumerOptions": {"$ref": "#/components/schemas/Pick_StartInput_any_.maxBytes-or-maxMessages_"}, "generatedDatasetConfig": {"$ref": "#/components/schemas/GeneratedDatasetConfig"}, "consumerAmount": {"type": "number", "format": "double"}, "readAnnotations": {"type": "boolean"}, "projectId": {"type": "string"}, "datasetId": {"type": "string"}, "strategy": {"$ref": "#/components/schemas/BenchmarkIngestionStrategyType"}, "concurrency": {"type": "number", "format": "double"}, "generatedDatasetType": {"$ref": "#/components/schemas/GeneratedDatasetTypes"}}, "required": ["generatedDatasetConfig", "strategy"], "type": "object"}, "AddAnnotationsOperationInput": {"properties": {"consumerOptions": {"$ref": "#/components/schemas/Pick_StartInput_any_.maxBytes-or-maxMessages_"}, "strategy": {"$ref": "#/components/schemas/BenchmarkIngestionStrategyType"}, "concurrency": {"type": "number", "format": "double"}, "generatedDatasetConfig": {"$ref": "#/components/schemas/GeneratedDatasetConfig"}, "consumerAmount": {"type": "number", "format": "double"}, "datasetId": {"type": "string"}, "generatedDatasetType": {"$ref": "#/components/schemas/GeneratedDatasetTypes"}}, "required": ["generatedDatasetConfig", "datasetId"], "type": "object"}, "UploadItemsBenchmarkCommandV2Input": {"properties": {"indexDriver": {"$ref": "#/components/schemas/IndexDriver"}, "itemsCount": {"type": "number", "format": "double"}, "batchSize": {"type": "number", "format": "double"}, "concurrency": {"type": "number", "format": "double"}, "gateUrl": {"type": "string"}, "uploadFileConfig": {"properties": {"filePath": {"type": "string"}}, "required": ["filePath"], "type": "object"}}, "required": ["indexDriver", "itemsCount", "batchSize", "concurrency"], "type": "object", "additionalProperties": true}, "BenchmarkOptions": {"properties": {"exportType": {"type": "string", "enum": ["json", "lance"]}, "bulkSize": {"type": "number", "format": "double"}, "childCommands": {"type": "number", "format": "double"}}, "required": ["exportType", "bulkSize", "childCommands"], "type": "object", "additionalProperties": true}, "SetTaskRefsBenchmarkInput": {"properties": {"datasetId": {"type": "string"}, "operation": {"type": "string", "enum": ["create", "delete"]}, "itemsQuery": {"$ref": "#/components/schemas/Dictionary"}, "taskIds": {"items": {"type": "string"}, "type": "array"}, "assignmentIds": {"items": {"type": "string"}, "type": "array"}, "concurrency": {"type": "number", "format": "double"}, "itemsBatchSize": {"type": "number", "format": "double"}, "updateItemsBatchSize": {"type": "number", "format": "double"}}, "required": ["datasetId"], "type": "object", "additionalProperties": true}, "SetTaskRefsBenchmarkOperationInput": {"$ref": "#/components/schemas/SetTaskRefsBenchmarkInput"}, "SetTaskRefsStatusBenchmarkInput": {"properties": {"datasetId": {"type": "string"}, "itemsQuery": {"$ref": "#/components/schemas/Dictionary"}, "status": {"$ref": "#/components/schemas/TaskItemStatus"}, "previousStatus": {"type": "string"}, "operation": {"$ref": "#/components/schemas/ItemRefOperation"}, "concurrency": {"type": "number", "format": "double"}, "itemsBatchSize": {"type": "number", "format": "double"}}, "required": ["datasetId", "status", "operation"], "type": "object", "additionalProperties": true}, "SetTaskRefsStatusBenchmarkOperationInput": {"$ref": "#/components/schemas/SetTaskRefsStatusBenchmarkInput"}, "BulkCreateAnnotationsBenchmarkInput": {"properties": {"datasetId": {"type": "string"}, "concurrency": {"type": "number", "format": "double"}, "childCount": {"type": "number", "format": "double"}, "annotationsPerItem": {"type": "number", "format": "double"}}, "required": ["datasetId"], "type": "object", "additionalProperties": true}, "BulkCreateAnnotationsBenchmarkOperationInput": {"$ref": "#/components/schemas/BulkCreateAnnotationsBenchmarkInput"}, "DriverReadBenchmarkOperationInput": {"properties": {"scenarioDetails": {"type": "string", "enum": ["smallFile", "mediumFile", "largeFile"], "nullable": false}, "addingItemsInParallel": {"type": "number", "format": "double"}, "itemsNumber": {"type": "number", "format": "double"}, "concurrency": {"type": "number", "format": "double"}, "consumersAmount": {"type": "number", "format": "double"}, "waitUntilCompletion": {"type": "boolean"}, "projectId": {"type": "string"}, "datasetWithItemsToStreamId": {"type": "string"}, "driverId": {"anyOf": [{"type": "string"}, {"$ref": "#/components/schemas/ObjectId"}]}}, "required": ["scenarioDetails", "projectId", "datasetWithItemsToStreamId", "driverId"], "type": "object"}, "DriverWriteBenchmarkOperationInput": {"properties": {"scenarioDetails": {"type": "string", "enum": ["smallFile", "mediumFile", "largeFile"], "nullable": false}, "projectId": {"type": "string"}, "itemsNumber": {"type": "number", "format": "double"}, "concurrency": {"type": "number", "format": "double"}, "producersAmount": {"type": "number", "format": "double"}, "waitUntilCompletion": {"type": "boolean"}, "datasetWithItemsToStreamId": {"type": "string"}, "driverId": {"anyOf": [{"type": "string"}, {"$ref": "#/components/schemas/ObjectId"}]}}, "required": ["scenarioDetails", "datasetWithItemsToStreamId", "driverId"], "type": "object"}, "APIOntologyV2": {"properties": {"id": {"type": "string"}, "url": {"type": "string"}, "createdAt": {"type": "string", "format": "date-time", "nullable": true}, "updatedAt": {"type": "string", "format": "date-time", "nullable": true}, "updatedBy": {"type": "string", "nullable": true}, "creator": {"type": "string"}, "metadata": {"$ref": "#/components/schemas/APIMetadata"}, "v2": {"type": "boolean", "enum": [true], "nullable": false}}, "required": ["id", "url", "creator", "metadata", "v2"], "type": "object", "additionalProperties": true}, "APILabelTree": {"properties": {"children": {"items": {"$ref": "#/components/schemas/APILabelTree"}, "type": "array", "nullable": true}, "value": {"$ref": "#/components/schemas/APILabel"}}, "required": ["value"], "type": "object", "additionalProperties": true}, "APILabelDisplayImage": {"properties": {"itemId": {"type": "string"}, "datasetId": {"type": "string"}}, "required": ["itemId", "datasetId"], "type": "object", "additionalProperties": true}, "APILabelDisplayData": {"properties": {"displayImage": {"allOf": [{"$ref": "#/components/schemas/APILabelDisplayImage"}], "nullable": true}}, "type": "object", "additionalProperties": true}, "APILabel": {"properties": {"tag": {"type": "string"}, "displayLabel": {"type": "string"}, "color": {"type": "string"}, "attributes": {"items": {"type": "string"}, "type": "array", "nullable": true}, "displayData": {"allOf": [{"$ref": "#/components/schemas/APILabelDisplayData"}], "nullable": true}}, "required": ["tag", "displayLabel", "color"], "type": "object", "additionalProperties": true}, "APIOntology": {"properties": {"id": {"type": "string"}, "url": {"type": "string"}, "createdAt": {"type": "string", "format": "date-time", "nullable": true}, "updatedAt": {"type": "string", "format": "date-time", "nullable": true}, "updatedBy": {"type": "string", "nullable": true}, "creator": {"type": "string"}, "title": {"type": "string"}, "roots": {"items": {"$ref": "#/components/schemas/APILabelTree"}, "type": "array"}, "metadata": {"$ref": "#/components/schemas/APIMetadata"}, "attributes": {"items": {"type": "string"}, "type": "array", "nullable": true}, "errors": {"items": {"type": "string"}, "type": "array", "nullable": true}}, "required": ["id", "url", "creator", "title", "roots", "metadata"], "type": "object", "additionalProperties": true}, "CreateOntologyPayloadV2": {"properties": {"roots": {"items": {"type": "string"}, "type": "array", "nullable": true}, "attributes": {"items": {"type": "string"}, "type": "array", "nullable": true}, "structureIds": {"items": {"type": "string"}, "type": "array", "nullable": true}, "projectIds": {"items": {"type": "string"}, "type": "array"}, "system": {"type": "boolean", "nullable": true}, "v2": {"type": "boolean", "nullable": true}}, "required": ["projectIds"], "type": "object", "additionalProperties": true}, "LabelDisplayImage": {"properties": {"itemId": {"type": "string"}, "datasetId": {"type": "string"}}, "required": ["itemId", "datasetId"], "type": "object", "additionalProperties": true}, "LabelDisplayData": {"properties": {"displayImage": {"allOf": [{"$ref": "#/components/schemas/LabelDisplayImage"}], "nullable": true}}, "type": "object", "additionalProperties": true}, "CreateLabelPayloadV1": {"properties": {"tag": {"type": "string"}, "displayLabel": {"type": "string", "nullable": true}, "color": {"type": "string", "nullable": true}, "attributes": {"items": {"type": "string"}, "type": "array", "nullable": true}, "displayData": {"allOf": [{"$ref": "#/components/schemas/LabelDisplayData"}], "nullable": true}}, "required": ["tag"], "type": "object", "additionalProperties": true}, "CreateLabelPayloadTreeV1": {"properties": {"value": {"$ref": "#/components/schemas/CreateLabelPayloadV1"}, "children": {"items": {"$ref": "#/components/schemas/CreateLabelPayloadTreeV1"}, "type": "array"}}, "required": ["value", "children"], "type": "object", "additionalProperties": true}, "CreateOntologyPayload": {"properties": {"roots": {"items": {"$ref": "#/components/schemas/CreateLabelPayloadTreeV1"}, "type": "array", "nullable": true}, "title": {"type": "string", "nullable": true}, "projectIds": {"items": {"type": "string"}, "type": "array", "nullable": true}, "system": {"type": "boolean", "nullable": true}, "attributes": {"items": {"type": "string"}, "type": "array", "nullable": true}}, "type": "object", "additionalProperties": true}, "APIOntologyConfigurationV2": {"properties": {"creator": {"type": "string", "nullable": true}, "metadata": {"allOf": [{"$ref": "#/components/schemas/APIMetadata"}], "nullable": true}}, "type": "object", "additionalProperties": true}, "CreateLabelPayload": {"properties": {"tag": {"type": "string"}, "displayLabel": {"type": "string", "nullable": true}, "color": {"type": "string", "nullable": true}, "attributes": {"items": {"type": "string"}, "type": "array", "nullable": true}}, "required": ["tag"], "type": "object", "additionalProperties": true}, "AddLabelsNodePayload": {"properties": {"labelsNode": {"items": {"$ref": "#/components/schemas/CreateLabelPayload"}, "type": "array"}}, "required": ["labelsNode"], "type": "object", "additionalProperties": true}, "UpdateLabelsNodePayload": {"properties": {"labelsNode": {"items": {"$ref": "#/components/schemas/CreateLabelPayload"}, "type": "array"}, "upsert": {"type": "boolean", "nullable": true}}, "required": ["labelsNode"], "type": "object", "additionalProperties": true}, "AttributeType": {"enum": ["options", "boolean", "range", "freeText", "number"], "type": "string"}, "AttributeCreationPayload": {"properties": {"title": {"type": "string"}, "key": {"type": "string"}, "scope": {"items": {"type": "string"}, "type": "array", "nullable": true}, "optional": {"type": "boolean", "nullable": true}, "multi": {"type": "boolean", "nullable": true}, "type": {"$ref": "#/components/schemas/AttributeType"}, "values": {"items": {"type": "string"}, "type": "array", "nullable": true}, "range": {"nullable": true}}, "required": ["title", "key", "type"], "type": "object", "additionalProperties": true}, "UpsertRequestPayload_AttributeCreationPayload_": {"properties": {"items": {"items": {"$ref": "#/components/schemas/AttributeCreationPayload"}, "type": "array"}, "upsert": {"type": "boolean", "nullable": true}}, "required": ["items"], "type": "object", "additionalProperties": true}, "APIOntologyCursor": {"properties": {"totalItemsCount": {"type": "number", "format": "double"}, "items": {"items": {"anyOf": [{"$ref": "#/components/schemas/APIOntologyV2"}, {"$ref": "#/components/schemas/APIOntology"}]}, "type": "array"}, "totalPagesCount": {"type": "number", "format": "double"}, "hasNextPage": {"type": "boolean"}}, "required": ["totalItemsCount", "items", "totalPagesCount", "hasNextPage"], "type": "object", "additionalProperties": true}, "APILabelScopeV2": {"properties": {"subtrees": {"items": {"type": "string"}, "type": "array"}, "labelIds": {"items": {"type": "string"}, "type": "array"}}, "required": ["subtrees", "labelIds"], "type": "object", "additionalProperties": true}, "APIToolOptionsV2": {"properties": {"labelScope": {"$ref": "#/components/schemas/APILabelScopeV2"}, "options": {"allOf": [{"$ref": "#/components/schemas/Dictionary"}], "nullable": true}}, "required": ["labelScope"], "type": "object", "additionalProperties": true}, "RecipeType": {"properties": {"dataType": {"type": "string"}, "mlGroup": {"type": "string"}, "mlTask": {"items": {"type": "string"}, "type": "array"}}, "required": ["dataType", "mlGroup", "mlTask"], "type": "object", "additionalProperties": true}, "APIRecipeV2": {"properties": {"id": {"type": "string"}, "url": {"type": "string"}, "createdAt": {"type": "string", "format": "date-time", "nullable": true}, "updatedAt": {"type": "string", "format": "date-time", "nullable": true}, "updatedBy": {"type": "string", "nullable": true}, "creator": {"type": "string"}, "title": {"type": "string"}, "projectIds": {"items": {"type": "string"}, "type": "array"}, "ontology": {"properties": {"structureIds": {"items": {"type": "string"}, "type": "array"}, "attributes": {"items": {"type": "string"}, "type": "array"}, "labelScope": {"allOf": [{"$ref": "#/components/schemas/APILabelScopeV2"}], "nullable": true}, "ontologyId": {"type": "string"}}, "required": ["structureIds", "attributes", "ontologyId"], "type": "object"}, "labelScript": {"type": "string"}, "toolsSettings": {"properties": {}, "additionalProperties": {"$ref": "#/components/schemas/APIToolOptionsV2"}, "type": "object"}, "uiSettings": {"$ref": "#/components/schemas/Dictionary"}, "metadata": {"$ref": "#/components/schemas/APIMetadata"}, "v2": {"type": "boolean", "enum": [true], "nullable": false}, "type": {"allOf": [{"$ref": "#/components/schemas/RecipeType"}], "nullable": true}}, "required": ["id", "url", "creator", "title", "projectIds", "ontology", "labelScript", "toolsSettings", "uiSettings", "metadata", "v2"], "type": "object", "additionalProperties": true}, "APIRecipe": {"properties": {}, "type": "object", "additionalProperties": true}, "ObjectID": {"type": "string", "description": "A class representation of the BSON ObjectId type."}, "LabelScopeV2": {"properties": {"subtrees": {"items": {"$ref": "#/components/schemas/ObjectID"}, "type": "array"}, "labelIds": {"items": {"$ref": "#/components/schemas/ObjectID"}, "type": "array"}}, "required": ["subtrees", "labelIds"], "type": "object", "additionalProperties": true}, "Pick_RecipeV2.title-or-projectIds-or-ontology_": {"properties": {"title": {"type": "string"}, "projectIds": {"items": {"type": "string"}, "type": "array"}, "ontology": {"properties": {"structureIds": {"items": {"$ref": "#/components/schemas/ObjectID"}, "type": "array"}, "attributes": {"items": {"$ref": "#/components/schemas/ObjectID"}, "type": "array"}, "labelScope": {"allOf": [{"$ref": "#/components/schemas/LabelScopeV2"}], "nullable": true}, "ontologyId": {"$ref": "#/components/schemas/ObjectID"}}, "required": ["structureIds", "attributes", "ontologyId"], "type": "object"}}, "required": ["title", "projectIds", "ontology"], "type": "object", "description": "From T, pick a set of properties whose keys are in the union K"}, "ToolOptions": {"properties": {"labelScope": {"$ref": "#/components/schemas/LabelScopeV2"}, "options": {"allOf": [{"$ref": "#/components/schemas/Dictionary"}], "nullable": true}}, "required": ["labelScope"], "type": "object", "additionalProperties": true}, "Metadata": {"properties": {"system": {"allOf": [{"$ref": "#/components/schemas/Dictionary"}], "nullable": true}}, "type": "object", "additionalProperties": true}, "RecipeV2Context": {"properties": {"org": {"type": "string", "nullable": true}, "project": {"type": "string", "nullable": true}, "creator": {"type": "string"}, "createdAt": {"type": "string", "format": "date-time"}, "updatedAt": {"type": "string", "format": "date-time"}, "ontology": {"type": "string"}}, "required": ["creator", "createdAt", "updatedAt", "ontology"], "type": "object", "additionalProperties": true}, "AuthZBlock_RecipeV2Context_": {"properties": {"scope": {"type": "string", "nullable": true}, "context": {"allOf": [{"$ref": "#/components/schemas/Context"}, {"$ref": "#/components/schemas/RecipeV2Context"}]}, "access": {"items": {}, "type": "array", "nullable": true}}, "required": ["context"], "type": "object", "additionalProperties": true}, "Partial_RecipeV2_": {"properties": {"_id": {"allOf": [{"$ref": "#/components/schemas/ObjectID"}], "nullable": true}, "creator": {"type": "string", "nullable": true}, "title": {"type": "string", "nullable": true}, "projectIds": {"items": {"type": "string"}, "type": "array", "nullable": true}, "ontology": {"properties": {"structureIds": {"items": {"$ref": "#/components/schemas/ObjectID"}, "type": "array"}, "attributes": {"items": {"$ref": "#/components/schemas/ObjectID"}, "type": "array"}, "labelScope": {"allOf": [{"$ref": "#/components/schemas/LabelScopeV2"}], "nullable": true}, "ontologyId": {"$ref": "#/components/schemas/ObjectID"}}, "required": ["structureIds", "attributes", "ontologyId"], "type": "object", "nullable": true}, "toolsSettings": {"properties": {}, "additionalProperties": {"$ref": "#/components/schemas/ToolOptions"}, "type": "object", "nullable": true}, "uiSettings": {"allOf": [{"$ref": "#/components/schemas/Dictionary"}], "nullable": true}, "metadata": {"allOf": [{"$ref": "#/components/schemas/Metadata"}], "nullable": true}, "authz": {"allOf": [{"$ref": "#/components/schemas/AuthZBlock_RecipeV2Context_"}], "nullable": true}, "createdAt": {"type": "string", "format": "date-time", "nullable": true}, "updatedAt": {"type": "string", "format": "date-time", "nullable": true}, "updatedBy": {"type": "string", "nullable": true}, "v2": {"type": "boolean", "enum": [true], "nullable": true}, "type": {"allOf": [{"$ref": "#/components/schemas/RecipeType"}], "nullable": true}}, "type": "object", "description": "Make all properties in T optional"}, "RecipeV2Input": {"allOf": [{"$ref": "#/components/schemas/Pick_RecipeV2.title-or-projectIds-or-ontology_"}, {"$ref": "#/components/schemas/Partial_RecipeV2_"}]}, "Pick_Recipe.title-or-projectIds-or-ontologyIds_": {"properties": {"title": {"type": "string"}, "projectIds": {"items": {"type": "string"}, "type": "array"}, "ontologyIds": {"items": {"$ref": "#/components/schemas/ObjectID"}, "type": "array"}}, "required": ["title", "projectIds", "ontologyIds"], "type": "object", "description": "From T, pick a set of properties whose keys are in the union K"}, "InstructionAction": {"enum": ["annotate", "remove", "change"], "type": "string"}, "InstructionScope": {"enum": ["image", "detail"], "type": "string"}, "ToolInstruction": {"properties": {"scope": {"$ref": "#/components/schemas/InstructionScope"}, "action": {"$ref": "#/components/schemas/InstructionAction"}, "tool": {"$ref": "#/components/schemas/AnnotationType"}, "options": {"allOf": [{"properties": {"minSize": {"type": "number", "format": "double", "nullable": true}}, "type": "object"}, {"$ref": "#/components/schemas/Dictionary"}]}, "tags": {"items": {"type": "string"}, "type": "array"}}, "required": ["scope", "action", "tool", "options", "tags"], "type": "object", "additionalProperties": true}, "GoodExample": {"properties": {"itemId": {"type": "string"}, "comments": {"type": "string", "nullable": true}, "instructions": {"items": {"$ref": "#/components/schemas/ToolInstruction"}, "type": "array"}}, "required": ["itemId", "instructions"], "type": "object", "additionalProperties": true}, "Example": {"properties": {"itemId": {"type": "string"}, "comments": {"type": "string", "nullable": true}}, "required": ["itemId"], "type": "object", "additionalProperties": true}, "BadExample": {"$ref": "#/components/schemas/Example"}, "CustomAction": {"properties": {"targets": {"items": {"properties": {"labelId": {"type": "string"}, "ontologyId": {"type": "string"}}, "required": ["labelId", "ontologyId"], "type": "object"}, "type": "array"}, "controls": {"type": "string", "enum": ["button", "radio", "checkbox"]}}, "required": ["targets", "controls"], "type": "object", "additionalProperties": true}, "RecipeContext": {"properties": {"org": {"type": "string", "nullable": true}, "project": {"type": "string", "nullable": true}, "creator": {"type": "string"}, "createdAt": {"type": "string", "format": "date-time"}, "updatedAt": {"type": "string", "format": "date-time"}, "ontology": {"type": "string"}}, "required": ["creator", "createdAt", "updatedAt", "ontology"], "type": "object", "additionalProperties": true}, "AuthZBlock_RecipeContext_": {"properties": {"scope": {"type": "string", "nullable": true}, "context": {"allOf": [{"$ref": "#/components/schemas/Context"}, {"$ref": "#/components/schemas/RecipeContext"}]}, "access": {"items": {}, "type": "array", "nullable": true}}, "required": ["context"], "type": "object", "additionalProperties": true}, "Partial_Recipe_": {"properties": {"_id": {"allOf": [{"$ref": "#/components/schemas/ObjectID"}], "nullable": true}, "creator": {"type": "string", "nullable": true}, "title": {"type": "string", "nullable": true}, "projectIds": {"items": {"type": "string"}, "type": "array", "nullable": true}, "description": {"type": "string", "nullable": true}, "ontologyIds": {"items": {"$ref": "#/components/schemas/ObjectID"}, "type": "array", "nullable": true}, "instructions": {"items": {"$ref": "#/components/schemas/ToolInstruction"}, "type": "array", "nullable": true}, "examples": {"properties": {"bad": {"items": {"$ref": "#/components/schemas/BadExample"}, "type": "array"}, "good": {"items": {"$ref": "#/components/schemas/GoodExample"}, "type": "array"}}, "required": ["bad", "good"], "type": "object", "nullable": true}, "customActions": {"items": {"$ref": "#/components/schemas/CustomAction"}, "type": "array", "nullable": true}, "uiSettings": {"allOf": [{"$ref": "#/components/schemas/Dictionary"}], "nullable": true}, "metadata": {"allOf": [{"$ref": "#/components/schemas/Metadata"}], "nullable": true}, "authz": {"allOf": [{"$ref": "#/components/schemas/AuthZBlock_RecipeContext_"}], "nullable": true}, "deprecatedBy": {"allOf": [{"$ref": "#/components/schemas/ObjectID"}], "nullable": true}, "createdAt": {"type": "string", "format": "date-time", "nullable": true}, "updatedAt": {"type": "string", "format": "date-time", "nullable": true}, "updatedBy": {"type": "string", "nullable": true}, "type": {"allOf": [{"$ref": "#/components/schemas/RecipeType"}], "nullable": true}}, "type": "object", "description": "Make all properties in T optional"}, "RecipeInput": {"allOf": [{"$ref": "#/components/schemas/Pick_Recipe.title-or-projectIds-or-ontologyIds_"}, {"$ref": "#/components/schemas/Partial_Recipe_"}]}, "IClientLabel": {"properties": {"tag": {"type": "string"}, "displayLabel": {"type": "string"}, "color": {"type": "string"}, "attributes": {"items": {"type": "string"}, "type": "array", "nullable": true}}, "required": ["tag", "displayLabel", "color"], "type": "object", "additionalProperties": true}, "LabelTree": {"properties": {"value": {"$ref": "#/components/schemas/IClientLabel"}, "children": {"items": {"$ref": "#/components/schemas/LabelTree"}, "type": "array"}}, "required": ["value", "children"], "type": "object", "additionalProperties": true}, "CloneRecipePayload": {"properties": {"shallow": {"type": "boolean", "nullable": true}, "type": {"allOf": [{"$ref": "#/components/schemas/RecipeType"}], "nullable": true}, "roots": {"items": {"$ref": "#/components/schemas/LabelTree"}, "type": "array", "nullable": true}, "defaultApp": {"type": "string", "nullable": true}}, "type": "object", "additionalProperties": true}, "PartialRecipePayloadV2": {"properties": {"title": {"type": "string", "nullable": true}, "projectIds": {"items": {"type": "string"}, "type": "array", "nullable": true}, "labelScript": {"type": "string", "nullable": true}, "uiSettings": {"allOf": [{"$ref": "#/components/schemas/Dictionary"}], "nullable": true}, "metadata": {"allOf": [{"$ref": "#/components/schemas/APIMetadata"}], "nullable": true}, "type": {"allOf": [{"$ref": "#/components/schemas/RecipeType"}], "nullable": true}}, "type": "object", "additionalProperties": true}, "APIInstruction": {"properties": {"scope": {"$ref": "#/components/schemas/InstructionScope"}, "action": {"$ref": "#/components/schemas/InstructionAction"}, "tool": {"$ref": "#/components/schemas/AnnotationType"}, "options": {}, "tags": {"items": {"type": "string"}, "type": "array"}}, "required": ["scope", "action", "tool", "options", "tags"], "type": "object", "additionalProperties": true}, "APIGoodExample": {"properties": {"itemId": {"type": "string"}, "comments": {"type": "string", "nullable": true}, "instructions": {"items": {"$ref": "#/components/schemas/APIInstruction"}, "type": "array"}}, "required": ["itemId", "instructions"], "type": "object", "additionalProperties": true}, "APIBadExample": {"properties": {"itemId": {"type": "string"}, "comments": {"type": "string", "nullable": true}}, "required": ["itemId"], "type": "object", "additionalProperties": true}, "APICustomAction": {"properties": {"targets": {"items": {"properties": {"labelId": {"type": "string"}, "ontologyId": {"type": "string"}}, "required": ["labelId", "ontologyId"], "type": "object"}, "type": "array"}, "controls": {"type": "string", "enum": ["button", "radio", "checkbox"]}}, "required": ["targets", "controls"], "type": "object", "additionalProperties": true}, "PartialRecipePayload": {"properties": {"title": {"type": "string", "nullable": true}, "projectIds": {"items": {"type": "string"}, "type": "array", "nullable": true}, "description": {"type": "string", "nullable": true}, "ontologyIds": {"items": {"type": "string"}, "type": "array", "nullable": true}, "instructions": {"items": {"$ref": "#/components/schemas/APIInstruction"}, "type": "array", "nullable": true}, "examples": {"properties": {"bad": {"items": {"$ref": "#/components/schemas/APIBadExample"}, "type": "array"}, "good": {"items": {"$ref": "#/components/schemas/APIGoodExample"}, "type": "array"}}, "required": ["bad", "good"], "type": "object", "nullable": true}, "customActions": {"items": {"$ref": "#/components/schemas/APICustomAction"}, "type": "array", "nullable": true}, "uiSettings": {"allOf": [{"$ref": "#/components/schemas/Dictionary"}], "nullable": true}, "metadata": {"allOf": [{"$ref": "#/components/schemas/APIMetadata"}], "nullable": true}, "type": {"allOf": [{"$ref": "#/components/schemas/RecipeType"}], "nullable": true}}, "type": "object", "additionalProperties": true}, "CursorPage_APIRecipeV2-or-APIRecipe_": {"properties": {"totalItemsCount": {"type": "number", "format": "double"}, "items": {"items": {"anyOf": [{"$ref": "#/components/schemas/APIRecipeV2"}, {"$ref": "#/components/schemas/APIRecipe"}]}, "type": "array"}, "totalPagesCount": {"type": "number", "format": "double"}, "hasNextPage": {"type": "boolean"}}, "required": ["totalItemsCount", "items", "totalPagesCount", "hasNextPage"], "type": "object", "additionalProperties": true}, "AssignmentStatus": {"enum": ["todo", "in progress", "done", "completed with issues"], "type": "string"}, "ItemStatus": {"properties": {"completed": {"type": "number", "format": "double"}, "remaining": {"type": "number", "format": "double"}, "actions": {"properties": {}, "additionalProperties": {"type": "number", "format": "double"}, "type": "object", "nullable": true}}, "required": ["completed", "remaining"], "type": "object", "additionalProperties": true}, "APIAssignment": {"properties": {"id": {"type": "string"}, "url": {"type": "string"}, "createdAt": {"type": "string", "format": "date-time", "nullable": true}, "updatedAt": {"type": "string", "format": "date-time", "nullable": true}, "updatedBy": {"type": "string", "nullable": true}, "name": {"type": "string"}, "annotator": {"type": "string"}, "status": {"$ref": "#/components/schemas/AssignmentStatus"}, "projectId": {"type": "string"}, "metadata": {"$ref": "#/components/schemas/APIMetadata"}, "totalItems": {"type": "number", "format": "double"}, "itemStatus": {"$ref": "#/components/schemas/ItemStatus"}, "taskType": {"type": "string"}, "progress": {"type": "number", "format": "double"}, "forReview": {"type": "number", "format": "double"}, "issues": {"type": "number", "format": "double"}, "inRedistributeProcess": {"type": "string", "format": "date-time", "nullable": true}, "removeItemsProcess": {"properties": {"count": {"type": "number", "format": "double"}, "date": {"type": "string", "format": "date-time"}}, "required": ["count", "date"], "type": "object", "nullable": true}, "redistributeProcess": {"properties": {"count": {"type": "number", "format": "double"}, "date": {"type": "string", "format": "date-time"}}, "required": ["count", "date"], "type": "object", "nullable": true}, "error": {"type": "string", "nullable": true}, "priority": {"type": "number", "format": "double", "nullable": true}}, "required": ["id", "url", "name", "annotator", "status", "projectId", "metadata", "totalItems", "itemStatus", "taskType", "progress", "forReview", "issues"], "type": "object", "additionalProperties": true}, "PartialAssignmentPayload": {"properties": {"name": {"type": "string", "nullable": true}, "metadata": {"allOf": [{"$ref": "#/components/schemas/Dictionary"}], "nullable": true}}, "type": "object", "additionalProperties": true}, "APIAssignmentCursor": {"properties": {"totalItemsCount": {"type": "number", "format": "double"}, "items": {"items": {"$ref": "#/components/schemas/APIAssignment"}, "type": "array"}, "totalPagesCount": {"type": "number", "format": "double"}, "hasNextPage": {"type": "boolean"}}, "required": ["totalItemsCount", "items", "totalPagesCount", "hasNextPage"], "type": "object", "additionalProperties": true}, "ReassignAssignmentPayload": {"properties": {"annotator": {"type": "string"}, "asynced": {"type": "boolean", "nullable": true}}, "required": ["annotator"], "type": "object", "additionalProperties": true}, "AssignmentWorkload": {"properties": {"assigneeId": {"type": "string"}, "load": {"type": "number", "format": "double"}}, "required": ["assigneeId", "load"], "type": "object", "additionalProperties": true}, "RedistributeAssignmentPayload": {"properties": {"workload": {"items": {"$ref": "#/components/schemas/AssignmentWorkload"}, "type": "array"}, "selectNotAnnotatedOnly": {"type": "boolean", "nullable": true}, "asynced": {"type": "boolean", "nullable": true}, "isSudoCtx": {"type": "boolean", "nullable": true}, "allowToSkipAssignments": {"type": "boolean", "nullable": true}, "query": {"type": "string", "nullable": true}}, "required": ["workload"], "type": "object", "additionalProperties": true}, "BatchAssignmentPayload": {"properties": {"assignmentId": {"type": "string"}, "asynced": {"type": "boolean", "nullable": true}}, "required": ["assignmentId"], "type": "object", "additionalProperties": true}, "AssignmentStatusPayload": {"properties": {"operation": {"$ref": "#/components/schemas/ItemRefOperation"}, "status": {"type": "string", "nullable": true}, "returnLastStatus": {"type": "boolean", "nullable": true}, "asynced": {"type": "boolean", "nullable": true}}, "required": ["operation"], "type": "object", "additionalProperties": true}, "AssignmentMetadata": {"properties": {"system": {"allOf": [{"$ref": "#/components/schemas/Dictionary"}, {"properties": {"itemsAmountGoal": {"type": "number", "format": "double", "nullable": true}, "markForDeletion": {"type": "boolean", "nullable": true}, "archive": {"type": "boolean", "nullable": true}, "active": {"type": "boolean", "nullable": true}, "defaultAssignment": {"type": "boolean", "nullable": true}, "consensusAssignment": {"type": "boolean", "nullable": true}, "queueAssignment": {"type": "boolean", "nullable": true}, "hidden": {"type": "boolean", "nullable": true}, "type": {"type": "string", "enum": ["bucket"], "nullable": true}, "taskId": {"type": "string"}, "dueDate": {"type": "number", "format": "double", "nullable": true}, "datasetId": {"type": "string"}}, "required": ["taskId", "datasetId"], "type": "object"}]}}, "required": ["system"], "type": "object", "additionalProperties": true}, "TaskType": {"enum": ["annotation", "qa", "annotation", "qa"], "type": "string"}, "AssignmentContext": {"properties": {"org": {"type": "string", "nullable": true}, "project": {"type": "string"}, "creator": {"type": "string"}, "createdAt": {"type": "string", "format": "date-time"}, "updatedAt": {"type": "string", "format": "date-time"}, "dataset": {"type": "string"}, "recipe": {"type": "string"}, "task": {"type": "string"}}, "required": ["creator", "createdAt", "updatedAt", "project", "dataset", "recipe", "task"], "type": "object", "additionalProperties": true}, "AuthZBlock_AssignmentContext_": {"properties": {"scope": {"type": "string", "nullable": true}, "context": {"allOf": [{"$ref": "#/components/schemas/Context"}, {"$ref": "#/components/schemas/AssignmentContext"}]}, "access": {"items": {}, "type": "array", "nullable": true}}, "required": ["context"], "type": "object", "additionalProperties": true}, "Partial_Assignment_": {"properties": {"_id": {"allOf": [{"$ref": "#/components/schemas/ObjectID"}], "nullable": true}, "name": {"type": "string", "nullable": true}, "annotator": {"type": "string", "nullable": true}, "projectId": {"type": "string", "nullable": true}, "metadata": {"allOf": [{"$ref": "#/components/schemas/AssignmentMetadata"}], "nullable": true}, "totalItems": {"type": "number", "format": "double", "nullable": true}, "itemStatus": {"allOf": [{"$ref": "#/components/schemas/ItemStatus"}], "nullable": true}, "taskType": {"allOf": [{"$ref": "#/components/schemas/TaskType"}], "nullable": true}, "forReview": {"type": "number", "format": "double", "nullable": true}, "issues": {"type": "number", "format": "double", "nullable": true}, "inRedistributeProcess": {"type": "string", "format": "date-time", "nullable": true}, "redistributeProcess": {"properties": {"count": {"type": "number", "format": "double"}, "date": {"type": "string", "format": "date-time"}}, "required": ["count", "date"], "type": "object", "nullable": true}, "removeItemsProcess": {"properties": {"count": {"type": "number", "format": "double"}, "date": {"type": "string", "format": "date-time"}}, "required": ["count", "date"], "type": "object", "nullable": true}, "error": {"type": "string", "nullable": true}, "authz": {"allOf": [{"$ref": "#/components/schemas/AuthZBlock_AssignmentContext_"}], "nullable": true}, "priority": {"type": "number", "format": "double", "nullable": true}, "createdAt": {"type": "string", "format": "date-time", "nullable": true}, "updatedAt": {"type": "string", "format": "date-time", "nullable": true}, "updatedBy": {"type": "string", "nullable": true}}, "type": "object", "description": "Make all properties in T optional"}, "APILabelV2": {"properties": {"tag": {"type": "string"}, "displayLabel": {"type": "string"}, "color": {"type": "string"}, "attributes": {"items": {"type": "string"}, "type": "array", "nullable": true}, "displayData": {"allOf": [{"$ref": "#/components/schemas/APILabelDisplayData"}], "nullable": true}}, "required": ["tag", "displayLabel", "color"], "type": "object", "additionalProperties": true}, "APILabelTreeNodeV2": {"properties": {"id": {"type": "string"}, "url": {"type": "string"}, "createdAt": {"type": "string", "format": "date-time", "nullable": true}, "updatedAt": {"type": "string", "format": "date-time", "nullable": true}, "updatedBy": {"type": "string", "nullable": true}, "parent": {"type": "string", "nullable": true}, "root": {"type": "string"}, "ontologyId": {"type": "string"}, "path": {"type": "string"}, "value": {"$ref": "#/components/schemas/APILabelV2"}, "hasChildren": {"type": "boolean", "nullable": true}, "depth": {"type": "number", "format": "double"}, "creator": {"type": "string"}}, "required": ["id", "url", "parent", "root", "ontologyId", "path", "value", "depth", "creator"], "type": "object", "additionalProperties": true}, "CursorPage_APILabelTreeNodeV2_": {"properties": {"totalItemsCount": {"type": "number", "format": "double"}, "items": {"items": {"$ref": "#/components/schemas/APILabelTreeNodeV2"}, "type": "array"}, "totalPagesCount": {"type": "number", "format": "double"}, "hasNextPage": {"type": "boolean"}}, "required": ["totalItemsCount", "items", "totalPagesCount", "hasNextPage"], "type": "object", "additionalProperties": true}, "FilterQueryInput": {"properties": {"context": {"properties": {"projects": {"items": {"type": "string"}, "type": "array", "nullable": true}, "datasets": {"items": {"type": "string"}, "type": "array", "nullable": true}, "projectIds": {"items": {"type": "string"}, "type": "array", "nullable": true}}, "type": "object"}, "page": {"type": "number", "format": "double"}, "pageSize": {"type": "number", "format": "double"}, "resource": {"type": "string"}, "filter": {"$ref": "#/components/schemas/Dictionary"}, "join": {"allOf": [{"$ref": "#/components/schemas/Dictionary"}], "nullable": true}, "update": {"allOf": [{"$ref": "#/components/schemas/Dictionary"}], "nullable": true}, "delete": {"type": "boolean", "nullable": true}, "sort": {"allOf": [{"$ref": "#/components/schemas/Dictionary"}], "nullable": true}, "systemSpace": {"type": "boolean", "nullable": true}, "references": {"properties": {"refs": {"items": {"properties": {"id": {"type": "string"}, "type": {"type": "string"}}, "required": ["id", "type"], "type": "object"}, "type": "array"}, "operation": {"type": "string"}}, "required": ["refs", "operation"], "type": "object", "nullable": true}}, "required": ["context", "page", "pageSize", "resource", "filter"], "type": "object", "additionalProperties": true}, "UpdateLabelNodePayload": {"properties": {"id": {"type": "string"}, "tag": {"type": "string", "nullable": true}, "displayLabel": {"type": "string", "nullable": true}, "color": {"type": "string", "nullable": true}, "system": {"type": "boolean", "nullable": true}, "displayData": {"allOf": [{"$ref": "#/components/schemas/LabelDisplayData"}], "nullable": true}}, "required": ["id"], "type": "object", "additionalProperties": true}, "APIAttributeSection": {"properties": {"id": {"type": "string"}, "url": {"type": "string"}, "createdAt": {"type": "string", "format": "date-time", "nullable": true}, "updatedAt": {"type": "string", "format": "date-time", "nullable": true}, "updatedBy": {"type": "string", "nullable": true}, "ontologyId": {"type": "string"}, "scope": {"$ref": "#/components/schemas/APILabelScopeV2"}, "key": {"type": "string"}, "type": {"$ref": "#/components/schemas/AttributeType"}, "values": {"items": {"type": "string"}, "type": "array", "nullable": true}, "range": {"nullable": true}, "creator": {"type": "string"}}, "required": ["id", "url", "ontologyId", "scope", "key", "type", "creator"], "type": "object", "additionalProperties": true}, "CreateAttributePayload": {"properties": {"key": {"type": "string"}, "type": {"type": "string"}, "scope": {"properties": {"labelIds": {"items": {"type": "string"}, "type": "array"}, "subtrees": {"items": {"type": "string"}, "type": "array"}}, "required": ["labelIds", "subtrees"], "type": "object", "nullable": true}, "values": {"items": {"type": "string"}, "type": "array", "nullable": true}, "range": {"nullable": true}}, "required": ["key", "type"], "type": "object", "additionalProperties": true}, "CursorPage_APIAttributeSection_": {"properties": {"totalItemsCount": {"type": "number", "format": "double"}, "items": {"items": {"$ref": "#/components/schemas/APIAttributeSection"}, "type": "array"}, "totalPagesCount": {"type": "number", "format": "double"}, "hasNextPage": {"type": "boolean"}}, "required": ["totalItemsCount", "items", "totalPagesCount", "hasNextPage"], "type": "object", "additionalProperties": true}, "APIUpdateAttributePayload": {"properties": {"key": {"type": "string", "nullable": true}, "scope": {"properties": {"labelIds": {"items": {"type": "string"}, "type": "array", "nullable": true}, "subtrees": {"items": {"type": "string"}, "type": "array", "nullable": true}}, "type": "object", "nullable": true}, "values": {"items": {"type": "string"}, "type": "array", "nullable": true}, "range": {"nullable": true}}, "type": "object", "additionalProperties": true}, "APIStructure": {"properties": {"id": {"type": "string"}, "url": {"type": "string"}, "createdAt": {"type": "string", "format": "date-time", "nullable": true}, "updatedAt": {"type": "string", "format": "date-time", "nullable": true}, "updatedBy": {"type": "string", "nullable": true}, "order": {"items": {"type": "string"}, "type": "array"}, "arcs": {"items": {"items": {"type": "string"}, "type": "array"}, "type": "array"}, "name": {"type": "string"}, "ontologyId": {"type": "string"}, "creator": {"type": "string"}}, "required": ["id", "url", "order", "arcs", "name", "ontologyId", "creator"], "type": "object", "additionalProperties": true}, "CreateStructurePayload": {"properties": {"order": {"items": {"type": "string"}, "type": "array"}, "arcs": {"items": {"items": {"type": "string"}, "type": "array"}, "type": "array"}, "name": {"type": "string"}}, "required": ["order", "arcs", "name"], "type": "object", "additionalProperties": true}, "APIUpdateStructurePayload": {"properties": {"order": {"items": {"type": "string"}, "type": "array", "nullable": true}, "arcs": {"items": {"items": {"type": "string"}, "type": "array"}, "type": "array", "nullable": true}, "name": {"type": "string", "nullable": true}}, "type": "object", "additionalProperties": true}, "CursorPage_APIStructure_": {"properties": {"totalItemsCount": {"type": "number", "format": "double"}, "items": {"items": {"$ref": "#/components/schemas/APIStructure"}, "type": "array"}, "totalPagesCount": {"type": "number", "format": "double"}, "hasNextPage": {"type": "boolean"}}, "required": ["totalItemsCount", "items", "totalPagesCount", "hasNextPage"], "type": "object", "additionalProperties": true}, "ScoreType": {"enum": ["annotation_iou", "annotation_label", "annotation_attribute", "annotation_overall", "label_confusion", "item_overall", "user_overall", "user_confusion"], "type": "string"}, "APIScore": {"properties": {"_id": {"allOf": [{"$ref": "#/components/schemas/ObjectID"}], "nullable": true}, "creator": {"type": "string", "nullable": true}, "createdAt": {"type": "string", "format": "date-time"}, "updatedAt": {"type": "string", "format": "date-time"}, "entityId": {"type": "string"}, "value": {"type": "number", "format": "double"}, "type": {"$ref": "#/components/schemas/ScoreType"}, "context": {"properties": {"relativeId": {"type": "string", "nullable": true}, "relative": {"type": "string", "nullable": true}, "modelId": {"type": "string", "nullable": true}, "annotationId": {"type": "string", "nullable": true}, "itemId": {"type": "string", "nullable": true}, "assignmentId": {"type": "string", "nullable": true}, "userId": {"type": "string", "nullable": true}, "taskId": {"type": "string", "nullable": true}, "datasetId": {"type": "string", "nullable": true}, "projectId": {"type": "string", "nullable": true}}, "type": "object"}, "id": {"type": "string"}}, "required": ["entityId", "value", "type", "context", "id", "createdAt", "updatedAt"], "type": "object", "additionalProperties": true}, "Score": {"properties": {"_id": {"allOf": [{"$ref": "#/components/schemas/ObjectID"}], "nullable": true}, "creator": {"type": "string", "nullable": true}, "createdAt": {"type": "string", "format": "date-time", "nullable": true}, "updatedAt": {"type": "string", "format": "date-time", "nullable": true}, "entityId": {"type": "string"}, "value": {"type": "number", "format": "double"}, "type": {"$ref": "#/components/schemas/ScoreType"}, "context": {"properties": {"relativeId": {"type": "string", "nullable": true}, "relative": {"type": "string", "nullable": true}, "modelId": {"type": "string", "nullable": true}, "annotationId": {"type": "string", "nullable": true}, "itemId": {"type": "string", "nullable": true}, "assignmentId": {"type": "string", "nullable": true}, "userId": {"type": "string", "nullable": true}, "taskId": {"type": "string", "nullable": true}, "datasetId": {"type": "string", "nullable": true}, "projectId": {"type": "string", "nullable": true}}, "type": "object"}}, "required": ["entityId", "value", "type", "context"], "type": "object", "additionalProperties": true}, "ScoreParameters": {"properties": {"score": {"properties": {"context": {"properties": {"userId": {"anyOf": [{"type": "string"}, {"items": {"type": "string"}, "type": "array"}], "nullable": true}, "assignmentId": {"type": "string", "nullable": true}, "taskId": {"type": "string", "nullable": true}}, "type": "object", "nullable": true}, "type": {"allOf": [{"$ref": "#/components/schemas/ScoreType"}], "nullable": true}}, "type": "object"}, "options": {"properties": {"includeHistogramItems": {"type": "boolean", "nullable": true}}, "type": "object", "nullable": true}}, "required": ["score"], "type": "object", "additionalProperties": true}, "DeleteTaskItemScoresPayload": {"properties": {"context": {"properties": {"relative": {"type": "string", "nullable": true}, "userId": {"type": "string", "nullable": true}, "itemId": {"type": "string", "nullable": true}, "taskId": {"type": "string"}}, "required": ["taskId"], "type": "object"}, "entityId": {"type": "string", "nullable": true}}, "required": ["context"], "type": "object", "additionalProperties": true}, "APITaskSpec": {"properties": {"type": {"$ref": "#/components/schemas/TaskType"}}, "required": ["type"], "type": "object", "additionalProperties": true}, "APISpawnTaskSpec": {"properties": {"type": {"$ref": "#/components/schemas/TaskType"}, "parentTaskId": {"type": "string"}}, "required": ["type", "parentTaskId"], "type": "object", "additionalProperties": true}, "TaskStatus": {"enum": ["open", "dismissed", "completed", "completed with issues", "open", "dismissed", "completed", "completed with issues", "in progress"], "type": "string"}, "ItemAction": {"properties": {"action": {"type": "string"}, "displayName": {"type": "string"}, "color": {"type": "string", "nullable": true}, "icon": {"type": "string", "nullable": true}}, "required": ["action", "displayName", "action", "color", "displayName"], "type": "object", "additionalProperties": false}, "Description": {"properties": {"content": {"type": "string"}, "createdBy": {"type": "string"}, "updatedBy": {"type": "string"}, "createdAt": {"type": "string", "format": "date-time"}, "updatedAt": {"type": "string", "format": "date-time"}}, "required": ["content", "createdBy", "updatedBy", "createdAt", "updatedAt"], "type": "object", "additionalProperties": true}, "APITask": {"properties": {"id": {"type": "string"}, "url": {"type": "string"}, "createdAt": {"type": "string", "format": "date-time"}, "updatedAt": {"type": "string", "format": "date-time"}, "updatedBy": {"type": "string", "nullable": true}, "creator": {"type": "string"}, "name": {"type": "string"}, "taskOwner": {"type": "string"}, "dueDate": {"type": "number", "format": "double"}, "datasetId": {"type": "string"}, "recipeId": {"type": "string"}, "projectId": {"type": "string"}, "spec": {"anyOf": [{"$ref": "#/components/schemas/APITaskSpec"}, {"$ref": "#/components/schemas/APISpawnTaskSpec"}]}, "hasParent": {"type": "boolean"}, "query": {"type": "string"}, "assignmentIds": {"items": {"type": "string"}, "type": "array"}, "status": {"$ref": "#/components/schemas/TaskStatus"}, "metadata": {"$ref": "#/components/schemas/APIMetadata"}, "totalItems": {"type": "number", "format": "double"}, "itemStatus": {"$ref": "#/components/schemas/ItemStatus"}, "progress": {"type": "number", "format": "double"}, "forReview": {"type": "number", "format": "double"}, "issues": {"type": "number", "format": "double"}, "availableActions": {"items": {"$ref": "#/components/schemas/ItemAction"}, "type": "array", "nullable": true}, "error": {"type": "string", "nullable": true}, "priority": {"type": "number", "format": "double", "nullable": true}, "emptyInactiveAssignments": {"type": "number", "format": "double", "nullable": true}, "description": {"allOf": [{"$ref": "#/components/schemas/Description"}], "nullable": true}, "hasDueDate": {"type": "boolean", "nullable": true}}, "required": ["id", "url", "creator", "name", "createdAt", "updatedAt", "taskOwner", "dueDate", "datasetId", "recipeId", "projectId", "spec", "hasParent", "query", "assignmentIds", "status", "metadata", "totalItems", "itemStatus", "progress", "forReview", "issues"], "type": "object", "additionalProperties": true}, "TaskWorkload": {"properties": {"assigneeId": {"type": "string"}, "load": {"type": "number", "format": "double"}}, "required": ["assigneeId", "load", "assigneeId", "load"], "type": "object", "additionalProperties": false}, "QueryFilter": {"properties": {"context": {"properties": {"projectIds": {"items": {"type": "string"}, "type": "array"}}, "required": ["projectIds"], "type": "object"}, "page": {"type": "number", "format": "double"}, "pageSize": {"type": "number", "format": "double"}, "resource": {"$ref": "#/components/schemas/QueryResource"}, "filter": {"$ref": "#/components/schemas/Dictionary"}, "sort": {"allOf": [{"$ref": "#/components/schemas/Dictionary"}], "nullable": true}}, "required": ["context", "page", "pageSize", "resource", "filter"], "type": "object", "additionalProperties": true}, "QualityTaskTypes": {"enum": ["consensus", "qualification", "honeypot"], "type": "string"}, "InstructionsDocumentMode": {"enum": ["all", "range", "none"], "type": "string"}, "Partial_TaskInstructionsDocumentDetails_": {"properties": {"mode": {"allOf": [{"$ref": "#/components/schemas/InstructionsDocumentMode"}], "nullable": true}, "fromPage": {"type": "number", "format": "double", "nullable": true}, "toPage": {"type": "number", "format": "double", "nullable": true}, "datasetId": {"type": "string", "nullable": true}, "itemId": {"type": "string", "nullable": true}, "name": {"type": "string", "nullable": true}}, "type": "object", "description": "Make all properties in T optional"}, "TaskMetadata": {"properties": {"system": {"allOf": [{"$ref": "#/components/schemas/Dictionary"}, {"properties": {"instructionDocument": {"allOf": [{"$ref": "#/components/schemas/Partial_TaskInstructionsDocumentDetails_"}], "nullable": true}, "hasDefaultAssignment": {"type": "boolean", "nullable": true}, "locked": {"type": "boolean", "nullable": true}, "enforceDueDate": {"type": "boolean", "nullable": true}, "markForDeletion": {"type": "boolean", "nullable": true}, "archive": {"type": "boolean", "nullable": true}, "taskError": {"type": "string", "nullable": true}, "workloadDistribution": {"items": {"$ref": "#/components/schemas/TaskWorkload"}, "type": "array", "nullable": true}, "nodeId": {"type": "string", "nullable": true}, "pipelineId": {"type": "string", "nullable": true}, "scoring": {"type": "boolean", "nullable": true}, "webmInstalled": {"type": "boolean", "nullable": true}, "disableWebm": {"type": "boolean", "nullable": true}, "consensusAssignees": {"type": "number", "format": "double", "nullable": true}, "consensusPercentage": {"type": "number", "format": "double", "nullable": true}, "consensusTaskType": {"allOf": [{"$ref": "#/components/schemas/QualityTaskTypes"}], "nullable": true}, "relatedTasks": {"items": {"type": "string"}, "type": "array", "nullable": true}, "groups": {"items": {"type": "string"}, "type": "array", "nullable": true}, "allowedAssignees": {"items": {"type": "string"}, "type": "array", "nullable": true}, "maxBatchWorkload": {"type": "number", "format": "double", "nullable": true}, "batchSize": {"type": "number", "format": "double", "nullable": true}, "nextIndex": {"type": "number", "format": "double", "nullable": true}}, "type": "object"}], "nullable": true}}, "type": "object", "additionalProperties": true}, "Pick_Description.content_": {"properties": {"content": {"type": "string"}}, "required": ["content"], "type": "object", "description": "From T, pick a set of properties whose keys are in the union K"}, "DescriptionInput": {"$ref": "#/components/schemas/Pick_Description.content_"}, "TaskPayload": {"properties": {"datasetId": {"type": "string"}, "recipeId": {"type": "string"}, "projectId": {"type": "string"}, "name": {"type": "string"}, "taskOwner": {"type": "string"}, "dueDate": {"type": "number", "format": "double", "nullable": true}, "query": {"type": "string"}, "status": {"type": "string", "nullable": true}, "assignmentIds": {"items": {"type": "string"}, "type": "array", "nullable": true}, "spec": {"anyOf": [{"$ref": "#/components/schemas/APITaskSpec"}, {"$ref": "#/components/schemas/APISpawnTaskSpec"}]}, "workload": {"items": {"$ref": "#/components/schemas/TaskWorkload"}, "type": "array", "nullable": true}, "limit": {"type": "number", "format": "double", "nullable": true}, "percentage": {"type": "boolean", "nullable": true}, "asynced": {"type": "boolean", "nullable": true}, "emptyTask": {"type": "boolean", "nullable": true}, "checkIfExist": {"properties": {"query": {"$ref": "#/components/schemas/QueryFilter"}}, "required": ["query"], "type": "object", "nullable": true}, "availableActions": {"items": {"$ref": "#/components/schemas/ItemAction"}, "type": "array", "nullable": true}, "disableWebm": {"type": "boolean", "nullable": true}, "metadata": {"allOf": [{"$ref": "#/components/schemas/TaskMetadata"}], "nullable": true}, "priority": {"type": "number", "format": "double", "nullable": true}, "description": {"allOf": [{"$ref": "#/components/schemas/DescriptionInput"}], "nullable": true}}, "required": ["datasetId", "recipeId", "projectId", "name", "taskOwner", "query", "spec"], "type": "object", "additionalProperties": true}, "AddToTaskPayload": {"properties": {"query": {"type": "string"}, "workload": {"items": {"$ref": "#/components/schemas/TaskWorkload"}, "type": "array", "nullable": true}, "limit": {"type": "number", "format": "double", "nullable": true}, "percentage": {"type": "boolean", "nullable": true}, "asynced": {"type": "boolean", "nullable": true}, "disableWebm": {"type": "boolean", "nullable": true}, "groups": {"items": {"type": "string"}, "type": "array", "nullable": true}}, "required": ["query"], "type": "object", "additionalProperties": true}, "RemoveFromTaskPayload": {"properties": {"query": {"type": "string"}, "asynced": {"type": "boolean", "nullable": true}}, "required": ["query"], "type": "object", "additionalProperties": true}, "PartialTaskPayload": {"properties": {"recipeId": {"type": "string", "nullable": true}, "query": {"type": "string", "nullable": true}, "name": {"type": "string", "nullable": true}, "creator": {"type": "string", "nullable": true}, "taskOwner": {"type": "string", "nullable": true}, "priority": {"type": "number", "format": "double", "nullable": true}, "dueDate": {"type": "number", "format": "double", "nullable": true}, "status": {"type": "string", "nullable": true}, "availableActions": {"items": {"$ref": "#/components/schemas/ItemAction"}, "type": "array", "nullable": true}, "spec": {"anyOf": [{"$ref": "#/components/schemas/APITaskSpec"}, {"$ref": "#/components/schemas/APISpawnTaskSpec"}], "nullable": true}, "metadata": {"$ref": "#/components/schemas/Dictionary"}, "asynced": {"type": "boolean", "nullable": true}, "description": {"allOf": [{"$ref": "#/components/schemas/DescriptionInput"}], "nullable": true}}, "required": ["metadata"], "type": "object", "additionalProperties": true}, "TaskContributorsAction": {"enum": ["add", "remove"], "type": "string"}, "UpdateContributorsPayload": {"properties": {"action": {"$ref": "#/components/schemas/TaskContributorsAction"}, "assignees": {"items": {"type": "string"}, "type": "array", "nullable": true}, "groups": {"items": {"type": "string"}, "type": "array", "nullable": true}}, "required": ["action"], "type": "object", "additionalProperties": true}, "APITaskCursor": {"properties": {"totalItemsCount": {"type": "number", "format": "double"}, "items": {"items": {"$ref": "#/components/schemas/APITask"}, "type": "array"}, "totalPagesCount": {"type": "number", "format": "double"}, "hasNextPage": {"type": "boolean"}}, "required": ["totalItemsCount", "items", "totalPagesCount", "hasNextPage"], "type": "object", "additionalProperties": true}, "TaskRelativeInput": {"properties": {"id": {"type": "string"}, "name": {"type": "string"}}, "required": ["id", "name"], "type": "object", "additionalProperties": true}, "TaskQueueDetails": {"properties": {"remaining": {"type": "number", "format": "double"}}, "required": ["remaining"], "type": "object", "additionalProperties": true}, "DeleteTaskPayload": {"properties": {"asynced": {"type": "boolean", "nullable": true}, "deleteWithPipeline": {"type": "boolean", "nullable": true}, "emptyOnly": {"type": "boolean", "nullable": true}, "force": {"type": "boolean", "nullable": true}}, "type": "object", "additionalProperties": true}, "CursorPage_any_": {"properties": {"totalItemsCount": {"type": "number", "format": "double"}, "items": {"items": {}, "type": "array"}, "totalPagesCount": {"type": "number", "format": "double"}, "hasNextPage": {"type": "boolean"}}, "required": ["totalItemsCount", "items", "totalPagesCount", "hasNextPage"], "type": "object", "additionalProperties": true}, "APITaskCounters": {"properties": {"activeProjects": {"type": "number", "format": "double"}, "activeDatasets": {"type": "number", "format": "double"}, "activeTasks": {"type": "number", "format": "double"}, "tasksCount": {"type": "number", "format": "double"}}, "required": ["activeProjects", "activeDatasets", "activeTasks", "tasksCount"], "type": "object", "additionalProperties": true}, "WorkflowsCounters": {"properties": {"tasksCount": {"type": "number", "format": "double"}, "assignmentsCount": {"type": "number", "format": "double"}, "issuesCount": {"type": "number", "format": "double"}, "reviewsCount": {"type": "number", "format": "double"}}, "required": ["tasksCount", "assignmentsCount", "issuesCount", "reviewsCount"], "type": "object", "additionalProperties": true}, "GroupCtx": {"properties": {"id": {"type": "string"}, "name": {"type": "string"}}, "required": ["id", "name"], "type": "object", "additionalProperties": true}, "APIUser": {"properties": {"id": {"type": "string"}, "url": {"type": "string"}, "createdAt": {"type": "number", "format": "double"}, "updatedAt": {"type": "number", "format": "double"}, "username": {"type": "string"}, "firstName": {"type": "string"}, "lastName": {"type": "string"}, "email": {"type": "string"}, "avatar": {"type": "string"}, "projects": {"items": {"type": "string"}, "type": "array"}, "groups": {"items": {"$ref": "#/components/schemas/GroupCtx"}, "type": "array"}, "org": {"anyOf": [{"$ref": "#/components/schemas/APIOrg"}, {"type": "string"}]}, "orgs": {"items": {"type": "string"}, "type": "array"}, "type": {"type": "string"}, "lastLogin": {"type": "number", "format": "double"}, "interest": {"type": "string"}, "boarded": {"type": "boolean"}, "timezone": {"type": "string"}, "created": {"type": "boolean"}, "inviteEmail": {"type": "string"}, "status": {"type": "string"}, "member": {"type": "string"}, "guest": {"properties": {"name": {"type": "string"}, "org": {"type": "string"}, "id": {"type": "string"}}, "required": ["id"], "type": "object"}, "denyMembersManagement": {"type": "boolean"}, "defaultProjectRole": {"$ref": "#/components/schemas/Role"}, "previousLogin": {"type": "number", "format": "double"}}, "required": ["id", "username", "firstName", "email", "projects", "groups", "orgs", "type", "createdAt", "updatedAt"], "type": "object", "additionalProperties": true}, "APIOrg": {"properties": {"id": {"type": "string"}, "url": {"type": "string"}, "createdAt": {"type": "number", "format": "double"}, "updatedAt": {"type": "number", "format": "double"}, "role": {"type": "string"}, "name": {"type": "string"}, "logoUrl": {"type": "string"}, "members": {"anyOf": [{"items": {"$ref": "#/components/schemas/APIUser"}, "type": "array"}, {"items": {"type": "string"}, "type": "array"}]}, "groups": {"anyOf": [{"items": {"$ref": "#/components/schemas/APIGroup"}, "type": "array"}, {"items": {"type": "string"}, "type": "array"}]}, "owner": {"anyOf": [{"$ref": "#/components/schemas/APIUser"}, {"type": "string"}]}, "account": {"anyOf": [{"$ref": "#/components/schemas/APIAccount"}, {"type": "string"}]}, "creator": {"anyOf": [{"$ref": "#/components/schemas/APIUser"}, {"type": "string"}]}, "plan": {"$ref": "#/components/schemas/OrgPlans"}, "integrations": {"anyOf": [{"items": {"$ref": "#/components/schemas/APIIntegration"}, "type": "array"}, {"items": {"type": "string"}, "type": "array"}]}, "industry": {"type": "string"}, "size": {"type": "string"}}, "required": ["id", "name", "members", "groups", "owner", "account", "creator", "plan", "integrations", "createdAt", "updatedAt"], "type": "object", "additionalProperties": true}, "Role": {"enum": ["owner", "annotator", "engineer", "annotationManager", "owner", "annotator", "engineer", "annotationManager", "owner", "annotator", "engineer", "annotationManager"], "type": "string"}, "APIGroup": {"properties": {"id": {"type": "string"}, "url": {"type": "string"}, "createdAt": {"type": "number", "format": "double"}, "updatedAt": {"type": "number", "format": "double"}, "name": {"type": "string"}, "org": {"anyOf": [{"$ref": "#/components/schemas/APIOrg"}, {"type": "string"}]}, "owner": {"anyOf": [{"$ref": "#/components/schemas/APIUser"}, {"type": "string"}]}, "creator": {"anyOf": [{"$ref": "#/components/schemas/APIUser"}, {"type": "string"}]}, "members": {"anyOf": [{"items": {"$ref": "#/components/schemas/APIUser"}, "type": "array"}, {"items": {"type": "string"}, "type": "array"}]}, "defaultProjectRole": {"$ref": "#/components/schemas/Role"}, "projects": {"anyOf": [{"items": {"$ref": "#/components/schemas/APIProject"}, "type": "array"}, {"items": {"type": "string"}, "type": "array"}]}, "role": {"$ref": "#/components/schemas/Role"}}, "required": ["id", "name", "org", "owner", "creator", "members", "projects", "createdAt", "updatedAt"], "type": "object", "additionalProperties": true}, "APIAccount": {"properties": {"id": {"type": "string"}, "url": {"type": "string"}, "createdAt": {"type": "number", "format": "double"}, "updatedAt": {"type": "number", "format": "double"}, "name": {"type": "string"}, "owner": {"anyOf": [{"$ref": "#/components/schemas/APIUser"}, {"type": "string"}]}, "org": {"anyOf": [{"$ref": "#/components/schemas/APIOrg"}, {"type": "string"}]}, "creator": {"anyOf": [{"$ref": "#/components/schemas/APIUser"}, {"type": "string"}]}}, "required": ["id", "name", "owner", "org", "creator", "createdAt", "updatedAt"], "type": "object", "additionalProperties": true}, "FeatureConstraint": {"properties": {"title": {"type": "string"}, "quota": {"type": "number", "format": "double"}, "name": {"type": "string"}}, "required": ["title", "quota", "name"], "type": "object"}, "APIProject": {"properties": {"id": {"type": "string"}, "url": {"type": "string"}, "createdAt": {"type": "number", "format": "double"}, "updatedAt": {"type": "number", "format": "double"}, "name": {"type": "string"}, "contributors": {"anyOf": [{"items": {"$ref": "#/components/schemas/APIUser"}, "type": "array"}, {"items": {"type": "string"}, "type": "array"}]}, "groups": {"anyOf": [{"items": {"$ref": "#/components/schemas/APIGroup"}, "type": "array"}, {"items": {"type": "string"}, "type": "array"}]}, "creator": {"anyOf": [{"$ref": "#/components/schemas/APIUser"}, {"type": "string"}]}, "org": {"anyOf": [{"$ref": "#/components/schemas/APIOrg"}, {"type": "string"}]}, "account": {"anyOf": [{"$ref": "#/components/schemas/APIAccount"}, {"type": "string"}]}, "featureConstraints": {"items": {"$ref": "#/components/schemas/FeatureConstraint"}, "type": "array"}, "guests": {"anyOf": [{"items": {"$ref": "#/components/schemas/APIProjectGuest"}, "type": "array"}, {"items": {"type": "string"}, "type": "array"}]}, "role": {"type": "string"}, "archived": {"type": "boolean"}}, "required": ["id", "name", "contributors", "groups", "creator", "org", "account", "guests", "createdAt", "updatedAt"], "type": "object", "additionalProperties": true}, "APIProjectGuest": {"properties": {"id": {"type": "string"}, "url": {"type": "string"}, "createdAt": {"type": "number", "format": "double"}, "updatedAt": {"type": "number", "format": "double"}, "project": {"anyOf": [{"$ref": "#/components/schemas/APIProject"}, {"type": "string"}]}, "guestOrg": {"anyOf": [{"$ref": "#/components/schemas/APIOrg"}, {"type": "string"}]}, "name": {"type": "string"}, "type": {"type": "string"}, "creator": {"anyOf": [{"$ref": "#/components/schemas/APIUser"}, {"type": "string"}]}, "archived": {"type": "boolean"}}, "required": ["id", "project", "guestOrg", "name", "type", "creator", "createdAt", "updatedAt"], "type": "object", "additionalProperties": true}, "OrgPlans": {"enum": ["freemium", "premium"], "type": "string"}, "APIIntegration": {"properties": {"id": {"type": "string"}, "url": {"type": "string"}, "createdAt": {"type": "number", "format": "double"}, "updatedAt": {"type": "number", "format": "double"}, "name": {"type": "string"}, "type": {"type": "string"}, "org": {"anyOf": [{"$ref": "#/components/schemas/APIOrg"}, {"type": "string"}]}, "creator": {"anyOf": [{"$ref": "#/components/schemas/APIUser"}, {"type": "string"}]}, "metadata": {"items": {"$ref": "#/components/schemas/APIIntegrationMetadata"}, "type": "array"}}, "required": ["id", "name", "type", "org", "creator", "metadata", "createdAt", "updatedAt"], "type": "object", "additionalProperties": true}, "APIIntegrationMetadata": {"properties": {"id": {"type": "string"}, "url": {"type": "string"}, "createdAt": {"type": "number", "format": "double"}, "updatedAt": {"type": "number", "format": "double"}, "name": {"type": "string"}, "value": {"type": "string"}, "integration": {"anyOf": [{"$ref": "#/components/schemas/APIIntegration"}, {"type": "string"}]}}, "required": ["id", "name", "value", "integration", "createdAt", "updatedAt"], "type": "object", "additionalProperties": true}, "CreateAccountRequest": {"properties": {"name": {"type": "string"}, "createdBy": {"type": "string"}, "org": {"type": "string"}}, "required": ["name", "createdBy", "org"], "type": "object", "additionalProperties": true}, "APIGoogleMarketplaceAccount": {"properties": {"id": {"type": "string"}, "url": {"type": "string"}, "createdAt": {"type": "number", "format": "double"}, "updatedAt": {"type": "number", "format": "double"}, "userIdentity": {"type": "string"}, "approved": {"type": "boolean"}, "orgId": {"type": "string"}, "accountId": {"type": "string"}}, "required": ["id", "userIdentity", "approved", "createdAt", "updatedAt"], "type": "object", "additionalProperties": true}, "EditAccountRequest": {"properties": {"name": {"type": "string"}, "org": {"type": "string"}}, "required": ["name", "org"], "type": "object", "additionalProperties": true}, "AlertTier": {"enum": ["early", "preliminary", "acute", "enforcement", "early", "preliminary", "acute", "enforcement"], "type": "string"}, "OrgRole": {"enum": ["owner", "admin", "member", "worker", "owner", "admin", "member", "worker"], "type": "string"}, "RoleEntry": {"properties": {"role": {"anyOf": [{"$ref": "#/components/schemas/Role"}, {"$ref": "#/components/schemas/OrgRole"}]}, "projectId": {"type": "string"}, "orgId": {"type": "string"}, "orgName": {"type": "string"}, "active": {"type": "boolean"}}, "required": ["role"], "type": "object"}, "CreateBotPayload": {"properties": {"name": {"type": "string"}, "returnCredentials": {"type": "boolean"}}, "type": "object", "additionalProperties": true}, "CreateGroupPayload": {"properties": {"name": {"type": "string"}, "orgId": {"type": "string"}}, "required": ["name", "orgId"], "type": "object", "additionalProperties": true}, "PatchGroupPayload": {"properties": {"name": {"type": "string"}, "default_project_role": {"type": "boolean"}}, "required": ["name"], "type": "object", "additionalProperties": true}, "DLEntityType": {"enum": ["dataset", "recipe", "ontology", "item", "annotation", "execution", "task", "assignment", "service", "package", "project", "model", "member", "group", "org", "account", "subscription", "plan", "qouta"], "type": "string"}, "AuthUserAttributes": {"properties": {"id": {"type": "string"}, "url": {"type": "string"}, "username": {"type": "string"}, "firstName": {"type": "string"}, "lastName": {"type": "string"}, "email": {"type": "string"}, "avatar": {"type": "string"}, "projects": {"items": {"type": "string"}, "type": "array"}, "groups": {"items": {"$ref": "#/components/schemas/GroupCtx"}, "type": "array"}, "org": {"type": "string"}, "orgs": {"items": {"type": "string"}, "type": "array"}, "type": {"type": "string"}, "lastLogin": {"type": "number", "format": "double"}, "interest": {"type": "string"}, "boarded": {"type": "boolean"}, "hash": {"type": "string"}, "timezone": {"type": "string"}, "createdAt": {"type": "number", "format": "double"}, "updatedAt": {"type": "number", "format": "double"}, "orgRole": {"type": "string"}, "created": {"type": "boolean"}, "domain": {"type": "string"}, "given_name": {"type": "string"}, "returningUser": {"type": "boolean"}, "membershipType": {"$ref": "#/components/schemas/DLEntityType"}, "membershipEntityId": {"type": "string"}, "role": {"$ref": "#/components/schemas/Role"}, "superuser": {"type": "boolean"}, "picture": {"type": "string"}, "via": {"type": "string"}}, "required": ["id", "username", "firstName", "email", "type", "createdAt", "updatedAt", "orgRole", "created", "domain", "given_name", "membershipType", "membershipEntityId"], "type": "object", "additionalProperties": true}, "OrgSize": {"enum": ["small", "medium", "enterprise"], "type": "string"}, "OrgIndustry": {"enum": ["automotive", "medical", "retail", "agriculture", "sports", "aerialImagery", "media", "other"], "type": "string"}, "APIOrgUser": {"properties": {"id": {"type": "string"}, "url": {"type": "string"}, "createdAt": {"type": "number", "format": "double"}, "updatedAt": {"type": "number", "format": "double"}, "member": {"anyOf": [{"$ref": "#/components/schemas/APIUser"}, {"type": "string"}]}, "org": {"anyOf": [{"$ref": "#/components/schemas/APIOrg"}, {"type": "string"}]}, "role": {"anyOf": [{"$ref": "#/components/schemas/OrgRole"}, {"type": "string"}]}, "status": {"type": "string"}, "inviteEmail": {"type": "string"}, "defaultProjectRole": {"$ref": "#/components/schemas/Role"}}, "required": ["id", "member", "org", "role", "status", "inviteEmail", "createdAt", "updatedAt"], "type": "object", "additionalProperties": true}, "APIOrgDomain": {"properties": {"id": {"type": "string"}, "url": {"type": "string"}, "createdAt": {"type": "number", "format": "double"}, "updatedAt": {"type": "number", "format": "double"}, "org": {"anyOf": [{"$ref": "#/components/schemas/APIOrg"}, {"type": "string"}]}, "domain": {"type": "string"}}, "required": ["id", "org", "domain", "createdAt", "updatedAt"], "type": "object", "additionalProperties": true}, "INTEGRATION_TYPE": {"enum": ["s3", "aws-sts", "aws-cross", "gcp-cross", "gcp-workload-identity-federation", "gcs", "azureblob", "key_value", "private-registry"], "type": "string"}, "IKeyValueMetadata": {"properties": {"ref": {"type": "string"}, "provider": {"type": "string"}}, "type": "object", "additionalProperties": true}, "IntegrationTypeMetadata": {"$ref": "#/components/schemas/IKeyValueMetadata"}, "IntegrationMetadataBody": {"properties": {"value": {"type": "string"}, "name": {"type": "string"}, "id": {"type": "string"}}, "required": ["value", "name"], "type": "object"}, "IntegrationBody": {"properties": {"metadata": {"items": {"$ref": "#/components/schemas/IntegrationMetadataBody"}, "type": "array"}, "credentials": {"properties": {"options": {"$ref": "#/components/schemas/Dictionary"}, "type": {"$ref": "#/components/schemas/INTEGRATION_TYPE"}}, "required": ["options", "type"], "type": "object"}, "name": {"type": "string"}, "integrationId": {"type": "string"}}, "required": ["integrationId"], "type": "object"}, "BillingResourceKey": {"enum": ["annotation-tool-hours", "data-points", "ingested-data-points", "api-calls", "hosted-storage", "system-compute", "compute-cpu-regular-xs", "compute-cpu-regular-s", "compute-cpu-regular-m", "compute-cpu-regular-l", "compute-cpu-highmem-xs", "compute-cpu-highmem-s", "compute-cpu-highmem-m", "compute-cpu-highmem-l", "compute-gpu-k80-s", "compute-gpu-k80-m", "compute-gpu-a100-s", "compute-gpu-a100-m", "compute-gpu-t4", "compute-gpu-t4-m", "compute-gpu-a100-4g", "compute-gpu-a100-4g-m", "compute-budget", "unlimited-seats", "default-annotation-studios", "lidar", "auto-annotation-tools", "ml-model-assisted-annotation", "ai-video-tracker", "data-bug-tracking", "storage-integration", "data-visualization", "metadata-search", "data-versioning", "output-format-converters", "workforce-management-tool", "analytics-dashboard", "advanced-analytics-history", "multiple-workforces", "sdk-access", "api-access", "data-pipeline-filters", "human-tasks", "faas", "model-management", "email-customer-support", "knowledge-base", "faq", "instructional-video-library-access", "ticket-based-troubleshooting", "access-to-customer-success-representation-pool", "debug-and-guide-via-tracking-sys", "on-demand-calls", "engineering-consulting", "dedicated-customer-success", "quarterly-customer-success-check-in", "on-demand-customer-success-calls", "monthly-customer-success-calls", "weekly-customer-success-calls", "developer-success-assistance", "professional-services-or-developer-success-lead-onboarding", "professional-services-custom-development", "managed-labeling-service", "professional-services", "role-and-group-based-access-control", "custom-project-dashboard", "enterprise-support-sla", "sso-integration", "mfa-integration", "ip-whitelist", "vpc-deployment", "annotation-tool-hours", "data-points", "ingested-data-points", "api-calls", "hosted-storage", "system-compute", "compute-cpu-regular-xs", "compute-cpu-regular-s", "compute-cpu-regular-m", "compute-cpu-regular-l", "compute-cpu-highmem-xs", "compute-cpu-highmem-s", "compute-cpu-highmem-m", "compute-cpu-highmem-l", "compute-gpu-k80-s", "compute-gpu-k80-m", "compute-gpu-a100-s", "compute-gpu-a100-m", "compute-gpu-t4", "compute-gpu-t4-m", "compute-gpu-a100-4g", "compute-gpu-a100-4g-m", "compute-budget", "unlimited-seats", "default-annotation-studios", "lidar", "auto-annotation-tools", "ml-model-assisted-annotation", "ai-video-tracker", "data-bug-tracking", "storage-integration", "data-visualization", "metadata-search", "data-versioning", "output-format-converters", "workforce-management-tool", "analytics-dashboard", "advanced-analytics-history", "multiple-workforces", "sdk-access", "api-access", "data-pipeline-filters", "human-tasks", "faas", "model-management", "email-customer-support", "knowledge-base", "faq", "instructional-video-library-access", "ticket-based-troubleshooting", "access-to-customer-success-representation-pool", "debug-and-guide-via-tracking-sys", "on-demand-calls", "engineering-consulting", "dedicated-customer-success", "quarterly-customer-success-check-in", "on-demand-customer-success-calls", "monthly-customer-success-calls", "weekly-customer-success-calls", "developer-success-assistance", "professional-services-or-developer-success-lead-onboarding", "professional-services-custom-development", "managed-labeling-service", "professional-services", "role-and-group-based-access-control", "custom-project-dashboard", "enterprise-support-sla", "sso-integration", "mfa-integration", "ip-whitelist", "vpc-deployment"], "type": "string"}, "MetricGroup": {"enum": ["Annotation tool studios", "automation", "Data QA tools", "Data management", "Workforce management", "Data pipelines", "Customer support", "Customer care", "Enterprise features", "General", "Annotation tool studios", "automation", "Data QA tools", "Data management", "Workforce management", "Data pipelines", "Customer support", "Customer care", "Enterprise features", "General"], "type": "string"}, "BillingResource": {"properties": {"key": {"$ref": "#/components/schemas/BillingResourceKey"}, "name": {"type": "string"}, "type": {"type": "string"}, "description": {"type": "string"}, "icon": {"type": "string"}, "price": {"type": "number", "format": "double"}, "amount": {"type": "number", "format": "double"}, "unit": {"type": "string"}, "displayedInInvoice": {"type": "boolean"}, "group": {"$ref": "#/components/schemas/MetricGroup"}, "tier": {"type": "string"}}, "required": ["key", "name", "type", "description", "icon", "key", "name", "type", "description", "icon"], "type": "object", "additionalProperties": true}, "Plan": {"properties": {"key": {"type": "string"}, "name": {"type": "string"}, "description": {"type": "string"}, "resources": {"items": {"$ref": "#/components/schemas/BillingResource"}, "type": "array"}, "annualPlanPrice": {"type": "number", "format": "double"}, "monthlyPlanPrice": {"type": "number", "format": "double"}, "annualDiscountPercentage": {"type": "number", "format": "double"}, "price": {"type": "number", "format": "double"}}, "required": ["key", "name", "description", "resources", "key", "name", "description", "resources"], "type": "object", "additionalProperties": true}, "BillingPeriod": {"type": "string", "enum": ["monthly", "annual", "custom", "monthly", "annual", "custom"]}, "BillingStatus": {"enum": ["future", "active", "paused", "blocked", "expired", "canceled", "renewed", "future", "active", "paused", "blocked", "expired", "canceled", "renewed"], "type": "string"}, "ScopeType": {"enum": ["org", "project", "org", "project"], "type": "string"}, "APISubscription": {"properties": {"id": {"type": "string", "description": "Unique identifier for the subscription"}, "url": {"type": "string", "description": "Url for the subscription"}, "plan": {"$ref": "#/components/schemas/Plan", "description": "Plan detailing the resources allocated to the subscription"}, "createdAt": {"type": "string", "format": "date-time", "description": "Creation date"}, "updatedAt": {"type": "string", "format": "date-time", "description": "Latest update date"}, "period": {"$ref": "#/components/schemas/BillingPeriod", "description": "Subscription period"}, "startTime": {"type": "string", "format": "date-time", "description": "Subscription start time"}, "endTime": {"type": "string", "format": "date-time", "description": "Subscription expiration time"}, "status": {"$ref": "#/components/schemas/BillingStatus", "description": "Current status"}, "scope": {"properties": {"entityId": {"type": "string"}, "type": {"$ref": "#/components/schemas/ScopeType"}}, "required": ["entityId", "type", "entityId", "type"], "type": "object", "description": "Subscription scope type and id"}, "accountId": {"type": "string", "description": "DL account Id"}, "autoRenewal": {"type": "boolean", "description": "Whether the subscription will auto renew when its current quota expires"}, "addon": {"type": "boolean", "description": "Whether the subscription is an addon or not"}, "paymentDriverId": {"type": "string"}, "paymentMethodId": {"type": "string"}, "externalSubscriptionId": {"type": "string", "description": "External subscription id"}}, "required": ["id", "url", "plan", "createdAt", "period", "startTime", "status", "scope", "accountId", "id", "url", "plan", "createdAt", "period", "startTime", "endTime", "scope", "accountId", "status"], "type": "object", "additionalProperties": true}, "GuestType": {"enum": ["labeling", "development"], "type": "string"}, "APIGuest": {"properties": {"id": {"type": "string"}, "url": {"type": "string"}, "createdAt": {"type": "number", "format": "double"}, "updatedAt": {"type": "number", "format": "double"}, "name": {"type": "string"}, "guestOrg": {"type": "string"}, "project": {"type": "string"}, "type": {"anyOf": [{"$ref": "#/components/schemas/GuestType"}, {"type": "string"}]}}, "required": ["id", "name", "guestOrg", "project", "type"], "type": "object", "additionalProperties": true}, "CreateGuestPayload": {"properties": {"denyMembersManagement": {"type": "boolean"}, "type": {"$ref": "#/components/schemas/GuestType"}, "name": {"type": "string"}, "guestEmail": {"type": "string"}}, "required": ["type", "name", "guestEmail"], "type": "object"}, "CreateProjectPayload": {"properties": {"account": {"type": "string"}, "name": {"type": "string"}}, "required": ["name"], "type": "object"}, "APIMembership": {"properties": {"id": {"type": "string"}, "url": {"type": "string"}, "createdAt": {"type": "number", "format": "double"}, "updatedAt": {"type": "number", "format": "double"}, "member": {"anyOf": [{"$ref": "#/components/schemas/APIUser"}, {"type": "string"}]}, "project": {"anyOf": [{"$ref": "#/components/schemas/APIProject"}, {"type": "string"}]}, "role": {"anyOf": [{"$ref": "#/components/schemas/Role"}, {"type": "string"}, {"type": "string", "enum": ["superuser"]}]}, "creator": {"anyOf": [{"$ref": "#/components/schemas/APIUser"}, {"type": "string"}]}, "via": {"type": "string"}, "domain": {"type": "string"}, "canAddGroups": {"type": "boolean"}, "denyMembersManagement": {"type": "boolean"}, "status": {"type": "string"}, "archived": {"type": "boolean"}}, "required": ["id", "member", "project", "role", "creator", "via", "createdAt", "updatedAt"], "type": "object", "additionalProperties": true}, "UserInterestType": {"enum": ["dataManagement", "dataScience", "pipelines", "annotation", "AILeadership", "softwareDeveloper", "mlDeveloper", "dataEngineer", "annotationManager"], "type": "string"}, "AddMembersBatchPayload": {"properties": {"interest": {"$ref": "#/components/schemas/UserInterestType"}, "via": {"type": "string"}, "denyMembersManagement": {"type": "boolean"}, "skip_response": {"type": "boolean"}, "skip_welcome_email": {"type": "boolean"}, "role": {"$ref": "#/components/schemas/Role"}, "users": {"items": {"type": "string"}, "type": "array"}}, "required": ["role", "users"], "type": "object"}, "ClientContributor": {"properties": {"id": {"type": "string"}, "email": {"type": "string"}, "username": {"type": "string"}, "firstName": {"type": "string"}, "lastName": {"type": "string"}, "avatar": {"type": "string"}, "domain": {"type": "string"}, "lastLogin": {"type": "number", "format": "double"}, "createdAt": {"type": "number", "format": "double"}, "role": {"$ref": "#/components/schemas/Role"}, "type": {"type": "string"}, "groups": {"items": {"$ref": "#/components/schemas/GroupCtx"}, "type": "array"}, "guest": {"properties": {"org": {"type": "string"}, "name": {"type": "string"}, "id": {"type": "string"}}, "required": ["id"], "type": "object"}, "membershipType": {"$ref": "#/components/schemas/DLEntityType"}, "denyMembersManagement": {"type": "boolean"}, "membershipEntityId": {"type": "string"}, "updatedAt": {"type": "number", "format": "double"}}, "required": ["id", "email", "username", "firstName", "domain", "createdAt", "role", "membershipType", "membershipEntityId", "updatedAt"], "type": "object", "additionalProperties": true}, "AddMemberPayload": {"properties": {"via": {"type": "string"}, "denyMembersManagement": {"type": "boolean"}, "can_add_groups": {"type": "boolean"}, "skip_welcome_email": {"type": "boolean"}, "skip_response": {"type": "boolean"}, "role": {"$ref": "#/components/schemas/Role"}}, "required": ["role"], "type": "object"}, "PatchMemberPayload": {"properties": {"denyMembersManagement": {"type": "boolean"}, "role": {"$ref": "#/components/schemas/Role"}}, "required": ["role"], "type": "object"}, "updateMyDetailsPayload": {"properties": {"cookieApproval": {"type": "number", "format": "double"}, "interest": {"$ref": "#/components/schemas/UserInterestType"}, "timezone": {"type": "string"}, "lastName": {"type": "string"}, "firstName": {"type": "string"}, "org": {"type": "string", "nullable": true}}, "type": "object"}, "APIHashUser": {"properties": {"id": {"type": "string"}, "url": {"type": "string"}, "createdAt": {"type": "number", "format": "double"}, "updatedAt": {"type": "number", "format": "double"}, "hash": {"type": "string"}, "username": {"type": "string"}, "avatar": {"type": "string"}}, "required": ["id", "hash", "username", "avatar"], "type": "object", "additionalProperties": true}, "ApiKeyType": {"enum": ["user", "project"], "type": "string"}, "APIApiKey": {"properties": {"id": {"type": "string"}, "url": {"type": "string"}, "createdAt": {"type": "number", "format": "double"}, "updatedAt": {"type": "number", "format": "double"}, "creator": {"type": "string"}, "description": {"type": "string"}, "expiresAt": {"type": "number", "format": "double"}, "type": {"$ref": "#/components/schemas/ApiKeyType"}, "projectId": {"type": "string"}, "userId": {"type": "string"}, "revokedAt": {"type": "number", "format": "double"}}, "required": ["id", "createdAt", "updatedAt", "creator", "description", "expiresAt", "type"], "type": "object", "additionalProperties": true}, "APILogin": {"properties": {"id": {"type": "string"}, "url": {"type": "string"}, "createdAt": {"type": "number", "format": "double"}, "updatedAt": {"type": "number", "format": "double"}, "userId": {"type": "string"}, "date": {"type": "number", "format": "double"}, "orgId": {"type": "string"}, "orgRole": {"$ref": "#/components/schemas/OrgRole"}, "userAgent": {"type": "string"}}, "required": ["id", "userId", "date", "userAgent"], "type": "object", "additionalProperties": true}, "CursorPage_APILogin_": {"properties": {"totalItemsCount": {"type": "number", "format": "double"}, "items": {"items": {"$ref": "#/components/schemas/APILogin"}, "type": "array"}, "totalPagesCount": {"type": "number", "format": "double"}, "hasNextPage": {"type": "boolean"}}, "required": ["totalItemsCount", "items", "totalPagesCount", "hasNextPage"], "type": "object", "additionalProperties": true}, "LoginsLogQuery": {"properties": {"order": {"type": "string", "enum": ["ASC", "DESC"]}, "orderBy": {"type": "string", "enum": ["id", "sequelize", "destroy", "restore", "update", "increment", "decrement", "addHook", "removeHook", "hasHook", "hasHooks", "_creationAttributes", "orgId", "_attributes", "validate", "isNewRecord", "where", "userId", "orgRole", "date", "userAgent", "dataValues", "getDataValue", "setDataValue", "get", "set", "setAttributes", "changed", "previous", "save", "reload", "equals", "equalsOneOf", "toJSON", "isSoftDeleted", "_model"], "nullable": false}, "page": {"type": "number", "format": "double"}, "pageSize": {"type": "number", "format": "double"}, "groupId": {"type": "string"}, "orgRole": {"$ref": "#/components/schemas/OrgRole"}, "userId": {"type": "string"}, "toDate": {"type": "string", "format": "date-time"}, "fromDate": {"type": "string", "format": "date-time"}, "orgId": {"type": "string"}}, "required": ["orgId"], "type": "object"}, "EntityScopeLevel": {"enum": ["private", "project", "org", "public", "private", "project", "org", "public"], "type": "string"}, "ModelStatus": {"enum": ["created", "pre-trained", "pending", "training", "trained", "deployed", "failed", "cloning", "created", "pre-trained", "pending", "training", "trained", "deployed", "failed", "cloning"], "type": "string"}, "APIModelConfiguration": {"properties": {"label_to_id_map": {"properties": {}, "additionalProperties": {"anyOf": [{"type": "number", "format": "double"}, {"type": "string"}]}, "type": "object", "nullable": true}}, "type": "object", "additionalProperties": true}, "ModelInputType": {"enum": ["image", "video", "text", "audio", "image", "video", "text", "audio"], "type": "string"}, "ModelOutputType": {"anyOf": [{"$ref": "#/components/schemas/AnnotationType"}, {"type": "string", "enum": ["embedding"]}, {"$ref": "#/components/schemas/AnnotationType"}, {"type": "string", "enum": ["embedding"]}]}, "ArtifactType": {"enum": ["item", "local", "link"], "type": "string"}, "ItemArtifact": {"properties": {"type": {"$ref": "#/components/schemas/ArtifactType"}, "itemId": {"type": "string"}}, "required": ["type", "itemId"], "type": "object", "additionalProperties": true}, "LocalArtifact": {"properties": {"type": {"$ref": "#/components/schemas/ArtifactType"}, "localPath": {"type": "string"}}, "required": ["type"], "type": "object", "additionalProperties": true}, "EntityContext": {"properties": {"project": {"type": "string"}, "creator": {"type": "string"}, "org": {"type": "string"}}, "type": "object", "additionalProperties": false}, "ModelOperationMetadata": {"properties": {"datasets": {"items": {"type": "string"}, "type": "array"}, "services": {"items": {"type": "string"}, "type": "array"}, "executions": {"items": {"type": "string"}, "type": "array"}}, "type": "object"}, "APIModelMetadataSubsets": {"properties": {"train": {"allOf": [{"$ref": "#/components/schemas/Dictionary"}], "nullable": true}, "validation": {"allOf": [{"$ref": "#/components/schemas/Dictionary"}], "nullable": true}}, "type": "object", "additionalProperties": true}, "APIModelMetadataAnnotationsSubsets": {"properties": {"train": {"allOf": [{"$ref": "#/components/schemas/Dictionary"}], "nullable": true}, "validation": {"allOf": [{"$ref": "#/components/schemas/Dictionary"}], "nullable": true}}, "type": "object", "additionalProperties": true}, "ReferenceType": {"enum": ["service", "pipeline", "model", "app", "dpk", "service", "pipeline", "model", "app", "dpk"], "type": "string"}, "EntityReference": {"properties": {"metadata": {"$ref": "#/components/schemas/Dictionary"}, "id": {"type": "string"}, "type": {"$ref": "#/components/schemas/ReferenceType"}}, "required": ["id", "type", "id", "type"], "type": "object"}, "NodeMlType": {"enum": ["genAi", "embeddings"], "type": "string"}, "APIModelMetadataSystem": {"properties": {"archived": {"type": "boolean", "nullable": true}, "ontologyId": {"type": "string", "nullable": true}, "train": {"allOf": [{"$ref": "#/components/schemas/ModelOperationMetadata"}], "nullable": true}, "predict": {"allOf": [{"$ref": "#/components/schemas/ModelOperationMetadata"}], "nullable": true}, "evaluate": {"allOf": [{"$ref": "#/components/schemas/ModelOperationMetadata"}], "nullable": true}, "deploy": {"allOf": [{"$ref": "#/components/schemas/ModelOperationMetadata"}], "nullable": true}, "subsets": {"allOf": [{"$ref": "#/components/schemas/APIModelMetadataSubsets"}], "nullable": true}, "annotationsSubsets": {"allOf": [{"$ref": "#/components/schemas/APIModelMetadataAnnotationsSubsets"}], "nullable": true}, "refs": {"items": {"$ref": "#/components/schemas/EntityReference"}, "type": "array"}, "mlType": {"properties": {"subType": {"anyOf": [{"type": "string"}, {"items": {"type": "string"}, "type": "array"}]}, "type": {"$ref": "#/components/schemas/NodeMlType"}}, "required": ["type"], "type": "object", "nullable": true}, "cloneCommand": {"properties": {"error": {"type": "string"}, "commandId": {"type": "string"}}, "required": ["commandId"], "type": "object", "nullable": true}, "embedDatasets": {"properties": {"error": {"type": "string"}, "commandId": {"type": "string"}}, "required": ["commandId"], "type": "object", "nullable": true}, "reloadServices": {"properties": {"error": {"type": "string"}, "commandId": {"type": "string"}}, "required": ["commandId"], "type": "object", "nullable": true}}, "type": "object", "additionalProperties": true}, "APIModelMetadata": {"properties": {"system": {"allOf": [{"$ref": "#/components/schemas/APIModelMetadataSystem"}], "nullable": true}}, "type": "object", "additionalProperties": true}, "IAppDefinition": {"properties": {"id": {"type": "string"}, "componentName": {"type": "string", "nullable": true}, "dpkName": {"type": "string", "nullable": true}, "dpkVersion": {"type": "string", "nullable": true}, "dpkId": {"type": "string", "nullable": true}}, "required": ["id", "dpkName", "dpkVersion", "dpkId", "id", "dpkName", "dpkVersion", "dpkId"], "type": "object", "additionalProperties": false}, "ModelStatusLog": {"properties": {"status": {"$ref": "#/components/schemas/ModelStatus"}, "message": {"type": "string"}, "timestamp": {"type": "string", "format": "date-time"}}, "required": ["status", "timestamp"], "type": "object", "additionalProperties": true}, "APIModel": {"properties": {"id": {"type": "string"}, "url": {"type": "string"}, "createdAt": {"type": "string", "format": "date-time"}, "updatedAt": {"type": "string", "format": "date-time"}, "updatedBy": {"type": "string"}, "name": {"type": "string", "description": "The models name"}, "packageId": {"type": "string", "description": "The model this model is derived from"}, "description": {"type": "string", "description": "description of the model\ndefault 'My model'"}, "scope": {"$ref": "#/components/schemas/EntityScopeLevel", "description": "Field that shows the scope in which the model exists\ndefault 'private'"}, "status": {"$ref": "#/components/schemas/ModelStatus", "description": "the current models status\ndefault ModelStatus.CREATED"}, "tags": {"items": {"type": "string"}, "type": "array", "description": "Tags related to the model\ndefault []"}, "labels": {"items": {"type": "string"}, "type": "array", "description": "Labels related to the model\ndefault []"}, "configuration": {"$ref": "#/components/schemas/APIModelConfiguration", "description": "The configuration that the model was created with\ndefault {}"}, "inputType": {"$ref": "#/components/schemas/ModelInputType", "description": "Model Input Type\ndefault ModelInputType.IMAGE"}, "outputType": {"$ref": "#/components/schemas/ModelOutputType", "description": "Model Output Type\ndefault AnnotationType.BOX"}, "datasetId": {"type": "string", "description": "The datasets id that the model is connected to"}, "artifacts": {"items": {"anyOf": [{"$ref": "#/components/schemas/ItemArtifact"}, {"$ref": "#/components/schemas/LocalArtifact"}]}, "type": "array", "description": "the artifacts of the model\nan artifact indicates where the model binaries sit"}, "context": {"$ref": "#/components/schemas/EntityContext", "description": "The context which the model exists in"}, "moduleName": {"type": "string", "description": "The module name of the model"}, "metadata": {"$ref": "#/components/schemas/APIModelMetadata"}, "app": {"$ref": "#/components/schemas/IAppDefinition"}, "statusLogs": {"items": {"$ref": "#/components/schemas/ModelStatusLog"}, "type": "array"}}, "required": ["id", "url", "createdAt", "updatedAt", "name", "packageId", "description", "scope", "status", "tags", "labels", "configuration", "inputType", "outputType", "context", "moduleName"], "type": "object", "additionalProperties": true}, "CursorPageAPISetting": {"properties": {"totalItemsCount": {"type": "number", "format": "double"}, "items": {"items": {"$ref": "#/components/schemas/APIModel", "anyOf": [{"$ref": "#/components/schemas/APIFeatureFlag"}, {"$ref": "#/components/schemas/APIUserSetting"}]}, "type": "array"}, "totalPagesCount": {"type": "number", "format": "double"}, "hasNextPage": {"type": "boolean"}}, "required": ["totalItemsCount", "items", "totalPagesCount", "hasNextPage", "totalItemsCount", "items", "totalPagesCount", "hasNextPage"], "type": "object", "additionalProperties": true}, "CreateModelRequest": {"properties": {"name": {"type": "string", "description": "The models name"}, "packageId": {"type": "string", "description": "The model this model is derived from"}, "description": {"type": "string", "nullable": true, "description": "description of the model\ndefault 'My model'"}, "projectId": {"type": "string", "description": "the id of the project the model belongs to"}, "scope": {"allOf": [{"$ref": "#/components/schemas/EntityScopeLevel"}], "nullable": true, "description": "Field that shows the scope in which the model exists\ndefault 'project'"}, "status": {"allOf": [{"$ref": "#/components/schemas/ModelStatus"}], "nullable": true, "description": "the current models status\ndefault ModelStatus.CREATED"}, "tags": {"items": {"type": "string"}, "type": "array", "nullable": true, "description": "Tags related to the model\ndefault []"}, "labels": {"items": {"type": "string"}, "type": "array", "nullable": true, "description": "Labels related to the model"}, "configuration": {"allOf": [{"$ref": "#/components/schemas/APIModelConfiguration"}], "nullable": true, "description": "The configuration that the model was created with\ndefault {}"}, "inputType": {"allOf": [{"$ref": "#/components/schemas/ModelInputType"}], "nullable": true, "description": "Model Input Type\ndefault ModelInputType.IMAGE"}, "outputType": {"allOf": [{"$ref": "#/components/schemas/ModelOutputType"}], "nullable": true, "description": "Model Output Type\ndefault AnnotationType.BOX"}, "datasetId": {"type": "string", "nullable": true, "description": "The datasets id that the model is connected to"}, "artifacts": {"items": {"anyOf": [{"$ref": "#/components/schemas/ItemArtifact"}, {"$ref": "#/components/schemas/LocalArtifact"}]}, "type": "array", "nullable": true, "description": "the artifacts of the model\nan artifact indicates where the model binaries sit"}, "metadata": {"allOf": [{"$ref": "#/components/schemas/APIModelMetadata"}], "nullable": true}, "moduleName": {"type": "string", "nullable": true, "description": "The module name of the model"}, "app": {"allOf": [{"$ref": "#/components/schemas/IAppDefinition"}], "nullable": true}}, "required": ["name", "packageId", "projectId"], "type": "object", "additionalProperties": true}, "PatchModelRequest": {"properties": {"name": {"type": "string", "nullable": true, "description": "The models name"}, "description": {"type": "string", "nullable": true, "description": "description of the model"}, "datasetId": {"type": "string", "nullable": true, "description": "The datasets id that the model is connected to"}, "artifacts": {"items": {"anyOf": [{"$ref": "#/components/schemas/ItemArtifact"}, {"$ref": "#/components/schemas/LocalArtifact"}]}, "type": "array", "nullable": true, "description": "the artifacts of the model\nan artifact indicates where the model binaries sit"}, "scope": {"allOf": [{"$ref": "#/components/schemas/EntityScopeLevel"}], "nullable": true, "description": "Field that shows the scope in which the model exists"}, "status": {"allOf": [{"$ref": "#/components/schemas/ModelStatus"}], "nullable": true, "description": "the current models status"}, "tags": {"items": {"type": "string"}, "type": "array", "nullable": true, "description": "Tags related to the model"}, "labels": {"items": {"type": "string"}, "type": "array", "nullable": true, "description": "Labels related to the model"}, "configuration": {"allOf": [{"$ref": "#/components/schemas/APIModelConfiguration"}], "nullable": true, "description": "The configuration that the model was created with"}, "inputType": {"allOf": [{"$ref": "#/components/schemas/ModelInputType"}], "nullable": true, "description": "Model Input Type"}, "outputType": {"allOf": [{"$ref": "#/components/schemas/ModelOutputType"}], "nullable": true, "description": "Model Output Type"}, "metadata": {"allOf": [{"$ref": "#/components/schemas/APIModelMetadata"}], "nullable": true}, "moduleName": {"type": "string", "nullable": true, "description": "The module name of the model"}, "app": {"allOf": [{"$ref": "#/components/schemas/IAppDefinition"}], "nullable": true}}, "type": "object", "additionalProperties": true}, "ModelOperationTypes": {"enum": ["train", "predict", "evaluate", "deploy", "embed", "train", "predict", "evaluate", "deploy", "embed"], "type": "string"}, "QueryModel": {"properties": {"resource": {"allOf": [{"$ref": "#/components/schemas/QueryResource"}, {"$ref": "#/components/schemas/QueryResource"}], "nullable": true}, "filter": {"nullable": true}, "sort": {"nullable": true}, "page": {"type": "number", "format": "double", "nullable": true}, "pageSize": {"type": "number", "format": "double", "nullable": true}, "type": {"allOf": [{"$ref": "#/components/schemas/ModelOperationTypes"}], "nullable": true}}, "required": ["filter", "filter"], "type": "object", "additionalProperties": true}, "ExecutionStatus": {"type": "string", "enum": ["created", "in-progress", "failed", "success", "canceled", "rerun"]}, "ExecutionStatusReport": {"properties": {"timestamp": {"type": "string", "format": "date-time"}, "status": {"$ref": "#/components/schemas/ExecutionStatusName"}, "message": {"type": "string"}, "percentComplete": {"type": "number", "format": "double"}, "error": {"$ref": "#/components/schemas/Dictionary", "type": "string"}, "output": {"$ref": "#/components/schemas/Dictionary"}, "action": {"type": "string"}, "replicaId": {"type": "string"}, "replicaType": {"type": "string"}, "skipUpdate": {"type": "boolean"}, "hookResolved": {"type": "boolean"}}, "required": ["timestamp", "status", "message", "percentComplete", "timestamp", "status"], "type": "object", "additionalProperties": false}, "ExecutionPipelineStateReference": {"properties": {"id": {"type": "string"}, "nodeId": {"type": "string"}, "executionId": {"type": "string"}}, "required": ["id", "nodeId", "executionId"], "type": "object", "additionalProperties": true}, "ExecutionModel": {"properties": {"modelOperation": {"type": "string"}, "modelId": {"type": "string"}}, "type": "object"}, "EventResourceType": {"enum": ["items", "annotations", "datasets", "executions", "items.status", "tasks", "assignments", "recipes", "ontologies", "packages", "compositions", "pipelines", "pipeline.run", "services", "triggers", "models", "settings", "projects", "users", "groups", "trigger_cmds", "orgs", "projectGuests", "integrations", "apps", "dpk", "billingResources", "subscriptions", "accounts", "drivers", "annotations.status"], "type": "string"}, "ItemStatusEvent": {"properties": {"action": {"type": "string"}, "status": {"properties": {"timestamp": {"type": "string"}, "creator": {"type": "string"}, "status": {"type": "string"}, "assignmentId": {"type": "string"}, "taskId": {"type": "string"}}, "type": "object", "required": ["timestamp", "creator", "status", "assignmentId", "taskId"]}, "nodeId": {"type": "string"}, "pipelineId": {"type": "string"}}, "type": "object", "required": ["action", "status", "nodeId", "pipelineId"]}, "ExecutionEventContext": {"properties": {"resource": {"$ref": "#/components/schemas/ResourceType"}, "source": {"type": "string", "$ref": "#/components/schemas/RequestSource"}, "action": {"type": "string"}, "resourceId": {"type": "string"}, "userId": {"type": "string"}, "datasetId": {"type": "string"}, "projectId": {"type": "string"}, "body": {}, "itemStatusEvent": {"$ref": "#/components/schemas/ItemStatusEvent"}}, "type": "object", "additionalProperties": false}, "IDate": {"anyOf": [{"type": "string", "format": "date-time"}, {"type": "number", "format": "double"}, {"type": "string"}]}, "JssdkDictionary": {"properties": {}, "additionalProperties": {}, "type": "object", "description": "A dictionary is a simple object that can be used to store key-value pairs."}, "Execution": {"properties": {"id": {"type": "string", "description": "A globally unique identifier for the Entity."}, "clientId": {"type": "string", "description": "A local identifier for the Entity, unique within the client."}, "creator": {"type": "string", "description": "The creator of the Entity."}, "createdAt": {"type": "string", "format": "date-time", "description": "The date and time when the Entity was created."}, "updatedAt": {"type": "string", "format": "date-time", "description": "The date and time when the Entity was last updated."}, "updatedBy": {"type": "string", "description": "The user who last updated the Entity."}, "attempts": {"type": "number", "format": "double"}, "maxAttempts": {"type": "number", "format": "double"}, "toTerminate": {"type": "boolean"}, "input": {"$ref": "#/components/schemas/Dictionary"}, "output": {"$ref": "#/components/schemas/Dictionary"}, "feedbackQueue": {"properties": {"routing": {"type": "string"}, "exchange": {"type": "string"}}, "required": ["routing", "exchange"], "type": "object"}, "status": {"items": {"$ref": "#/components/schemas/ExecutionStatusReport"}, "type": "array"}, "statusLog": {"items": {"$ref": "#/components/schemas/ExecutionStatusReport"}, "type": "array"}, "latestStatus": {"$ref": "#/components/schemas/ExecutionStatusReport"}, "duration": {"type": "number", "format": "double"}, "projectId": {"type": "string"}, "functionName": {"type": "string"}, "serviceId": {"type": "string", "$ref": "#/components/schemas/ObjectID"}, "triggerId": {"type": "string", "$ref": "#/components/schemas/ObjectID"}, "serviceName": {"type": "string"}, "packageId": {"type": "string", "$ref": "#/components/schemas/ObjectID"}, "packageName": {"type": "string"}, "packageRevision": {"type": "number", "format": "double", "anyOf": [{"type": "number", "format": "double"}, {"type": "string"}]}, "serviceVersion": {"type": "number", "format": "double", "anyOf": [{"type": "number", "format": "double"}, {"type": "string"}]}, "pipeline": {"$ref": "#/components/schemas/ExecutionPipeline"}, "moduleName": {"type": "string"}, "model": {"$ref": "#/components/schemas/ExecutionModel"}, "eventContext": {"$ref": "#/components/schemas/ExecutionEventContext"}, "_id": {"$ref": "#/components/schemas/ObjectID"}, "authz": {"$ref": "#/components/schemas/AuthZBlock_ExecutionContext_"}, "orgId": {"type": "string"}, "global": {"type": "boolean"}, "resources": {"items": {"$ref": "#/components/schemas/ExecutionResource"}, "type": "array"}, "mode": {"$ref": "#/components/schemas/ExecutionMode"}, "syncReplyTo": {"properties": {"route": {"type": "string"}, "exchange": {"type": "string"}}, "required": ["route", "exchange"], "type": "object"}, "archiveService": {"type": "boolean"}, "app": {"$ref": "#/components/schemas/IAppDefinition"}, "driverId": {"type": "string"}, "hook": {"$ref": "#/components/schemas/ExecutionHook"}, "timeoutSeconds": {"type": "number", "format": "double"}, "deadline": {"type": "string", "format": "date-time"}, "apiHandleTimeout": {"type": "string", "format": "date-time"}, "phase": {"$ref": "#/components/schemas/ExecutionPhase"}, "onReset": {"$ref": "#/components/schemas/OnResetAction"}}, "required": ["id", "createdAt", "updatedAt", "creator", "attempts", "maxAttempts", "toTerminate", "input", "feedbackQueue", "status", "statusLog", "latestStatus", "duration", "projectId", "serviceId", "packageId", "packageName", "packageRevision", "serviceVersion", "_id", "createdAt", "updatedAt", "creator", "attempts", "maxAttempts", "toTerminate", "input", "statusLog", "duration", "projectId", "serviceId", "packageId", "packageName", "packageRevision", "serviceVersion", "authz", "latestStatus", "syncReplyTo", "hook"], "type": "object", "additionalProperties": false}, "Partial_APIEmbedDatasetsSpec_": {"properties": {"datasetIds": {"items": {"type": "string"}, "type": "array"}, "attachTrigger": {"type": "boolean"}, "config": {"properties": {"serviceReference": {"$ref": "#/components/schemas/EntityReference"}, "serviceId": {"type": "string"}, "pipeline": {"$ref": "#/components/schemas/ExecutionPipelineStateReference"}, "serviceConfig": {"$ref": "#/components/schemas/Dictionary"}}, "type": "object"}}, "type": "object", "description": "Make all properties in T optional"}, "Partial_CreateModelRequest_": {"properties": {"name": {"type": "string", "description": "The models name"}, "packageId": {"type": "string", "description": "The model this model is derived from"}, "description": {"type": "string", "nullable": true, "description": "description of the model\ndefault 'My model'"}, "projectId": {"type": "string", "description": "the id of the project the model belongs to"}, "scope": {"allOf": [{"$ref": "#/components/schemas/EntityScopeLevel"}], "nullable": true, "description": "Field that shows the scope in which the model exists\ndefault 'project'"}, "status": {"allOf": [{"$ref": "#/components/schemas/ModelStatus"}], "nullable": true, "description": "the current models status\ndefault ModelStatus.CREATED"}, "tags": {"items": {"type": "string"}, "type": "array", "nullable": true, "description": "Tags related to the model\ndefault []"}, "labels": {"items": {"type": "string"}, "type": "array", "nullable": true, "description": "Labels related to the model"}, "configuration": {"allOf": [{"$ref": "#/components/schemas/APIModelConfiguration"}], "nullable": true, "description": "The configuration that the model was created with\ndefault {}"}, "inputType": {"allOf": [{"$ref": "#/components/schemas/ModelInputType"}], "nullable": true, "description": "Model Input Type\ndefault ModelInputType.IMAGE"}, "outputType": {"allOf": [{"$ref": "#/components/schemas/ModelOutputType"}], "nullable": true, "description": "Model Output Type\ndefault AnnotationType.BOX"}, "datasetId": {"type": "string", "nullable": true, "description": "The datasets id that the model is connected to"}, "artifacts": {"items": {"anyOf": [{"$ref": "#/components/schemas/ItemArtifact"}, {"$ref": "#/components/schemas/LocalArtifact"}]}, "type": "array", "nullable": true, "description": "the artifacts of the model\nan artifact indicates where the model binaries sit"}, "metadata": {"allOf": [{"$ref": "#/components/schemas/APIModelMetadata"}], "nullable": true}, "moduleName": {"type": "string", "nullable": true, "description": "The module name of the model"}, "app": {"allOf": [{"$ref": "#/components/schemas/IAppDefinition"}], "nullable": true}}, "type": "object", "description": "Make all properties in T optional"}, "APICopyEnvironmentSpec": {"properties": {"cloneModelRequest": {"$ref": "#/components/schemas/Partial_CreateModelRequest_"}, "fromDatasetId": {"type": "string"}, "fromProjectId": {"type": "string"}, "cloneDatasetName": {"type": "string"}, "fromDatasetFilter": {"$ref": "#/components/schemas/Dictionary"}, "fromArtifactItemId": {"type": "string", "nullable": true}, "clonedModelId": {"type": "string", "nullable": true}, "clonedBucketItemId": {"type": "string", "nullable": true}, "clonedDatasetId": {"type": "string", "nullable": true}}, "required": ["cloneModelRequest", "fromDatasetId", "fromProjectId", "cloneDatasetName"], "type": "object", "additionalProperties": true}, "ModelJoinMap": {"properties": {}, "type": "object", "additionalProperties": {"properties": {"items": {"items": {}, "type": "array"}, "ids": {"items": {"type": "string"}, "type": "array"}, "modelName": {"type": "string"}}, "required": ["items", "ids", "modelName"], "type": "object"}}, "PrecisionRecallInputRequest": {"properties": {"modelId": {"type": "string", "description": "The model that calculated on it"}, "datasetId": {"type": "string", "description": "The dataset that calculated on it"}, "iouThreshold": {"type": "number", "format": "double", "description": "The iouThreshold of the calculation"}, "metric": {"type": "string", "description": "The metric to calculation the confusion Matrix"}}, "required": ["modelId", "datasetId", "iouThreshold"], "type": "object", "additionalProperties": true}, "Error": {"properties": {"name": {"type": "string"}, "message": {"type": "string"}, "stack": {"type": "string"}}, "required": ["name", "message"], "type": "object", "additionalProperties": true}, "LineData": {"properties": {"y": {"type": "number", "format": "double"}, "x": {"type": "number", "format": "double"}}, "required": ["y", "x"], "type": "object"}, "MatrixData": {"properties": {"matrix": {"items": {"items": {"type": "number", "format": "double"}, "type": "array"}, "type": "array"}}, "required": ["matrix"], "type": "object"}, "SummaryData": {"properties": {"summary": {"$ref": "#/components/schemas/Dictionary"}}, "required": ["summary"], "type": "object"}, "MetricData": {"anyOf": [{"$ref": "#/components/schemas/LineData"}, {"$ref": "#/components/schemas/MatrixData"}, {"$ref": "#/components/schemas/SummaryData"}]}, "MetricRequest": {"properties": {"modelId": {"type": "string", "description": "The model the metric was generated on"}, "datasetId": {"type": "string", "description": "The dataset the metric was generated on"}, "figure": {"type": "string", "description": "The figure of the metric"}, "legend": {"type": "string", "description": "The legend of the metric"}, "data": {"$ref": "#/components/schemas/MetricData", "description": "The metric data"}}, "required": ["modelId", "figure", "data"], "type": "object", "additionalProperties": true}, "PrivateRegistry": {"properties": {}, "type": "object", "additionalProperties": false}, "ServiceDriver": {"properties": {"privateRegistry": {"$ref": "#/components/schemas/PrivateRegistry"}}, "required": ["privateRegistry"], "type": "object", "additionalProperties": false}, "AutoscalersDriverZombies": {"properties": {"autoscalersName": {"items": {"type": "string"}, "type": "array"}, "namespace": {"type": "string"}, "driver": {"$ref": "#/components/schemas/ServiceDriver"}}, "required": ["autoscalersName", "namespace", "driver"], "type": "object"}, "APIWebHook": {"properties": {"id": {"type": "string"}, "url": {"type": "string"}, "project": {"type": "string"}, "creator": {"type": "string"}, "createdAt": {"type": "string", "format": "date-time"}, "updatedAt": {"type": "string", "format": "date-time"}, "name": {"type": "string"}, "httpMethod": {"type": "string"}, "hookUrl": {"type": "string"}}, "required": ["id", "url", "project", "creator", "createdAt", "updatedAt", "name", "httpMethod", "hookUrl"], "type": "object", "additionalProperties": false}, "WebHooksPage": {"properties": {"totalItemsCount": {"type": "number", "format": "double"}, "items": {"items": {"$ref": "#/components/schemas/APIWebHook"}, "type": "array"}, "totalPagesCount": {"type": "number", "format": "double"}, "hasNextPage": {"type": "boolean"}}, "required": ["totalItemsCount", "items", "totalPagesCount", "hasNextPage"], "type": "object", "additionalProperties": false}, "CreateWebHookDTO": {"properties": {"name": {"type": "string"}, "project": {"type": "string"}, "httpMethod": {"type": "string", "enum": ["GET", "POST"]}, "hookUrl": {"type": "string"}}, "required": ["name", "project", "httpMethod", "hookUrl"], "type": "object", "additionalProperties": false}, "UpdateWebHookDTO": {"properties": {"name": {"type": "string"}, "project": {"type": "string"}, "httpMethod": {"type": "string", "enum": ["GET", "POST"]}, "hookUrl": {"type": "string"}}, "type": "object", "additionalProperties": false}, "ServiceRuntime": {"properties": {"concurrency": {"type": "number", "format": "double"}, "singleAgent": {"type": "boolean"}}, "type": "object", "additionalProperties": false}, "ServiceVersions": {"properties": {"app": {"type": "string"}, "dtlpy": {"type": "string"}}, "required": ["dtlpy"], "type": "object", "additionalProperties": false}, "OnResetAction": {"enum": ["rerun", "failed"], "type": "string"}, "Panel": {"properties": {"name": {"type": "string"}, "role": {"$ref": "#/components/schemas/Role"}}, "required": ["name", "role"], "type": "object", "additionalProperties": false}, "IServiceAppConfig": {"properties": {"isCustomServer": {"type": "boolean"}}, "type": "object", "additionalProperties": false}, "ServiceType": {"enum": ["system", "regular", "system", "regular"], "type": "string"}, "CrashloopAction": {"enum": ["deactivate"], "type": "string"}, "CrashloopReason": {"enum": ["depletion"], "type": "string"}, "Crashloop": {"properties": {"time": {"type": "string", "format": "date-time"}, "action": {"$ref": "#/components/schemas/CrashloopAction"}, "reason": {"$ref": "#/components/schemas/CrashloopReason"}}, "required": ["time", "action"], "type": "object", "additionalProperties": false}, "ServiceModeType": {"enum": ["debug", "regular"], "type": "string"}, "ServiceMode": {"properties": {"type": {"$ref": "#/components/schemas/ServiceModeType"}}, "required": ["type"], "type": "object", "additionalProperties": false}, "SystemRefs": {"properties": {"refs": {"items": {"$ref": "#/components/schemas/EntityReference"}, "type": "array"}, "errors": {"$ref": "#/components/schemas/Dictionary"}}, "type": "object", "additionalProperties": false}, "ServiceMetadata": {"properties": {"user": {"allOf": [{"properties": {"fetchExecutionsFromApi": {"type": "boolean"}}, "type": "object"}, {"$ref": "#/components/schemas/Dictionary"}]}, "ml": {"properties": {"modelOperation": {"type": "string"}, "modelId": {"type": "string"}}, "type": "object"}, "system": {"allOf": [{"properties": {"dynamicConcurrency": {"type": "boolean"}, "fetchExecutionsFromApi": {"type": "boolean"}}, "type": "object"}, {"$ref": "#/components/schemas/SystemRefs"}, {"$ref": "#/components/schemas/Dictionary"}]}}, "type": "object", "additionalProperties": false}, "IServiceGeneralSettings": {"properties": {"autoUpdate": {"type": "boolean"}}, "type": "object", "additionalProperties": false}, "ServiceIntegration": {"properties": {"key": {"type": "string"}, "type": {"type": "string"}, "env": {"type": "string"}, "value": {"type": "string"}, "optional": {"type": "boolean"}, "description": {"type": "string"}, "displayName": {"type": "string"}, "to": {"type": "string"}}, "required": ["key"], "type": "object", "additionalProperties": false}, "APIService": {"properties": {"id": {"type": "string"}, "url": {"type": "string"}, "packageId": {"type": "string"}, "appId": {"type": "string"}, "packageRevision": {"type": "string"}, "initParams": {}, "runtime": {"$ref": "#/components/schemas/ServiceRuntime"}, "useUserJwt": {"type": "boolean"}, "botUserName": {"type": "string"}, "versions": {"$ref": "#/components/schemas/ServiceVersions"}, "moduleName": {"type": "string"}, "global": {"type": "boolean"}, "active": {"type": "boolean"}, "runExecutionAsProcess": {"type": "boolean"}, "executionTimeout": {"type": "number", "format": "double"}, "drainTime": {"type": "number", "format": "double"}, "onReset": {"$ref": "#/components/schemas/OnResetAction"}, "name": {"type": "string"}, "projectId": {"type": "string"}, "driverId": {"type": "string"}, "version": {"type": "string"}, "createdAt": {"type": "string", "format": "date-time"}, "updatedAt": {"type": "string", "format": "date-time"}, "creator": {"type": "string"}, "maxAttempts": {"type": "number", "format": "double"}, "secrets": {"items": {"type": "string"}, "type": "array"}, "panels": {"items": {"$ref": "#/components/schemas/Panel"}, "type": "array"}, "config": {"$ref": "#/components/schemas/IServiceAppConfig"}, "type": {"$ref": "#/components/schemas/ServiceType"}, "crashloop": {"$ref": "#/components/schemas/Crashloop"}, "mode": {"$ref": "#/components/schemas/ServiceMode"}, "metadata": {"$ref": "#/components/schemas/ServiceMetadata"}, "updatedBy": {"type": "string"}, "archive": {"type": "boolean"}, "settings": {"$ref": "#/components/schemas/IServiceGeneralSettings"}, "displayName": {"type": "string"}, "app": {"$ref": "#/components/schemas/IAppDefinition"}, "integrations": {"items": {"$ref": "#/components/schemas/ServiceIntegration"}, "type": "array"}, "orgId": {"type": "string"}}, "required": ["id", "url", "packageId", "initParams", "runtime", "useUserJwt", "botUserName", "versions", "moduleName", "runExecutionAsProcess", "executionTimeout", "drainTime", "onReset", "name", "projectId", "driverId", "version", "createdAt", "updatedAt", "creator"], "type": "object", "additionalProperties": false}, "PackageResourceType": {"enum": ["Dataset", "Item", "Annotation", "Execution", "Task", "Assignment", "Service", "Package", "Project", "Json", "String", "Number", "Integer", "Float", "Boolean", "Model", "Recipe", "Dataset[]", "Item[]", "Annotation[]", "Execution[]", "Task[]", "Assignment[]", "Service[]", "Package[]", "Project[]", "Json[]", "String[]", "Number[]", "Integer[]", "Float[]", "Boolean[]", "Model[]", "Recipe[]", "Vector[]"], "type": "string"}, "ExecutionHookValueFrom": {"enum": ["execution", "command"], "type": "string"}, "ExecutionHookType": {"enum": ["command"], "type": "string"}, "ExecutionHook": {"properties": {"index": {"type": "number", "format": "double"}, "type": {"$ref": "#/components/schemas/ExecutionHookType"}, "commandOutputPath": {"type": "string"}, "valueFrom": {"$ref": "#/components/schemas/ExecutionHookValueFrom"}}, "required": ["type", "valueFrom"], "type": "object"}, "PackageIO": {"properties": {"type": {"$ref": "#/components/schemas/PackageResourceType"}, "name": {"type": "string"}, "actions": {"items": {"type": "string"}, "type": "array"}, "description": {"type": "string"}, "mandatory": {"type": "boolean"}, "integration": {"properties": {"type": {"type": "string"}}, "required": ["type"], "type": "object"}, "value": {}, "hook": {"$ref": "#/components/schemas/ExecutionHook"}}, "required": ["type", "name"], "type": "object", "additionalProperties": false}, "UiBindingResource": {"enum": ["annotation", "item", "dataset", "datasetQuery", "project", "task", "assignment"], "type": "string"}, "UiBindingPanel": {"enum": ["browser", "studio", "table", "all"], "type": "string"}, "DisplayScope": {"properties": {"resource": {"$ref": "#/components/schemas/UiBindingResource"}, "filter": {"$ref": "#/components/schemas/Dictionary"}, "panel": {"$ref": "#/components/schemas/UiBindingPanel"}}, "required": ["resource", "filter"], "type": "object", "additionalProperties": false}, "ExecutionPostActionType": {"enum": ["download", "drawAnnotation", "noAction"], "type": "string"}, "ExecutionPostAction": {"properties": {"type": {"$ref": "#/components/schemas/ExecutionPostActionType"}}, "required": ["type"], "type": "object", "additionalProperties": false}, "DLFunctionDefaultInputSpec": {"properties": {"name": {"type": "string"}, "value": {}}, "required": ["name", "value"], "type": "object", "additionalProperties": false}, "DLFunctionInputOptionsSpec": {"properties": {"name": {"type": "string"}, "values": {"items": {}, "type": "array"}}, "required": ["name", "values"], "type": "object", "additionalProperties": false}, "DLFunction": {"properties": {"name": {"type": "string"}, "input": {"items": {"$ref": "#/components/schemas/PackageIO"}, "type": "array"}, "output": {"items": {"$ref": "#/components/schemas/PackageIO"}, "type": "array"}, "description": {"type": "string"}, "displayName": {"type": "string"}, "displayIcon": {"type": "string"}, "displayScopes": {"items": {"$ref": "#/components/schemas/DisplayScope"}, "type": "array"}, "postAction": {"$ref": "#/components/schemas/ExecutionPostAction"}, "defaultInputs": {"items": {"$ref": "#/components/schemas/DLFunctionDefaultInputSpec"}, "type": "array"}, "inputOptions": {"items": {"$ref": "#/components/schemas/DLFunctionInputOptionsSpec"}, "type": "array"}, "computeConfig": {"type": "string"}}, "required": ["name"], "type": "object", "additionalProperties": false}, "ExecutionStatusName": {"enum": ["created", "in-progress", "failed", "success", "canceled", "aborted", "rerun", "system-failure"], "type": "string"}, "IPipelineExecution": {"properties": {"id": {"type": "string"}, "nodeId": {"type": "string"}, "executionId": {"type": "string"}, "archived": {"type": "boolean"}}, "required": ["id", "nodeId", "executionId"], "type": "object", "additionalProperties": false}, "ResourceType": {"enum": ["items", "annotations", "datasets", "executions", "items.status", "tasks", "assignments", "recipes", "ontologies", "packages", "compositions", "pipelines", "pipeline.run", "services", "triggers", "models", "settings", "projects", "users", "groups", "trigger_cmds", "orgs", "projectGuests", "integrations", "apps", "dpk", "billingResources", "subscriptions", "accounts", "drivers", "annotations.status"], "type": "string"}, "APIExecution": {"properties": {"id": {"type": "string"}, "url": {"type": "string"}, "createdAt": {"type": "string", "format": "date-time"}, "updatedAt": {"type": "string", "format": "date-time"}, "creator": {"type": "string"}, "attempts": {"type": "number", "format": "double"}, "maxAttempts": {"type": "number", "format": "double"}, "toTerminate": {"type": "boolean"}, "input": {"$ref": "#/components/schemas/Dictionary"}, "output": {"$ref": "#/components/schemas/Dictionary"}, "status": {"items": {"$ref": "#/components/schemas/ExecutionStatusReport"}, "type": "array"}, "statusLog": {"items": {"$ref": "#/components/schemas/ExecutionStatusReport"}, "type": "array"}, "latestStatus": {"$ref": "#/components/schemas/ExecutionStatusReport"}, "duration": {"type": "number", "format": "double"}, "projectId": {"type": "string"}, "functionName": {"type": "string"}, "serviceId": {"type": "string"}, "triggerId": {"type": "string"}, "serviceName": {"type": "string", "description": "The service name where the execution was executed"}, "moduleName": {"type": "string", "description": "The module containing the function code"}, "packageId": {"type": "string"}, "packageName": {"type": "string"}, "packageRevision": {"anyOf": [{"type": "number", "format": "double"}, {"type": "string"}]}, "serviceVersion": {"anyOf": [{"type": "number", "format": "double"}, {"type": "string"}]}, "pipeline": {"$ref": "#/components/schemas/IPipelineExecution", "description": "The pipeline details - If the execution came from the pipeline flow\notherwise it will not exist"}, "model": {"$ref": "#/components/schemas/ExecutionModel"}, "syncReplyTo": {"properties": {"route": {"type": "string"}, "exchange": {"type": "string"}}, "required": ["route", "exchange"], "type": "object", "description": "Used when running execution in sync mode"}, "eventContext": {"$ref": "#/components/schemas/ExecutionEventContext"}, "archiveService": {"type": "boolean", "description": "Archive the service after the execution is done (mode = ExecutionMode.ONCE)"}, "app": {"$ref": "#/components/schemas/IAppDefinition"}, "driverId": {"type": "string"}, "hook": {"$ref": "#/components/schemas/ExecutionHook"}, "timeoutSeconds": {"type": "number", "format": "double"}, "deadline": {"type": "string", "format": "date-time"}}, "required": ["id", "url", "createdAt", "updatedAt", "creator", "attempts", "maxAttempts", "toTerminate", "input", "status", "statusLog", "latestStatus", "duration", "projectId", "serviceId", "packageId", "packageName", "packageRevision", "serviceVersion", "syncReplyTo"], "type": "object", "additionalProperties": false}, "UiSlot": {"properties": {"moduleName": {"type": "string"}, "functionName": {"type": "string"}, "displayName": {"type": "string"}, "displayScopes": {"items": {"$ref": "#/components/schemas/DisplayScope"}, "type": "array"}, "postAction": {"$ref": "#/components/schemas/ExecutionPostAction"}, "displayIcon": {"type": "string"}, "defaultInputs": {"items": {"$ref": "#/components/schemas/DLFunctionDefaultInputSpec"}, "type": "array"}, "inputOptions": {"items": {"$ref": "#/components/schemas/DLFunctionInputOptionsSpec"}, "type": "array"}}, "required": ["moduleName", "functionName", "displayName", "displayScopes", "postAction"], "type": "object", "additionalProperties": false}, "ActivitiesDescriptor_": {"properties": {}, "type": "object", "additionalProperties": {"properties": {"functions": {"properties": {}, "additionalProperties": {"properties": {"slot": {"$ref": "#/components/schemas/UiSlot"}, "executions": {"items": {"$ref": "#/components/schemas/APIExecution"}, "type": "array"}, "func": {"$ref": "#/components/schemas/DLFunction"}}, "required": ["executions", "func"], "type": "object"}, "type": "object"}, "service": {"$ref": "#/components/schemas/APIService"}}, "required": ["functions", "service"], "type": "object"}}, "TriggerType": {"enum": ["Event", "Cron"], "type": "string"}, "EntityReferenceMetadata": {"properties": {"system": {"$ref": "#/components/schemas/SystemRefs"}}, "type": "object", "additionalProperties": false}, "APITrigger": {"properties": {"id": {"type": "string"}, "url": {"type": "string"}, "type": {"$ref": "#/components/schemas/TriggerType"}, "createdAt": {"type": "string", "format": "date-time"}, "updatedAt": {"type": "string", "format": "date-time"}, "creator": {"type": "string"}, "name": {"type": "string"}, "projectId": {"type": "string"}, "active": {"type": "boolean"}, "metadata": {"$ref": "#/components/schemas/EntityReferenceMetadata"}, "updatedBy": {"type": "string"}}, "required": ["id", "url", "type", "createdAt", "updatedAt", "creator", "name", "projectId", "active"], "type": "object", "additionalProperties": false}, "TriggersPage": {"properties": {"totalItemsCount": {"type": "number", "format": "double"}, "items": {"items": {"$ref": "#/components/schemas/APITrigger"}, "type": "array"}, "totalPagesCount": {"type": "number", "format": "double"}, "hasNextPage": {"type": "boolean"}}, "required": ["totalItemsCount", "items", "totalPagesCount", "hasNextPage"], "type": "object", "additionalProperties": false}, "CreateTriggerRequest": {"properties": {"type": {"$ref": "#/components/schemas/TriggerType"}, "name": {"type": "string"}, "projectId": {"type": "string"}, "active": {"type": "boolean"}}, "required": ["type", "name", "projectId", "active"], "type": "object", "additionalProperties": false}, "TriggerResourceInformationItem": {"properties": {"serviceId": {"type": "string"}, "serviceName": {"type": "string"}, "triggerId": {"type": "string"}, "triggerActions": {"items": {"type": "string"}, "type": "array"}, "packageModuleName": {"type": "string"}, "packageFunctionName": {"type": "string"}, "packageFunctionDescription": {"type": "string"}}, "required": ["serviceId", "serviceName", "triggerId", "triggerActions", "packageModuleName", "packageFunctionName", "packageFunctionDescription"], "type": "object", "additionalProperties": false}, "TriggerResourceInformationPage": {"properties": {"totalItemsCount": {"type": "number", "format": "double"}, "items": {"items": {"$ref": "#/components/schemas/TriggerResourceInformationItem"}, "type": "array"}, "totalPagesCount": {"type": "number", "format": "double"}, "hasNextPage": {"type": "boolean"}}, "required": ["totalItemsCount", "items", "totalPagesCount", "hasNextPage"], "type": "object", "additionalProperties": false}, "TriggerResourceInformationQuery": {"properties": {"resource": {"type": "string"}, "entity": {}, "action": {"type": "string"}}, "required": ["resource", "entity", "action"], "type": "object", "additionalProperties": false}, "AgentNotificationPayload": {"properties": {"action": {"type": "string"}, "message": {"type": "string"}, "notificationName": {"type": "string"}, "notificationPath": {"type": "string"}, "agentInfo": {"properties": {"replicaId": {"type": "string"}}, "additionalProperties": {}, "type": "object"}}, "required": ["action"], "type": "object", "additionalProperties": false}, "ECacheMode": {"enum": ["apply", "destroy", "get", "apply-filestore"], "type": "string"}, "FaaSCacheSize": {"enum": ["large", "medium", "small"], "type": "string"}, "FaaSCacheType": {"enum": ["ssd", "standard"], "type": "string"}, "ICacheRunner": {"properties": {"redisHost": {"type": "string"}, "numReplicas": {"type": "number", "format": "double"}, "size": {"$ref": "#/components/schemas/FaaSCacheSize"}, "type": {"$ref": "#/components/schemas/FaaSCacheType"}, "minReplica": {"type": "number", "format": "double"}, "maxReplica": {"type": "number", "format": "double"}}, "required": ["redisHost", "numReplicas", "size", "type", "minReplica", "maxReplica"], "type": "object", "additionalProperties": false}, "ICacheOptions": {"properties": {"org": {"properties": {"id": {"type": "string"}, "name": {"type": "string"}}, "required": ["id", "name"], "type": "object"}, "driverId": {"type": "string"}, "runner": {"$ref": "#/components/schemas/ICacheRunner"}}, "required": ["org"], "type": "object", "additionalProperties": false}, "ServicesPage": {"properties": {"totalItemsCount": {"type": "number", "format": "double"}, "items": {"items": {"$ref": "#/components/schemas/APIService"}, "type": "array"}, "totalPagesCount": {"type": "number", "format": "double"}, "hasNextPage": {"type": "boolean"}}, "required": ["totalItemsCount", "items", "totalPagesCount", "hasNextPage"], "type": "object", "additionalProperties": false}, "APIServicePatch": {"properties": {"packageRevision": {"type": "string"}, "initParams": {}, "runtime": {"$ref": "#/components/schemas/ServiceRuntime"}, "useUserJwt": {"type": "boolean"}, "versions": {"$ref": "#/components/schemas/ServiceVersions"}, "moduleName": {"type": "string"}, "global": {"type": "boolean"}, "active": {"type": "boolean"}, "runExecutionAsProcess": {"type": "boolean"}, "executionTimeout": {"type": "number", "format": "double"}, "drainTime": {"type": "number", "format": "double"}, "onReset": {"type": "string"}, "maxAttempts": {"type": "number", "format": "double"}, "version": {"type": "string"}, "botUserName": {"type": "string"}, "driverId": {"type": "string"}, "secrets": {"items": {"type": "string"}, "type": "array"}, "type": {"$ref": "#/components/schemas/ServiceType"}, "mode": {"$ref": "#/components/schemas/ServiceMode"}, "metadata": {"$ref": "#/components/schemas/ServiceMetadata"}, "panels": {"items": {"$ref": "#/components/schemas/Panel"}, "type": "array"}, "packageId": {"type": "string"}, "packageName": {"type": "string"}, "archive": {"type": "boolean"}, "displayName": {"type": "string"}, "app": {"$ref": "#/components/schemas/IAppDefinition"}, "integrations": {"items": {"$ref": "#/components/schemas/ServiceIntegration"}, "type": "array"}}, "type": "object", "additionalProperties": false}, "ServiceLogLevel": {"enum": ["CRITICAL", "ERROR", "WARNING", "INFO", "DEBUG"], "type": "string"}, "ServiceLogEntry": {"properties": {"message": {"type": "string"}, "timestamp": {}, "replicaId": {"type": "string"}, "executionId": {"type": "string"}, "functionName": {"type": "string"}, "level": {"$ref": "#/components/schemas/ServiceLogLevel"}, "modelId": {"type": "string"}, "modelOperation": {"type": "string"}, "serviceId": {"type": "string"}, "projectId": {"anyOf": [{"type": "string"}, {"items": {"type": "string"}, "type": "array"}]}, "pipelineId": {"type": "string"}, "nodeId": {"type": "string"}, "pipelineExecutionId": {"type": "string"}}, "required": ["message", "timestamp", "replicaId"], "type": "object", "additionalProperties": false}, "ServiceLogsPage": {"properties": {"logs": {"items": {"$ref": "#/components/schemas/ServiceLogEntry"}, "type": "array"}, "stop": {"type": "boolean"}, "checkpoint": {"type": "string"}}, "required": ["logs", "stop"], "type": "object", "additionalProperties": false}, "LogsListDirection": {"enum": ["asc", "desc"], "type": "string"}, "LogQuery": {"properties": {"serviceId": {"type": "string"}, "follow": {"type": "boolean"}, "size": {"type": "number", "format": "double"}, "checkpoint": {"type": "string"}, "direction": {"$ref": "#/components/schemas/LogsListDirection"}, "start": {"type": "string", "format": "date-time"}, "end": {"type": "string", "format": "date-time"}, "executionId": {"anyOf": [{"type": "string"}, {"items": {"type": "string"}, "type": "array"}]}, "functionName": {"type": "string"}, "replicaId": {"type": "string"}, "text": {"anyOf": [{"type": "string"}, {"items": {"type": "string"}, "type": "array"}]}, "logLevel": {"$ref": "#/components/schemas/ServiceLogLevel"}, "pipelineId": {"type": "string"}, "nodeId": {"type": "string"}, "pipelineExecutionId": {"type": "string"}, "system": {"type": "boolean"}, "projectId": {"anyOf": [{"type": "string"}, {"items": {"type": "string"}, "type": "array"}]}, "modelId": {"type": "string"}, "modelOperation": {"type": "string"}, "includeServiceLevel": {"type": "boolean"}}, "type": "object", "additionalProperties": false}, "ReplicaStatus": {"enum": ["down", "initializing", "running", "full", "terminating", "failed", "paused"], "type": "string"}, "APIReplicaStatusUpdate": {"properties": {"replicaId": {"type": "string"}, "status": {"$ref": "#/components/schemas/ReplicaStatus"}, "numRestarts": {"type": "number", "format": "double"}, "uptime": {"type": "number", "format": "double"}}, "required": ["replicaId", "status", "numRestarts", "uptime"], "type": "object", "additionalProperties": false}, "ReplicaReason": {"enum": ["ContainerCreating", "CrashLoopBackOff", "ErrImagePull", "ImagePullBackOff", "CreateContainerConfigError", "InvalidImageName", "CreateContainerError", "Unschedulable", "Pending", "OOMKilled", "Error", "Completed", "ContainerCannotRun", "DeadlineExceeded", "NodeLost", "Evicted", "UnexpectedAdmissionError", "NodeAffinity", "Shutdown"], "type": "string"}, "ServiceRuntimeStatus": {"properties": {"replicaId": {"type": "string"}, "status": {"type": "boolean"}, "createdAt": {"type": "string", "format": "date-time"}, "reason": {"$ref": "#/components/schemas/ReplicaReason"}, "message": {"type": "string"}, "restartCount": {"type": "number", "format": "double"}, "lastRestartTime": {"type": "string", "format": "date-time"}}, "required": ["replicaId", "status"], "type": "object", "additionalProperties": false}, "APIServiceStatus": {"properties": {"numMessagesInQueue": {"type": "number", "format": "double"}, "runtimeStatus": {"items": {"$ref": "#/components/schemas/ServiceRuntimeStatus"}, "type": "array"}}, "required": ["numMessagesInQueue", "runtimeStatus"], "type": "object", "additionalProperties": false}, "EDebugOptionsStatus": {"enum": ["placed", "activate", "deactivate"], "type": "string"}, "DebugSession": {"properties": {"serveDebugIngressCreated": {"type": "boolean", "description": "Server-only: set after first successful debug ingress create (ACTIVATE may poll frequently)"}, "time": {"type": "string", "format": "date-time"}, "status": {"$ref": "#/components/schemas/EDebugOptionsStatus"}}, "required": ["status"], "type": "object"}, "ReportType": {"enum": ["serviceStatus", "executionStatus"], "type": "string"}, "BaseReportMessage": {"properties": {"type": {"$ref": "#/components/schemas/ReportType"}, "serviceId": {"type": "string"}, "timestamp": {"type": "string", "format": "date-time"}, "replicaId": {"type": "string"}, "replicaType": {"type": "string"}}, "required": ["type", "serviceId", "timestamp"], "type": "object", "additionalProperties": false}, "IServiceScaler": {"properties": {"pendingMessages": {"type": "number", "format": "double"}}, "required": ["pendingMessages"], "type": "object", "additionalProperties": false}, "ServiceDriverType": {"enum": ["Kubernetes", "Fargate-EKS", "Mock", "Noop"], "type": "string"}, "IComputeContext": {"properties": {"org": {"type": "string"}, "project": {"type": "string"}}, "required": ["org"], "type": "object", "additionalProperties": false}, "DataloopPodType": {"enum": ["regular-xs", "regular-s", "regular-m", "regular-l", "highmem-xs", "highmem-s", "highmem-m", "highmem-l", "gpu-t4", "gpu-t4-m", "gpu-a100-s", "gpu-a100-4g", "gpu-a100-4g-m"], "type": "string"}, "DriverCondition": {"properties": {"value": {}, "path": {"type": "string"}}, "required": ["value", "path"], "type": "object"}, "DriverToleration": {"properties": {"conditions": {"properties": {"and": {"items": {"$ref": "#/components/schemas/DriverCondition"}, "type": "array"}, "or": {"items": {"$ref": "#/components/schemas/DriverCondition"}, "type": "array"}}, "type": "object"}, "effect": {"type": "string"}, "operator": {"type": "string"}, "value": {"type": "string"}, "name": {"type": "string"}}, "required": ["value", "name"], "type": "object"}, "DriverNodeSelector": {"properties": {"conditions": {"properties": {"and": {"items": {"$ref": "#/components/schemas/DriverCondition"}, "type": "array"}, "or": {"items": {"$ref": "#/components/schemas/DriverCondition"}, "type": "array"}}, "type": "object"}, "value": {"type": "string"}, "key": {"type": "string"}}, "required": ["value", "key"], "type": "object"}, "CacheRunner": {"properties": {"redisHost": {"type": "string"}, "numReplicas": {"type": "number", "format": "double"}, "size": {"$ref": "#/components/schemas/FaaSCacheSize"}, "type": {"$ref": "#/components/schemas/FaaSCacheType"}, "minReplica": {"type": "number", "format": "double"}, "maxReplica": {"type": "number", "format": "double"}}, "required": ["redisHost", "numReplicas", "size", "type", "minReplica", "maxReplica"], "type": "object", "additionalProperties": false}, "ComputeMetadata": {"allOf": [{"$ref": "#/components/schemas/Dictionary"}, {"properties": {"serveAgentGateway": {"type": "string", "enum": ["nginx-gateway", "direct"], "description": "Tracks which gateway was last deployed in front of serve-agent.\nUsed to cleanup the previous gateway when switching between Nginx gateway and direct access."}, "serveAgentServiceType": {"type": "string"}, "serveAgentInternalLoadBalancer": {"type": "boolean"}, "serveAgentDNS": {"type": "string"}, "cacheRunnerFS": {"type": "string"}, "filestoreServer": {"type": "string"}, "cacheRunner": {"$ref": "#/components/schemas/CacheRunner"}, "nfsServer": {"type": "string"}, "agentScriptUpdatedTime": {"type": "string"}, "nodeSelector": {"items": {"$ref": "#/components/schemas/DriverNodeSelector"}, "type": "array"}, "tolerations": {"items": {"$ref": "#/components/schemas/DriverToleration"}, "type": "array"}, "allowedInstances": {"items": {"$ref": "#/components/schemas/DataloopPodType"}, "type": "array"}, "serveAgentIP": {"type": "string"}, "serveAgentEndpoint": {"type": "string"}}, "type": "object"}]}, "APIServiceDriver": {"properties": {"id": {"type": "string"}, "url": {"type": "string"}, "name": {"type": "string"}, "type": {"$ref": "#/components/schemas/ServiceDriverType"}, "createdAt": {"type": "string", "format": "date-time"}, "updatedAt": {"type": "string", "format": "date-time"}, "context": {"$ref": "#/components/schemas/IComputeContext"}, "namespace": {"type": "string"}, "computeId": {"type": "string"}, "metadata": {"$ref": "#/components/schemas/ComputeMetadata"}, "isCacheAvailable": {"type": "boolean"}, "archived": {"type": "boolean"}}, "required": ["id", "url", "name", "type", "context", "computeId", "isCacheAvailable"], "type": "object", "additionalProperties": false}, "CompositionElementStatus": {"enum": ["uninstalled", "installed", "attached", "failed", "pause", "resume"], "type": "string"}, "APIServiceCompositionElement": {"properties": {"id": {"type": "string"}, "url": {"type": "string"}, "packageId": {"type": "string"}, "appId": {"type": "string"}, "packageRevision": {"type": "string"}, "initParams": {}, "runtime": {"$ref": "#/components/schemas/ServiceRuntime"}, "useUserJwt": {"type": "boolean"}, "botUserName": {"type": "string"}, "versions": {"$ref": "#/components/schemas/ServiceVersions"}, "moduleName": {"type": "string"}, "global": {"type": "boolean"}, "active": {"type": "boolean"}, "runExecutionAsProcess": {"type": "boolean"}, "executionTimeout": {"type": "number", "format": "double"}, "drainTime": {"type": "number", "format": "double"}, "onReset": {"$ref": "#/components/schemas/OnResetAction"}, "name": {"type": "string"}, "projectId": {"type": "string"}, "driverId": {"type": "string"}, "version": {"type": "string"}, "createdAt": {"type": "string", "format": "date-time"}, "updatedAt": {"type": "string", "format": "date-time"}, "creator": {"type": "string"}, "maxAttempts": {"type": "number", "format": "double"}, "secrets": {"items": {"type": "string"}, "type": "array"}, "panels": {"items": {"$ref": "#/components/schemas/Panel"}, "type": "array"}, "config": {"$ref": "#/components/schemas/IServiceAppConfig"}, "type": {"$ref": "#/components/schemas/ServiceType"}, "crashloop": {"$ref": "#/components/schemas/Crashloop"}, "mode": {"$ref": "#/components/schemas/ServiceMode"}, "metadata": {"$ref": "#/components/schemas/ServiceMetadata"}, "updatedBy": {"type": "string"}, "archive": {"type": "boolean"}, "settings": {"$ref": "#/components/schemas/IServiceGeneralSettings"}, "displayName": {"type": "string"}, "app": {"$ref": "#/components/schemas/IAppDefinition"}, "integrations": {"items": {"$ref": "#/components/schemas/ServiceIntegration"}, "type": "array"}, "orgId": {"type": "string"}, "state": {"properties": {"errorDate": {"type": "string", "format": "date-time"}, "errorMessage": {"type": "string"}, "serviceId": {"type": "string"}, "status": {"$ref": "#/components/schemas/CompositionElementStatus"}}, "required": ["status"], "type": "object"}, "packageName": {"type": "string"}, "uiHooks": {"items": {}, "type": "array"}, "shareable": {"type": "boolean"}}, "required": ["id", "url", "packageId", "initParams", "runtime", "useUserJwt", "botUserName", "versions", "moduleName", "runExecutionAsProcess", "executionTimeout", "drainTime", "onReset", "name", "projectId", "driverId", "version", "createdAt", "updatedAt", "creator", "state"], "type": "object", "additionalProperties": false}, "CompositionStatus": {"enum": ["Created", "Initializing", "Installed", "Reconfiguring", "Activated", "Deactivated", "Uninstalled", "Terminating", "Terminated", "Updating", "Failure", "ActiveTest"], "type": "string"}, "ICompositionError": {"properties": {"code": {"type": "string"}, "type": {"type": "string"}, "message": {"type": "string"}, "displayMessage": {"type": "string"}, "context": {"properties": {"traceId": {"type": "string"}, "appId": {"type": "string"}, "pipelineId": {"type": "string"}, "projectId": {"type": "string"}}, "required": ["traceId", "projectId"], "type": "object"}, "support": {"type": "string"}}, "required": ["code", "type", "message", "displayMessage", "context", "support"], "type": "object", "additionalProperties": false}, "TriggerResourceType": {"enum": ["Dataset", "Item", "Annotation", "ItemStatus", "Task", "Assignment", "Model"], "type": "string"}, "TriggerActionType": {"enum": ["Created", "Updated", "Deleted", "statusChanged", "taskAssigned", "Clone"], "type": "string"}, "ExecutionMode": {"enum": ["Once", "Always"], "type": "string"}, "TriggerOperationType": {"enum": ["pipeline", "function", "webhook", "rabbitmq"], "type": "string"}, "TriggerOperation": {"properties": {"type": {"$ref": "#/components/schemas/TriggerOperationType"}}, "required": ["type"], "type": "object", "additionalProperties": false}, "ICompositionTrigger": {"properties": {"type": {"$ref": "#/components/schemas/TriggerType"}, "spec": {"properties": {"input": {"$ref": "#/components/schemas/Dictionary"}, "endAt": {"type": "string", "format": "date-time"}, "startAt": {"type": "string", "format": "date-time"}, "cron": {"type": "string"}, "operation": {"$ref": "#/components/schemas/TriggerOperation"}, "filter": {"type": "string"}, "executionMode": {"$ref": "#/components/schemas/ExecutionMode"}, "actions": {"items": {"$ref": "#/components/schemas/TriggerActionType"}, "type": "array"}, "resource": {"$ref": "#/components/schemas/TriggerResourceType"}}, "type": "object"}, "name": {"type": "string"}, "scope": {"type": "string"}, "global": {"type": "boolean"}, "namespace": {"type": "string"}, "triggerId": {"type": "string"}, "projectId": {"type": "string"}}, "required": ["type", "spec", "name", "projectId"], "type": "object", "additionalProperties": false}, "ECompositionPackageStatus": {"enum": ["installed", "deleted", "placed", "failed"], "type": "string"}, "Partial_Module_": {"properties": {"name": {"type": "string"}, "entryPoint": {"type": "string"}, "className": {"type": "string"}, "initInputs": {"items": {"$ref": "#/components/schemas/PackageIO"}, "type": "array"}, "functions": {"items": {"$ref": "#/components/schemas/DLFunction"}, "type": "array"}}, "type": "object", "description": "Make all properties in T optional"}, "PackageConfigType": {"enum": ["codebase", "code"], "type": "string"}, "PackageRequirementOperator": {"enum": ["==", ">", "<", "<=", ">="], "type": "string"}, "PackageRequirement": {"properties": {"name": {"type": "string"}, "version": {"type": "string"}, "operator": {"$ref": "#/components/schemas/PackageRequirementOperator"}}, "required": ["name"], "type": "object", "additionalProperties": false}, "CodebaseType_": {"enum": ["item", "git", "filesystem", "local"], "type": "string"}, "Codebase": {"properties": {"type": {"$ref": "#/components/schemas/CodebaseType_"}}, "required": ["type"], "type": "object", "additionalProperties": false}, "ICompositionPackage": {"properties": {"state": {"properties": {"status": {"$ref": "#/components/schemas/ECompositionPackageStatus"}}, "required": ["status"], "type": "object"}, "packageId": {"type": "string"}, "codebaseId": {"type": "string"}, "entryFile": {"type": "string"}, "code": {"type": "string"}, "module": {"$ref": "#/components/schemas/Partial_Module_"}, "name": {"type": "string"}, "type": {"$ref": "#/components/schemas/PackageConfigType"}, "requirements": {"items": {"$ref": "#/components/schemas/PackageRequirement"}, "type": "array"}, "codebase": {"$ref": "#/components/schemas/Codebase"}, "nodeId": {"type": "string"}}, "required": ["module", "name"], "type": "object", "additionalProperties": false}, "ICompositionTask": {"properties": {"datasetId": {"type": "string"}, "taskOwner": {"type": "string"}, "recipeId": {"type": "string"}, "name": {"type": "string"}, "dueDate": {"type": "number", "format": "double"}, "state": {"properties": {"taskId": {"type": "string"}, "status": {"$ref": "#/components/schemas/TaskStatus"}}, "required": ["taskId", "status"], "type": "object"}, "metadata": {"$ref": "#/components/schemas/Dictionary"}, "workload": {"items": {"$ref": "#/components/schemas/TaskWorkload"}, "type": "array"}, "availableActions": {"items": {"$ref": "#/components/schemas/ItemAction"}, "type": "array"}, "nodeId": {"type": "string"}, "taskType": {"$ref": "#/components/schemas/TaskType"}, "batchSize": {"type": "number", "format": "double"}, "maxBatchWorkload": {"type": "number", "format": "double"}, "relatedTasks": {"items": {"type": "number", "format": "double"}, "type": "array"}, "identifier": {"type": "number", "format": "double"}, "consensusTaskType": {"type": "string"}, "consensusAssignees": {"type": "number", "format": "double"}, "consensusPercentage": {"type": "number", "format": "double"}, "disableWebm": {"type": "boolean"}, "priority": {"type": "number", "format": "double"}, "groups": {"items": {"type": "string"}, "type": "array"}}, "required": ["datasetId", "taskOwner", "recipeId", "name", "dueDate", "state", "metadata", "nodeId", "taskType"], "type": "object", "additionalProperties": false}, "ModelConfiguration": {"properties": {"label_to_id_map": {"properties": {}, "additionalProperties": {"anyOf": [{"type": "number", "format": "double"}, {"type": "string"}]}, "type": "object"}}, "type": "object", "additionalProperties": false}, "IModel": {"properties": {"id": {"type": "string"}, "name": {"type": "string", "description": "The models name"}, "description": {"type": "string", "description": "description of the model", "default": "My model"}, "scope": {"$ref": "#/components/schemas/EntityScopeLevel", "description": "Field that shows the scope in which the model exists"}, "status": {"$ref": "#/components/schemas/ModelStatus", "description": "the current models status"}, "tags": {"items": {"type": "string"}, "type": "array", "description": "Tags related to the model", "default": []}, "labels": {"items": {"type": "string"}, "type": "array", "description": "Labels related to the model", "default": []}, "configuration": {"$ref": "#/components/schemas/ModelConfiguration", "description": "The configuration that the model was created with"}, "inputType": {"$ref": "#/components/schemas/ModelInputType", "description": "Model Input Type"}, "outputType": {"$ref": "#/components/schemas/ModelOutputType", "description": "Model Output Type"}, "datasetId": {"type": "string", "description": "The datasets id that the model is connected to"}, "artifacts": {"items": {"$ref": "#/components/schemas/Dictionary"}, "type": "array", "description": "the artifacts of the model\nan artifact indicates where the model binaries sit"}, "context": {"$ref": "#/components/schemas/EntityContext", "description": "The context which the model exists in"}, "moduleName": {"type": "string", "description": "The module name of the model"}, "metadata": {"$ref": "#/components/schemas/Dictionary"}, "app": {"$ref": "#/components/schemas/IAppDefinition"}}, "required": ["name", "context"], "type": "object", "additionalProperties": false}, "ICompositionElementState": {"properties": {"status": {"$ref": "#/components/schemas/CompositionElementStatus"}, "serviceId": {"type": "string"}, "executionId": {"type": "string"}, "errorMessage": {"type": "string"}, "errorDate": {"type": "string", "format": "date-time"}}, "required": ["status"], "type": "object", "additionalProperties": false}, "ServiceConfig": {"properties": {"initParams": {}, "runtime": {"$ref": "#/components/schemas/ServiceRuntime"}, "useUserJwt": {"type": "boolean"}, "botUserName": {"type": "string"}, "versions": {"$ref": "#/components/schemas/ServiceVersions"}, "moduleName": {"type": "string"}, "global": {"type": "boolean"}, "active": {"type": "boolean"}, "runExecutionAsProcess": {"type": "boolean"}, "executionTimeout": {"type": "number", "format": "double"}, "onReset": {"type": "string"}, "name": {"type": "string"}, "maxAttempts": {"type": "number", "format": "double"}, "secrets": {"items": {"type": "string"}, "type": "array"}}, "type": "object", "additionalProperties": false}, "APICompositionModel": {"properties": {"model": {"$ref": "#/components/schemas/IModel"}, "state": {"$ref": "#/components/schemas/ICompositionElementState"}, "modelId": {"type": "string"}, "nodeId": {"type": "string"}, "serviceConfig": {"$ref": "#/components/schemas/ServiceConfig"}, "action": {"$ref": "#/components/schemas/ModelOperationTypes"}, "metadata": {"$ref": "#/components/schemas/Dictionary"}, "inputs": {"$ref": "#/components/schemas/Dictionary"}}, "type": "object", "additionalProperties": false}, "ChannelType": {"enum": ["email", "application", "internal"], "type": "string"}, "CompositionChannelStatus": {"enum": ["uninstalled", "failed", "paused", "active", "created"], "type": "string"}, "NotificationEntityContext": {"properties": {"project": {"type": "string"}, "org": {"type": "string"}, "creator": {"type": "string"}}, "required": ["project", "org", "creator"], "type": "object", "additionalProperties": false}, "FilterTarget": {"properties": {"project": {"type": "string"}, "org": {"type": "string"}, "userId": {"type": "string"}}, "type": "object", "additionalProperties": false}, "NotificationEventContext": {"properties": {"project": {"type": "string"}, "org": {"type": "string"}, "pipeline": {"type": "string"}, "service": {"type": "string"}, "node": {"type": "string"}, "taskId": {"type": "string"}, "assignmentId": {"type": "string"}, "userId": {"type": "string"}, "member": {"type": "string"}, "creator": {"type": "string"}, "model": {"type": "string"}, "modelOperation": {"type": "string"}, "package": {"type": "string"}, "cycle": {"type": "string"}, "trigger": {"type": "string"}}, "type": "object", "additionalProperties": false}, "ICompositionFilter": {"properties": {"state": {"properties": {"errorDate": {"type": "string", "format": "date-time"}, "errorMessage": {"type": "string"}, "status": {"$ref": "#/components/schemas/CompositionElementStatus"}, "filterId": {"type": "string"}}, "required": ["status"], "type": "object"}, "target": {"$ref": "#/components/schemas/FilterTarget"}, "notificationCode": {"type": "string"}, "contextMatch": {"$ref": "#/components/schemas/NotificationEventContext"}, "frequency": {"$ref": "#/components/schemas/Dictionary"}, "context": {"$ref": "#/components/schemas/NotificationEntityContext"}, "notificationId": {"type": "string"}, "channelId": {"type": "string"}}, "required": ["frequency", "context"], "type": "object", "additionalProperties": false}, "ICompositionChannel": {"properties": {"name": {"type": "string"}, "icon": {"type": "string"}, "description": {"type": "string"}, "global": {"type": "boolean"}, "type": {"$ref": "#/components/schemas/ChannelType"}, "metadata": {"properties": {"codebase": {"$ref": "#/components/schemas/Codebase"}, "functionName": {"type": "string"}, "serviceName": {"type": "string"}}, "required": ["functionName", "serviceName"], "type": "object"}, "state": {"properties": {"errorDate": {"type": "string", "format": "date-time"}, "errorMessage": {"type": "string"}, "status": {"$ref": "#/components/schemas/CompositionChannelStatus"}, "channelId": {"type": "string"}}, "required": ["status"], "type": "object"}, "context": {"$ref": "#/components/schemas/NotificationEntityContext"}, "filters": {"items": {"$ref": "#/components/schemas/ICompositionFilter"}, "type": "array"}}, "required": ["name", "global", "type", "metadata", "context"], "type": "object", "additionalProperties": false}, "TemplateKind": {"enum": ["project", "global", "org"], "type": "string"}, "INodeConfig": {"properties": {"package": {"properties": {"codebaseFilename": {"type": "string"}, "codebase": {"$ref": "#/components/schemas/Codebase"}, "requirementsFilename": {"type": "string"}, "requirements": {"items": {"$ref": "#/components/schemas/PackageRequirement"}, "type": "array"}, "code": {"type": "string"}, "entryFile": {"type": "string"}, "type": {"$ref": "#/components/schemas/PackageConfigType"}, "name": {"type": "string"}}, "required": ["name"], "type": "object"}}, "type": "object", "additionalProperties": false}, "NodeNamespace": {"properties": {"projectName": {"type": "string"}, "serviceName": {"type": "string"}, "functionName": {"type": "string"}, "moduleName": {"type": "string"}, "packageName": {"type": "string"}}, "required": ["serviceName", "functionName", "moduleName"], "type": "object", "additionalProperties": false}, "PortIO": {"properties": {"type": {"$ref": "#/components/schemas/PackageResourceType"}, "name": {"type": "string"}, "portId": {"type": "string"}, "displayName": {"type": "string"}, "color": {"type": "string"}, "actionIcon": {"type": "string"}, "actions": {"items": {"type": "string"}, "type": "array"}, "portPercentage": {"type": "number", "format": "double"}, "defaultValue": {}, "variableName": {"type": "string"}, "description": {"type": "string"}}, "required": ["type", "name", "portId"], "type": "object", "additionalProperties": false}, "NodeType": {"enum": ["code", "function", "task", "merge", "split", "ml", "storage", "api", "custom", "updateVariable"], "type": "string"}, "PipelineNodeDescriptor": {"properties": {"id": {"type": "string"}, "config": {"$ref": "#/components/schemas/INodeConfig"}, "namespace": {"$ref": "#/components/schemas/NodeNamespace"}, "inputs": {"items": {"$ref": "#/components/schemas/PortIO"}, "type": "array"}, "outputs": {"items": {"$ref": "#/components/schemas/PortIO"}, "type": "array"}, "type": {"$ref": "#/components/schemas/NodeType"}, "projectId": {"type": "string"}, "name": {"type": "string"}, "appName": {"type": "string"}, "dpkName": {"type": "string"}, "metadata": {"$ref": "#/components/schemas/Dictionary"}, "app": {"$ref": "#/components/schemas/IAppDefinition"}}, "required": ["id", "namespace", "inputs", "outputs", "type", "name", "metadata"], "type": "object", "additionalProperties": false}, "PipelineNodeSource": {"properties": {"nodeId": {"type": "string"}, "portId": {"type": "string"}}, "required": ["nodeId", "portId"], "type": "object", "additionalProperties": false}, "PipelineNodeTarget": {"properties": {"nodeId": {"type": "string"}, "portId": {"type": "string"}}, "required": ["nodeId", "portId"], "type": "object", "additionalProperties": false}, "PipelineConnection": {"properties": {"src": {"$ref": "#/components/schemas/PipelineNodeSource"}, "tgt": {"$ref": "#/components/schemas/PipelineNodeTarget"}, "condition": {"type": "string"}, "action": {"type": "string"}}, "required": ["src", "tgt", "condition"], "type": "object", "additionalProperties": false}, "StartNodeType": {"enum": ["root", "trigger"], "type": "string"}, "ITriggerSpec": {"properties": {"type": {"$ref": "#/components/schemas/TriggerType"}, "spec": {"properties": {"input": {"$ref": "#/components/schemas/Dictionary"}, "endAt": {"type": "string", "format": "date-time"}, "startAt": {"type": "string", "format": "date-time"}, "cron": {"type": "string"}, "operation": {"$ref": "#/components/schemas/TriggerOperation"}, "filter": {"type": "string"}, "executionMode": {"$ref": "#/components/schemas/ExecutionMode"}, "actions": {"items": {"$ref": "#/components/schemas/TriggerActionType"}, "type": "array"}, "resource": {"$ref": "#/components/schemas/TriggerResourceType"}}, "type": "object"}, "name": {"type": "string"}, "scope": {"type": "string"}, "global": {"type": "boolean"}}, "required": ["type", "spec"], "type": "object", "additionalProperties": false}, "IStartNode": {"properties": {"id": {"type": "string"}, "nodeId": {"type": "string"}, "type": {"$ref": "#/components/schemas/StartNodeType"}, "trigger": {"$ref": "#/components/schemas/ITriggerSpec"}}, "required": ["id", "nodeId", "type"], "type": "object", "additionalProperties": false}, "ResumePipelineOption": {"enum": ["terminateExistingCycles", "resumeExistingCycles"], "type": "string"}, "IPipelineSettings": {"properties": {"defaultResumeOption": {"$ref": "#/components/schemas/ResumePipelineOption"}, "keepTriggersActive": {"type": "boolean"}, "activeTriggerAskAgain": {"type": "boolean"}, "lastUpdate": {"properties": {"updatedAt": {"type": "string", "format": "date-time"}, "updatedBy": {"type": "string"}}, "required": ["updatedAt", "updatedBy"], "type": "object"}}, "required": ["lastUpdate"], "type": "object", "additionalProperties": false}, "PipelineVariable": {"properties": {"id": {"type": "string"}, "name": {"type": "string"}, "reference": {"type": "string"}, "creator": {"type": "string"}, "value": {}, "type": {"$ref": "#/components/schemas/PackageResourceType"}, "createdAt": {"type": "string", "format": "date-time"}, "updatedAt": {"type": "string", "format": "date-time"}, "description": {"type": "string"}}, "required": ["id", "name", "reference", "creator", "value", "type"], "type": "object", "additionalProperties": false}, "PipelineFromTemplateState": {"enum": ["initial", "dirty"], "type": "string"}, "ICompositionPipelineTemplate": {"properties": {"id": {"type": "string"}, "url": {"type": "string"}, "name": {"type": "string"}, "creator": {"type": "string"}, "createdAt": {"type": "string", "format": "date-time"}, "updatedAt": {"type": "string", "format": "date-time"}, "updatedBy": {"type": "string"}, "projectId": {"type": "string"}, "orgId": {"type": "string"}, "compositionId": {"type": "string"}, "nodes": {"items": {"$ref": "#/components/schemas/PipelineNodeDescriptor"}, "type": "array"}, "connections": {"items": {"$ref": "#/components/schemas/PipelineConnection"}, "type": "array"}, "description": {"type": "string"}, "preview": {"type": "string"}, "startNodes": {"items": {"$ref": "#/components/schemas/IStartNode"}, "type": "array"}, "status": {"$ref": "#/components/schemas/CompositionStatus"}, "settings": {"$ref": "#/components/schemas/IPipelineSettings"}, "variables": {"items": {"$ref": "#/components/schemas/PipelineVariable"}, "type": "array"}, "resetTimestamp": {"type": "string", "format": "date-time"}, "template": {"properties": {"state": {"$ref": "#/components/schemas/PipelineFromTemplateState"}, "id": {"type": "string"}}, "required": ["state", "id"], "type": "object"}, "templateKind": {"$ref": "#/components/schemas/TemplateKind"}, "state": {"properties": {"errorDate": {"type": "string", "format": "date-time"}, "errorMessage": {"type": "string"}, "pipelineId": {"type": "string"}, "status": {"$ref": "#/components/schemas/ECompositionPackageStatus"}}, "required": ["status"], "type": "object"}}, "required": ["id", "url", "name", "creator", "createdAt", "updatedAt", "projectId", "orgId", "nodes", "connections", "description", "preview", "status"], "type": "object", "additionalProperties": false}, "ICompositionDatasetState": {"properties": {"serviceId": {"type": "string"}, "executionId": {"type": "string"}, "dataset": {"properties": {"indexDriver": {"type": "string", "enum": ["v1", "v2"]}, "error": {}, "driver": {"type": "string"}, "shareLevel": {"type": "string", "enum": ["private", "project"]}, "readableType": {"type": "string"}, "createdAt": {"type": "string", "format": "date-time"}, "maxClientObjectId": {"type": "number", "format": "double"}, "clientObjectId": {"type": "number", "format": "double"}, "metadata": {}, "export": {"properties": {"json": {"type": "string"}, "zip": {"type": "string"}}, "required": ["json", "zip"], "type": "object"}, "projects": {"items": {"type": "string"}, "type": "array"}, "creator": {"type": "string"}, "directoryTree": {"type": "string"}, "items": {"type": "string"}, "url": {"type": "string"}, "itemsCount": {"type": "number", "format": "double"}, "attributes": {"items": {"type": "string"}, "type": "array"}, "classes": {"properties": {}, "additionalProperties": {"type": "string"}, "type": "object"}, "annotated": {"type": "number", "format": "double"}, "annotations": {"items": {"properties": {"itemsCount": {"type": "number", "format": "double"}, "name": {"type": "string"}}, "required": ["itemsCount", "name"], "type": "object"}, "type": "array"}, "name": {"type": "string"}, "id": {"type": "string"}}, "required": ["driver", "shareLevel", "readableType", "createdAt", "export", "projects", "creator", "directoryTree", "items", "url", "itemsCount", "attributes", "classes", "annotated", "annotations", "name", "id"], "type": "object"}, "status": {"$ref": "#/components/schemas/CompositionElementStatus"}, "errorMessage": {"type": "string"}, "errorDate": {"type": "string", "format": "date-time"}}, "type": "object", "additionalProperties": false}, "TextSearch": {"properties": {"functions": {"type": "string"}, "projectName": {"type": "string"}, "orgName": {"type": "string"}}, "required": ["functions", "projectName", "orgName"], "type": "object", "additionalProperties": false}, "MqDetails": {"properties": {"exchange": {"type": "string"}, "queue": {"type": "string"}, "route": {"type": "string"}}, "required": ["exchange", "queue", "route"], "type": "object", "additionalProperties": false}, "ServiceContext": {"properties": {"createdAt": {"type": "string", "format": "date-time"}, "updatedAt": {"type": "string", "format": "date-time"}, "org": {"type": "string"}, "project": {"type": "string"}, "creator": {"type": "string"}, "package": {"type": "string"}}, "required": ["createdAt", "updatedAt", "org", "project", "creator", "package"], "type": "object", "additionalProperties": false}, "AuthZBlock_ServiceContext_": {"properties": {"scope": {"type": "string"}, "context": {"allOf": [{"$ref": "#/components/schemas/Context"}, {"$ref": "#/components/schemas/ServiceContext"}]}, "access": {"items": {}, "type": "array"}}, "required": ["context"], "type": "object", "additionalProperties": false}, "Partial_Service_": {"properties": {"packageId": {"$ref": "#/components/schemas/ObjectId"}, "orgId": {"type": "string"}, "orgName": {"type": "string"}, "packageRevision": {"type": "string"}, "initParams": {}, "runtime": {"$ref": "#/components/schemas/ServiceRuntime"}, "useUserJwt": {"type": "boolean"}, "botUserName": {"type": "string"}, "versions": {"$ref": "#/components/schemas/ServiceVersions"}, "moduleName": {"type": "string"}, "global": {"type": "boolean"}, "active": {"type": "boolean"}, "runExecutionAsProcess": {"type": "boolean"}, "executionTimeout": {"type": "number", "format": "double"}, "drainTime": {"type": "number", "format": "double"}, "onReset": {"$ref": "#/components/schemas/OnResetAction"}, "name": {"type": "string"}, "textSearch": {"$ref": "#/components/schemas/TextSearch"}, "projectId": {"type": "string"}, "driverId": {"type": "string"}, "_id": {"$ref": "#/components/schemas/ObjectId"}, "mq": {"$ref": "#/components/schemas/MqDetails"}, "version": {"type": "string"}, "createdAt": {"type": "string", "format": "date-time"}, "updatedAt": {"type": "string", "format": "date-time"}, "creator": {"type": "string"}, "idInDriver": {"type": "string"}, "secrets": {"items": {"type": "string"}, "type": "array"}, "maxAttempts": {"type": "number", "format": "double"}, "mqUsername": {"type": "string"}, "authz": {"$ref": "#/components/schemas/AuthZBlock_ServiceContext_"}, "panels": {"items": {"$ref": "#/components/schemas/Panel"}, "type": "array"}, "config": {"$ref": "#/components/schemas/IServiceAppConfig"}, "type": {"$ref": "#/components/schemas/ServiceType"}, "appId": {"type": "string"}, "crashloop": {"$ref": "#/components/schemas/Crashloop"}, "mode": {"$ref": "#/components/schemas/ServiceMode"}, "metadata": {"$ref": "#/components/schemas/ServiceMetadata"}, "updatedBy": {"type": "string"}, "archive": {"type": "boolean"}, "settings": {"$ref": "#/components/schemas/IServiceGeneralSettings"}, "displayName": {"type": "string"}, "app": {"$ref": "#/components/schemas/IAppDefinition"}, "integrations": {"items": {"$ref": "#/components/schemas/ServiceIntegration"}, "type": "array"}, "concurrencyUpdatedAt": {"type": "string", "format": "date-time"}}, "type": "object", "description": "Make all properties in T optional"}, "DpkDatasetOntologyType": {"enum": ["import", "platform", "installed"], "type": "string"}, "ICompositionDataset": {"properties": {"name": {"type": "string"}, "mandatory": {"type": "boolean"}, "docs": {"type": "string"}, "source": {"type": "string"}, "ontology": {"properties": {"value": {"type": "string"}, "from": {"$ref": "#/components/schemas/DpkDatasetOntologyType"}}, "type": "object"}, "invoke": {"properties": {"namespace": {"type": "string"}}, "required": ["namespace"], "type": "object"}, "computeConfig": {"type": "string"}, "description": {"type": "string"}, "metadata": {"$ref": "#/components/schemas/Dictionary"}, "driver": {"type": "string"}, "driverId": {"type": "string"}, "datasetId": {"type": "string"}, "state": {"$ref": "#/components/schemas/ICompositionDatasetState"}, "service": {"$ref": "#/components/schemas/Partial_Service_"}}, "required": ["source", "invoke"], "type": "object", "additionalProperties": false}, "APIComposition": {"properties": {"id": {"type": "string"}, "url": {"type": "string"}, "name": {"type": "string"}, "creator": {"type": "string"}, "createdAt": {"type": "string", "format": "date-time"}, "updatedAt": {"type": "string", "format": "date-time"}, "projectId": {"type": "string"}, "orgId": {"type": "string"}, "spec": {"items": {"$ref": "#/components/schemas/APIServiceCompositionElement"}, "type": "array", "description": "Array of services details"}, "status": {"$ref": "#/components/schemas/CompositionStatus"}, "terminated": {"type": "boolean"}, "errorText": {"anyOf": [{"$ref": "#/components/schemas/ICompositionError"}, {"type": "string"}]}, "triggers": {"items": {"$ref": "#/components/schemas/ICompositionTrigger"}, "type": "array", "description": "Array of services details"}, "packages": {"items": {"$ref": "#/components/schemas/ICompositionPackage"}, "type": "array", "description": "Array of packages details"}, "tasks": {"items": {"$ref": "#/components/schemas/ICompositionTask"}, "type": "array", "description": "Array of tasks details"}, "models": {"items": {"$ref": "#/components/schemas/APICompositionModel"}, "type": "array", "description": "Array of models details"}, "channels": {"items": {"$ref": "#/components/schemas/ICompositionChannel"}, "type": "array", "description": "Array of channels details"}, "secrets": {"items": {"type": "string"}, "type": "array", "description": "Array of integrations ids - each one will be added to the service deployment as an environment variable"}, "pipelineTemplates": {"items": {"$ref": "#/components/schemas/ICompositionPipelineTemplate"}, "type": "array", "description": "Array of pipeline templates details"}, "datasets": {"items": {"$ref": "#/components/schemas/ICompositionDataset"}, "type": "array", "description": "Array of datasets details"}}, "required": ["id", "url", "name", "creator", "createdAt", "updatedAt", "projectId", "orgId", "spec", "status", "terminated"], "type": "object", "additionalProperties": false}, "APIPipeline": {"properties": {"id": {"type": "string"}, "url": {"type": "string"}, "name": {"type": "string"}, "creator": {"type": "string"}, "createdAt": {"type": "string", "format": "date-time"}, "updatedAt": {"type": "string", "format": "date-time"}, "updatedBy": {"type": "string"}, "projectId": {"type": "string"}, "orgId": {"type": "string"}, "compositionId": {"type": "string"}, "nodes": {"items": {"$ref": "#/components/schemas/PipelineNodeDescriptor"}, "type": "array"}, "connections": {"items": {"$ref": "#/components/schemas/PipelineConnection"}, "type": "array"}, "description": {"type": "string"}, "preview": {"type": "string"}, "startNodes": {"items": {"$ref": "#/components/schemas/IStartNode"}, "type": "array"}, "status": {"$ref": "#/components/schemas/CompositionStatus"}, "settings": {"$ref": "#/components/schemas/IPipelineSettings"}, "variables": {"items": {"$ref": "#/components/schemas/PipelineVariable"}, "type": "array"}, "resetTimestamp": {"type": "string", "format": "date-time"}, "template": {"properties": {"state": {"$ref": "#/components/schemas/PipelineFromTemplateState"}, "id": {"type": "string"}}, "required": ["state", "id"], "type": "object"}}, "required": ["id", "url", "name", "creator", "createdAt", "updatedAt", "projectId", "orgId", "nodes", "connections", "description", "preview", "status"], "type": "object", "additionalProperties": false}, "ExecutionContext": {"properties": {"createdAt": {"type": "string", "format": "date-time"}, "updatedAt": {"type": "string", "format": "date-time"}, "org": {"type": "string"}, "project": {"type": "string"}, "creator": {"type": "string"}, "package": {"type": "string"}, "service": {"type": "string"}, "pipeline": {"type": "string"}, "trigger": {"type": "string"}}, "required": ["createdAt", "updatedAt", "org", "project", "creator", "package", "service"], "type": "object", "additionalProperties": false}, "AuthZBlock_ExecutionContext_": {"properties": {"scope": {"type": "string"}, "context": {"allOf": [{"$ref": "#/components/schemas/Context"}, {"$ref": "#/components/schemas/ExecutionContext"}]}, "access": {"items": {}, "type": "array"}}, "required": ["context"], "type": "object", "additionalProperties": false}, "ExecutionResource": {"properties": {"id": {"type": "string"}, "type": {"$ref": "#/components/schemas/PackageResourceType"}}, "required": ["id", "type"], "type": "object"}, "ExecutionPhase": {"enum": ["pending", "running", "completed"], "type": "string"}, "Partial_Execution_": {"properties": {"_id": {"$ref": "#/components/schemas/ObjectId"}, "createdAt": {"type": "string", "format": "date-time"}, "updatedAt": {"type": "string", "format": "date-time"}, "creator": {"type": "string"}, "attempts": {"type": "number", "format": "double"}, "maxAttempts": {"type": "number", "format": "double"}, "toTerminate": {"type": "boolean"}, "input": {"$ref": "#/components/schemas/Dictionary"}, "output": {"$ref": "#/components/schemas/Dictionary"}, "statusLog": {"items": {"$ref": "#/components/schemas/ExecutionStatusReport"}, "type": "array"}, "duration": {"type": "number", "format": "double"}, "projectId": {"type": "string"}, "functionName": {"type": "string"}, "serviceId": {"$ref": "#/components/schemas/ObjectId"}, "triggerId": {"$ref": "#/components/schemas/ObjectId"}, "serviceName": {"type": "string"}, "moduleName": {"type": "string"}, "packageId": {"$ref": "#/components/schemas/ObjectId"}, "packageName": {"type": "string"}, "packageRevision": {"anyOf": [{"type": "string"}, {"type": "number", "format": "double"}]}, "serviceVersion": {"anyOf": [{"type": "string"}, {"type": "number", "format": "double"}]}, "pipeline": {"$ref": "#/components/schemas/IPipelineExecution"}, "model": {"$ref": "#/components/schemas/ExecutionModel"}, "authz": {"$ref": "#/components/schemas/AuthZBlock_ExecutionContext_"}, "orgId": {"type": "string"}, "global": {"type": "boolean"}, "resources": {"items": {"$ref": "#/components/schemas/ExecutionResource"}, "type": "array"}, "eventContext": {"$ref": "#/components/schemas/ExecutionEventContext"}, "mode": {"$ref": "#/components/schemas/ExecutionMode"}, "latestStatus": {"$ref": "#/components/schemas/ExecutionStatusReport"}, "syncReplyTo": {"properties": {"route": {"type": "string"}, "exchange": {"type": "string"}}, "required": ["route", "exchange"], "type": "object"}, "archiveService": {"type": "boolean"}, "app": {"$ref": "#/components/schemas/IAppDefinition"}, "driverId": {"type": "string"}, "hook": {"$ref": "#/components/schemas/ExecutionHook"}, "timeoutSeconds": {"type": "number", "format": "double"}, "deadline": {"type": "string", "format": "date-time"}, "apiHandleTimeout": {"type": "string", "format": "date-time"}, "phase": {"$ref": "#/components/schemas/ExecutionPhase"}, "onReset": {"$ref": "#/components/schemas/OnResetAction"}}, "type": "object", "description": "Make all properties in T optional"}, "ENodeStatus": {"enum": ["pending", "in-progress", "failed", "success", "queue"], "type": "string"}, "IPipelineNodeState": {"properties": {"createdAt": {"type": "string", "format": "date-time"}, "updatedAt": {"type": "string", "format": "date-time"}, "id": {"type": "string"}, "namespace": {"$ref": "#/components/schemas/NodeNamespace"}, "status": {"$ref": "#/components/schemas/ENodeStatus"}, "name": {"type": "string"}, "attempts": {"type": "number", "format": "double"}, "type": {"$ref": "#/components/schemas/NodeType"}}, "required": ["createdAt", "updatedAt", "id", "namespace", "status", "name", "attempts", "type"], "type": "object", "additionalProperties": false}, "EPipelineStatus": {"enum": ["pending", "in-progress", "failed", "success", "queue", "terminated", "rerun"], "type": "string"}, "INodeTransitionError": {"properties": {"sourceNodeName": {"type": "string"}, "sourceNodeId": {"type": "string"}, "targetNodeName": {"type": "string"}, "targetNodeId": {"type": "string"}, "error": {}, "displayMessage": {"type": "string"}, "message": {"type": "string"}}, "required": ["sourceNodeName", "sourceNodeId", "targetNodeName", "targetNodeId", "error", "displayMessage"], "type": "object", "additionalProperties": false}, "APIPipelineState": {"properties": {"id": {"type": "string"}, "url": {"type": "string"}, "pipelineId": {"type": "string"}, "createdAt": {"type": "string", "format": "date-time"}, "updatedAt": {"type": "string", "format": "date-time"}, "projectId": {"type": "string"}, "creator": {"type": "string"}, "executions": {"properties": {}, "additionalProperties": {"items": {"$ref": "#/components/schemas/Partial_Execution_"}, "type": "array"}, "type": "object"}, "nodes": {"items": {"$ref": "#/components/schemas/IPipelineNodeState"}, "type": "array"}, "status": {"$ref": "#/components/schemas/EPipelineStatus"}, "maxAttempts": {"type": "number", "format": "double"}, "transitionErrors": {"items": {"$ref": "#/components/schemas/INodeTransitionError"}, "type": "array"}, "mergeCount": {"properties": {}, "additionalProperties": {"type": "number", "format": "double"}, "type": "object"}, "taskNodeItemCount": {"properties": {}, "additionalProperties": {"type": "number", "format": "double"}, "type": "object"}, "testMode": {"type": "boolean"}}, "required": ["id", "url", "pipelineId", "createdAt", "updatedAt", "executions", "nodes", "status", "maxAttempts"], "type": "object", "additionalProperties": false}, "IPipelineState": {"properties": {"pipelineId": {"$ref": "#/components/schemas/ObjectID"}, "_id": {"$ref": "#/components/schemas/ObjectID"}, "createdAt": {"type": "string", "format": "date-time"}, "updatedAt": {"type": "string", "format": "date-time"}, "projectId": {"type": "string"}, "creator": {"type": "string"}, "status": {"$ref": "#/components/schemas/EPipelineStatus"}, "executions": {"$ref": "#/components/schemas/Dictionary"}, "nodes": {"items": {"$ref": "#/components/schemas/IPipelineNodeState"}, "type": "array"}, "countInProgress": {"type": "number", "format": "double"}, "isPipelineFailed": {"type": "boolean"}, "maxAttempts": {"type": "number", "format": "double"}, "duration": {"type": "number", "format": "double"}, "transitionErrors": {"items": {"$ref": "#/components/schemas/INodeTransitionError"}, "type": "array"}, "mergeCount": {"properties": {}, "additionalProperties": {"type": "number", "format": "double"}, "type": "object"}, "taskNodeItemCount": {"properties": {}, "additionalProperties": {"anyOf": [{"type": "number", "format": "double"}, {"properties": {}, "additionalProperties": {"type": "number", "format": "double"}, "type": "object"}]}, "type": "object"}, "testMode": {"type": "boolean"}}, "required": ["pipelineId", "_id", "createdAt", "updatedAt", "status", "executions", "nodes", "maxAttempts"], "type": "object", "additionalProperties": false}, "ResourceExecution": {"properties": {"resourceId": {"type": "string"}, "resourceType": {"$ref": "#/components/schemas/PackageResourceType"}, "executionId": {"type": "string"}, "status": {"type": "string"}, "timestamp": {"type": "string", "format": "date-time"}, "progress": {"type": "number", "format": "double"}, "message": {"type": "string"}, "error": {"type": "string"}, "serviceName": {"type": "string"}, "functionName": {"type": "string"}, "moduleName": {"type": "string"}, "packageName": {"type": "string"}, "creator": {"type": "string"}, "projectId": {"type": "string"}, "serviceVersion": {"type": "string"}, "attempts": {"type": "number", "format": "double"}, "duration": {"type": "number", "format": "double"}, "lagTime": {"type": "number", "format": "double"}, "cycleId": {"type": "string"}, "pipelineId": {"type": "string"}, "nodeId": {"type": "string"}, "serviceId": {"type": "string"}}, "required": ["resourceId", "resourceType", "executionId", "serviceName", "functionName", "moduleName", "projectId"], "type": "object", "additionalProperties": false}, "EDpkScope": {"enum": ["public", "project", "organization"], "type": "string"}, "IDpkMetadata": {"properties": {"system": {"$ref": "#/components/schemas/SystemRefs"}, "commands": {"properties": {"services": {"type": "string"}, "apps": {"type": "string"}}, "required": ["services", "apps"], "type": "object"}}, "type": "object", "additionalProperties": false}, "IAppContext": {"properties": {"org": {"type": "string"}, "project": {"type": "string"}}, "type": "object", "additionalProperties": false}, "IDpkInitialContext": {"properties": {"creator": {"type": "string"}, "createdAt": {"type": "string", "format": "date-time"}}, "required": ["creator", "createdAt"], "type": "object", "additionalProperties": false}, "IDpkComponentPanel": {"properties": {"name": {"type": "string"}, "mandatory": {"type": "boolean"}, "path": {"type": "string"}, "minRole": {"type": "string"}, "supportedSlots": {"items": {"properties": {"configuration": {"$ref": "#/components/schemas/Dictionary"}, "id": {"type": "string"}, "type": {"type": "string"}}, "required": ["configuration", "id", "type"], "type": "object"}, "type": "array"}, "icon": {"type": "string"}, "metadata": {"$ref": "#/components/schemas/Dictionary"}, "conditions": {"$ref": "#/components/schemas/Dictionary"}, "defaultSettings": {"$ref": "#/components/schemas/Dictionary"}, "serveFromFilesystem": {"type": "boolean"}, "computeConfig": {"type": "string"}}, "required": ["name", "minRole", "supportedSlots", "icon", "metadata"], "type": "object", "additionalProperties": false}, "IDpkComponentModel": {"properties": {"id": {"type": "string"}, "name": {"type": "string", "description": "The models name"}, "description": {"type": "string", "description": "description of the model", "default": "My model"}, "scope": {"$ref": "#/components/schemas/EntityScopeLevel", "description": "Field that shows the scope in which the model exists"}, "status": {"$ref": "#/components/schemas/ModelStatus", "description": "the current models status"}, "tags": {"items": {"type": "string"}, "type": "array", "description": "Tags related to the model", "default": []}, "labels": {"items": {"type": "string"}, "type": "array", "description": "Labels related to the model", "default": []}, "configuration": {"$ref": "#/components/schemas/ModelConfiguration", "description": "The configuration that the model was created with"}, "inputType": {"$ref": "#/components/schemas/ModelInputType", "description": "Model Input Type"}, "outputType": {"$ref": "#/components/schemas/ModelOutputType", "description": "Model Output Type"}, "datasetId": {"type": "string", "description": "The datasets id that the model is connected to"}, "artifacts": {"items": {"$ref": "#/components/schemas/Dictionary"}, "type": "array", "description": "the artifacts of the model\nan artifact indicates where the model binaries sit"}, "context": {"$ref": "#/components/schemas/EntityContext", "description": "The context which the model exists in"}, "moduleName": {"type": "string", "description": "The module name of the model"}, "metadata": {"$ref": "#/components/schemas/Dictionary"}, "app": {"$ref": "#/components/schemas/IAppDefinition"}, "mandatory": {"type": "boolean"}, "operationType": {"$ref": "#/components/schemas/ModelOperationTypes"}, "computeConfigs": {"properties": {"default": {"type": "string"}, "embed": {"type": "string"}, "evaluate": {"type": "string"}, "predict": {"type": "string"}, "train": {"type": "string"}}, "required": ["default", "evaluate", "predict", "train"], "type": "object"}}, "required": ["name", "context", "metadata", "computeConfigs"], "type": "object", "additionalProperties": false}, "JsServiceVersions": {"properties": {"dtlpy": {"type": "string"}, "runner": {"type": "string"}, "proxy": {"type": "string"}, "verify": {"type": "boolean"}}, "type": "object", "additionalProperties": false}, "IDpkComponentModule": {"properties": {"name": {"type": "string"}, "entryPoint": {"type": "string"}, "className": {"type": "string"}, "initInputs": {"items": {"$ref": "#/components/schemas/PackageIO"}, "type": "array"}, "functions": {"items": {"$ref": "#/components/schemas/DLFunction"}, "type": "array"}, "mandatory": {"type": "boolean"}, "versions": {"$ref": "#/components/schemas/JsServiceVersions"}, "config": {"$ref": "#/components/schemas/IServiceAppConfig"}, "serviceConfig": {"$ref": "#/components/schemas/Partial_Service_"}, "computeConfig": {"type": "string"}, "integrations": {"items": {"type": "string"}, "type": "array"}}, "required": ["name", "entryPoint", "className", "initInputs", "functions"], "type": "object", "additionalProperties": false}, "EComponentServiceOperation": {"enum": ["install", "none"], "type": "string"}, "IDpkComponentTrigger": {"properties": {"type": {"$ref": "#/components/schemas/TriggerType"}, "spec": {"properties": {"input": {"$ref": "#/components/schemas/Dictionary"}, "endAt": {"type": "string", "format": "date-time"}, "startAt": {"type": "string", "format": "date-time"}, "cron": {"type": "string"}, "operation": {"$ref": "#/components/schemas/TriggerOperation"}, "filter": {"type": "string"}, "executionMode": {"$ref": "#/components/schemas/ExecutionMode"}, "actions": {"items": {"$ref": "#/components/schemas/TriggerActionType"}, "type": "array"}, "resource": {"$ref": "#/components/schemas/TriggerResourceType"}}, "type": "object"}, "name": {"type": "string"}, "scope": {"type": "string"}, "global": {"type": "boolean"}, "mandatory": {"type": "boolean"}, "namespace": {"type": "string"}, "operation": {"$ref": "#/components/schemas/EComponentServiceOperation"}}, "required": ["type", "spec", "namespace"], "type": "object", "additionalProperties": false}, "IDpkComponentService": {"properties": {"name": {"type": "string"}, "mandatory": {"type": "boolean"}, "runExecutionAsProcess": {"type": "boolean"}, "executionTimeout": {"type": "number", "format": "double"}, "drainTime": {"type": "number", "format": "double"}, "onReset": {"$ref": "#/components/schemas/OnResetAction"}, "runtime": {"$ref": "#/components/schemas/ServiceRuntime"}, "initParams": {"$ref": "#/components/schemas/Dictionary"}, "moduleName": {"type": "string"}, "panelNames": {"items": {"type": "string"}, "type": "array"}, "botUserName": {"type": "string"}, "maxAttempts": {"type": "number", "format": "double"}, "useUserJwt": {"type": "boolean"}, "metadata": {"$ref": "#/components/schemas/ServiceMetadata"}, "versions": {"$ref": "#/components/schemas/JsServiceVersions"}, "secrets": {"items": {"type": "string"}, "type": "array"}, "driverId": {"type": "string"}, "modelOperation": {"$ref": "#/components/schemas/ModelOperationTypes"}, "operation": {"$ref": "#/components/schemas/EComponentServiceOperation"}, "computeConfig": {"type": "string"}, "integrations": {"items": {"$ref": "#/components/schemas/ServiceIntegration"}, "type": "array"}, "app": {"$ref": "#/components/schemas/Dictionary"}}, "required": ["name"], "type": "object", "additionalProperties": false}, "IDpkComponentToolbars": {"properties": {"name": {"type": "string"}, "mandatory": {"type": "boolean"}, "displayName": {"type": "string"}, "conditions": {"$ref": "#/components/schemas/Dictionary"}, "invoke": {"$ref": "#/components/schemas/Dictionary"}, "location": {"type": "string"}, "icon": {"type": "string"}}, "required": ["displayName", "invoke"], "type": "object", "additionalProperties": false}, "FilterFrequencyType": {"enum": ["rate"], "type": "string"}, "seconds": {"type": "number", "format": "double"}, "FilterFrequencyValue": {"$ref": "#/components/schemas/seconds"}, "FilterFrequency": {"properties": {"type": {"$ref": "#/components/schemas/FilterFrequencyType"}, "value": {"$ref": "#/components/schemas/FilterFrequencyValue"}}, "required": ["type", "value"], "type": "object", "additionalProperties": false}, "IDpkFilter": {"properties": {"name": {"type": "string"}, "mandatory": {"type": "boolean"}, "target": {"$ref": "#/components/schemas/FilterTarget"}, "notificationCode": {"type": "string"}, "contextMatch": {"$ref": "#/components/schemas/NotificationEventContext"}, "frequency": {"$ref": "#/components/schemas/FilterFrequency"}, "context": {"$ref": "#/components/schemas/NotificationEntityContext"}, "notificationId": {"type": "string"}}, "required": ["frequency", "context"], "type": "object", "additionalProperties": false}, "IDpkChannel": {"properties": {"name": {"type": "string"}, "mandatory": {"type": "boolean"}, "icon": {"type": "string"}, "description": {"type": "string"}, "global": {"type": "boolean"}, "metadata": {"properties": {"codebase": {"$ref": "#/components/schemas/Codebase"}, "functionName": {"type": "string"}, "serviceName": {"type": "string"}}, "required": ["functionName", "serviceName"], "type": "object"}, "context": {"$ref": "#/components/schemas/NotificationEntityContext"}, "filters": {"items": {"$ref": "#/components/schemas/IDpkFilter"}, "type": "array"}}, "required": ["name", "global", "metadata", "context"], "type": "object", "additionalProperties": false}, "IDpkComputeConfigs": {"properties": {"name": {"type": "string"}, "mandatory": {"type": "boolean"}, "runExecutionAsProcess": {"type": "boolean"}, "executionTimeout": {"type": "number", "format": "double"}, "drainTime": {"type": "number", "format": "double"}, "onReset": {"$ref": "#/components/schemas/OnResetAction"}, "runtime": {"$ref": "#/components/schemas/ServiceRuntime"}, "botUserName": {"type": "string"}, "maxAttempts": {"type": "number", "format": "double"}, "useUserJwt": {"type": "boolean"}, "driverId": {"type": "string"}, "versions": {"$ref": "#/components/schemas/JsServiceVersions"}, "integrations": {"items": {"$ref": "#/components/schemas/ServiceIntegration"}, "type": "array"}}, "required": ["name"], "type": "object", "additionalProperties": false}, "InvokeType": {"enum": ["panel", "function", "script"], "type": "string"}, "ToolbarInvoke": {"properties": {"type": {"$ref": "#/components/schemas/InvokeType"}, "namespace": {"type": "string"}, "source": {"type": "string"}, "inputOptions": {"$ref": "#/components/schemas/Dictionary"}}, "required": ["type", "namespace"], "type": "object", "additionalProperties": false}, "CustomNodeScope": {"enum": ["global", "project", "node"], "type": "string"}, "IInvoke": {"properties": {"type": {"type": "string"}, "namespace": {"type": "string"}, "source": {"type": "string"}, "inputOptions": {"$ref": "#/components/schemas/Dictionary"}}, "required": ["type", "namespace"], "type": "object", "additionalProperties": false}, "IPipelineNode": {"properties": {"displayName": {"type": "string"}, "invoke": {"$ref": "#/components/schemas/ToolbarInvoke"}, "icon": {"type": "string"}, "name": {"type": "string"}, "panel": {"type": "string"}, "categories": {"items": {"type": "string"}, "type": "array"}, "description": {"type": "string"}, "configuration": {"$ref": "#/components/schemas/Dictionary"}, "scope": {"$ref": "#/components/schemas/CustomNodeScope"}}, "required": ["invoke"], "type": "object", "additionalProperties": false}, "IDpkPipelineTemplate": {"properties": {"id": {"type": "string"}, "url": {"type": "string"}, "name": {"type": "string"}, "creator": {"type": "string"}, "createdAt": {"type": "string", "format": "date-time"}, "updatedAt": {"type": "string", "format": "date-time"}, "updatedBy": {"type": "string"}, "projectId": {"type": "string"}, "orgId": {"type": "string"}, "compositionId": {"type": "string"}, "nodes": {"items": {"$ref": "#/components/schemas/PipelineNodeDescriptor"}, "type": "array"}, "connections": {"items": {"$ref": "#/components/schemas/PipelineConnection"}, "type": "array"}, "description": {"type": "string"}, "preview": {"type": "string"}, "startNodes": {"items": {"$ref": "#/components/schemas/IStartNode"}, "type": "array"}, "status": {"$ref": "#/components/schemas/CompositionStatus"}, "settings": {"$ref": "#/components/schemas/IPipelineSettings"}, "variables": {"items": {"$ref": "#/components/schemas/PipelineVariable"}, "type": "array"}, "resetTimestamp": {"type": "string", "format": "date-time"}, "template": {"properties": {"state": {"$ref": "#/components/schemas/PipelineFromTemplateState"}, "id": {"type": "string"}}, "required": ["state", "id"], "type": "object"}, "mandatory": {"type": "boolean"}, "templateKind": {"$ref": "#/components/schemas/TemplateKind"}}, "required": ["id", "url", "name", "creator", "createdAt", "updatedAt", "projectId", "orgId", "nodes", "connections", "description", "preview", "status"], "type": "object", "additionalProperties": false}, "IDpkComponentDataset": {"properties": {"name": {"type": "string"}, "mandatory": {"type": "boolean"}, "docs": {"type": "string"}, "source": {"type": "string"}, "ontology": {"properties": {"value": {"type": "string"}, "from": {"$ref": "#/components/schemas/DpkDatasetOntologyType"}}, "type": "object"}, "invoke": {"properties": {"namespace": {"type": "string"}}, "required": ["namespace"], "type": "object"}, "computeConfig": {"type": "string"}, "description": {"type": "string"}, "metadata": {"$ref": "#/components/schemas/Dictionary"}, "driver": {"type": "string"}, "driverId": {"type": "string"}}, "required": ["source", "invoke"], "type": "object", "additionalProperties": false}, "IDpkComponentIntegrations": {"properties": {"name": {"type": "string"}, "mandatory": {"type": "boolean"}, "key": {"type": "string"}, "type": {"type": "string"}, "env": {"type": "string"}, "value": {"type": "string"}, "optional": {"type": "boolean"}, "description": {"type": "string"}, "displayName": {"type": "string"}, "to": {"type": "string"}}, "required": ["key"], "type": "object", "additionalProperties": false}, "DpkComponents": {"properties": {"integrations": {"items": {"$ref": "#/components/schemas/IDpkComponentIntegrations"}, "type": "array"}, "datasets": {"items": {"$ref": "#/components/schemas/IDpkComponentDataset"}, "type": "array"}, "pipelineTemplates": {"items": {"$ref": "#/components/schemas/IDpkPipelineTemplate"}, "type": "array"}, "pipelineNodes": {"items": {"$ref": "#/components/schemas/IPipelineNode"}, "type": "array"}, "computeConfigs": {"items": {"$ref": "#/components/schemas/IDpkComputeConfigs"}, "type": "array"}, "channels": {"items": {"$ref": "#/components/schemas/IDpkChannel"}, "type": "array"}, "toolbars": {"items": {"$ref": "#/components/schemas/IDpkComponentToolbars"}, "type": "array"}, "services": {"items": {"$ref": "#/components/schemas/IDpkComponentService"}, "type": "array"}, "triggers": {"items": {"$ref": "#/components/schemas/IDpkComponentTrigger"}, "type": "array"}, "modules": {"items": {"$ref": "#/components/schemas/IDpkComponentModule"}, "type": "array"}, "models": {"items": {"$ref": "#/components/schemas/IDpkComponentModel"}, "type": "array"}, "panels": {"items": {"$ref": "#/components/schemas/IDpkComponentPanel"}, "type": "array"}}, "type": "object"}, "EComponentElementType": {"enum": ["panel", "toolbar", "model", "trigger", "service", "module", "channel", "computeConfig", "pipelineNode", "pipelineTemplate"], "type": "string"}, "IDpkPipelineNode": {"properties": {"displayName": {"type": "string"}, "invoke": {"$ref": "#/components/schemas/ToolbarInvoke"}, "icon": {"type": "string"}, "name": {"type": "string"}, "panel": {"type": "string"}, "categories": {"items": {"type": "string"}, "type": "array"}, "description": {"type": "string"}, "configuration": {"$ref": "#/components/schemas/Dictionary"}, "scope": {"$ref": "#/components/schemas/CustomNodeScope"}, "mandatory": {"type": "boolean"}}, "required": ["invoke"], "type": "object", "additionalProperties": false}, "IDpkComponentElementSpec": {"anyOf": [{"$ref": "#/components/schemas/IDpkComponentPanel"}, {"$ref": "#/components/schemas/IDpkComponentModel"}, {"$ref": "#/components/schemas/IDpkComponentModule"}, {"$ref": "#/components/schemas/IDpkComponentTrigger"}, {"$ref": "#/components/schemas/IDpkComponentService"}, {"$ref": "#/components/schemas/IDpkComponentToolbars"}, {"$ref": "#/components/schemas/IDpkChannel"}, {"$ref": "#/components/schemas/IDpkComputeConfigs"}, {"$ref": "#/components/schemas/IDpkPipelineNode"}, {"$ref": "#/components/schemas/IDpkPipelineTemplate"}]}, "IComponentElement": {"properties": {"type": {"$ref": "#/components/schemas/EComponentElementType"}, "spec": {"$ref": "#/components/schemas/IDpkComponentElementSpec"}}, "required": ["type", "spec"], "type": "object", "additionalProperties": false}, "DpkComponentsFlatten": {"properties": {}, "additionalProperties": {"$ref": "#/components/schemas/IComponentElement"}, "type": "object"}, "IDpkDependency": {"properties": {"name": {"type": "string"}, "version": {"type": "string"}, "scope": {"$ref": "#/components/schemas/EDpkScope"}, "scopeId": {"type": "string"}, "mandatory": {"type": "boolean"}, "components": {"anyOf": [{"$ref": "#/components/schemas/DpkComponents"}, {"$ref": "#/components/schemas/DpkComponentsFlatten"}]}, "integrations": {"items": {"$ref": "#/components/schemas/ServiceIntegration"}, "type": "array"}, "dependencies": {"items": {"$ref": "#/components/schemas/IDpkDependency"}, "type": "array"}}, "required": ["name"], "type": "object", "additionalProperties": false}, "APIDpk": {"properties": {"id": {"type": "string"}, "url": {"type": "string"}, "baseId": {"type": "string"}, "name": {"type": "string"}, "version": {"type": "string"}, "attributes": {"properties": {}, "additionalProperties": {"anyOf": [{"type": "string"}, {"items": {"type": "string"}, "type": "array"}]}, "type": "object"}, "updatedAt": {"type": "string", "format": "date-time"}, "createdAt": {"type": "string", "format": "date-time"}, "creator": {"type": "string"}, "displayName": {"type": "string"}, "description": {"type": "string"}, "icon": {"type": "string"}, "tags": {"items": {"type": "string"}, "type": "array"}, "codebase": {"$ref": "#/components/schemas/Codebase"}, "trusted": {"type": "boolean"}, "scope": {"$ref": "#/components/schemas/EDpkScope"}, "latest": {"type": "boolean"}, "metadata": {"$ref": "#/components/schemas/IDpkMetadata"}, "context": {"$ref": "#/components/schemas/IAppContext"}, "initialContext": {"$ref": "#/components/schemas/IDpkInitialContext"}, "components": {"anyOf": [{"$ref": "#/components/schemas/DpkComponents"}, {"$ref": "#/components/schemas/DpkComponentsFlatten"}]}, "dependencies": {"items": {"$ref": "#/components/schemas/IDpkDependency"}, "type": "array"}, "variables": {"properties": {}, "additionalProperties": {"type": "string"}, "type": "object"}}, "required": ["id", "url", "baseId", "name", "version", "updatedAt", "createdAt", "creator", "displayName", "description", "icon", "tags", "codebase", "scope", "latest", "components"], "type": "object", "additionalProperties": false}, "EAppScope": {"enum": ["system", "project"], "type": "string"}, "Partial_APIDpk_": {"properties": {"id": {"type": "string"}, "baseId": {"type": "string"}, "name": {"type": "string"}, "url": {"type": "string"}, "version": {"type": "string"}, "attributes": {"properties": {}, "additionalProperties": {"anyOf": [{"type": "string"}, {"items": {"type": "string"}, "type": "array"}]}, "type": "object"}, "updatedAt": {"type": "string", "format": "date-time"}, "createdAt": {"type": "string", "format": "date-time"}, "creator": {"type": "string"}, "displayName": {"type": "string"}, "description": {"type": "string"}, "icon": {"type": "string"}, "tags": {"items": {"type": "string"}, "type": "array"}, "codebase": {"$ref": "#/components/schemas/Codebase"}, "trusted": {"type": "boolean"}, "scope": {"$ref": "#/components/schemas/EDpkScope"}, "latest": {"type": "boolean"}, "metadata": {"$ref": "#/components/schemas/IDpkMetadata"}, "context": {"$ref": "#/components/schemas/IAppContext"}, "initialContext": {"$ref": "#/components/schemas/IDpkInitialContext"}, "components": {"anyOf": [{"$ref": "#/components/schemas/DpkComponents"}, {"$ref": "#/components/schemas/DpkComponentsFlatten"}]}, "dependencies": {"items": {"$ref": "#/components/schemas/IDpkDependency"}, "type": "array"}, "variables": {"properties": {}, "additionalProperties": {"type": "string"}, "type": "object"}}, "type": "object", "description": "Make all properties in T optional"}, "Pick_APIDpk.dependencies_": {"properties": {"dependencies": {"items": {"$ref": "#/components/schemas/IDpkDependency"}, "type": "array"}}, "type": "object", "description": "From T, pick a set of properties whose keys are in the union K"}, "CustomInstallation": {"allOf": [{"$ref": "#/components/schemas/Pick_APIDpk.dependencies_"}, {"properties": {"codebase": {"$ref": "#/components/schemas/Codebase"}, "components": {"$ref": "#/components/schemas/DpkComponents"}}, "type": "object"}]}, "AppCommandsReference": {"properties": {"update": {"type": "string"}, "uninstall": {"type": "string"}, "install": {"type": "string"}}, "type": "object"}, "AppMetadata": {"allOf": [{"$ref": "#/components/schemas/EntityReferenceMetadata"}, {"properties": {"system": {"properties": {"commands": {"$ref": "#/components/schemas/AppCommandsReference"}}, "type": "object"}}, "type": "object"}]}, "IAppGeneralSettings": {"properties": {"autoUpdate": {"type": "boolean"}}, "type": "object", "additionalProperties": false}, "APIApp": {"properties": {"id": {"type": "string"}, "url": {"type": "string"}, "name": {"type": "string"}, "createdAt": {"type": "string", "format": "date-time"}, "updatedAt": {"type": "string", "format": "date-time"}, "updatedBy": {"type": "string"}, "creator": {"type": "string"}, "projectId": {"type": "string"}, "orgId": {"type": "string"}, "dpkName": {"type": "string"}, "dpkVersion": {"type": "string"}, "compositionId": {"type": "string"}, "scope": {"$ref": "#/components/schemas/EAppScope"}, "routes": {"$ref": "#/components/schemas/Dictionary"}, "dpk": {"$ref": "#/components/schemas/Partial_APIDpk_"}, "customInstallation": {"$ref": "#/components/schemas/CustomInstallation"}, "status": {"$ref": "#/components/schemas/CompositionStatus"}, "trusted": {"type": "boolean"}, "metadata": {"$ref": "#/components/schemas/AppMetadata"}, "settings": {"$ref": "#/components/schemas/IAppGeneralSettings"}, "integrations": {"items": {"$ref": "#/components/schemas/ServiceIntegration"}, "type": "array"}}, "required": ["id", "url", "name", "createdAt", "updatedAt", "creator", "projectId", "orgId", "dpkName", "dpkVersion", "compositionId", "routes"], "type": "object", "additionalProperties": false}, "EComputeType": {"enum": ["kubernetes"], "type": "string"}, "EComputeStatus": {"enum": ["ready", "initializing", "pause", "failed", "validating"], "type": "string"}, "EClusterProvider": {"enum": ["gcp", "aws", "azure", "hpc", "local", "rancher-k3s", "rancher-rke", "openshift"], "type": "string"}, "Toleration": {"properties": {"effect": {"type": "string"}, "value": {"type": "string"}, "operator": {"type": "string"}, "key": {"type": "string"}}, "required": ["effect", "value", "operator", "key"], "type": "object"}, "INodePoolDeploymentResources": {"properties": {"requests": {"properties": {"gpu": {"type": "string"}, "memory": {"type": "string"}, "cpu": {"type": "string"}}, "type": "object"}, "limits": {"properties": {"gpu": {"type": "string"}, "memory": {"type": "string"}, "cpu": {"type": "string"}}, "type": "object"}}, "required": ["requests", "limits"], "type": "object", "additionalProperties": false}, "INodePool": {"properties": {"name": {"type": "string"}, "isDlTypeDefault": {"type": "boolean"}, "isMonitoringConfiguration": {"type": "boolean"}, "dlTypes": {"items": {"type": "string"}, "type": "array"}, "tolerations": {"items": {"$ref": "#/components/schemas/Toleration"}, "type": "array"}, "description": {"type": "string"}, "nodeSelector": {"$ref": "#/components/schemas/Dictionary"}, "preemptible": {"type": "boolean"}, "deploymentResources": {"$ref": "#/components/schemas/INodePoolDeploymentResources"}, "runAiManaged": {"type": "boolean", "description": "When true, workloads target Run:ai-managed nodes; inject scheduler + annotations"}}, "required": ["name", "isDlTypeDefault", "tolerations", "description", "nodeSelector", "preemptible"], "type": "object", "additionalProperties": false}, "EComputePlugin": {"enum": ["keda", "monitoring", "mirrors", "nfs", "node-exporter", "fluentd", "scaler", "nginx-gateway", "grafana", "storage-driver"], "type": "string"}, "IExternalMonitoringConfig": {"properties": {"port": {"type": "string"}, "namespace": {"type": "string"}, "serviceName": {"type": "string"}}, "required": ["port", "serviceName"], "type": "object", "additionalProperties": false}, "IHpaControllerConfig": {"properties": {"insecureSkipVerify": {"type": "string"}}, "required": ["insecureSkipVerify"], "type": "object", "additionalProperties": false}, "EStorageType": {"enum": ["nfs", "pvc", "s3"], "type": "string"}, "IStorage": {"properties": {"name": {"type": "string"}, "type": {"$ref": "#/components/schemas/EStorageType"}}, "required": ["name"], "type": "object", "additionalProperties": false}, "IStorageDriverConfig": {"properties": {"storages": {"items": {"$ref": "#/components/schemas/IStorage"}, "type": "array"}}, "required": ["storages"], "type": "object", "additionalProperties": false}, "KubernetesServiceType": {"type": "string", "enum": ["ClusterIP", "LoadBalancer", "NodePort"]}, "ComputePluginSpec": {"properties": {}, "additionalProperties": {"properties": {"spec": {"properties": {"type": {"$ref": "#/components/schemas/KubernetesServiceType"}, "resources": {"properties": {"cpu": {"type": "string"}, "memory": {"type": "string"}}, "required": ["cpu", "memory"], "type": "object"}}, "type": "object"}}, "required": ["spec"], "type": "object"}, "type": "object"}, "IComputePlugin": {"properties": {"name": {"$ref": "#/components/schemas/EComputePlugin"}, "useExternalResources": {"type": "boolean"}, "config": {"anyOf": [{"$ref": "#/components/schemas/IExternalMonitoringConfig"}, {"$ref": "#/components/schemas/IHpaControllerConfig"}, {"$ref": "#/components/schemas/Dictionary"}, {"$ref": "#/components/schemas/IStorageDriverConfig"}]}, "spec": {"$ref": "#/components/schemas/ComputePluginSpec"}}, "required": ["name"], "type": "object", "additionalProperties": false}, "IComputeAuthentication": {"properties": {"integration": {"properties": {"type": {"type": "string"}, "id": {"type": "string"}}, "required": ["type", "id"], "type": "object"}}, "required": ["integration"], "type": "object", "additionalProperties": false}, "IClusterVolume": {"properties": {"name": {"type": "string"}, "mountPath": {"type": "string"}, "subPath": {"type": "string"}, "readOnly": {"type": "boolean"}, "persistentVolumeClaim": {"properties": {"claimName": {"type": "string"}}, "required": ["claimName"], "type": "object"}, "emptyDir": {"properties": {}, "type": "object"}, "hostPath": {"properties": {"type": {"type": "string"}, "path": {"type": "string"}}, "required": ["path"], "type": "object"}, "configMap": {"properties": {"items": {"items": {"properties": {"path": {"type": "string"}, "key": {"type": "string"}}, "required": ["path", "key"], "type": "object"}, "type": "array"}, "name": {"type": "string"}}, "required": ["name"], "type": "object"}, "secret": {"properties": {"items": {"items": {"properties": {"path": {"type": "string"}, "key": {"type": "string"}}, "required": ["path", "key"], "type": "object"}, "type": "array"}, "secretName": {"type": "string"}}, "required": ["secretName"], "type": "object"}, "nfs": {"properties": {"path": {"type": "string"}, "server": {"type": "string"}}, "required": ["path", "server"], "type": "object"}}, "required": ["name", "mountPath"], "type": "object", "additionalProperties": false}, "IDeploymentSecurityContext": {"properties": {"runAsUser": {"type": "number", "format": "double"}, "runAsGroup": {"type": "number", "format": "double"}, "runAsNonRoot": {"type": "boolean"}, "fsGroup": {"type": "number", "format": "double"}, "allowPrivilegeEscalation": {"type": "boolean"}, "readOnlyRootFilesystem": {"type": "boolean"}}, "type": "object", "additionalProperties": false}, "IClusterEnvironmentVariable": {"properties": {"name": {"type": "string"}, "value": {"type": "string"}, "valueFrom": {"properties": {"configMapKeyRef": {"properties": {"key": {"type": "string"}, "name": {"type": "string"}}, "required": ["key", "name"], "type": "object"}, "secretKeyRef": {"properties": {"key": {"type": "string"}, "name": {"type": "string"}}, "required": ["key", "name"], "type": "object"}, "fieldRef": {"properties": {"fieldPath": {"type": "string"}}, "required": ["fieldPath"], "type": "object"}}, "type": "object"}}, "required": ["name"], "type": "object", "additionalProperties": false}, "IComputeRegistry": {"properties": {"domain": {"type": "string"}, "faasFolder": {"type": "string"}, "bootstrapFolder": {"type": "string"}}, "required": ["domain"], "type": "object", "additionalProperties": false}, "IDeploymentConfiguration": {"properties": {"volumes": {"items": {"$ref": "#/components/schemas/IClusterVolume"}, "type": "array"}, "securityContext": {"$ref": "#/components/schemas/IDeploymentSecurityContext"}, "environmentVariables": {"items": {"$ref": "#/components/schemas/IClusterEnvironmentVariable"}, "type": "array"}, "registry": {"$ref": "#/components/schemas/IComputeRegistry"}, "serviceAccountName": {"type": "string"}, "internalRequestsUrl": {"type": "string"}, "defaultResources": {"properties": {"limits": {"properties": {"memory": {"type": "string"}, "cpu": {"type": "string"}}, "required": ["memory", "cpu"], "type": "object"}, "requests": {"properties": {"memory": {"type": "string"}, "cpu": {"type": "string"}}, "required": ["memory", "cpu"], "type": "object"}}, "required": ["limits", "requests"], "type": "object"}}, "type": "object", "additionalProperties": false}, "IRunAiConfig": {"description": "Run:ai configuration for GPU workload scheduling (scheduler, fractional GPU)", "properties": {"enabled": {"type": "boolean", "description": "When true, GPU workloads on this compute use Run:ai scheduler"}, "projectNameTemplate": {"type": "string", "description": "Run:ai project name template, e.g. \"dataloop-{{orgId}}\" or \"{{namespace}}\""}, "projectName": {"type": "string", "description": "Run:ai project name (resolved per org/namespace when passed to workload)"}, "defaultGpuFraction": {"type": "number", "format": "double", "description": "GPU fraction for workloads (0.25, 0.5, 1). null = full GPU"}, "useFractionalGpu": {"type": "boolean", "description": "Use fractional GPU for GPU pod types when fraction < 1"}, "defaultGpuFractionNumDevices": {"type": "number", "format": "double", "description": "Default number of GPU devices to apply fraction across (Run:ai gpu-fraction-num-devices). Default 1"}}, "required": ["enabled"], "type": "object", "additionalProperties": false}, "IComputeCluster": {"properties": {"name": {"type": "string"}, "endpoint": {"type": "string"}, "kubernetesVersion": {"type": "string"}, "provider": {"$ref": "#/components/schemas/EClusterProvider"}, "nodePools": {"items": {"$ref": "#/components/schemas/INodePool"}, "type": "array"}, "metadata": {"$ref": "#/components/schemas/Dictionary"}, "plugins": {"items": {"$ref": "#/components/schemas/IComputePlugin"}, "type": "array"}, "authentication": {"$ref": "#/components/schemas/IComputeAuthentication"}, "deploymentConfiguration": {"$ref": "#/components/schemas/IDeploymentConfiguration"}, "runAi": {"$ref": "#/components/schemas/IRunAiConfig", "description": "Run:ai config for GPU workload scheduling on Run:ai-managed node pools"}}, "required": ["name", "endpoint", "kubernetesVersion", "provider", "nodePools", "metadata", "authentication"], "type": "object", "additionalProperties": false}, "EComputeConsumptionMethod": {"enum": ["MQ", "API"], "type": "string"}, "IComputeSettings": {"properties": {"consumptionMethod": {"$ref": "#/components/schemas/EComputeConsumptionMethod"}, "defaultNamespace": {"type": "string"}}, "type": "object", "additionalProperties": false}, "APICompute": {"properties": {"id": {"type": "string"}, "url": {"type": "string"}, "name": {"type": "string"}, "context": {"$ref": "#/components/schemas/IComputeContext"}, "sharedContexts": {"items": {"$ref": "#/components/schemas/IComputeContext"}, "type": "array"}, "type": {"$ref": "#/components/schemas/EComputeType"}, "metadata": {"$ref": "#/components/schemas/Dictionary"}, "status": {"$ref": "#/components/schemas/EComputeStatus"}, "global": {"type": "boolean"}, "cluster": {"$ref": "#/components/schemas/IComputeCluster"}, "archived": {"type": "boolean"}, "settings": {"$ref": "#/components/schemas/IComputeSettings"}, "createdBy": {"type": "string"}, "createdAt": {"type": "string", "format": "date-time"}, "updatedAt": {"type": "string", "format": "date-time"}}, "required": ["id", "url", "name", "context", "sharedContexts", "type", "status"], "type": "object", "additionalProperties": false}, "CursorPageT": {"properties": {"totalItemsCount": {"type": "number", "format": "double"}, "items": {"anyOf": [{"items": {"$ref": "#/components/schemas/APIComposition"}, "type": "array"}, {"items": {"$ref": "#/components/schemas/APIPipeline"}, "type": "array"}, {"items": {"anyOf": [{"$ref": "#/components/schemas/APIPipelineState"}, {"$ref": "#/components/schemas/IPipelineState"}]}, "type": "array"}, {"items": {"$ref": "#/components/schemas/ResourceExecution"}, "type": "array"}, {"items": {"$ref": "#/components/schemas/APIDpk"}, "type": "array"}, {"items": {"$ref": "#/components/schemas/APIApp"}, "type": "array"}, {"items": {"$ref": "#/components/schemas/APICompute"}, "type": "array"}, {"items": {"$ref": "#/components/schemas/APIServiceDriver"}, "type": "array"}]}, "totalPagesCount": {"type": "number", "format": "double"}, "hasNextPage": {"type": "boolean"}}, "required": ["totalItemsCount", "items", "totalPagesCount", "hasNextPage"], "type": "object", "additionalProperties": false}, "QueryString": {"properties": {"pageSize": {"type": "number", "format": "double"}, "page": {"type": "number", "format": "double"}, "sort": {}, "filter": {}, "resource": {"$ref": "#/components/schemas/QueryResource"}}, "required": ["pageSize", "page", "sort", "filter", "resource"], "type": "object"}, "CursorPageAPIPipelineState": {"properties": {"hasNextPage": {"type": "boolean"}, "totalPagesCount": {"type": "number", "format": "double"}, "items": {"items": {"$ref": "#/components/schemas/APIPipelineState"}, "type": "array"}, "totalItemsCount": {"type": "number", "format": "double"}}, "required": ["hasNextPage", "totalPagesCount", "items", "totalItemsCount"], "type": "object"}, "CycleRerunMethod": {"enum": ["startFromNodes", "startFromFailedExecutions", "startFromBeginning"], "type": "string"}, "IRerunCycleOptions": {"properties": {"method": {"$ref": "#/components/schemas/CycleRerunMethod"}, "startNodeIds": {"items": {"type": "string"}, "type": "array"}}, "required": ["method"], "type": "object", "additionalProperties": false}, "JsExecuteOptionsBatchQuery": {"properties": {"context": {"properties": {"items": {"items": {"type": "string"}, "type": "array"}, "datasets": {"items": {"type": "string"}, "type": "array"}}, "type": "object"}, "resource": {"$ref": "#/components/schemas/QueryResource"}, "filter": {"$ref": "#/components/schemas/Dictionary"}}, "required": ["resource", "filter"], "type": "object"}, "IExecuteOptionsBatch": {"properties": {"query": {"$ref": "#/components/schemas/JsExecuteOptionsBatchQuery"}, "args": {"$ref": "#/components/schemas/Dictionary"}}, "required": ["query"], "type": "object", "additionalProperties": false}, "IRerunCycleBatchOptions": {"properties": {"pipeline": {"$ref": "#/components/schemas/IRerunCycleOptions"}, "batch": {"$ref": "#/components/schemas/IExecuteOptionsBatch"}}, "required": ["batch"], "type": "object", "additionalProperties": false}, "APIPipelineTemplate": {"properties": {"id": {"type": "string"}, "url": {"type": "string"}, "name": {"type": "string"}, "creator": {"type": "string"}, "createdAt": {"type": "string", "format": "date-time"}, "updatedAt": {"type": "string", "format": "date-time"}, "updatedBy": {"type": "string"}, "projectId": {"type": "string"}, "orgId": {"type": "string"}, "compositionId": {"type": "string"}, "nodes": {"items": {"$ref": "#/components/schemas/PipelineNodeDescriptor"}, "type": "array"}, "connections": {"items": {"$ref": "#/components/schemas/PipelineConnection"}, "type": "array"}, "description": {"type": "string"}, "preview": {"type": "string"}, "startNodes": {"items": {"$ref": "#/components/schemas/IStartNode"}, "type": "array"}, "status": {"$ref": "#/components/schemas/CompositionStatus"}, "settings": {"$ref": "#/components/schemas/IPipelineSettings"}, "variables": {"items": {"$ref": "#/components/schemas/PipelineVariable"}, "type": "array"}, "resetTimestamp": {"type": "string", "format": "date-time"}, "template": {"properties": {"state": {"$ref": "#/components/schemas/PipelineFromTemplateState"}, "id": {"type": "string"}}, "required": ["state", "id"], "type": "object"}, "templateKind": {"$ref": "#/components/schemas/TemplateKind"}}, "required": ["id", "url", "name", "creator", "createdAt", "updatedAt", "projectId", "orgId", "nodes", "connections", "description", "preview", "status"], "type": "object", "additionalProperties": false}, "CursorPageAPIPipelineTemplate": {"properties": {"hasNextPage": {"type": "boolean"}, "totalPagesCount": {"type": "number", "format": "double"}, "items": {"items": {"$ref": "#/components/schemas/APIPipeline"}, "type": "array"}, "totalItemsCount": {"type": "number", "format": "double"}}, "required": ["hasNextPage", "totalPagesCount", "items", "totalItemsCount"], "type": "object"}, "APITemplateQuery": {"properties": {"global": {"$ref": "#/components/schemas/CursorPageAPIPipelineTemplate"}, "project": {"$ref": "#/components/schemas/CursorPageAPIPipelineTemplate"}, "org": {"$ref": "#/components/schemas/CursorPageAPIPipelineTemplate"}}, "required": ["global", "project", "org"], "type": "object", "additionalProperties": false}, "QueryStringTemplate": {"properties": {"pageSize": {"type": "number", "format": "double"}, "page": {"type": "number", "format": "double"}, "sort": {}, "filter": {}}, "required": ["pageSize", "page", "sort", "filter"], "type": "object"}, "TemplateQuery": {"properties": {"global": {"$ref": "#/components/schemas/QueryStringTemplate"}, "org": {"$ref": "#/components/schemas/QueryStringTemplate"}, "project": {"$ref": "#/components/schemas/QueryStringTemplate"}}, "required": ["global", "org", "project"], "type": "object"}, "ExecutionLogs": {"properties": {"logs": {"items": {"$ref": "#/components/schemas/ServiceLogEntry"}, "type": "array"}, "stop": {"type": "boolean"}, "checkpoint": {"type": "string"}, "id": {"type": "string"}, "inputs": {"$ref": "#/components/schemas/Dictionary"}, "output": {"$ref": "#/components/schemas/Dictionary"}, "functionName": {"type": "string"}}, "required": ["logs", "stop", "id", "inputs", "output", "functionName"], "type": "object", "additionalProperties": false}, "PipelineExecutionLogs": {"properties": {"nodeId": {"type": "string"}, "executions": {"items": {"$ref": "#/components/schemas/ExecutionLogs"}, "type": "array"}}, "required": ["nodeId", "executions"], "type": "object", "additionalProperties": false}, "IPostPipeline": {"properties": {"name": {"type": "string"}, "projectId": {"type": "string"}, "startNodes": {"items": {"$ref": "#/components/schemas/IStartNode"}, "type": "array"}, "spec": {}, "compositionId": {"type": "string"}, "description": {"type": "string"}, "preview": {"type": "string"}, "nodes": {"items": {"$ref": "#/components/schemas/PipelineNodeDescriptor"}, "type": "array"}, "connections": {"items": {"$ref": "#/components/schemas/PipelineConnection"}, "type": "array"}, "secrets": {"items": {"type": "string"}, "type": "array", "description": "Array of integrations ids - each one will be added to the service deployment as an environment variable"}, "variables": {"items": {"$ref": "#/components/schemas/PipelineVariable"}, "type": "array"}}, "required": ["name", "projectId", "description", "preview", "nodes", "connections", "secrets"], "type": "object", "additionalProperties": false}, "IPipelineExecutionCount": {"properties": {"status": {"$ref": "#/components/schemas/EPipelineStatus"}, "count": {"type": "number", "format": "double"}}, "required": ["status", "count"], "type": "object", "additionalProperties": false}, "IExecutionCount": {"properties": {"status": {"$ref": "#/components/schemas/ExecutionStatusName"}, "count": {"type": "number", "format": "double"}}, "required": ["status", "count"], "type": "object", "additionalProperties": false}, "INodeExecutionCount": {"properties": {"nodeId": {"type": "string"}, "statusCount": {"items": {"$ref": "#/components/schemas/IExecutionCount"}, "type": "array"}}, "required": ["nodeId", "statusCount"], "type": "object", "additionalProperties": false}, "IExecutionStatistics": {"properties": {"avgTimePerExecution": {"type": "number", "format": "double"}, "avgExecutionsPerDay": {"type": "number", "format": "double"}}, "required": ["avgTimePerExecution", "avgExecutionsPerDay"], "type": "object", "additionalProperties": false}, "INodeExecutionStatistics": {"properties": {"nodeId": {"type": "string"}, "executionStatistics": {"$ref": "#/components/schemas/IExecutionStatistics"}}, "required": ["nodeId", "executionStatistics"], "type": "object", "additionalProperties": false}, "IPipelineStatistics": {"properties": {"pipelineExecutionCounters": {"items": {"$ref": "#/components/schemas/IPipelineExecutionCount"}, "type": "array"}, "nodeExecutionsCounters": {"items": {"$ref": "#/components/schemas/INodeExecutionCount"}, "type": "array"}, "pipelineExecutionStatistics": {"$ref": "#/components/schemas/IExecutionStatistics"}, "nodeExecutionStatistics": {"items": {"$ref": "#/components/schemas/INodeExecutionStatistics"}, "type": "array"}}, "required": ["pipelineExecutionCounters", "nodeExecutionsCounters"], "type": "object", "additionalProperties": false}, "ExecutePipelinePayload": {"properties": {"testMode": {"type": "boolean"}, "input": {}, "nodeId": {"type": "string"}, "id": {"type": "string"}}, "type": "object"}, "ExecuteOptionsBatchQuery": {"properties": {"join": {"$ref": "#/components/schemas/Dictionary"}, "context": {"properties": {"items": {"items": {"type": "string"}, "type": "array"}, "datasets": {"items": {"type": "string"}, "type": "array"}}, "type": "object"}, "resource": {"$ref": "#/components/schemas/QueryResource"}, "filter": {"type": "string"}}, "required": ["resource", "filter"], "type": "object"}, "ExecuteOptionsBatch": {"properties": {"args": {"$ref": "#/components/schemas/Dictionary"}, "query": {"$ref": "#/components/schemas/ExecuteOptionsBatchQuery"}}, "required": ["query"], "type": "object"}, "ExecuteOptions": {"properties": {"batch": {"$ref": "#/components/schemas/ExecuteOptionsBatch"}, "pipeline": {"$ref": "#/components/schemas/ExecutePipelinePayload"}}, "required": ["batch", "pipeline"], "type": "object"}, "NodeDescriptor": {"properties": {"id": {"type": "string"}, "config": {"$ref": "#/components/schemas/INodeConfig"}, "namespace": {"$ref": "#/components/schemas/NodeNamespace"}, "inputs": {"items": {"$ref": "#/components/schemas/PortIO"}, "type": "array"}, "outputs": {"items": {"$ref": "#/components/schemas/PortIO"}, "type": "array"}, "type": {"$ref": "#/components/schemas/NodeType"}, "projectId": {"type": "string"}, "name": {"type": "string"}, "appName": {"type": "string"}, "dpkName": {"type": "string"}}, "required": ["id", "namespace", "inputs", "outputs", "type", "name"], "type": "object", "additionalProperties": false}, "CompositionStatusDescriptor": {"properties": {"running": {"type": "number", "format": "double"}, "failed": {"type": "number", "format": "double"}, "pending": {"type": "number", "format": "double"}, "standBy": {"type": "number", "format": "double"}}, "required": ["running", "failed", "pending", "standBy"], "type": "object", "additionalProperties": false}, "CursorPageAPIPipeline": {"properties": {"hasNextPage": {"type": "boolean"}, "totalPagesCount": {"type": "number", "format": "double"}, "items": {"items": {"$ref": "#/components/schemas/APIPipeline"}, "type": "array"}, "totalItemsCount": {"type": "number", "format": "double"}}, "required": ["hasNextPage", "totalPagesCount", "items", "totalItemsCount"], "type": "object"}, "PipelineNodeCategory": {"properties": {"color": {"type": "string"}}, "required": ["color"], "type": "object", "additionalProperties": false}, "Module": {"properties": {"name": {"type": "string"}, "entryPoint": {"type": "string"}, "className": {"type": "string"}, "initInputs": {"items": {"$ref": "#/components/schemas/PackageIO"}, "type": "array"}, "functions": {"items": {"$ref": "#/components/schemas/DLFunction"}, "type": "array"}}, "required": ["name", "entryPoint", "className", "initInputs", "functions"], "type": "object", "additionalProperties": false}, "UiHook": {"properties": {"bindTo": {"type": "string"}, "config": {}, "icon": {"type": "string"}, "slots": {"items": {"type": "string"}, "type": "array"}}, "required": ["bindTo", "config", "icon", "slots"], "type": "object", "additionalProperties": false}, "PiperUiSlot": {"properties": {"moduleName": {"type": "string"}, "functionName": {"type": "string"}, "displayName": {"type": "string"}, "displayScopes": {"items": {"$ref": "#/components/schemas/DisplayScope"}, "type": "array"}, "postAction": {"$ref": "#/components/schemas/ExecutionPostAction"}, "displayIcon": {"type": "string"}, "defaultInputs": {"items": {"$ref": "#/components/schemas/DLFunctionDefaultInputSpec"}, "type": "array"}, "inputOptions": {"items": {"$ref": "#/components/schemas/DLFunctionInputOptionsSpec"}, "type": "array"}}, "required": ["moduleName", "functionName", "displayName", "displayScopes", "postAction"], "type": "object", "additionalProperties": false}, "PackageType": {"enum": ["app", "faas", "ml"], "type": "string"}, "PackageMetadata": {"properties": {"user": {"$ref": "#/components/schemas/Dictionary"}, "system": {"$ref": "#/components/schemas/Dictionary"}}, "type": "object", "additionalProperties": false}, "APIPackage": {"properties": {"id": {"type": "string"}, "url": {"type": "string"}, "version": {"type": "string"}, "createdAt": {"type": "string", "format": "date-time"}, "updatedAt": {"type": "string", "format": "date-time"}, "creator": {"type": "string"}, "updatedBy": {"type": "string"}, "name": {"type": "string"}, "global": {"type": "boolean"}, "projectId": {"type": "string"}, "codebase": {"$ref": "#/components/schemas/Codebase"}, "modules": {"items": {"$ref": "#/components/schemas/Module"}, "type": "array"}, "uiHooks": {"items": {"$ref": "#/components/schemas/UiHook"}, "type": "array"}, "slots": {"items": {"$ref": "#/components/schemas/PiperUiSlot"}, "type": "array"}, "serviceConfig": {"$ref": "#/components/schemas/ServiceConfig"}, "type": {"$ref": "#/components/schemas/PackageType"}, "requirements": {"items": {"$ref": "#/components/schemas/PackageRequirement"}, "type": "array"}, "metadata": {"$ref": "#/components/schemas/PackageMetadata"}, "panels": {"items": {"$ref": "#/components/schemas/Panel"}, "type": "array"}}, "required": ["id", "url", "version", "createdAt", "updatedAt", "creator", "updatedBy", "name", "global", "projectId", "codebase", "modules", "type"], "type": "object", "additionalProperties": false}, "PackagesPage": {"properties": {"totalItemsCount": {"type": "number", "format": "double"}, "items": {"items": {"$ref": "#/components/schemas/APIPackage"}, "type": "array"}, "totalPagesCount": {"type": "number", "format": "double"}, "hasNextPage": {"type": "boolean"}}, "required": ["totalItemsCount", "items", "totalPagesCount", "hasNextPage"], "type": "object", "additionalProperties": false}, "JobMetadata": {"properties": {"appId": {"type": "string"}, "panelName": {"type": "string"}, "mountFilePath": {"type": "string"}}, "type": "object", "additionalProperties": false}, "JobRuntime": {"properties": {"concurrency": {"type": "number", "format": "double"}, "singleAgent": {"type": "boolean"}, "podType": {"$ref": "#/components/schemas/DataloopPodType"}, "image": {"type": "string"}, "preemptible": {"type": "boolean"}, "gpuFraction": {"type": "number", "format": "double", "description": "GPU fraction for Run:ai (0.25, 0.5, 1). When < 1 with useFractionalGpu, uses fractional GPU sharing"}, "gpuFractionNumDevices": {"type": "number", "format": "double", "description": "Number of GPU devices to apply fraction across (Run:ai gpu-fraction-num-devices). Default 1"}}, "required": ["podType", "image"], "type": "object", "additionalProperties": false}, "JobStatusEnum": {"enum": ["success", "failure", "created"], "type": "string"}, "JobStatus": {"properties": {"status": {"$ref": "#/components/schemas/JobStatusEnum"}, "message": {"type": "string"}}, "required": ["status"], "type": "object", "additionalProperties": false}, "Job": {"properties": {"_id": {"$ref": "#/components/schemas/ObjectID"}, "driverId": {"type": "string"}, "orgId": {"type": "string"}, "projectId": {"type": "string"}, "metadata": {"$ref": "#/components/schemas/JobMetadata"}, "runtime": {"$ref": "#/components/schemas/JobRuntime"}, "status": {"$ref": "#/components/schemas/JobStatus"}, "bot": {"type": "string"}, "packageRevision": {"type": "string"}, "sdkVersion": {"type": "string"}, "packageId": {"type": "string"}}, "required": ["driverId", "metadata", "runtime", "status", "bot", "packageRevision", "sdkVersion", "packageId"], "type": "object", "additionalProperties": false}, "Partial_Job_": {"properties": {"_id": {"$ref": "#/components/schemas/ObjectId"}, "driverId": {"type": "string"}, "orgId": {"type": "string"}, "projectId": {"type": "string"}, "metadata": {"$ref": "#/components/schemas/JobMetadata"}, "runtime": {"$ref": "#/components/schemas/JobRuntime"}, "status": {"$ref": "#/components/schemas/JobStatus"}, "bot": {"type": "string"}, "packageRevision": {"type": "string"}, "sdkVersion": {"type": "string"}, "packageId": {"type": "string"}}, "type": "object", "description": "Make all properties in T optional"}, "ExecutionsPage": {"properties": {"totalItemsCount": {"type": "number", "format": "double"}, "items": {"items": {"$ref": "#/components/schemas/APIExecution"}, "type": "array"}, "totalPagesCount": {"type": "number", "format": "double"}, "hasNextPage": {"type": "boolean"}}, "required": ["totalItemsCount", "items", "totalPagesCount", "hasNextPage"], "type": "object", "additionalProperties": false}, "ExecutionsOrderByType": {"enum": ["createdAt", "updatedAt"], "type": "string"}, "ExecutionsOrderByDirection": {"enum": ["asc", "desc"], "type": "string"}, "CommandPriority": {"type": "number", "format": "double"}, "CommandError": {"properties": {"_id": {"$ref": "#/components/schemas/ObjectId"}, "message": {"type": "string"}, "stack": {"type": "string"}, "metadata": {"type": "string"}}, "required": ["_id", "message", "stack"], "type": "object", "additionalProperties": false}, "CommandStatus": {"enum": ["created", "in-progress", "making-children", "waiting-children", "aborted", "canceled", "finalizing", "cleaning-up", "on-error", "success", "failed", "timeout"], "type": "string"}, "CommandStatusHistoryEntry": {"properties": {"status": {"$ref": "#/components/schemas/CommandStatus"}, "date": {"type": "string", "format": "date-time"}, "startedExecution": {"type": "boolean"}, "startedExecutionDate": {"type": "string", "format": "date-time"}}, "required": ["status", "date", "startedExecution", "startedExecutionDate"], "type": "object", "additionalProperties": false}, "HttpContext": {"properties": {"id": {"type": "string", "description": "Http Request Id"}, "user": {"type": "string", "description": "Requesting user"}, "client": {"type": "string", "description": "Client used for the request"}, "endpointId": {"type": "string", "description": "Given request from a Dataloop FaaS service - service identifier"}, "jwtExp": {"type": "number", "format": "double", "description": "Expiration time of the Http Request JWT"}}, "required": ["id", "user", "client"], "type": "object", "additionalProperties": false}, "CommandCtx": {"properties": {"creator": {"type": "string"}, "projectId": {"type": "string"}, "orgId": {"type": "string"}, "request": {"$ref": "#/components/schemas/HttpContext", "description": "Http Request Context the command was created in"}}, "required": ["creator"], "type": "object", "additionalProperties": false}, "ChildrenCommandsProgress": {"properties": {"success": {"type": "number", "format": "double"}, "failed": {"type": "number", "format": "double"}, "aborted": {"type": "number", "format": "double"}, "errors": {"items": {"$ref": "#/components/schemas/CommandError"}, "type": "array"}}, "required": ["success", "failed", "aborted"], "type": "object", "additionalProperties": false}, "CommandsDomain": {"enum": ["data", "workflows", "faas", "billing", "model-management", "settings"], "type": "string"}, "PiperSettingsCommands": {"properties": {"_id": {"$ref": "#/components/schemas/ObjectId"}, "createdAt": {"type": "string", "format": "date-time"}, "updatedAt": {"type": "string", "format": "date-time"}, "parentCommandId": {"$ref": "#/components/schemas/ObjectId"}, "visitedCount": {"type": "number", "format": "double", "description": "Number of times execution attempted"}, "type": {"type": "string", "description": "type of the command to process as string"}, "childsCount": {"type": "number", "format": "double", "description": "Number of child commands"}, "persistedChildsCount": {"type": "number", "format": "double", "description": "Number of child commands persisted"}, "dispatchedChildsCount": {"type": "number", "format": "double", "description": "Number of child commands dispatched for execution"}, "childsEstimationCount": {"type": "number", "format": "double", "description": "Estimated child commands count"}, "spec": {"$ref": "#/components/schemas/Dictionary", "description": "To be used by developer for storing command state"}, "priority": {"$ref": "#/components/schemas/CommandPriority", "description": "Optional Pod priority for routing"}, "error": {"$ref": "#/components/schemas/CommandError", "description": "Execution error"}, "status": {"$ref": "#/components/schemas/CommandStatus", "description": "Command current status"}, "statusHistory": {"items": {"$ref": "#/components/schemas/CommandStatusHistoryEntry"}, "type": "array", "description": "Command status log"}, "trackingInfo": {"properties": {"route": {"type": "string"}, "exchange": {"type": "string"}}, "required": ["route", "exchange"], "type": "object"}, "ctx": {"$ref": "#/components/schemas/CommandCtx", "description": "Command ctx"}, "childrenProgress": {"$ref": "#/components/schemas/ChildrenCommandsProgress", "description": "Command children progress counters"}, "domain": {"$ref": "#/components/schemas/CommandsDomain"}, "report": {"$ref": "#/components/schemas/Dictionary"}, "retry": {"properties": {"nonRetryableError": {"type": "boolean"}, "attempts": {"type": "number", "format": "double"}, "maxRetries": {"type": "number", "format": "double"}}, "required": ["attempts", "maxRetries"], "type": "object"}}, "required": ["_id", "createdAt", "visitedCount", "type", "childsCount", "persistedChildsCount", "dispatchedChildsCount", "childsEstimationCount", "status", "statusHistory", "trackingInfo", "ctx", "childrenProgress", "domain"], "type": "object", "additionalProperties": false}, "APIExecutionPatch": {"properties": {"duration": {"type": "number", "format": "double"}, "serviceVersion": {"type": "string"}}, "type": "object", "additionalProperties": false}, "ExecutionPipeline": {"properties": {"id": {"type": "string"}, "nodeId": {"type": "string"}, "executionId": {"type": "string"}, "archived": {"type": "boolean"}}, "required": ["id", "nodeId", "executionId"], "type": "object", "additionalProperties": false}, "WorkloadParams": {"properties": {"agentId": {"type": "string"}, "serviceId": {"type": "string"}, "load": {"type": "number", "format": "double"}}, "required": ["agentId", "serviceId", "load"], "type": "object", "additionalProperties": false}, "APIPostDpk": {"properties": {"name": {"type": "string", "description": "The app name"}, "version": {"type": "string", "description": "The app version"}, "attributes": {"properties": {}, "additionalProperties": {"anyOf": [{"type": "string"}, {"items": {"type": "string"}, "type": "array"}]}, "type": "object", "description": "List of attributes linked to the app"}, "displayName": {"type": "string", "description": "The display Name"}, "description": {"type": "string", "description": "description of the dpk"}, "icon": {"type": "string", "description": "icon style - should present in the ui platform"}, "tags": {"items": {"type": "string"}, "type": "array", "description": "List of tags linked to the app"}, "codebase": {"$ref": "#/components/schemas/Codebase"}, "scope": {"$ref": "#/components/schemas/EDpkScope", "description": "the scope is belong to"}, "trusted": {"type": "boolean"}, "components": {"anyOf": [{"$ref": "#/components/schemas/DpkComponents"}, {"$ref": "#/components/schemas/DpkComponentsFlatten"}]}, "context": {"$ref": "#/components/schemas/IAppContext"}}, "required": ["name", "codebase", "components"], "type": "object", "additionalProperties": false}, "CursorPageAPIDpk": {"properties": {"hasNextPage": {"type": "boolean"}, "totalPagesCount": {"type": "number", "format": "double"}, "items": {"items": {"$ref": "#/components/schemas/APIDpk"}, "type": "array"}, "totalItemsCount": {"type": "number", "format": "double"}}, "required": ["hasNextPage", "totalPagesCount", "items", "totalItemsCount"], "type": "object"}, "DpkAttributeValueDefinition": {"properties": {"name": {"type": "string"}, "displayName": {"type": "string"}, "icon": {"properties": {"light": {"type": "string"}, "dark": {"type": "string"}}, "type": "object"}, "color": {"properties": {"light": {"type": "string"}, "dark": {"type": "string"}}, "type": "object"}, "description": {"type": "string"}, "link": {"type": "string"}}, "required": ["name"], "type": "object", "additionalProperties": false}, "DpkAttributesDefinition": {"properties": {"key": {"type": "string"}, "values": {"items": {"$ref": "#/components/schemas/DpkAttributeValueDefinition"}, "type": "array"}, "isMultiple": {"type": "boolean"}}, "required": ["key", "values", "isMultiple"], "type": "object", "additionalProperties": false}, "PreviewsComponentsPatch": {"properties": {"pipelineTemplates": {"items": {"properties": {"preview": {"type": "string"}, "name": {"type": "string"}}, "required": ["preview", "name"], "type": "object"}, "type": "array"}}, "required": ["pipelineTemplates"], "type": "object"}, "APIPatchDpk": {"properties": {"attributes": {"properties": {}, "additionalProperties": {"anyOf": [{"type": "string"}, {"items": {"type": "string"}, "type": "array"}]}, "type": "object", "description": "List of attributes linked to the app"}, "displayName": {"type": "string", "description": "The display Name"}, "description": {"type": "string", "description": "description of the dpk"}, "icon": {"type": "string", "description": "icon style - should present in the ui platform"}, "components": {"$ref": "#/components/schemas/PreviewsComponentsPatch", "description": "List of tags linked to the app"}}, "type": "object", "additionalProperties": false}, "AgentCtx": {"properties": {"projectId": {"type": "string"}, "orgId": {"type": "string"}, "serviceId": {"type": "string"}}, "type": "object", "additionalProperties": false}, "ICompute": {"properties": {"_id": {"$ref": "#/components/schemas/ObjectID"}, "name": {"type": "string"}, "context": {"$ref": "#/components/schemas/IComputeContext"}, "sharedContexts": {"items": {"$ref": "#/components/schemas/IComputeContext"}, "type": "array"}, "global": {"type": "boolean"}, "createdAt": {"type": "string", "format": "date-time"}, "updatedAt": {"type": "string", "format": "date-time"}, "orgIds": {"items": {"type": "string"}, "type": "array"}, "type": {"$ref": "#/components/schemas/EComputeType"}, "metadata": {"$ref": "#/components/schemas/ComputeMetadata"}, "status": {"$ref": "#/components/schemas/EComputeStatus"}, "archived": {"type": "boolean"}, "settings": {"$ref": "#/components/schemas/IComputeSettings"}, "createdBy": {"type": "string", "description": "User id or email of the user who created the compute"}, "defaultNamespace": {"type": "string"}}, "required": ["_id", "name", "context", "sharedContexts", "createdAt", "updatedAt", "orgIds", "type", "status"], "type": "object", "additionalProperties": false}, "Partial_ICompute_": {"properties": {"_id": {"$ref": "#/components/schemas/ObjectId"}, "name": {"type": "string"}, "context": {"$ref": "#/components/schemas/IComputeContext"}, "sharedContexts": {"items": {"$ref": "#/components/schemas/IComputeContext"}, "type": "array"}, "global": {"type": "boolean"}, "createdAt": {"type": "string", "format": "date-time"}, "updatedAt": {"type": "string", "format": "date-time"}, "orgIds": {"items": {"type": "string"}, "type": "array"}, "type": {"$ref": "#/components/schemas/EComputeType"}, "metadata": {"$ref": "#/components/schemas/ComputeMetadata"}, "status": {"$ref": "#/components/schemas/EComputeStatus"}, "archived": {"type": "boolean"}, "settings": {"$ref": "#/components/schemas/IComputeSettings"}, "createdBy": {"type": "string", "description": "User id or email of the user who created the compute"}, "defaultNamespace": {"type": "string"}}, "type": "object", "description": "Make all properties in T optional"}, "IPostComposition": {"properties": {"driverId": {"type": "string", "description": "The user cluster driver id - defining the compute cluster the server should connect to"}, "channels": {"items": {"$ref": "#/components/schemas/ICompositionChannel"}, "type": "array", "description": "Array of channels details"}, "spec": {"items": {"$ref": "#/components/schemas/APIServiceCompositionElement"}, "type": "array", "description": "An array of services"}, "tasks": {"items": {"$ref": "#/components/schemas/ICompositionTask"}, "type": "array", "description": "An array of tasks"}, "packages": {"items": {"$ref": "#/components/schemas/ICompositionPackage"}, "type": "array", "description": "An array of packages"}, "triggers": {"items": {"$ref": "#/components/schemas/ICompositionTrigger"}, "type": "array", "description": "An array of triggers"}, "projectId": {"type": "string", "description": "The project where the composition should be install the entities"}, "name": {"type": "string", "description": "The composition name"}}, "required": ["driverId", "spec", "projectId", "name"], "type": "object"}, "CursorPageAPIComposition": {"properties": {"hasNextPage": {"type": "boolean"}, "totalPagesCount": {"type": "number", "format": "double"}, "items": {"items": {"$ref": "#/components/schemas/APIComposition"}, "type": "array"}, "totalItemsCount": {"type": "number", "format": "double"}}, "required": ["hasNextPage", "totalPagesCount", "items", "totalItemsCount"], "type": "object"}, "APIPostApp": {"properties": {"name": {"type": "string", "description": "The app name"}, "projectId": {"type": "string", "description": "The project where the app should be install"}, "dpkName": {"type": "string", "description": "A unique DPK app name"}, "dpkVersion": {"type": "string", "description": "The version of the dpk app"}, "scope": {"$ref": "#/components/schemas/EAppScope", "description": "The app scope"}, "customInstallation": {"$ref": "#/components/schemas/CustomInstallation"}}, "required": ["name", "projectId", "dpkName"], "type": "object", "additionalProperties": false}, "APIPatchApp": {"properties": {"name": {"type": "string", "description": "The app name"}, "dpkName": {"type": "string", "description": "A unique DPK app name"}, "dpkVersion": {"type": "string", "description": "The version of the dpk app"}, "trusted": {"type": "boolean"}, "customInstallation": {"$ref": "#/components/schemas/CustomInstallation"}, "status": {"$ref": "#/components/schemas/CompositionStatus"}}, "required": ["name", "dpkName"], "type": "object", "additionalProperties": false}, "PipelineType": {"enum": ["regular", "template"], "type": "string"}, "ITextSearch": {"properties": {"name": {"type": "string"}, "projectName": {"type": "string"}, "orgName": {"type": "string"}}, "required": ["name", "projectName", "orgName"], "type": "object", "additionalProperties": false}, "IPipeline": {"properties": {"_id": {"$ref": "#/components/schemas/ObjectID"}, "name": {"type": "string"}, "creator": {"type": "string"}, "createdAt": {"type": "string", "format": "date-time"}, "updatedAt": {"type": "string", "format": "date-time"}, "updatedBy": {"type": "string"}, "type": {"$ref": "#/components/schemas/PipelineType"}, "orgId": {"type": "string"}, "projectId": {"type": "string"}, "terminated": {"type": "boolean"}, "startNodes": {"items": {"$ref": "#/components/schemas/IStartNode"}, "type": "array"}, "spec": {}, "compositionId": {"type": "string"}, "description": {"type": "string"}, "preview": {"type": "string"}, "nodes": {"items": {"$ref": "#/components/schemas/PipelineNodeDescriptor"}, "type": "array"}, "connections": {"items": {"$ref": "#/components/schemas/PipelineConnection"}, "type": "array"}, "templateKind": {"$ref": "#/components/schemas/TemplateKind"}, "maxAttempts": {"type": "number", "format": "double"}, "resetTimestamp": {"type": "string", "format": "date-time"}, "textSearch": {"$ref": "#/components/schemas/ITextSearch"}, "status": {"$ref": "#/components/schemas/CompositionStatus"}, "settings": {"$ref": "#/components/schemas/IPipelineSettings"}, "variables": {"items": {"$ref": "#/components/schemas/PipelineVariable"}, "type": "array"}, "template": {"properties": {"state": {"$ref": "#/components/schemas/PipelineFromTemplateState"}, "id": {"type": "string"}}, "required": ["state", "id"], "type": "object"}}, "required": ["_id", "name", "creator", "createdAt", "updatedAt", "type", "orgId", "projectId", "terminated", "description", "preview", "nodes", "connections", "maxAttempts", "status"], "type": "object", "additionalProperties": false}, "IVersion": {"properties": {"latestVersion": {"type": "string"}, "latestForcedVersion": {"type": "boolean"}}, "required": ["latestVersion", "latestForcedVersion"], "type": "object", "additionalProperties": true}, "SettingsValueTypes": {"enum": ["boolean", "number", "select", "multi-select", "string", "object", "array"], "type": "string"}, "PlatformEntityType": {"enum": ["user", "task", "dataset", "project", "billing-project", "org", "billing-org"], "type": "string"}, "SettingScope": {"properties": {"type": {"anyOf": [{"$ref": "#/components/schemas/PlatformEntityType"}, {"type": "string", "enum": ["DATALOOP"]}]}, "id": {"anyOf": [{"type": "string"}, {"type": "string", "enum": ["*"]}]}, "role": {"anyOf": [{"$ref": "#/components/schemas/Role"}, {"$ref": "#/components/schemas/OrgRole"}, {"type": "string", "enum": ["*"]}]}, "preventOverride": {"type": "boolean"}, "visible": {"type": "boolean"}}, "required": ["type", "id", "role", "preventOverride", "visible"], "type": "object", "additionalProperties": true}, "SettingsTypes": {"enum": ["feature_flag", "user_settings"], "type": "string"}, "APIFeatureFlag": {"properties": {"id": {"type": "string"}, "defaultValue": {"description": "the value that will be taken if no value was passed"}, "name": {"type": "string", "description": "the name of the setting"}, "value": {"description": "the value of the setting"}, "valueType": {"$ref": "#/components/schemas/SettingsValueTypes", "description": "the value type of the setting"}, "scope": {"$ref": "#/components/schemas/SettingScope", "description": "the scope in which the setting is defined."}, "metadata": {"$ref": "#/components/schemas/Dictionary"}, "settingType": {"$ref": "#/components/schemas/SettingsTypes", "description": "the setting type\ncan either be UserSetting or FeatureFlag"}, "createdAt": {"type": "string", "format": "date-time"}, "createdBy": {"type": "string"}, "updatedAt": {"type": "string", "format": "date-time"}, "updatedBy": {"type": "string"}, "expiredAt": {"type": "string", "format": "date-time", "description": "the date the feature flag expired"}, "expired": {"type": "boolean", "description": "value of that is interpreted from the expired at date. it signals if the flag is expired or not"}}, "required": ["id", "defaultValue", "name", "value", "valueType", "scope", "metadata", "settingType", "createdAt", "createdBy", "updatedAt", "expired"], "type": "object", "additionalProperties": true}, "SettingsSectionNames": {"enum": ["Account", "Contact", "Applications", "Studio", "Platform", "SDK"], "type": "string"}, "APIUserSetting": {"properties": {"id": {"type": "string"}, "defaultValue": {"description": "the value that will be taken if no value was passed"}, "name": {"type": "string", "description": "the name of the setting"}, "value": {"description": "the value of the setting"}, "valueType": {"$ref": "#/components/schemas/SettingsValueTypes", "description": "the value type of the setting"}, "scope": {"$ref": "#/components/schemas/SettingScope", "description": "the scope in which the setting is defined."}, "metadata": {"$ref": "#/components/schemas/Dictionary"}, "settingType": {"$ref": "#/components/schemas/SettingsTypes", "description": "the setting type\ncan either be UserSetting or FeatureFlag"}, "createdAt": {"type": "string", "format": "date-time"}, "createdBy": {"type": "string"}, "updatedAt": {"type": "string", "format": "date-time"}, "updatedBy": {"type": "string"}, "description": {"type": "string", "description": "description field for the user setting"}, "inputs": {"description": "inputs specified for the user setting"}, "icon": {"type": "string", "description": "an icon for the setting"}, "hint": {"type": "string", "description": "a hint for the setting"}, "sectionName": {"$ref": "#/components/schemas/SettingsSectionNames", "description": "the main section that the setting belongs to"}, "subSectionName": {"type": "string", "description": "the sub section that the setting belongs to"}}, "required": ["id", "defaultValue", "name", "value", "valueType", "scope", "metadata", "settingType", "createdAt", "createdBy", "updatedAt", "inputs", "sectionName"], "type": "object", "additionalProperties": true}, "IUserContext": {"properties": {"userId": {"type": "string", "description": "ID of the User"}, "orgId": {"type": "string", "description": "ID of the Org"}, "projectId": {"type": "string", "description": "ID of the Project"}, "taskId": {"type": "string", "description": "ID of the Task"}, "datasetId": {"type": "string", "description": "ID of the Dataset"}}, "required": ["userId"], "type": "object", "additionalProperties": true}, "ResolverPayload": {"properties": {"userCtx": {"$ref": "#/components/schemas/IUserContext", "description": "User Context"}, "flags": {"anyOf": [{"type": "string"}, {"items": {"type": "string"}, "type": "array"}], "description": "Specific flags to resolve"}}, "required": ["userCtx"], "type": "object", "additionalProperties": true}, "CreateSettingRequest": {"properties": {"defaultValue": {"description": "the value that will be taken if no value was passed"}, "name": {"type": "string", "description": "the name of the setting"}, "value": {"description": "the value of the setting"}, "valueType": {"$ref": "#/components/schemas/SettingsValueTypes", "description": "the value type of the setting"}, "scope": {"$ref": "#/components/schemas/SettingScope", "description": "the scope in which the setting is defined."}, "metadata": {"allOf": [{"$ref": "#/components/schemas/Dictionary"}], "nullable": true}, "settingType": {"$ref": "#/components/schemas/SettingsTypes", "description": "the setting type\ncan either be UserSetting or FeatureFlag"}}, "required": ["name", "valueType", "scope", "settingType"], "type": "object", "additionalProperties": true}, "CreateFeatureFlagRequest": {"properties": {"defaultValue": {"description": "the value that will be taken if no value was passed"}, "name": {"type": "string", "description": "the name of the setting"}, "value": {"description": "the value of the setting"}, "valueType": {"$ref": "#/components/schemas/SettingsValueTypes", "description": "the value type of the setting"}, "scope": {"$ref": "#/components/schemas/SettingScope", "description": "the scope in which the setting is defined."}, "metadata": {"allOf": [{"$ref": "#/components/schemas/Dictionary"}], "nullable": true}, "settingType": {"$ref": "#/components/schemas/SettingsTypes", "description": "the setting type\ncan either be UserSetting or FeatureFlag"}, "expiredAt": {"type": "string", "format": "date-time", "nullable": true, "description": "the date the feature flag expired"}}, "required": ["name", "valueType", "scope", "settingType"], "type": "object", "additionalProperties": true}, "CreateUserSettingRequest": {"properties": {"defaultValue": {"description": "the value that will be taken if no value was passed"}, "name": {"type": "string", "description": "the name of the setting"}, "value": {"description": "the value of the setting"}, "valueType": {"$ref": "#/components/schemas/SettingsValueTypes", "description": "the value type of the setting"}, "scope": {"$ref": "#/components/schemas/SettingScope", "description": "the scope in which the setting is defined."}, "metadata": {"allOf": [{"$ref": "#/components/schemas/Dictionary"}], "nullable": true}, "settingType": {"$ref": "#/components/schemas/SettingsTypes", "description": "the setting type\ncan either be UserSetting or FeatureFlag"}, "description": {"type": "string", "nullable": true, "description": "description field for the user setting"}, "inputs": {"description": "inputs specified for the user setting"}, "icon": {"type": "string", "nullable": true, "description": "an icon for the setting"}, "hint": {"type": "string", "nullable": true, "description": "a hint for the setting"}, "sectionName": {"allOf": [{"$ref": "#/components/schemas/SettingsSectionNames"}], "nullable": true, "description": "the main section that the setting belongs to"}, "subSectionName": {"type": "string", "nullable": true, "description": "the sub section that the setting belongs to"}}, "required": ["name", "valueType", "scope", "settingType", "sectionName"], "type": "object", "additionalProperties": true}, "Partial_SettingScope_": {"properties": {"type": {"anyOf": [{"$ref": "#/components/schemas/PlatformEntityType"}, {"type": "string", "enum": ["DATALOOP"]}], "description": "The type for which the setting belongs"}, "id": {"anyOf": [{"type": "string"}, {"type": "string", "enum": ["*"]}], "description": "The id for which the setting belongs"}, "role": {"anyOf": [{"$ref": "#/components/schemas/Role"}, {"$ref": "#/components/schemas/OrgRole"}, {"type": "string", "enum": ["*"]}], "description": "The role for which the setting belongs"}, "preventOverride": {"type": "boolean", "description": "allow other settings to override this setting"}, "visible": {"type": "boolean", "description": "a toggle if the setting is visible or not"}}, "type": "object", "description": "Make all properties in T optional"}, "PatchFeatureFlagRequest": {"properties": {"defaultValue": {"description": "the value that will be taken if no value was passed"}, "value": {"description": "the value of the setting"}, "valueType": {"allOf": [{"$ref": "#/components/schemas/SettingsValueTypes"}], "nullable": true, "description": "the value type of the setting"}, "scope": {"allOf": [{"$ref": "#/components/schemas/Partial_SettingScope_"}], "nullable": true, "description": "the scope in which the setting is defined."}, "metadata": {"allOf": [{"$ref": "#/components/schemas/Dictionary"}], "nullable": true}, "expiredAt": {"type": "string", "format": "date-time", "nullable": true, "description": "the date the feature flag expired"}}, "type": "object", "additionalProperties": true}, "PatchUserSettingRequest": {"properties": {"defaultValue": {"description": "the value that will be taken if no value was passed"}, "value": {"description": "the value of the setting"}, "valueType": {"allOf": [{"$ref": "#/components/schemas/SettingsValueTypes"}], "nullable": true, "description": "the value type of the setting"}, "scope": {"allOf": [{"$ref": "#/components/schemas/Partial_SettingScope_"}], "nullable": true, "description": "the scope in which the setting is defined."}, "metadata": {"allOf": [{"$ref": "#/components/schemas/Dictionary"}], "nullable": true}, "description": {"type": "string", "nullable": true, "description": "description field for the user setting"}, "inputs": {"description": "inputs specified for the user setting"}, "icon": {"type": "string", "nullable": true, "description": "an icon for the setting"}, "hint": {"type": "string", "nullable": true, "description": "a hint for the setting"}, "sectionName": {"allOf": [{"$ref": "#/components/schemas/SettingsSectionNames"}], "nullable": true, "description": "the main section that the setting belongs to"}, "subSectionName": {"type": "string", "nullable": true, "description": "the sub section that the setting belongs to"}}, "type": "object", "additionalProperties": true}, "CursorPage_APIUserSetting-or-APIFeatureFlag_": {"properties": {"totalItemsCount": {"type": "number", "format": "double"}, "items": {"items": {"anyOf": [{"$ref": "#/components/schemas/APIUserSetting"}, {"$ref": "#/components/schemas/APIFeatureFlag"}]}, "type": "array"}, "totalPagesCount": {"type": "number", "format": "double"}, "hasNextPage": {"type": "boolean"}}, "required": ["totalItemsCount", "items", "totalPagesCount", "hasNextPage"], "type": "object", "additionalProperties": true}, "MigrationSpec": {"allOf": [{"$ref": "#/components/schemas/Dictionary"}, {"properties": {"report": {"type": "boolean"}, "fix": {"type": "boolean"}}, "type": "object"}]}, "RemoveSettingTraceMigrationSpec": {"allOf": [{"$ref": "#/components/schemas/MigrationSpec"}, {"properties": {"settingName": {"anyOf": [{"type": "string"}, {"items": {"type": "string"}, "type": "array"}]}}, "required": ["settingName"], "type": "object"}]}, "UIHours": {"properties": {"sum": {"type": "number", "format": "double"}, "roles": {"properties": {}, "additionalProperties": {"type": "number", "format": "double"}, "type": "object"}}, "required": ["sum", "roles"], "type": "object", "additionalProperties": true}, "APICallResourceDescriptor": {"properties": {"sum": {"type": "number", "format": "double"}, "actions": {"properties": {}, "additionalProperties": {"type": "number", "format": "double"}, "type": "object"}}, "required": ["sum", "actions"], "type": "object", "additionalProperties": true}, "APICallSourceDescriptor": {"properties": {"sum": {"type": "number", "format": "double"}, "resources": {"properties": {}, "additionalProperties": {"$ref": "#/components/schemas/APICallResourceDescriptor"}, "type": "object"}}, "required": ["sum", "resources"], "type": "object", "additionalProperties": true}, "APICallDescriptor": {"properties": {"ui": {"$ref": "#/components/schemas/APICallSourceDescriptor"}, "sdk": {"$ref": "#/components/schemas/APICallSourceDescriptor"}, "system": {"$ref": "#/components/schemas/APICallSourceDescriptor"}, "other": {"$ref": "#/components/schemas/APICallSourceDescriptor"}, "sum": {"type": "number", "format": "double"}}, "required": ["ui", "sdk", "system", "other", "sum"], "type": "object", "additionalProperties": true}, "StorageModificationSourceDescriptor": {"properties": {"added": {"type": "number", "format": "double"}, "removed": {"type": "number", "format": "double"}}, "required": ["added", "removed"], "type": "object", "additionalProperties": true}, "StorageModificationDescriptor": {"properties": {"ui": {"$ref": "#/components/schemas/StorageModificationSourceDescriptor"}, "sdk": {"$ref": "#/components/schemas/StorageModificationSourceDescriptor"}, "system": {"$ref": "#/components/schemas/StorageModificationSourceDescriptor"}, "other": {"$ref": "#/components/schemas/StorageModificationSourceDescriptor"}, "unknown": {"$ref": "#/components/schemas/StorageModificationSourceDescriptor"}, "total": {"$ref": "#/components/schemas/StorageModificationSourceDescriptor"}}, "required": ["ui", "sdk", "system", "other", "total"], "type": "object", "additionalProperties": true}, "StorageDatasetDescriptor": {"properties": {"id": {"type": "string"}, "modified": {"$ref": "#/components/schemas/StorageModificationDescriptor"}}, "required": ["id", "modified"], "type": "object", "additionalProperties": true}, "StorageDescriptor": {"properties": {"totalModified": {"$ref": "#/components/schemas/StorageModificationDescriptor"}, "totalPersist": {"type": "number", "format": "double"}, "datasets": {"items": {"$ref": "#/components/schemas/StorageDatasetDescriptor"}, "type": "array"}}, "required": ["totalModified", "totalPersist", "datasets"], "type": "object", "additionalProperties": true}, "PodType": {"enum": ["regular-xs", "regular-s", "regular-m", "regular-l", "highmem-xs", "highmem-s", "highmem-m", "highmem-l", "gpu-k80-s", "gpu-k80-m", "gpu-t4", "gpu-t4-m", "gpu-a100-s", "gpu-a100-m", "gpu-a100-4g", "gpu-a100-4g-m"], "type": "string"}, "FaasUsageServiceInstanceDescriptor": {"properties": {"serviceId": {"type": "string"}, "serviceName": {"type": "string"}, "instanceType": {"$ref": "#/components/schemas/PodType"}, "sum": {"type": "number", "format": "double"}, "hours": {"type": "number", "format": "double"}, "serviceType": {"$ref": "#/components/schemas/ServiceType"}, "driverId": {"type": "string"}, "cost": {"type": "number", "format": "double"}, "preemptible": {"type": "boolean"}}, "required": ["serviceId", "serviceName", "instanceType", "sum", "hours"], "type": "object", "additionalProperties": true}, "FaasGlobalServiceDescriptor": {"properties": {"serviceId": {"type": "string"}, "serviceName": {"type": "string"}, "calls": {"type": "number", "format": "double"}, "totalDuration": {"type": "number", "format": "double"}}, "required": ["serviceId", "serviceName", "calls", "totalDuration"], "type": "object", "additionalProperties": true}, "FaasUsageDescriptor": {"properties": {"services": {"items": {"$ref": "#/components/schemas/FaasUsageServiceInstanceDescriptor"}, "type": "array"}, "globalServices": {"items": {"$ref": "#/components/schemas/FaasGlobalServiceDescriptor"}, "type": "array"}}, "required": ["services"], "type": "object", "additionalProperties": true}, "ItemsCount": {"properties": {"total": {"type": "number", "format": "double"}, "totalAnnotated": {"type": "number", "format": "double"}}, "required": ["total", "totalAnnotated"], "type": "object", "additionalProperties": true}, "IngestedDatapointsDescriptor": {"properties": {"items": {"type": "number", "format": "double"}, "annotations": {"type": "number", "format": "double"}, "frames": {"type": "number", "format": "double"}}, "type": "object", "additionalProperties": true}, "APIUsageEntry": {"properties": {"id": {"type": "string"}, "url": {"type": "string"}, "project": {"type": "string"}, "projectName": {"type": "string"}, "org": {"type": "string"}, "orgName": {"type": "string"}, "account": {"type": "string"}, "accountName": {"type": "string"}, "date": {"type": "string", "format": "date-time"}, "uiHours": {"$ref": "#/components/schemas/UIHours"}, "apiCalls": {"$ref": "#/components/schemas/APICallDescriptor"}, "storage": {"$ref": "#/components/schemas/StorageDescriptor"}, "faasUsage": {"$ref": "#/components/schemas/FaasUsageDescriptor"}, "externalFaasUsage": {"$ref": "#/components/schemas/FaasUsageDescriptor"}, "items": {"$ref": "#/components/schemas/ItemsCount"}, "annotations": {"type": "number", "format": "double"}, "keyframes": {"type": "number", "format": "double"}, "ingestedDatapoints": {"$ref": "#/components/schemas/IngestedDatapointsDescriptor"}}, "required": ["id", "url", "project", "date", "uiHours", "apiCalls", "storage", "items", "annotations", "keyframes", "ingestedDatapoints"], "type": "object", "additionalProperties": true}, "AlertStatus": {"enum": ["created", "emailSent", "acknowledged", "closed"], "type": "string"}, "APIAlert": {"properties": {"id": {"type": "string"}, "url": {"type": "string"}, "code": {"type": "string"}, "status": {"$ref": "#/components/schemas/AlertStatus"}, "description": {"type": "string"}, "date": {"type": "string", "format": "date-time"}, "metadata": {}, "accountId": {"type": "string"}, "tier": {"$ref": "#/components/schemas/AlertTier"}}, "required": ["id", "url", "code", "status", "description", "date", "accountId", "tier"], "type": "object", "additionalProperties": true}, "FieldSort": {"properties": {"field": {"type": "string", "enum": ["date", "id"]}, "direction": {"type": "string", "enum": ["asc", "desc"]}}, "type": "object", "additionalProperties": true}, "ResourceAuditEventType": {"type": "string", "enum": ["deleted", "updated", "created"]}, "ResourceAuditLog": {"properties": {"_id": {"type": "string"}, "time": {"type": "string", "format": "date-time"}, "ctx": {"properties": {"projectName": {"type": "string"}, "org": {"type": "string"}, "project": {"type": "string"}}, "type": "object"}, "user": {"type": "string"}, "entityType": {"type": "string"}, "eventType": {"$ref": "#/components/schemas/ResourceAuditEventType"}, "entityId": {"type": "string"}, "entityName": {"type": "string"}}, "required": ["_id", "time", "ctx", "user", "entityType", "eventType", "entityId"], "type": "object", "additionalProperties": true}, "AuditLogsCursorPage": {"properties": {"totalItemsCount": {"type": "number", "format": "double"}, "items": {"items": {"$ref": "#/components/schemas/ResourceAuditLog"}, "type": "array"}, "totalPagesCount": {"type": "number", "format": "double"}, "hasNextPage": {"type": "boolean"}}, "required": ["totalItemsCount", "items", "totalPagesCount", "hasNextPage"], "type": "object", "additionalProperties": true}, "Address": {"properties": {"line1": {"type": "string"}, "line2": {"type": "string"}, "country": {"type": "string"}, "city": {"type": "string"}, "postalCode": {"type": "string"}, "state": {"type": "string"}}, "required": ["line1", "country", "city"], "type": "object", "additionalProperties": true}, "TaxType": {"enum": ["ae_trn", "au_abn", "au_arn", "br_cnpj", "br_cpf", "ca_bn", "ca_gst_hst", "ca_pst_bc", "ca_pst_mb", "ca_pst_sk", "ca_qst", "ch_vat", "cl_tin", "es_cif", "eu_vat", "gb_vat", "ge_vat", "hk_br", "id_npwp", "il_vat", "in_gst", "jp_cn", "jp_rn", "kr_brn", "li_uid", "mx_rfc", "my_frp", "my_itn", "my_sst", "no_vat", "nz_gst", "ru_inn", "ru_kpp", "sa_vat", "sg_gst", "sg_uen", "th_vat", "tw_vat", "ua_vat", "us_ein", "za_vat"], "type": "string"}, "TaxData": {"properties": {"type": {"$ref": "#/components/schemas/TaxType"}, "value": {"type": "string"}}, "required": ["type", "value"], "type": "object", "additionalProperties": true}, "DBBillingAccount": {"properties": {"_id": {"type": "string"}, "companyName": {"type": "string"}, "companyPhone": {"type": "string"}, "billingContact": {"type": "string"}, "accountId": {"type": "string"}, "recipients": {"items": {"type": "string"}, "type": "array"}, "address": {"$ref": "#/components/schemas/Address"}, "createdAt": {"type": "string", "format": "date-time"}, "updatedAt": {"type": "string", "format": "date-time"}, "taxData": {"$ref": "#/components/schemas/TaxData"}, "creator": {"type": "string"}}, "required": ["_id", "companyName", "companyPhone", "billingContact", "accountId", "recipients", "address", "createdAt", "creator"], "type": "object", "additionalProperties": true}, "PartialBillingAccount": {"properties": {"companyName": {"type": "string"}, "companyPhone": {"type": "string"}, "billingContact": {"type": "string"}, "accountId": {"type": "string"}, "recipients": {"items": {"type": "string"}, "type": "array"}, "address": {"$ref": "#/components/schemas/Address"}, "taxData": {"properties": {"value": {"type": "string"}, "type": {"$ref": "#/components/schemas/TaxType"}}, "required": ["value", "type"], "type": "object"}}, "required": ["accountId", "address"], "type": "object", "additionalProperties": true}, "PaymentDriverType": {"type": "string", "enum": ["credits", "stripe", "azureMarketplace"], "nullable": false}, "DBPaymentDriverConfiguration": {"properties": {"_id": {"type": "string"}, "name": {"type": "string"}, "billingAccountId": {"type": "string"}, "type": {"$ref": "#/components/schemas/PaymentDriverType"}, "creator": {"type": "string"}, "metadata": {}}, "required": ["_id", "name", "billingAccountId", "type", "creator"], "type": "object", "additionalProperties": true}, "CreditCard": {"properties": {"brand": {"type": "string", "description": "Card brand. Can be `amex`, `diners`, `discover`, `jcb`, `mastercard`, `unionpay`, `visa`, or `unknown`."}, "country": {"type": "string", "nullable": true, "description": "Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected."}, "description": {"type": "string", "nullable": true, "description": "A high-level description of the type of cards issued in this range. (For internal use only and not typically available in standard API requests.)"}, "exp_month": {"type": "number", "format": "double", "description": "Two-digit number representing the card's expiration month."}, "exp_year": {"type": "number", "format": "double", "description": "Four-digit number representing the card's expiration year."}, "fingerprint": {"type": "string", "nullable": true, "description": "Uniquely identifies this particular card number. You can use this attribute to check whether two customers who've signed up with you are using the same card number, for example. For payment methods that tokenize card information (Apple Pay, Google Pay), the tokenized number might be provided instead of the underlying card number.\n\n*Starting May 1, 2021, card fingerprint in India for Connect will change to allow two fingerprints for the same card --- one for India and one for the rest of the world.*"}, "funding": {"type": "string", "description": "Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`."}, "last4": {"type": "string", "description": "The last four digits of the card."}}, "required": ["brand", "country", "exp_month", "exp_year", "funding", "last4"], "type": "object", "additionalProperties": true}, "PaymentMethod": {"properties": {"id": {"type": "string", "description": "Unique identifier for the object."}, "card": {"$ref": "#/components/schemas/CreditCard"}, "driverId": {"type": "string"}}, "required": ["id"], "type": "object", "additionalProperties": true}, "ContactAddress": {"properties": {"line1": {"type": "string"}, "line2": {"type": "string"}, "country": {"type": "string"}, "city": {"type": "string"}, "postalCode": {"type": "string"}, "state": {"type": "string"}}, "required": ["line1", "country", "city"], "type": "object", "additionalProperties": true}, "ContactInfo": {"properties": {"email": {"type": "string"}, "phone": {"type": "string"}, "address": {"$ref": "#/components/schemas/ContactAddress"}}, "required": ["email", "phone", "address"], "type": "object", "additionalProperties": true}, "LineItem": {"properties": {"code": {"type": "string"}, "description": {"type": "string"}, "amount": {"type": "number", "format": "double"}, "price": {"type": "number", "format": "double"}, "subscription": {"type": "string"}}, "required": ["code", "description", "price", "subscription"], "type": "object", "additionalProperties": true}, "InvoiceStatus": {"enum": ["submitted", "paid", "partiallyPaid", "debt", "Failed Payment", "refunded"], "type": "string"}, "Currency": {"type": "string", "enum": ["USD", "EUR", "NIS"]}, "PaymentDetails": {"properties": {"driverType": {"type": "string"}, "driverId": {"type": "string"}, "description": {"type": "string"}, "chargeDate": {"type": "string", "format": "date-time"}, "amount": {"type": "number", "format": "double"}, "currency": {"$ref": "#/components/schemas/Currency"}, "last4": {"type": "string"}}, "required": ["driverType", "driverId", "chargeDate", "amount", "currency"], "type": "object", "additionalProperties": true}, "Invoice": {"properties": {"_id": {"type": "string"}, "id": {"type": "string", "description": "Unique identifier for the invoice"}, "account": {"type": "string", "description": "DL account ID"}, "contacts": {"items": {"$ref": "#/components/schemas/ContactInfo"}, "type": "array", "description": "Detailed information about all of the invoice contacts"}, "items": {"items": {"$ref": "#/components/schemas/LineItem"}, "type": "array", "description": "Detailing all the billable products included in the invoice"}, "totalPrice": {"type": "number", "format": "double", "description": "Total billed amount"}, "billedPeriod": {"properties": {"endDate": {"type": "string", "format": "date-time"}, "startDate": {"type": "string", "format": "date-time"}}, "required": ["endDate", "startDate"], "type": "object", "description": "Date range of the resource usage"}, "status": {"$ref": "#/components/schemas/InvoiceStatus", "description": "Current invoice status"}, "payments": {"items": {"$ref": "#/components/schemas/PaymentDetails"}, "type": "array", "description": "All payments details"}, "stripeInvoiceUrl": {"type": "string", "description": "When applicable, include a link to a pdf invoice hosted by Stripe"}, "stripeInvoiceId": {"type": "string", "description": "When applicable, include the identifier of a Stripe invoice object"}, "stripeInvoiceNumber": {"type": "string", "description": "When applicable, include the number of a Stripe invoice"}, "pdfLocation": {"type": "string", "description": "When applicable, include the location in which the DL archive stores the Stripe invoice pdf"}, "chargeInProgress": {"type": "boolean", "description": "Specifies whether a charge is currently in progress"}}, "required": ["id", "account", "contacts", "items", "totalPrice", "billedPeriod", "status", "payments"], "type": "object", "additionalProperties": true}, "RangeOrFeatureTier": {"properties": {"price": {"type": "number", "format": "double"}, "range": {"properties": {"higher": {"type": "number", "format": "double"}, "lower": {"type": "number", "format": "double"}}, "required": ["higher", "lower"], "type": "object"}, "name": {"type": "string"}}, "required": ["price"], "type": "object", "additionalProperties": true}, "OverQuota": {"properties": {"price": {"type": "number", "format": "double"}, "limit": {"type": "number", "format": "double"}}, "required": ["price", "limit"], "type": "object", "additionalProperties": true}, "APIBillableResource": {"properties": {"id": {"type": "string"}, "url": {"type": "string"}, "key": {"$ref": "#/components/schemas/BillingResourceKey"}, "name": {"type": "string"}, "type": {"type": "string"}, "description": {"type": "string"}, "icon": {"type": "string"}, "price": {"type": "number", "format": "double"}, "amount": {"type": "number", "format": "double"}, "unit": {"type": "string"}, "tiers": {"items": {"$ref": "#/components/schemas/RangeOrFeatureTier"}, "type": "array"}, "overQuota": {"$ref": "#/components/schemas/OverQuota"}, "displayedInInvoice": {"type": "boolean"}, "group": {"type": "string"}, "tier": {"type": "string"}}, "required": ["id", "url", "key", "name", "type", "description", "icon"], "type": "object", "additionalProperties": true}, "BillingScope": {"properties": {"type": {"$ref": "#/components/schemas/ScopeType"}, "entityId": {"type": "string"}}, "required": ["type", "entityId"], "type": "object", "additionalProperties": true}, "SubscriptionInput": {"properties": {"period": {"$ref": "#/components/schemas/BillingPeriod"}, "startDate": {"type": "string", "format": "date-time"}, "endDate": {"type": "string", "format": "date-time"}, "scope": {"$ref": "#/components/schemas/BillingScope"}, "autoRenewal": {"type": "boolean"}, "account": {"type": "string"}, "driverId": {"type": "string"}, "methodId": {"type": "string"}, "planKey": {"type": "string"}, "plan": {"$ref": "#/components/schemas/Plan"}}, "required": ["period", "scope", "autoRenewal", "account"], "type": "object", "additionalProperties": true}, "EditSubscriptionInput": {"properties": {"autoRenewal": {"type": "boolean"}, "paymentDriverId": {"type": "string"}, "paymentMethodId": {"type": "string"}, "externalSubscriptionId": {"type": "string"}}, "type": "object", "additionalProperties": true}, "RenewSubscriptionInput": {"properties": {"chargeSubscription": {"type": "boolean"}, "force": {"type": "boolean"}}, "required": ["chargeSubscription"], "type": "object", "additionalProperties": true}, "CursorPage_APISubscription_": {"properties": {"totalItemsCount": {"type": "number", "format": "double"}, "items": {"items": {"$ref": "#/components/schemas/APISubscription"}, "type": "array"}, "totalPagesCount": {"type": "number", "format": "double"}, "hasNextPage": {"type": "boolean"}}, "required": ["totalItemsCount", "items", "totalPagesCount", "hasNextPage"], "type": "object", "additionalProperties": true}, "CustomSubscriptionInput": {"properties": {"period": {"$ref": "#/components/schemas/BillingPeriod"}, "startDate": {"type": "string", "format": "date-time"}, "endDate": {"type": "string", "format": "date-time"}, "scope": {"$ref": "#/components/schemas/BillingScope"}, "autoRenewal": {"type": "boolean"}, "account": {"type": "string"}, "plan": {"$ref": "#/components/schemas/Plan"}}, "required": ["period", "startDate", "endDate", "scope", "autoRenewal", "account", "plan"], "type": "object", "additionalProperties": true}, "SubscriptionUpgradeInput": {"properties": {"period": {"$ref": "#/components/schemas/BillingPeriod"}, "startDate": {"type": "string", "format": "date-time"}, "autoRenewal": {"type": "boolean"}, "planKey": {"type": "string"}, "paymentDriverId": {"type": "string"}, "paymentMethodId": {"type": "string"}, "driverId": {"type": "string"}, "methodId": {"type": "string"}}, "required": ["period", "planKey"], "type": "object", "additionalProperties": true}, "SubscriptionExtensionInput": {"properties": {"resource": {"type": "string"}, "amount": {"type": "number", "format": "double"}, "autoRenewal": {"type": "boolean"}}, "required": ["resource", "amount"], "type": "object", "additionalProperties": true}, "PaymentDriverTypes": {"enum": ["credits", "stripe", "azureMarketplace", "nop"], "type": "string"}, "UsageLog": {"properties": {"id": {"type": "string"}, "date": {"type": "string", "format": "date-time"}, "usage": {"type": "number", "format": "double"}, "project": {"type": "string"}}, "required": ["id", "date", "usage", "project"], "type": "object", "additionalProperties": true}, "ResourceUsage": {"properties": {"key": {"type": "string"}, "used": {"type": "number", "format": "double"}, "usageLog": {"items": {"$ref": "#/components/schemas/UsageLog"}, "type": "array"}, "dateDepleted": {"type": "string", "format": "date-time"}}, "required": ["key", "used", "usageLog"], "type": "object", "additionalProperties": true}, "UsageReport": {"properties": {"subscriptionId": {"type": "string"}, "plan": {"$ref": "#/components/schemas/Plan"}, "period": {"$ref": "#/components/schemas/BillingPeriod"}, "startDate": {"type": "string", "format": "date-time"}, "endDate": {"type": "string", "format": "date-time"}, "account": {"type": "string"}, "usage": {"items": {"$ref": "#/components/schemas/ResourceUsage"}, "type": "array"}, "autoRenewal": {"type": "boolean"}}, "required": ["subscriptionId", "plan", "period", "startDate", "endDate", "account", "usage", "autoRenewal"], "type": "object", "additionalProperties": true}, "UsageResourcesReport": {"properties": {"planName": {"type": "string"}, "planKey": {"type": "string"}, "resources": {"items": {"$ref": "#/components/schemas/BillingResourceKey"}, "type": "array"}}, "required": ["planName", "planKey", "resources"], "type": "object", "additionalProperties": true}, "AzureWebhookEvent": {"properties": {"id": {"type": "string"}, "activityId": {"type": "string"}, "publisherId": {"type": "string"}, "offerId": {"type": "string"}, "planId": {"type": "string"}, "quantity": {"type": "number", "format": "double", "nullable": true}, "subscriptionId": {"type": "string"}, "timeStamp": {"type": "string", "format": "date-time"}, "action": {"type": "string", "enum": ["ChangePlan", "ChangeQuantity", "Renew", "Suspend", "Unsubscribe", "Reinstate"]}, "status": {"type": "string"}, "operationRequestSource": {"anyOf": [{"type": "string"}, {"type": "string", "enum": ["Azure"]}], "nullable": true}, "subscription": {"properties": {"lastModified": {"type": "string", "format": "date-time"}, "created": {"type": "string", "format": "date-time", "nullable": true}, "autoRenew": {"type": "boolean"}, "term": {"properties": {"chargeDuration": {"type": "number", "format": "double"}, "termUnit": {"type": "string"}, "endDate": {"type": "string", "format": "date-time"}, "startDate": {"type": "string", "format": "date-time"}}, "required": ["termUnit", "endDate", "startDate"], "type": "object"}, "saasSubscriptionStatus": {"type": "string"}, "sandboxType": {"type": "string"}, "isTest": {"type": "boolean"}, "isFreeTrial": {"type": "boolean"}, "sessionMode": {"type": "string"}, "allowedCustomerOperations": {"items": {"type": "string"}, "type": "array"}, "purchaser": {"properties": {"puid": {"type": "string", "nullable": true}, "tenantId": {"type": "string"}, "objectId": {"type": "string"}, "emailId": {"type": "string"}}, "required": ["tenantId", "objectId", "emailId"], "type": "object"}, "beneficiary": {"properties": {"puid": {"type": "string", "nullable": true}, "tenantId": {"type": "string"}, "objectId": {"type": "string"}, "emailId": {"type": "string"}}, "required": ["tenantId", "objectId", "emailId"], "type": "object"}, "quantity": {"type": "number", "format": "double", "nullable": true}, "planId": {"type": "string"}, "offerId": {"type": "string"}, "publisherId": {"type": "string"}, "name": {"type": "string"}, "id": {"type": "string"}}, "required": ["lastModified", "autoRenew", "term", "saasSubscriptionStatus", "sandboxType", "isTest", "isFreeTrial", "sessionMode", "allowedCustomerOperations", "purchaser", "beneficiary", "planId", "offerId", "publisherId", "name", "id"], "type": "object"}, "purchaseToken": {"type": "string", "nullable": true}, "errorMessage": {"type": "string", "nullable": true}, "errorStatusCode": {"type": "string", "nullable": true}, "operationRequestedSource": {"type": "string", "nullable": true}}, "required": ["id", "activityId", "publisherId", "offerId", "planId", "subscriptionId", "timeStamp", "action", "status", "subscription"], "type": "object", "additionalProperties": true}}, "securitySchemes": {"bearerAuth": {"type": "http", "scheme": "bearer", "bearerFormat": "JWT"}}}, "info": {"description": "# Drive your AI to production with end-to-end data management, automation pipelines and a quality-first data labeling platform.", "title": "Dataloop.ai REST API", "contact": {"email": "support@dataloop.ai"}, "x-logo": {"url": "https://console.dataloop.ai/img/logo-for-white-bkg-big.f993f895.png"}, "version": "1.11.2"}, "openapi": "3.0.0", "paths": {"/accounts": {"get": {"operationId": "Get My Accounts", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"items": {"$ref": "#/components/schemas/APIAccount"}, "type": "array"}}}}}, "description": "List all user's accounts", "tags": ["Accounts"], "security": [], "parameters": []}, "post": {"operationId": "Create Account", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/APIAccount"}, "examples": {"Example 1": {"value": {"createdBy": "user@example.com", "name": "My New Account", "org": "myOrgId"}}}}}}}, "description": "Create a new account for a given organization", "tags": ["Accounts"], "security": [], "parameters": [], "requestBody": {"required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/CreateAccountRequest"}}}}}}, "/accounts/{accountId}": {"get": {"operationId": "Get Account", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/APIAccount"}}}}}, "description": "Get a single account", "tags": ["Accounts"], "security": [], "parameters": [{"in": "path", "name": "accountId", "required": true, "schema": {"type": "string"}}]}}, "/accounts/{accountId}/projects": {"get": {"operationId": "Get Account Projects", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"items": {"$ref": "#/components/schemas/APIProject"}, "type": "array"}}}}}, "description": "Get all projects for a given account", "tags": ["Accounts"], "security": [], "parameters": [{"in": "path", "name": "accountId", "required": true, "schema": {"type": "string"}}]}}, "/activities": {"get": {"operationId": "_getUiActivities", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ActivitiesDescriptor_"}}}}}, "tags": ["Activities"], "security": [], "parameters": [{"in": "query", "name": "projectId", "required": true, "schema": {"type": "string"}}]}}, "/annotations/archiveAnnotationLogs": {"post": {"operationId": "Archive Annotation to Storage", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/APICommand"}}}}}, "tags": ["Annotations"], "security": [], "parameters": [], "requestBody": {"required": true, "content": {"application/json": {"schema": {"properties": {"concurrency": {"type": "number", "format": "double"}, "sampleSize": {"type": "number", "format": "double"}, "spec": {"$ref": "#/components/schemas/DQLResourceQuery"}}, "required": ["concurrency", "sampleSize", "spec"], "type": "object"}}}}}}, "/annotations/restore-archived-annotation-logs": {"post": {"operationId": "Restore archived Annotation to DB", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/APICommand"}}}}}, "tags": ["Annotations"], "security": [], "parameters": [], "requestBody": {"required": true, "content": {"application/json": {"schema": {"properties": {"annotationLogId": {"type": "string"}, "annotationId": {"type": "string"}, "itemId": {"type": "string"}, "datasetId": {"type": "string"}}, "required": ["itemId", "datasetId"], "type": "object"}}}}}}, "/annotations/{annotationId}": {"get": {"operationId": "Get Annotation", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/APIAnnotation"}}}}}, "description": "Get annotation by id", "tags": ["Annotations"], "security": [], "parameters": [{"description": "annotation id", "in": "path", "name": "annotationId", "required": true, "schema": {"type": "string"}}], "x-codeSamples": [{"lang": "Python", "source": "\n# \n# Get a single annotation.\n# \n# **Prerequisites**: You must have an item that has been annotated. You must have the role of an *owner* or\n# *developer* or be assigned a task that includes that item as an *annotation manager* or *annotator*.\n# \n# :param str annotation_id: The id of the annotation\n# :return: Annotation object or None\n# :return: Annotation object or None\n# :rtype: dtlpy.entities.annotation.Annotation\n# \n# \n# annotation = item.annotations.get(annotation_id='annotation_id')\n# "}]}, "delete": {"operationId": "Delete Annotation", "responses": {"204": {"description": "No content"}}, "description": "Delete an Annotation from an item", "tags": ["Annotations"], "security": [], "parameters": [{"description": "Annotation id", "in": "path", "name": "annotationId", "required": true, "schema": {"type": "string"}}], "x-codeSamples": [{"lang": "Python", "source": "\n# \n# Remove an annotation from item.\n# \n# **Prerequisites**: You must have an item that has been annotated. You must have the role of an *owner* or\n# *developer* or be assigned a task that includes that item as an *annotation manager* or *annotator*.\n# \n# :param dtlpy.entities.annotation.Annotation annotation: Annotation object\n# :param str annotation_id: The id of the annotation\n# :param dtlpy.entities.filters.Filters filters: Filters entity or a dictionary containing filters parameters\n# :return: True/False\n# :rtype: bool\n# \n# \n# is_deleted = item.annotations.delete(annotation_id='annotation_id')\n# "}]}, "put": {"operationId": "Update Annotation", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/APIAnnotation"}}}}}, "description": "Update an item's annotation", "tags": ["Annotations"], "security": [], "parameters": [{"description": "Annotation id", "in": "path", "name": "annotationId", "required": true, "schema": {"type": "string"}}, {"description": "when specified - editing system space metadata is enabled", "in": "query", "name": "system", "required": false, "schema": {"type": "boolean"}}, {"in": "query", "name": "replace", "required": false, "schema": {"type": "boolean"}}], "requestBody": {"description": "Updated annotation object", "required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/UpdateAnnotationRequest", "description": "Updated annotation object"}}}}, "x-codeSamples": [{"lang": "Python", "source": "\n# \n# Update an existing annotation. For example, you may change the annotation's label and then use the update method.\n# \n# **Prerequisites**: You must have an item that has been annotated. You must have the role of an *owner* or\n# *developer* or be assigned a task that includes that item as an *annotation manager* or *annotator*.\n# \n# :param dtlpy.entities.annotation.Annotation annotations: Annotation object\n# :param bool system_metadata: bool - True, if you want to change metadata system\n# \n# :return: True if successful or error if unsuccessful\n# :rtype: bool\n# \n# \n# annotations = item.annotations.update(annotation='annotation')\n# "}]}}, "/annotations/{annotationId}/issue": {"put": {"operationId": "Annotation Issues", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/APIAnnotation"}}}}}, "description": "Update an item's annotation status to issue", "tags": ["Annotations"], "security": [], "parameters": [{"description": "Annotation id", "in": "path", "name": "annotationId", "required": true, "schema": {"type": "string"}}]}}, "/annotationtasks": {"post": {"operationId": "Create Annotation Task", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"anyOf": [{"$ref": "#/components/schemas/APITask"}, {"$ref": "#/components/schemas/APICommand"}]}}}}}, "description": "Create a new Task", "tags": ["Annotation Tasks"], "security": [], "parameters": [], "requestBody": {"description": ": Task creation payload", "required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/TaskPayload", "description": ": Task creation payload"}}}}, "x-codeSamples": [{"lang": "Python", "source": "\n# \n# Create a new Task (Annotation or QA).\n# \n# **Prerequisites**: You must be in the role of an *owner*, *developer*, or *annotation manager* who has been assigned to be *owner* of the annotation task.\n# \n# :param str task_name: the name of the task\n# :param float due_date: date by which the task should be finished; for example, due_date=datetime.datetime(day=1, month=1, year=2029).timestamp()\n# :param list assignee_ids: list the task assignees (contributors) that should be working on the task. Provide a list of users' emails\n# :param List[WorkloadUnit] List[WorkloadUnit] workload: list of WorkloadUnit objects. Customize distribution (percentage) between the task assignees. For example: [dl.WorkloadUnit(annotator@hi.com, 80), dl.WorkloadUnit(annotator2@hi.com, 20)]\n# :param entities.Dataset dataset: dataset object, the dataset that refer to the task\n# :param str task_owner: task owner. Provide user email\n# :param str task_type: task type \"annotation\" or \"qa\"\n# :param str task_parent_id: optional if type is qa - parent annotation task id\n# :param str project_id: the Id of the project where task will be created\n# :param str recipe_id: recipe id for the task\n# :param list assignments_ids: assignments ids to the task\n# :param dict metadata: metadata for the task\n# :param entities.Filters filters: dl.Filters entity to filter items for the task\n# :param List[entities.Item] items: list of items (item Id or objects) to insert to the task\n# :param dict DQL query: filter items for the task\n# :param list available_actions: list of available actions (statuses) that will be available for the task items; The default statuses are: \"completed\" and \"discard\"\n# :param bool wait: wait until create task finish\n# :param entities.Filters check_if_exist: dl.Filters check if task exist according to filter\n# :param int limit: the limit items that the task can include\n# :param int  batch_size: Pulling batch size (items), use with pulling allocation method. Restrictions - Min 3, max 100\n# :param int max_batch_workload: max_batch_workload: Max items in assignment, use with pulling allocation method. Restrictions - Min batchSize + 2, max batchSize * 2\n# :param list allowed_assignees: list the task assignees (contributors) that should be working on the task. Provide a list of users' emails\n# :param entities.TaskPriority priority: priority of the task options in entities.TaskPriority\n# :param entities.ConsensusTaskType consensus_task_type: consensus_task_type of the task options in entities.ConsensusTaskType\n# :param int consensus_percentage: percentage of items to be copied to multiple annotators (consensus items)\n# :param int consensus_assignees: the number of different annotators per item (number of copies per item)\n# :param bool scoring: create a scoring app in project. Note: Scoring is no longer applied by default for consensus tasks. Set scoring=True to enable it.\n# :param bool enforce_video_conversion: Enforce WEBM conversion on video items for frame-accurate annotations. WEBM Conversion will be executed as a project service and incurs compute costs. Service compute resources can be set according to planned workload.\n# :return: Task object\n# :rtype: dtlpy.entities.task.Task\n# \n# \n# dataset.tasks.create(task= 'task_entity',\n# due_date = datetime.datetime(day= 1, month= 1, year= 2029).timestamp(),\n# assignee_ids =[ 'annotator1@dataloop.ai', 'annotator2@dataloop.ai'],\n# available_actions=[dl.ItemAction(\"discard\"), dl.ItemAction(\"to-check\")])\n# "}]}, "get": {"operationId": "Find Annotation Tasks", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/APITaskCursor"}}}}}, "description": "Find tasks by query", "tags": ["Annotation Tasks"], "security": [], "parameters": [{"description": "- An array of project IDs", "in": "query", "name": "projects", "required": false, "schema": {"type": "array", "items": {"type": "string"}}}, {"description": "- Find by dataset", "in": "query", "name": "dataset", "required": false, "schema": {"type": "string"}}, {"description": "- Find by recipe", "in": "query", "name": "recipe", "required": false, "schema": {"type": "string"}}, {"description": "- Find by task status", "in": "query", "name": "status", "required": false, "schema": {"type": "string"}}, {"description": "- Filter by creator", "in": "query", "name": "creator", "required": false, "schema": {"type": "string"}}, {"description": "- Filter by task owner", "in": "query", "name": "taskOwner", "required": false, "schema": {"type": "string"}}, {"description": "- Find by task name", "in": "query", "name": "name", "required": false, "schema": {"type": "string"}}, {"description": "- Due date lower limit", "in": "query", "name": "minDate", "required": false, "schema": {"format": "double", "type": "number"}}, {"description": "- Due date upper limit", "in": "query", "name": "maxDate", "required": false, "schema": {"format": "double", "type": "number"}}, {"description": "- An array of assignment IDs", "in": "query", "name": "assignments", "required": false, "schema": {"type": "array", "items": {"type": "string"}}}, {"description": "- The number of pages to skip from the start", "in": "query", "name": "pageOffset", "required": false, "schema": {"format": "double", "type": "number"}}, {"description": "- How many tasks in one page", "in": "query", "name": "pageSize", "required": false, "schema": {"format": "double", "type": "number"}}, {"description": "- Filter by parent task", "in": "query", "name": "parentTaskId", "required": false, "schema": {"type": "string"}}, {"description": "- Filter by task type - Annotation or QA", "in": "query", "name": "type", "required": false, "schema": {"type": "string"}}, {"in": "query", "name": "archive", "required": false, "schema": {"type": "boolean"}}]}}, "/annotationtasks/count": {"post": {"operationId": "Get Projects Active Counters", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/APITaskCounters"}}}}}, "description": "For org admin / owner:\nGet active counters for projects", "tags": ["Annotation Tasks"], "security": [], "parameters": [], "requestBody": {"required": true, "content": {"application/json": {"schema": {"properties": {"datasetId": {"type": "string"}, "projectIds": {"items": {"type": "string"}, "type": "array"}}, "required": ["projectIds"], "type": "object"}}}}}}, "/annotationtasks/projects/{projectId}/counters": {"post": {"operationId": "Get counters for project", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/WorkflowsCounters"}}}}}, "description": "Get counters for project", "tags": ["Annotation Tasks"], "security": [], "parameters": [{"description": ": Project id", "in": "path", "name": "projectId", "required": true, "schema": {"type": "string"}}], "requestBody": {"required": true, "content": {"application/json": {"schema": {"properties": {"contributors": {"items": {"type": "string"}, "type": "array"}}, "type": "object"}}}}}}, "/annotationtasks/projects/{projectId}/datasets/{datasetId}/actions": {"get": {"operationId": "Get Dataset Actions", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"items": {"$ref": "#/components/schemas/ItemAction"}, "type": "array"}}}}, "400": {"description": "Missing or Invalid dataset id"}, "404": {"description": "Dataset not found"}}, "description": "Get all actions(statuses) related to the required dataset", "tags": ["Annotation Tasks"], "security": [], "parameters": [{"description": ": Project ID", "in": "path", "name": "projectId", "required": true, "schema": {"type": "string"}}, {"description": ": Dataset ID", "in": "path", "name": "datasetId", "required": true, "schema": {"type": "string"}}]}}, "/annotationtasks/query": {"post": {"operationId": "Query Annotation Tasks", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/CursorPage_any_"}}}}}, "tags": ["Annotation Tasks"], "security": [], "parameters": [], "requestBody": {"required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/QueryFilter"}}}}, "x-codeSamples": [{"lang": "Python", "source": "\n# \n# List all tasks.\n# \n# **Prerequisites**: You must be in the role of an *owner* or *developer* or *annotation manager* who has been assigned the task.\n# \n# :param project_ids: search tasks by given list of project ids\n# :param str status: search tasks by a given task status\n# :param str task_name: search tasks by a given task name\n# :param int pages_size: pages size of the output generator\n# :param int page_offset: page offset of the output generator\n# :param dtlpy.entities.recipe.Recipe recipe: Search tasks that use a given recipe. Provide the required recipe object\n# :param str creator: search tasks created by a given creator (user email)\n# :param dtlpy.entities.assignment.Assignment recipe assignments: assignments object\n# :param double min_date: search all tasks created AFTER a given date, use a milliseconds format. For example: 1661780622008\n# :param double max_date: search all tasks created BEFORE a given date, use a milliseconds format. For example: 1661780622008\n# :param dtlpy.entities.filters.Filters filters: dl.Filters entity to filters tasks using DQL\n# :return: List of Task objects\n# \n# \n# dataset.tasks.list(project_ids='project_ids',pages_size=100, page_offset=0)\n# "}]}}, "/annotationtasks/{id}": {"patch": {"operationId": "Update Annotation Task", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/APITask"}}}}}, "description": "Update an existing task", "tags": ["Annotation Tasks"], "security": [], "parameters": [{"description": ": Task ID", "in": "path", "name": "id", "required": true, "schema": {"type": "string"}}], "requestBody": {"description": ": The fields to update", "required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/PartialTaskPayload", "description": ": The fields to update"}}}}, "x-codeSamples": [{"lang": "Python", "source": "\n# \n# Update a Task.\n# \n# **Prerequisites**: You must be in the role of an *owner* or *developer* or *annotation manager* who created that task.\n# \n# :param dtlpy.entities.task.Task task: the task object\n# :param bool system_metadata: DEPRECATED\n# :return: Task object\n# :rtype: dtlpy.entities.task.Task\n# \n# \n# dataset.tasks.update(task='task_entity')\n# "}]}, "get": {"operationId": "Get Annotation Task", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/APITask"}}}}, "400": {"description": "Missing or Invalid id"}, "404": {"description": "Task not found"}}, "description": "Get a specific task", "tags": ["Annotation Tasks"], "security": [], "parameters": [{"description": ": Task ID", "in": "path", "name": "id", "required": true, "schema": {"type": "string"}}], "x-codeSamples": [{"lang": "Python", "source": "\n# \n# Get a Task object to use in your code.\n# \n# **Prerequisites**: You must be in the role of an *owner* or *developer* or *annotation manager* who has been assigned the task.\n# \n# :param str task_name: optional - search by name\n# :param str task_id: optional - search by id\n# :return: task object\n# :rtype: dtlpy.entities.task.Task\n# \n# \n# dataset.tasks.get(task_id='task_id')\n# "}]}, "delete": {"operationId": "Delete Annotation Task", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"anyOf": [{}, {"$ref": "#/components/schemas/APICommand"}]}}}}}, "description": "Delete a task", "tags": ["Annotation Tasks"], "security": [], "parameters": [{"description": ": Task ID", "in": "path", "name": "id", "required": true, "schema": {"type": "string"}}], "requestBody": {"required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/DeleteTaskPayload"}}}}, "x-codeSamples": [{"lang": "Python", "source": "\n# \n# Delete the Task.\n# \n# **Prerequisites**: You must be in the role of an *owner* or *developer* or *annotation manager* who created that task.\n# \n# :param dtlpy.entities.task.Task task: the task object\n# :param str task_name: the name of the task\n# :param str task_id: the Id of the task\n# :param bool wait: wait until delete task finish\n# :return: True is success\n# :rtype: bool\n# \n# \n# dataset.tasks.delete(task_id='task_id')\n# "}]}}, "/annotationtasks/{id}/addToTask": {"post": {"operationId": "Add Items to Annotation Task", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"anyOf": [{"$ref": "#/components/schemas/APITask"}, {"$ref": "#/components/schemas/APICommand"}]}}}}}, "description": "Add work to an existing Task", "tags": ["Annotation Tasks"], "security": [], "parameters": [{"in": "path", "name": "id", "required": true, "schema": {"type": "string"}}], "requestBody": {"description": ": Task update payload", "required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/AddToTaskPayload", "description": ": Task update payload"}}}}, "x-codeSamples": [{"lang": "Python", "source": "\n# \n# Add items to a Task.\n# \n# **Prerequisites**: You must be in the role of an *owner*, *developer*, or *annotation manager* who has been assigned to be *owner* of the annotation task.\n# \n# :param dtlpy.entities.task.Task task: task object\n# :param str task_id: the Id of the task\n# :param dtlpy.entities.filters.Filters filters: Filters entity or a dictionary containing filters parameters\n# :param list items: list of items (item Ids or objects) to add to the task\n# :param list assignee_ids: list to assignee who works in the task\n# :param dict query: query to filter the items for the task\n# :param list workload: list of WorkloadUnit objects. Customize distribution (percentage) between the task assignees. For example: [dl.WorkloadUnit(annotator@hi.com, 80), dl.WorkloadUnit(annotator2@hi.com, 20)]\n# :param int limit: the limit items that task can include\n# :param bool wait: wait until add items will to finish\n# :return: task entity\n# :rtype: dtlpy.entities.task.Task\n# \n# \n# dataset.tasks.add_items(task= 'task_entity',\n# items = [items])\n# "}]}}, "/annotationtasks/{id}/contributors": {"post": {"operationId": "Update Annotation Task Contributors", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/APITask"}}}}}, "description": "Update task contributors", "tags": ["Annotation Tasks"], "security": [], "parameters": [{"description": ": Task ID", "in": "path", "name": "id", "required": true, "schema": {"type": "string"}}], "requestBody": {"description": ": Task update payload", "required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/UpdateContributorsPayload", "description": ": Task update payload"}}}}}}, "/annotationtasks/{id}/queue": {"get": {"operationId": "Get Annotation Task Queue Details", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/TaskQueueDetails"}}}}, "400": {"description": "Missing or Invalid id"}, "404": {"description": "Task not found"}}, "description": "Get a specific task's queue details", "tags": ["Annotation Tasks"], "security": [], "parameters": [{"description": ": Task ID", "in": "path", "name": "id", "required": true, "schema": {"type": "string"}}]}}, "/annotationtasks/{id}/relatives": {"get": {"operationId": "Get Annotation Task Relatives", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"items": {"$ref": "#/components/schemas/TaskRelativeInput"}, "type": "array"}}}}, "400": {"description": "Missing or Invalid id"}, "404": {"description": "Task not found"}}, "description": "Get the relative task names of a specific task", "tags": ["Annotation Tasks"], "security": [], "parameters": [{"description": ": Task ID", "in": "path", "name": "id", "required": true, "schema": {"type": "string"}}]}}, "/annotationtasks/{id}/removeFromTask": {"post": {"operationId": "Remove Items from Annotation Task", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"anyOf": [{"$ref": "#/components/schemas/APICommand"}, {"$ref": "#/components/schemas/APITask"}]}}}}}, "description": "Remove work from an existing Task", "tags": ["Annotation Tasks"], "security": [], "parameters": [{"in": "path", "name": "id", "required": true, "schema": {"type": "string"}}], "requestBody": {"description": ": Task update payload", "required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/RemoveFromTaskPayload", "description": ": Task update payload"}}}}}}, "/apikeys": {"get": {"operationId": "List API Keys", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"items": {"$ref": "#/components/schemas/APIApiKey"}, "type": "array"}}}}}, "tags": ["APIKeys"], "security": [], "parameters": []}, "post": {"operationId": "Create API Key", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"properties": {"key": {"$ref": "#/components/schemas/APIApiKey"}, "jwt": {"type": "string"}}, "required": ["key", "jwt"], "type": "object"}}}}}, "tags": ["APIKeys"], "security": [], "parameters": [], "requestBody": {"required": true, "content": {"application/json": {"schema": {"properties": {"description": {"type": "string"}, "userId": {"type": "string"}}, "required": ["userId"], "type": "object"}}}}}}, "/apikeys/{keyId}": {"get": {"operationId": "Get API Key", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/APIApiKey"}}}}}, "tags": ["APIKeys"], "security": [], "parameters": [{"in": "path", "name": "keyId", "required": true, "schema": {"type": "string"}}]}, "delete": {"operationId": "Revoke API Key", "responses": {"204": {"description": "No content"}}, "tags": ["APIKeys"], "security": [], "parameters": [{"in": "path", "name": "keyId", "required": true, "schema": {"type": "string"}}]}}, "/app-registry": {"post": {"operationId": "_publish", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/APIDpk"}}}}}, "description": "Publish a DPK app.\nSupply the dpk settings in the body request to create the object.", "tags": ["dpk"], "security": [], "parameters": [], "requestBody": {"required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/APIPostDpk"}}}}}}, "/app-registry/attributes": {"get": {"operationId": "_getAttributes", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"items": {"$ref": "#/components/schemas/DpkAttributesDefinition"}, "type": "array"}}}}}, "tags": ["dpk"], "security": [], "parameters": []}}, "/app-registry/query": {"post": {"operationId": "_query", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/CursorPageAPIDpk"}}}}}, "tags": ["dpk"], "security": [], "parameters": [], "requestBody": {"required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/QueryString"}}}}}}, "/app-registry/{id}": {"get": {"operationId": "_get", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/APIDpk"}}}}}, "description": "Get a dpk updated object from the db.", "tags": ["dpk"], "security": [], "parameters": [{"description": "The dpk id", "in": "path", "name": "id", "required": true, "schema": {"type": "string"}}]}, "delete": {"operationId": "_deleteOne", "responses": {"204": {"description": "No content"}}, "tags": ["dpk"], "security": [], "parameters": [{"in": "path", "name": "id", "required": true, "schema": {"type": "string"}}]}, "patch": {"operationId": "_update", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"properties": {"message": {"type": "string"}, "dpk": {"$ref": "#/components/schemas/APIDpk"}}, "required": ["message", "dpk"], "type": "object"}}}}}, "description": "Update existing dpk.\nThe server will update dpk specified by id with the new dpk attributes.", "tags": ["dpk"], "security": [], "parameters": [{"description": "The dpk id", "in": "path", "name": "id", "required": true, "schema": {"type": "string"}}], "requestBody": {"required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/APIPatchDpk"}}}}}}, "/app-registry/{id}/previews": {"get": {"operationId": "_getPreview", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"items": {"type": "string"}, "type": "array"}}}}}, "tags": ["dpk"], "security": [], "parameters": [{"in": "path", "name": "id", "required": true, "schema": {"type": "string"}}]}}, "/app-registry/{id}/requirements": {"get": {"operationId": "_getDpkRequirements", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Dictionary"}}}}}, "description": "Get the dpk requirements for install.", "tags": ["dpk"], "security": [], "parameters": [{"in": "path", "name": "id", "required": true, "schema": {"type": "string"}}]}}, "/app-registry/{id}/revisions/{version}": {"get": {"operationId": "_getRevision", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/APIDpk"}}}}}, "description": "Get the revision of dpk by baseId.", "tags": ["dpk"], "security": [], "parameters": [{"description": "The base dpk id", "in": "path", "name": "id", "required": true, "schema": {"type": "string"}}, {"description": "The dpk version", "in": "path", "name": "version", "required": true, "schema": {"type": "string"}}]}}, "/app-registry/{name}/revisions": {"post": {"operationId": "_getRevisions", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/CursorPageAPIDpk"}}}}}, "description": "Get the revisions of dpk by name.", "tags": ["dpk"], "security": [], "parameters": [{"description": "The dpk id", "in": "path", "name": "name", "required": true, "schema": {"type": "string"}}], "requestBody": {"required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/QueryString"}}}}}, "delete": {"operationId": "_deleteWithRevisions", "responses": {"204": {"description": "No content"}}, "tags": ["dpk"], "security": [], "parameters": [{"in": "path", "name": "name", "required": true, "schema": {"type": "string"}}]}}, "/apps": {"post": {"operationId": "_install", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/APIApp"}}}}}, "description": "Install a new app.\nCreate and install a new app on the platform by given dpk name in the body request.", "tags": ["apps"], "security": [], "parameters": [], "requestBody": {"required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/APIPostApp"}}}}}}, "/apps/{id}": {"put": {"operationId": "_update", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/APIApp"}}}}}, "description": "Update existing app.\nThe server will save the new app props and refresh all the components belonging to the dpk app", "tags": ["apps"], "security": [], "parameters": [{"description": "The app id", "in": "path", "name": "id", "required": true, "schema": {"type": "string"}}], "requestBody": {"required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/APIPatchApp"}}}}}, "get": {"operationId": "_get", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/APIApp"}}}}}, "description": "Get an app updated object from the db.", "tags": ["apps"], "security": [], "parameters": [{"description": "The app id", "in": "path", "name": "id", "required": true, "schema": {"type": "string"}}]}, "delete": {"operationId": "_uninstall", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"anyOf": [{"$ref": "#/components/schemas/APIApp"}, {}]}}}}}, "description": "Uninstall running application.\nwill remove all the components belonging to the app", "tags": ["apps"], "security": [], "parameters": [{"description": "The app id", "in": "path", "name": "id", "required": true, "schema": {"type": "string"}}]}}, "/apps/{id}/activate": {"post": {"operationId": "_activate", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/APIApp"}}}}}, "description": "Activate an app.\nThe server will activate the app and all the components belonging to the app", "tags": ["apps"], "security": [], "parameters": [{"description": "The app id", "in": "path", "name": "id", "required": true, "schema": {"type": "string"}}]}}, "/apps/{id}/deactivate": {"post": {"operationId": "_deactivate", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/APIApp"}}}}}, "description": "Deactivate an app.\nThe server will deactivate the app and all the components belonging to the app", "tags": ["apps"], "security": [], "parameters": [{"description": "The app id", "in": "path", "name": "id", "required": true, "schema": {"type": "string"}}]}}, "/apps/{id}/resolvePipelineTemplate": {"post": {"operationId": "_resolveTemplate", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {}}}}}, "description": "Create a new pipeline from a template.\nThe server will create a new pipeline from a template and return the pipeline object.", "tags": ["apps"], "security": [], "parameters": [{"description": "The app id", "in": "path", "name": "id", "required": true, "schema": {"type": "string"}}], "requestBody": {"required": true, "content": {"application/json": {"schema": {"properties": {"extend": {"type": "boolean"}, "template": {"$ref": "#/components/schemas/IPipeline"}, "templateId": {"type": "string"}}, "type": "object"}}}}}}, "/assignments": {"get": {"operationId": "Find Assignments", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/APIAssignmentCursor"}}}}}, "description": "Find assignments by query", "tags": ["Assignments"], "security": [], "parameters": [{"in": "query", "name": "name", "required": false, "schema": {"type": "string"}}, {"description": "- Filter by project IDs", "in": "query", "name": "projects", "required": false, "schema": {"type": "array", "items": {"type": "string"}}}, {"description": "- Filter by assignee", "in": "query", "name": "annotator", "required": false, "schema": {"type": "string"}}, {"description": "- Find by status", "in": "query", "name": "status", "required": false, "schema": {"type": "string"}}, {"description": "- The number of pages to skip from the start", "in": "query", "name": "pageOffset", "required": false, "schema": {"format": "double", "type": "number"}}, {"description": "- How many assignments in one page", "in": "query", "name": "pageSize", "required": false, "schema": {"format": "double", "type": "number"}}, {"in": "query", "name": "taskId", "required": false, "schema": {"type": "string"}}, {"in": "query", "name": "active", "required": false, "schema": {"type": "boolean"}}, {"in": "query", "name": "archive", "required": false, "schema": {"type": "boolean"}}]}}, "/assignments/items/tasks/{taskId}/status": {"post": {"operationId": "Set Item Status Bulk Task", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {}}}}}, "description": "Set bulk items status to their assignment by task", "tags": ["Assignments"], "security": [], "parameters": [{"in": "path", "name": "taskId", "required": true, "schema": {"type": "string"}}], "requestBody": {"description": ": Assignment status payload", "required": true, "content": {"application/json": {"schema": {"properties": {"statusPayload": {"$ref": "#/components/schemas/AssignmentStatusPayload"}, "itemIds": {"items": {"type": "string"}, "type": "array"}}, "required": ["statusPayload", "itemIds"], "type": "object", "description": ": Assignment status payload"}}}}}}, "/assignments/{id}": {"patch": {"operationId": "Update Assignment", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/APIAssignment"}}}}}, "description": "Update an existing assignment", "tags": ["Assignments"], "security": [], "parameters": [{"description": ": Assignment ID", "in": "path", "name": "id", "required": true, "schema": {"type": "string"}}], "requestBody": {"description": ": The fields to update", "required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/PartialAssignmentPayload", "description": ": The fields to update"}}}}, "x-codeSamples": [{"lang": "Python", "source": "\n# \n# Update an assignment.\n# \n# **Prerequisites**: You must be in the role of an *owner*, *developer*, or *annotation manager* who has been assigned as *owner* of the annotation task.\n# \n# :param dtlpy.entities.assignment.Assignment assignment assignment: assignment entity\n# :param bool system_metadata: True, if you want to change metadata system\n# :return: Assignment object\n# :rtype: dtlpy.entities.assignment.Assignment assignment\n# \n# \n# assignment = task.assignments.update(assignment='assignment_entity', system_metadata=False)\n# "}]}, "get": {"operationId": "Get Assignment", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/APIAssignment"}}}}, "400": {"description": "Missing or Invalid id"}, "404": {"description": "Assignment not found"}}, "description": "Get a specific assignment", "tags": ["Assignments"], "security": [], "parameters": [{"description": ": Assignment ID", "in": "path", "name": "id", "required": true, "schema": {"type": "string"}}], "x-codeSamples": [{"lang": "Python", "source": "\n# \n# Get Assignment object to use it in your code.\n# \n# :param str assignment_name: optional - search by name\n# :param str assignment_id: optional - search by id\n# :return: Assignment object\n# :rtype: dtlpy.entities.assignment.Assignment\n# \n# \n# assignment = task.assignments.get(assignment_id='assignment_id')\n# "}]}}, "/assignments/{id}/batch": {"post": {"operationId": "Load Assignment Batch", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"anyOf": [{"$ref": "#/components/schemas/APICommand"}, {"items": {"$ref": "#/components/schemas/APIAssignment"}, "type": "array"}]}}}}}, "description": "Load batch to Assignment in a queueing task", "tags": ["Assignments"], "security": [], "parameters": [{"in": "path", "name": "id", "required": true, "schema": {"type": "string"}}], "requestBody": {"description": ": Assignment creation payload", "required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/BatchAssignmentPayload", "description": ": Assignment creation payload"}}}}}}, "/assignments/{id}/clear": {"post": {"operationId": "Clear Assignment Batch", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"anyOf": [{"$ref": "#/components/schemas/APICommand"}, {"$ref": "#/components/schemas/APIAssignment"}]}}}}}, "description": "Clear items left in assignment in a queueing task", "tags": ["Assignments"], "security": [], "parameters": [{"in": "path", "name": "id", "required": true, "schema": {"type": "string"}}], "requestBody": {"description": ": Assignment creation payload", "required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/BatchAssignmentPayload", "description": ": Assignment creation payload"}}}}}}, "/assignments/{id}/items/status": {"post": {"operationId": "Set Item Status Bulk Assignment", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {}}}}}, "description": "Set bulk items status by assignment", "tags": ["Assignments"], "security": [], "parameters": [{"in": "path", "name": "id", "required": true, "schema": {"type": "string"}}], "requestBody": {"description": ": Assignment status payload", "required": true, "content": {"application/json": {"schema": {"properties": {"statusPayload": {"$ref": "#/components/schemas/AssignmentStatusPayload"}, "itemIds": {"items": {"type": "string"}, "type": "array"}}, "required": ["statusPayload", "itemIds"], "type": "object", "description": ": Assignment status payload"}}}}}}, "/assignments/{id}/items/{itemId}/status": {"post": {"operationId": "Set Item Status", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Dictionary"}}}}}, "description": "Set status to one item in an assignment", "tags": ["Assignments"], "security": [], "parameters": [{"in": "path", "name": "id", "required": true, "schema": {"type": "string"}}, {"in": "path", "name": "itemId", "required": true, "schema": {"type": "string"}}], "requestBody": {"description": ": Assignment status payload", "required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/AssignmentStatusPayload", "description": ": Assignment status payload"}}}}}}, "/assignments/{id}/partial": {"post": {"operationId": "Get Assignment Fields", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Partial_Assignment_"}}}}, "400": {"description": "Missing or Invalid id"}, "404": {"description": "Assignment not found"}}, "description": "Get a specific assignment fields", "tags": ["Assignments"], "security": [], "parameters": [{"description": ": Assignment ID", "in": "path", "name": "id", "required": true, "schema": {"type": "string"}}], "requestBody": {"required": true, "content": {"application/json": {"schema": {"properties": {"relatedItemId": {"type": "string"}, "fields": {"items": {"type": "string"}, "type": "array"}}, "required": ["fields"], "type": "object"}}}}}}, "/assignments/{id}/reassign": {"post": {"operationId": "Reassign Assignment", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"anyOf": [{"$ref": "#/components/schemas/APICommand"}, {"$ref": "#/components/schemas/APIAssignment"}]}}}}}, "description": "Reassign Assignment to annotator", "tags": ["Assignments"], "security": [], "parameters": [{"in": "path", "name": "id", "required": true, "schema": {"type": "string"}}], "requestBody": {"description": ": Assignment creation payload", "required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ReassignAssignmentPayload", "description": ": Assignment creation payload"}}}}, "x-codeSamples": [{"lang": "Python", "source": "\n# \n# Reassign an assignment.\n# \n# **Prerequisites**: You must be in the role of an *owner*, *developer*, or *annotation manager* who has been assigned as *owner* of the annotation task.\n# \n# :param str assignee_id: the email of the user that want to assign the assignment\n# :param dtlpy.entities.assignment.Assignment assignment: assignment object\n# :param assignment_id: the Id of the assignment\n# :param dtlpy.entities.task.Task task: task object\n# :param str task_id: the Id of the task that include the assignment\n# :param bool wait: wait until reassign assignment finish\n# :return: Assignment object\n# :rtype: dtlpy.entities.assignment.Assignment\n# \n# \n# assignment = task.assignments.reassign(assignee_ids='annotator1@dataloop.ai')\n# "}]}, "get": {"operationId": "Get Reassign Assignment", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/APICommand"}}}}}, "description": "Get the latest reassign command", "tags": ["Assignments"], "security": [], "parameters": [{"in": "path", "name": "id", "required": true, "schema": {"type": "string"}}, {"in": "query", "name": "creator", "required": false, "schema": {"type": "string"}}]}}, "/assignments/{id}/redistribute": {"post": {"operationId": "Redistribute Assignment", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"anyOf": [{"$ref": "#/components/schemas/APICommand"}, {"items": {"$ref": "#/components/schemas/APIAssignment"}, "type": "array"}]}}}}}, "description": "Redistribute Assignment to annotators", "tags": ["Assignments"], "security": [], "parameters": [{"in": "path", "name": "id", "required": true, "schema": {"type": "string"}}], "requestBody": {"description": ": Assignment creation payload", "required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/RedistributeAssignmentPayload", "description": ": Assignment creation payload"}}}}, "x-codeSamples": [{"lang": "Python", "source": "\n# \n# Redistribute an assignment.\n# \n# **Prerequisites**: You must be in the role of an *owner*, *developer*, or *annotation manager* who has been assigned as *owner* of the annotation task.\n# \n# \n# :param dtlpy.entities.assignment.Workload workload: list of WorkloadUnit objects. Customize distribution (percentage) between the task assignees. For example: [dl.WorkloadUnit(annotator@hi.com, 80), dl.WorkloadUnit(annotator2@hi.com, 20)]\n# :param dtlpy.entities.assignment.Assignment assignment: assignment object\n# :param str assignment_id: the Id of the assignment\n# :param dtlpy.entities.task.Task task: the task object that include the assignment\n# :param str task_id: the Id of the task that include the assignment\n# :param bool wait: wait until redistribute assignment finish\n# :return: Assignment object\n# :rtype: dtlpy.entities.assignment.Assignment assignment\n# \n# assignment = task.assignments.redistribute(workload=dl.Workload([dl.WorkloadUnit(assignee_id=\"annotator1@dataloop.ai\", load=50),\n# dl.WorkloadUnit(assignee_id=\"annotator2@dataloop.ai\", load=50)]))\n# "}]}}, "/audit/logs": {"post": {"operationId": "Query Audit Logs", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/AuditLogsCursorPage"}}}}}, "tags": ["Audit"], "security": [], "parameters": [], "requestBody": {"required": true, "content": {"application/json": {"schema": {"properties": {"descending": {"type": "boolean"}, "sortBy": {"type": "string"}, "pageSize": {"type": "number", "format": "double"}, "page": {"type": "number", "format": "double"}, "toDate": {"type": "string", "format": "date-time"}, "fromDate": {"type": "string", "format": "date-time"}, "user": {"anyOf": [{"type": "string"}, {"items": {"type": "string"}, "type": "array"}]}, "action": {"type": "string"}, "entityName": {"type": "string"}, "entityType": {"type": "string"}, "id": {"type": "string"}, "orgId": {"type": "string"}}, "required": ["orgId"], "type": "object"}}}}}}, "/audit/logs/csv": {"get": {"operationId": "Get Audit Logs CSV", "responses": {"204": {"description": "No content"}}, "tags": ["Audit"], "security": [], "parameters": [{"in": "query", "name": "orgId", "required": true, "schema": {"type": "string"}}, {"in": "query", "name": "fromDate", "required": true, "schema": {"format": "date-time", "type": "string"}}, {"in": "query", "name": "toDate", "required": true, "schema": {"format": "date-time", "type": "string"}}, {"in": "query", "name": "id", "required": false, "schema": {"type": "string"}}, {"in": "query", "name": "entityType", "required": false, "schema": {"type": "string"}}, {"in": "query", "name": "entityName", "required": false, "schema": {"type": "string"}}, {"in": "query", "name": "entityId", "required": false, "schema": {"type": "string"}}, {"in": "query", "name": "action", "required": false, "schema": {"type": "string"}}, {"in": "query", "name": "user", "required": false, "schema": {"type": "string"}}, {"in": "query", "name": "sortBy", "required": false, "schema": {"type": "string"}}, {"in": "query", "name": "descending", "required": false, "schema": {"type": "string"}}]}}, "/billing": {"get": {"operationId": "List Usage Entries", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"items": {"$ref": "#/components/schemas/APIUsageEntry"}, "type": "array"}}}}}, "tags": ["Billing"], "security": [], "parameters": [{"in": "query", "name": "project", "required": true, "schema": {"type": "string"}}, {"in": "query", "name": "startDate", "required": true, "schema": {"type": "string"}}, {"in": "query", "name": "endDate", "required": true, "schema": {"type": "string"}}, {"in": "query", "name": "monthly", "required": false, "schema": {"type": "string"}}]}}, "/billing/account/{account}/alerts/{id}": {"get": {"operationId": "Get Alert", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/APIAlert"}}}}}, "tags": ["Billing"], "security": [], "parameters": [{"in": "path", "name": "account", "required": true, "schema": {"type": "string"}}, {"in": "path", "name": "id", "required": true, "schema": {"type": "string"}}]}}, "/billing/account/{account}/alerts/{id}/status": {"patch": {"operationId": "Update Alert", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/APIAlert"}}}}}, "tags": ["Billing"], "security": [], "parameters": [{"in": "path", "name": "account", "required": true, "schema": {"type": "string"}}, {"in": "path", "name": "id", "required": true, "schema": {"type": "string"}}], "requestBody": {"required": true, "content": {"application/json": {"schema": {"properties": {"status": {"$ref": "#/components/schemas/AlertStatus"}}, "required": ["status"], "type": "object"}}}}}}, "/billing/account/{id}": {"get": {"operationId": "List Usage Entries", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"items": {"$ref": "#/components/schemas/APIUsageEntry"}, "type": "array"}}}}}, "tags": ["Billing"], "security": [], "parameters": [{"in": "path", "name": "id", "required": true, "schema": {"type": "string"}}, {"in": "query", "name": "startDate", "required": true, "schema": {"type": "string"}}, {"in": "query", "name": "endDate", "required": true, "schema": {"type": "string"}}, {"in": "query", "name": "monthly", "required": true, "schema": {"type": "string"}}]}}, "/billing/account/{id}/alerts/query": {"post": {"operationId": "ListAccountAlerts", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"items": {"$ref": "#/components/schemas/APIAlert"}, "type": "array"}}}}}, "tags": ["Billing"], "security": [], "parameters": [{"in": "path", "name": "id", "required": true, "schema": {"type": "string"}}], "requestBody": {"required": true, "content": {"application/json": {"schema": {"properties": {"sort": {"$ref": "#/components/schemas/FieldSort"}, "pageSize": {"type": "number", "format": "double"}, "page": {"type": "number", "format": "double"}, "tier": {"$ref": "#/components/schemas/AlertTier"}, "code": {"type": "string"}, "status": {"$ref": "#/components/schemas/AlertStatus"}, "orgId": {"anyOf": [{"type": "string"}, {"items": {"type": "string"}, "type": "array"}]}, "accountId": {"anyOf": [{"type": "string"}, {"items": {"type": "string"}, "type": "array"}]}, "subscriptionId": {"anyOf": [{"type": "string"}, {"items": {"type": "string"}, "type": "array"}]}, "_id": {"anyOf": [{"type": "string"}, {"items": {"type": "string"}, "type": "array"}]}}, "type": "object"}}}}}}, "/billing/account/{id}/apicalls/csv": {"get": {"operationId": "Get Account API Calls CSV", "responses": {"204": {"description": "No content"}}, "tags": ["Billing"], "security": [], "parameters": [{"in": "path", "name": "id", "required": true, "schema": {"type": "string"}}, {"in": "query", "name": "startDate", "required": true, "schema": {"type": "string"}}, {"in": "query", "name": "endDate", "required": true, "schema": {"type": "string"}}, {"in": "query", "name": "monthly", "required": false, "schema": {"type": "string"}}, {"in": "query", "name": "skipSumming", "required": false, "schema": {"type": "string"}}]}}, "/billing/account/{id}/apicalls/json": {"get": {"operationId": "Get Account API Calls JSON", "responses": {"204": {"description": "No content"}}, "tags": ["Billing"], "security": [], "parameters": [{"in": "path", "name": "id", "required": true, "schema": {"type": "string"}}, {"in": "query", "name": "startDate", "required": true, "schema": {"type": "string"}}, {"in": "query", "name": "endDate", "required": true, "schema": {"type": "string"}}, {"in": "query", "name": "monthly", "required": false, "schema": {"type": "string"}}]}}, "/billing/account/{id}/csv": {"get": {"operationId": "List Usage CSV", "responses": {"204": {"description": "No content"}}, "tags": ["Billing"], "security": [], "parameters": [{"in": "path", "name": "id", "required": true, "schema": {"type": "string"}}, {"in": "query", "name": "startDate", "required": true, "schema": {"type": "string"}}, {"in": "query", "name": "endDate", "required": true, "schema": {"type": "string"}}, {"in": "query", "name": "monthly", "required": true, "schema": {"type": "string"}}]}}, "/billing/accounts": {"post": {"operationId": "Create Billing Account", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/DBBillingAccount"}}}}}, "tags": ["Billing"], "security": [], "parameters": [], "requestBody": {"required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/PartialBillingAccount"}}}}}}, "/billing/accounts/dl/{id}": {"get": {"operationId": "Get Billing Account By DLAccount", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/DBBillingAccount"}}}}}, "tags": ["Billing"], "security": [], "parameters": [{"in": "path", "name": "id", "required": true, "schema": {"type": "string"}}]}}, "/billing/accounts/{id}": {"get": {"operationId": "Get Billing Account", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/DBBillingAccount"}}}}}, "tags": ["Billing"], "security": [], "parameters": [{"in": "path", "name": "id", "required": true, "schema": {"type": "string"}}]}, "patch": {"operationId": "Edit Billing Account", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/DBBillingAccount"}}}}}, "tags": ["Billing"], "security": [], "parameters": [{"in": "path", "name": "id", "required": true, "schema": {"type": "string"}}], "requestBody": {"required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/PartialBillingAccount"}}}}}}, "/billing/accounts/{id}/payments/drivers": {"get": {"operationId": "List Payment Drivers", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"items": {"$ref": "#/components/schemas/DBPaymentDriverConfiguration"}, "type": "array"}}}}}, "tags": ["Billing"], "security": [], "parameters": [{"in": "path", "name": "id", "required": true, "schema": {"type": "string"}}, {"in": "query", "name": "page", "required": false, "schema": {"format": "double", "type": "number"}}, {"in": "query", "name": "pageSize", "required": false, "schema": {"format": "double", "type": "number"}}]}}, "/billing/accounts/{id}/payments/methods": {"get": {"operationId": "List Payment Methods", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"items": {"$ref": "#/components/schemas/PaymentMethod"}, "type": "array"}}}}}, "tags": ["Billing"], "security": [], "parameters": [{"in": "path", "name": "id", "required": true, "schema": {"type": "string"}}, {"in": "query", "name": "page", "required": false, "schema": {"format": "double", "type": "number"}}, {"in": "query", "name": "pageSize", "required": false, "schema": {"format": "double", "type": "number"}}]}}, "/billing/accounts/{id}/payments/methods/{methodid}": {"get": {"operationId": "Get Payment Method", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/PaymentMethod"}}}}}, "tags": ["Billing"], "security": [], "parameters": [{"in": "path", "name": "id", "required": true, "schema": {"type": "string"}}, {"in": "path", "name": "methodid", "required": true, "schema": {"type": "string"}}]}, "delete": {"operationId": "Delete Payment Method", "responses": {"204": {"description": "No content"}}, "tags": ["Billing"], "security": [], "parameters": [{"in": "path", "name": "id", "required": true, "schema": {"type": "string"}}, {"in": "path", "name": "methodid", "required": true, "schema": {"type": "string"}}]}}, "/billing/{id}": {"get": {"operationId": "Get Usage Entry", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/APIUsageEntry"}}}}}, "tags": ["Billing"], "security": [], "parameters": [{"in": "path", "name": "id", "required": true, "schema": {"type": "string"}}]}}, "/compositions": {"post": {"operationId": "_create", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/APIComposition"}}}}}, "description": "Create a new Composition.\nSupply the entities in the body request to create a Composition.", "tags": ["compositions"], "security": [], "parameters": [], "requestBody": {"required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/IPostComposition"}}}}}, "get": {"operationId": "_list", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/CursorPageAPIComposition"}}}}}, "description": "Retrieves Composition.\n\nSupply query parameters to filter the list.", "tags": ["compositions"], "security": [], "parameters": [{"description": "filter: accepts any string", "in": "query", "name": "filter", "required": true, "schema": {"type": "string"}}, {"description": "sort: accepts any string", "in": "query", "name": "sort", "required": true, "schema": {"type": "string"}}, {"description": "page: accepts any number", "in": "query", "name": "page", "required": true, "schema": {"format": "double", "type": "number"}}, {"description": "pageSize: accepts any number", "in": "query", "name": "pageSize", "required": true, "schema": {"format": "double", "type": "number"}}]}}, "/compositions/{compositionId}": {"get": {"operationId": "_get", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/APIComposition"}}}}}, "description": "Get an composition updated object from the db.", "tags": ["compositions"], "security": [], "parameters": [{"description": "The composition id", "in": "path", "name": "compositionId", "required": true, "schema": {"type": "string"}}]}, "patch": {"operationId": "_update", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/APIComposition"}}}}}, "description": "Update existing composition.\nThe server will save the new composition props and refresh all the entities belonging to the composition", "tags": ["compositions"], "security": [], "parameters": [{"description": "The composition id", "in": "path", "name": "compositionId", "required": true, "schema": {"type": "string"}}], "requestBody": {"required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/IPostComposition"}}}}}}, "/compositions/{compositionId}/install": {"post": {"operationId": "_install", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/APIComposition"}}}}}, "description": "Install existing composition. setting all the entities", "tags": ["compositions"], "security": [], "parameters": [{"description": "The composition id", "in": "path", "name": "compositionId", "required": true, "schema": {"type": "string"}}], "requestBody": {"description": "Pipeline resume option", "required": true, "content": {"application/json": {"schema": {"properties": {"resumeOption": {"$ref": "#/components/schemas/ResumePipelineOption"}}, "type": "object", "description": "Pipeline resume option"}}}}}}, "/compositions/{compositionId}/terminate": {"post": {"operationId": "_terminate", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/CompositionStatus"}}}}}, "description": "Delete the composition. delete all the entities", "tags": ["compositions"], "security": [], "parameters": [{"description": "The composition id", "in": "path", "name": "compositionId", "required": true, "schema": {"type": "string"}}]}}, "/compositions/{compositionId}/uninstall": {"post": {"operationId": "_uninstall", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/APIComposition"}}}}}, "description": "Uninstall existing composition. move all the entities to uninstall state", "tags": ["compositions"], "security": [], "parameters": [{"description": "The composition id", "in": "path", "name": "compositionId", "required": true, "schema": {"type": "string"}}], "requestBody": {"description": "Keep Composition Triggers Active", "required": false, "content": {"application/json": {"schema": {"type": "boolean", "description": "Keep Composition Triggers Active"}}}}}}, "/compute": {"post": {"operationId": "_registerCompute", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/APICompute"}}}}}, "description": "Add Driver Compute.", "tags": ["compute"], "security": [], "parameters": [], "requestBody": {"required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ICompute"}}}}}}, "/compute/globals": {"get": {"operationId": "_listGlobalComputes", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"items": {"type": "string"}, "type": "array"}}}}}, "description": "List Global Compute names.", "tags": ["compute"], "security": [], "parameters": []}}, "/compute/orgs/{orgId}/cleanup": {"delete": {"operationId": "_cleanupOrg", "responses": {"204": {"description": "No content"}}, "description": "Cleanup org driver", "tags": ["compute"], "security": [], "parameters": [{"description": "The org id", "in": "path", "name": "orgId", "required": true, "schema": {"type": "string"}}]}}, "/compute/registry/orgs/{orgId}/integrations/{integrationId}": {"post": {"operationId": "_registryCred", "responses": {"204": {"description": "No content"}}, "description": "Apply docker private registry credentials on the user compute system.", "tags": ["compute"], "security": [], "parameters": [{"description": "The org id", "in": "path", "name": "orgId", "required": true, "schema": {"type": "string"}}, {"description": "The integration id, each registry credentials should be saved as an integration vault", "in": "path", "name": "integrationId", "required": true, "schema": {"type": "string"}}]}, "delete": {"operationId": "_deleteRegistryCred", "responses": {"204": {"description": "No content"}}, "description": "Delete docker private registry credentials from the user compute system.", "tags": ["compute"], "security": [], "parameters": [{"description": "The org id", "in": "path", "name": "orgId", "required": true, "schema": {"type": "string"}}, {"description": "The integration id, each registry credentials should be saved as an integration vault", "in": "path", "name": "integrationId", "required": true, "schema": {"type": "string"}}]}}, "/compute/{computeId}": {"get": {"operationId": "_getCompute", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/APICompute"}}}}}, "description": "Get Driver Compute.", "tags": ["compute"], "security": [], "parameters": [{"in": "path", "name": "computeId", "required": true, "schema": {"type": "string"}}, {"in": "query", "name": "archived", "required": false, "schema": {"default": false, "type": "boolean"}}]}, "patch": {"operationId": "_updateCompute", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/APICompute"}}}}}, "description": "Update Driver Compute.", "tags": ["compute"], "security": [], "parameters": [{"in": "path", "name": "computeId", "required": true, "schema": {"type": "string"}}], "requestBody": {"required": true, "content": {"application/json": {"schema": {"allOf": [{"$ref": "#/components/schemas/Partial_ICompute_"}, {"properties": {"skipValidation": {"type": "boolean"}, "runBootstrap": {"type": "boolean"}}, "type": "object"}]}}}}}, "delete": {"operationId": "_deleteCompute", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"anyOf": [{"$ref": "#/components/schemas/APICommand"}, {}]}}}}}, "description": "Delete Driver Compute.", "tags": ["compute"], "security": [], "parameters": [{"in": "path", "name": "computeId", "required": true, "schema": {"type": "string"}}, {"in": "query", "name": "skipDestroy", "required": false, "schema": {"default": false, "type": "boolean"}}]}}, "/compute/{computeId}/validate": {"post": {"operationId": "_validateCompute", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/APICompute"}}}}}, "description": "Validate Compute.", "tags": ["compute"], "security": [], "parameters": [{"in": "path", "name": "computeId", "required": true, "schema": {"type": "string"}}]}}, "/datasets": {"get": {"operationId": "List Datasets", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"items": {"$ref": "#/components/schemas/APIDataset"}, "type": "array"}}}}}, "description": "Get a names list of all existing datasets", "tags": ["Datasets"], "security": [], "parameters": [{"in": "query", "name": "name", "required": false, "schema": {"type": "string"}}, {"in": "query", "name": "creator", "required": false, "schema": {"type": "string"}}, {"in": "query", "name": "recipe", "required": false, "schema": {"type": "string"}}, {"in": "query", "name": "projects", "required": false, "schema": {"type": "array", "items": {"type": "string"}}}, {"in": "query", "name": "markForDeletion", "required": false, "schema": {"type": "boolean"}}, {"in": "query", "name": "system", "required": false, "schema": {"default": false, "type": "boolean"}}]}, "post": {"operationId": "Create Dataset", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/APIDataset"}, "examples": {"Example 1": {"value": {"name": "New Set Name", "projects": ["project-id-1", "project-id-2"], "accessLevel": "project", "metadata": {"system": {}, "dsType": 1}}}}}}}, "400": {"description": "Missing argument"}}, "description": "Create a new dataset", "tags": ["Datasets"], "security": [], "parameters": [], "requestBody": {"description": "Dataset creation options\nMetadata for creation is optional", "required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/CreateDatasetRequest", "description": "Dataset creation options\nMetadata for creation is optional"}}}}, "x-codeSamples": [{"lang": "Python", "source": "\n# \n# Create a new dataset\n# \n# **Prerequisites**: You must be in the role of an *owner* or *developer*.\n# \n# :param str dataset_name: The Name of the dataset\n# :param list labels: dictionary of {tag: color} or list of label entities\n# :param list attributes: dataset's ontology's attributes\n# :param list ontology_ids: optional - dataset ontology\n# :param dtlpy.entities.driver.Driver driver: optional - storage driver Driver object or driver name\n# :param str driver_id: optional - driver id\n# :param bool checkout: set the dataset as a default dataset object (cookies)\n# :param ExpirationOptions expiration_options: dl.ExpirationOptions object that contain definitions for dataset like MaxItemDays\n# :param str index_driver: dl.IndexDriver, dataset driver version\n# :param str recipe_id: optional - recipe id\n# :return: Dataset object\n# :rtype: dtlpy.entities.dataset.Dataset\n# \n# \n# dataset = project.datasets.create(dataset_name='dataset_name', ontology_ids='ontology_ids')\n# "}]}}, "/datasets/cleanup-schema": {"post": {"operationId": "SchemaCleanup", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/APICommand"}}}}}, "tags": ["Datasets"], "security": [], "parameters": [], "requestBody": {"required": true, "content": {"application/json": {"schema": {"properties": {"query": {"$ref": "#/components/schemas/DQLResourceQuery"}}, "required": ["query"], "type": "object"}}}}}}, "/datasets/count": {"post": {"operationId": "Get Datasets By Project Ids", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"properties": {"total": {"type": "number", "format": "double"}, "datasets": {"items": {}, "type": "array"}}, "required": ["total", "datasets"], "type": "object"}}}}}, "description": "For org admin / owner:\nGet datasets count for projects\nGet datasets if a single project required", "tags": ["Datasets"], "security": [], "parameters": [], "requestBody": {"required": true, "content": {"application/json": {"schema": {"properties": {"projectIds": {"items": {"type": "string"}, "type": "array"}, "system": {"type": "boolean", "default": false}}, "required": ["projectIds"], "type": "object"}}}}}}, "/datasets/countAnnotationsByProject/{projectId}": {"post": {"operationId": "Count Annotations By Project", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/APICommand"}}}}}, "description": "Endpoint for counting amount of annotations by project ID\nSupports both mongo and S2 datasets\nMainly supposed to be used for billing purposes", "tags": ["Datasets"], "security": [], "parameters": [{"in": "path", "name": "projectId", "required": true, "schema": {"type": "string"}}]}}, "/datasets/deleteExpiredItems": {"post": {"operationId": "Delete Expired Items", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/APICommand"}}}}}, "description": "Deletes all expired items\nEach dataset has the option to set it's SLA according to the attached example\n\nWhen setting expirationOptions.itemMaxAge to a number (100 for example),\nEach item in the dataset will be deleted once the corresponding number of days have passed since it's creation", "tags": ["Datasets"], "security": [], "parameters": []}}, "/datasets/exports": {"post": {"operationId": "List Export History", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"properties": {"pageSize": {"type": "number", "format": "double"}, "pageOffset": {"type": "number", "format": "double"}, "records": {"items": {"$ref": "#/components/schemas/APIExportHistory"}, "type": "array"}, "total": {"type": "number", "format": "double"}}, "required": ["pageSize", "pageOffset", "records", "total"], "type": "object"}}}}}, "tags": ["Datasets"], "security": [], "parameters": [], "requestBody": {"required": true, "content": {"application/json": {"schema": {"properties": {"sortOrder": {"type": "string", "enum": ["ASC", "DESC"]}, "sortBy": {"type": "string", "enum": ["createdAt", "updatedAt"]}, "pageSize": {"type": "number", "format": "double"}, "pageOffset": {"type": "number", "format": "double"}, "exportId": {"type": "string"}, "creator": {"type": "string"}, "projects": {"items": {"type": "string"}, "type": "array"}, "datasetId": {"type": "string"}}, "required": ["projects"], "type": "object"}}}}}}, "/datasets/merge": {"post": {"operationId": "Merge Datasets", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/APICommand"}, "examples": {"Example 1": {"value": {"name": "New Set Name", "datasetsIds": [], "mergeDatasetParams": {"withItemsAnnotations": true, "withMetadata": true}}}}}}}, "400": {"description": "Missing argument"}}, "tags": ["Datasets"], "security": [], "parameters": [], "requestBody": {"required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/MergeDatasetsRequest"}}}}, "x-codeSamples": [{"lang": "Python", "source": "\n# \n# Merge a dataset. See our `SDK docs <https://developers.dataloop.ai/tutorials/data_management/data_versioning/chapter/>`_ for more information.\n# \n# **Prerequisites**: You must be an *owner* or *developer* to use this method.\n# \n# :param str merge_name: new dataset name\n# :param list dataset_ids: list id's of the datatsets you wish to merge\n# :param str project_ids: the project id that include the datasets\n# :param bool with_items_annotations: true to merge with items annotations\n# :param bool with_metadata: true to merge with metadata\n# :param bool with_task_annotations_status: true to merge with task annotations' status\n# :param bool wait: wait for the command to finish\n# :return: True if success\n# :rtype: bool\n# \n# \n# success = project.datasets.merge(dataset_ids=['dataset_id1','dataset_id2'],\n# merge_name='dataset_merge_name',\n# with_metadata=True,\n# with_items_annotations=False,\n# with_task_annotations_status=False)\n# "}]}}, "/datasets/query": {"post": {"operationId": "Query Datasets", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/CursorPage_APIAnnotation-or-APIDataset-or-APIDatasetFileItem-or-APIDatasetDirectoryItem_"}}}}}, "tags": ["Datasets"], "security": [], "parameters": [], "requestBody": {"required": true, "content": {"application/json": {"schema": {"allOf": [{"$ref": "#/components/schemas/DQLResourceQuery"}, {"anyOf": [{"$ref": "#/components/schemas/FilterQuery"}, {"$ref": "#/components/schemas/UpdateQuery"}, {"$ref": "#/components/schemas/DeleteQuery"}]}]}}}}, "x-codeSamples": [{"lang": "Python", "source": "# \n# List all datasets.\n# \n# **Prerequisites**: You must be an *owner* or *developer* to use this method.\n# \n# :param str name: list by name\n# :param str creator: list by\n# :param dtlpy.entities.filters.Filters filters: Filters entity containing filters parameters\n# :return: List of datasets\n# :rtype: list\n# \n# \n# filters = dl.Filters(resource='datasets')\n# filters.add(field='readonly', values=False)\n# datasets = project.datasets.list(filters=filters)\n# "}]}}, "/datasets/query/resolve": {"post": {"operationId": "Query Datasets", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/TranslatedQuery"}}}}}, "tags": ["Datasets"], "security": [], "parameters": [], "requestBody": {"required": true, "content": {"application/json": {"schema": {"properties": {"target": {"type": "string", "enum": ["lanceDB"], "nullable": false}, "query": {"allOf": [{"$ref": "#/components/schemas/DQLResourceQuery"}, {"$ref": "#/components/schemas/FilterQuery"}]}}, "required": ["target", "query"], "type": "object"}}}}}}, "/datasets/restore": {"post": {"operationId": "Restore Dataset", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"type": "number", "enum": [null], "nullable": true}}}}}, "description": "Restore a dataset marked for deletion", "tags": ["Datasets"], "security": [], "parameters": [], "requestBody": {"required": true, "content": {"application/json": {"schema": {"properties": {"query": {"$ref": "#/components/schemas/DQLResourceQuery"}}, "required": ["query"], "type": "object"}}}}}}, "/datasets/stats/{projectId}": {"post": {"operationId": "Count dataset stats by Project", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/APICommand"}}}}}, "description": "Endpoint for counting dataset stats by project ID\nSupports both mongo and S2 datasets", "tags": ["Datasets"], "security": [], "parameters": [{"in": "path", "name": "projectId", "required": true, "schema": {"type": "string"}}]}}, "/datasets/storage/project": {"post": {"operationId": "Get Project Size In Bytes", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"type": "number", "format": "double"}}}}}, "tags": ["Dataset Storage"], "security": [], "parameters": [], "requestBody": {"required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ProjectStorageRequest"}}}}}}, "/datasets/{datasetId}/items": {"get": {"operationId": "Get Dataset Items", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/APIDatasetItemCursor"}, "examples": {"Example 1": {"value": {"totalItemsCount": 4, "totalPagesCount": 1, "hasNextPage": false, "items": [{"id": "string", "datasetId": "string", "url": "string", "dataset": "string", "createdAt": "string", "dir": "string", "filename": "string", "type": "dir", "hidden": false, "metadata": {}, "name": "string", "creator": "string", "items": "string", "export": {"zip": "string", "json": "string"}}, {"id": "string", "datasetId": "string", "url": "string", "dataset": "string", "createdAt": "2023-06-12T11:56:04.562Z", "dir": "string", "filename": "string", "type": "file", "hidden": false, "metadata": {"system": {"channels": 3, "encoding": "7bit", "exif": {}, "height": 360, "isBinary": true, "mimetype": "image/png", "originalname": "string", "refs": [], "size": 10539, "taskStatusLog": [], "thumbnailId": "string", "width": 360}}, "name": "string", "creator": "string", "stream": "string", "thumbnail": "string", "annotations": "string", "annotationsCount": 0, "annotated": false}]}}}}}}}, "description": "List items in a dataset", "tags": ["Dataset Items"], "security": [], "parameters": [{"description": "Dataset id", "in": "path", "name": "datasetId", "required": true, "schema": {"type": "string"}}, {"description": "URL encoded JSON query - See JSON example below", "in": "query", "name": "query", "required": false, "schema": {"type": "string"}}, {"description": "Sorting criteria", "in": "query", "name": "sort", "required": false, "schema": {"type": "string"}}, {"description": "Pages to skip", "in": "query", "name": "pageOffset", "required": false, "schema": {"format": "double", "type": "number"}}, {"description": "Number of items to fetch in each page", "in": "query", "name": "pageSize", "required": false, "schema": {"format": "double", "type": "number"}}]}, "post": {"operationId": "Create Item", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"anyOf": [{"$ref": "#/components/schemas/APIDatasetFileItem"}, {"$ref": "#/components/schemas/APIDatasetDirectoryItem"}]}}}}}, "description": "Create a new item in a dataset\nOrder is important - FILE MUST BE LAST FIELD OF THE FORM", "tags": ["Dataset Items"], "security": [], "parameters": [{"description": "Dataset id", "in": "path", "name": "datasetId", "required": true, "schema": {"type": "string"}}, {"in": "query", "name": "mode", "required": false, "schema": {"$ref": "#/components/schemas/AddItemMode"}}]}, "delete": {"operationId": "Remove Items By Query", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/APICommand"}}}}}, "tags": ["Dataset Items"], "security": [], "parameters": [{"in": "path", "name": "datasetId", "required": true, "schema": {"type": "string"}}], "requestBody": {"required": true, "content": {"application/json": {"schema": {"properties": {"filter": {"$ref": "#/components/schemas/Dictionary"}, "join": {"$ref": "#/components/schemas/Dictionary"}}, "required": ["filter", "join"], "type": "object"}}}}}}, "/datasets/{datasetId}/items/bulk-update-metadata": {"post": {"operationId": "Bulk Update Metadata", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/APICommand"}}}}}, "tags": ["Dataset Items"], "security": [], "parameters": [{"in": "path", "name": "datasetId", "required": true, "schema": {"type": "string"}}], "requestBody": {"required": true, "content": {"application/json": {"schema": {"properties": {"updateQuery": {"$ref": "#/components/schemas/UpdateItemMetadataOptions"}, "query": {"$ref": "#/components/schemas/DQLResourceQuery"}}, "required": ["updateQuery", "query"], "type": "object"}}}}}}, "/datasets/{datasetId}/items/bullk-generate-annotation-thumbnails": {"post": {"operationId": "Bullk Generate Annotation Thumbnails", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/APICommand"}}}}}, "tags": ["Dataset Items"], "security": [], "parameters": [{"in": "path", "name": "datasetId", "required": true, "schema": {"type": "string"}}], "requestBody": {"required": true, "content": {"application/json": {"schema": {"properties": {"options": {"properties": {"opacity": {"type": "number", "format": "double"}, "width": {"type": "number", "format": "double"}, "height": {"type": "number", "format": "double"}}, "required": ["opacity", "width", "height"], "type": "object"}, "annotationsQuery": {"$ref": "#/components/schemas/DQLResourceQuery"}, "itemsQuery": {"$ref": "#/components/schemas/DQLResourceQuery"}}, "required": ["options", "annotationsQuery", "itemsQuery"], "type": "object"}}}}}}, "/datasets/{datasetId}/items/collections": {"post": {"operationId": "Create Item Collection", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Dictionary"}}}}}, "tags": ["Dataset Items"], "security": [], "parameters": [{"in": "path", "name": "datasetId", "required": true, "schema": {"type": "string"}}], "requestBody": {"required": true, "content": {"application/json": {"schema": {"properties": {"name": {"type": "string"}}, "required": ["name"], "type": "object"}}}}}, "get": {"operationId": "Get Item Collections", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Dictionary"}}}}}, "tags": ["Dataset Items"], "security": [], "parameters": [{"in": "path", "name": "datasetId", "required": true, "schema": {"type": "string"}}]}}, "/datasets/{datasetId}/items/collections/bulk-add": {"post": {"operationId": "Add Items to Item Collections", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/APICommand"}}}}}, "tags": ["Dataset Items"], "security": [], "parameters": [{"in": "path", "name": "datasetId", "required": true, "schema": {"type": "string"}}], "requestBody": {"required": true, "content": {"application/json": {"schema": {"properties": {"collections": {"items": {"type": "string"}, "type": "array"}, "query": {"$ref": "#/components/schemas/DQLResourceQuery"}}, "required": ["collections", "query"], "type": "object"}}}}}}, "/datasets/{datasetId}/items/collections/bulk-remove": {"post": {"operationId": "Remove Items from Item Collections", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/APICommand"}}}}}, "tags": ["Dataset Items"], "security": [], "parameters": [{"in": "path", "name": "datasetId", "required": true, "schema": {"type": "string"}}], "requestBody": {"required": true, "content": {"application/json": {"schema": {"properties": {"collections": {"items": {"type": "string"}, "type": "array"}, "query": {"$ref": "#/components/schemas/DQLResourceQuery"}}, "required": ["collections", "query"], "type": "object"}}}}}}, "/datasets/{datasetId}/items/collections/{collectionName}": {"delete": {"operationId": "Delete Item Collections", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/APICommand"}}}}}, "tags": ["Dataset Items"], "security": [], "parameters": [{"in": "path", "name": "datasetId", "required": true, "schema": {"type": "string"}}, {"in": "path", "name": "collectionName", "required": true, "schema": {"type": "string"}}]}, "patch": {"operationId": "Rename Item Collection", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Dictionary"}}}}}, "tags": ["Dataset Items"], "security": [], "parameters": [{"in": "path", "name": "datasetId", "required": true, "schema": {"type": "string"}}, {"in": "path", "name": "collectionName", "required": true, "schema": {"type": "string"}}], "requestBody": {"required": true, "content": {"application/json": {"schema": {"properties": {"name": {"type": "string"}}, "required": ["name"], "type": "object"}}}}}}, "/datasets/{datasetId}/items/invalidate-annotation-thumbnails": {"post": {"operationId": "Invalidate Annotation Thumbnails", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/APICommand"}}}}}, "tags": ["Dataset Items"], "security": [], "parameters": [{"in": "path", "name": "datasetId", "required": true, "schema": {"type": "string"}}], "requestBody": {"required": true, "content": {"application/json": {"schema": {"properties": {"itemsQuery": {"$ref": "#/components/schemas/DQLResourceQuery"}}, "required": ["itemsQuery"], "type": "object"}}}}}}, "/datasets/{datasetId}/items/{id}": {"put": {"operationId": "Move Items", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/APICommand"}}}}}, "description": "Move files to a specified directory", "tags": ["Dataset Items"], "security": [], "parameters": [{"description": "Dataset Id", "in": "path", "name": "datasetId", "required": true, "schema": {"type": "string"}}, {"in": "path", "name": "id", "required": true, "schema": {"type": "string"}}], "requestBody": {"required": true, "content": {"application/json": {"schema": {"anyOf": [{"properties": {"dqlQuery": {"$ref": "#/components/schemas/DQLResourceQuery"}}, "required": ["dqlQuery"], "type": "object"}, {"items": {"type": "string"}, "type": "array"}]}}}}}, "get": {"operationId": "Get Dataset Item", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"anyOf": [{"$ref": "#/components/schemas/APIDatasetFileItem"}, {"$ref": "#/components/schemas/APIDatasetDirectoryItem"}]}}}}}, "tags": ["Dataset Items"], "security": [], "parameters": [{"in": "path", "name": "id", "required": true, "schema": {"type": "string"}}, {"in": "path", "name": "datasetId", "required": true, "schema": {"type": "string"}}]}, "delete": {"operationId": "Remove Dataset Item", "responses": {"204": {"description": "No content"}}, "tags": ["Dataset Items"], "security": [], "parameters": [{"in": "path", "name": "id", "required": true, "schema": {"type": "string"}}, {"in": "path", "name": "datasetId", "required": true, "schema": {"type": "string"}}]}, "patch": {"operationId": "Edit Dataset Item", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"anyOf": [{"$ref": "#/components/schemas/APIDatasetFileItem"}, {"$ref": "#/components/schemas/APIDatasetDirectoryItem"}]}}}}}, "tags": ["Dataset Items"], "security": [], "parameters": [{"in": "path", "name": "id", "required": true, "schema": {"type": "string"}}, {"in": "query", "name": "system", "required": false, "schema": {"type": "boolean"}}, {"in": "path", "name": "datasetId", "required": true, "schema": {"type": "string"}}], "requestBody": {"required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/PartialAPIDatasetItem"}}}}}}, "/datasets/{datasetId}/items/{id}/clone": {"post": {"operationId": "Clone Dataset Item", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/APICommand"}}}}}, "tags": ["Dataset Items"], "security": [], "parameters": [{"in": "path", "name": "id", "required": true, "schema": {"type": "string"}}, {"in": "path", "name": "datasetId", "required": true, "schema": {"type": "string"}}], "requestBody": {"required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ItemCloneRequest"}}}}}}, "/datasets/{datasetId}/items/{id}/items": {"get": {"operationId": "Get Directory Child Dataset Items", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/APIDatasetItemCursor"}}}}}, "tags": ["Dataset Items"], "security": [], "parameters": [{"in": "path", "name": "id", "required": true, "schema": {"type": "string"}}, {"in": "query", "name": "pageOffset", "required": false, "schema": {"format": "double", "type": "number"}}, {"in": "query", "name": "pageSize", "required": false, "schema": {"format": "double", "type": "number"}}, {"in": "path", "name": "datasetId", "required": true, "schema": {"type": "string"}}]}}, "/datasets/{datasetId}/items/{id}/revisions": {"post": {"operationId": "Create Dataset Item Revision", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/APIDatasetFileItem"}}}}}, "tags": ["Dataset Items"], "security": [], "parameters": [{"in": "path", "name": "id", "required": true, "schema": {"type": "string"}}, {"in": "path", "name": "datasetId", "required": true, "schema": {"type": "string"}}]}}, "/datasets/{datasetId}/items/{id}/snapshots": {"post": {"operationId": "Create Dataset Item Snapshot", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/APIDatasetFileItem"}}}}}, "description": "Create a new snapshot on an existing item\nOrder is important - FILE MUST BE LAST FIELD OF THE FORM", "tags": ["Dataset Items"], "security": [], "parameters": [{"in": "path", "name": "id", "required": true, "schema": {"type": "string"}}, {"in": "path", "name": "datasetId", "required": true, "schema": {"type": "string"}}]}}, "/datasets/{datasetId}/items/{id}/stream": {"get": {"operationId": "Stream Dataset Item", "responses": {"204": {"description": "No content"}}, "tags": ["Dataset Items"], "security": [], "parameters": [{"in": "path", "name": "id", "required": true, "schema": {"type": "string"}}, {"in": "path", "name": "datasetId", "required": true, "schema": {"type": "string"}}]}}, "/datasets/{datasetId}/items/{id}/thumbnail": {"get": {"operationId": "Stream Dataset Item Thumbnail", "responses": {"204": {"description": "No content"}}, "tags": ["Dataset Items"], "security": [], "parameters": [{"in": "path", "name": "id", "required": true, "schema": {"type": "string"}}, {"in": "query", "name": "width", "required": false, "schema": {"format": "double", "type": "number"}}, {"in": "query", "name": "height", "required": false, "schema": {"format": "double", "type": "number"}}, {"in": "query", "name": "annotations", "required": false, "schema": {"type": "boolean"}}, {"in": "query", "name": "annotationsV2", "required": false, "schema": {"type": "boolean"}}, {"in": "query", "name": "queryHash", "required": false, "schema": {"type": "string"}}, {"in": "path", "name": "datasetId", "required": true, "schema": {"type": "string"}}]}}, "/datasets/{datasetId}/items/{itemId}/annotations": {"get": {"operationId": "List Dataset Item Annotations", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"items": {"$ref": "#/components/schemas/APIAnnotation"}, "type": "array"}}}}}, "description": "List all annotations of an item", "tags": ["Dataset Item Annotations"], "security": [], "parameters": [{"description": "Dataset id", "in": "path", "name": "datasetId", "required": true, "schema": {"type": "string"}}, {"description": "Item id", "in": "path", "name": "itemId", "required": true, "schema": {"type": "string"}}]}, "post": {"operationId": "Create Annotations", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"anyOf": [{"$ref": "#/components/schemas/APIAnnotation"}, {"items": {"$ref": "#/components/schemas/APIAnnotation"}, "type": "array"}]}}}}}, "description": "Create an annotation or annotations for an item", "tags": ["Dataset Item Annotations"], "security": [], "parameters": [{"description": "Dataset id", "in": "path", "name": "datasetId", "required": true, "schema": {"type": "string"}}, {"description": "Item id", "in": "path", "name": "itemId", "required": true, "schema": {"type": "string"}}], "requestBody": {"description": "Annotation/s to be created\nIn the case of annotation parenting, annotation will need to include a parent - annotation request object and children - array of annotation request objects\nIn that case only the parent and children will be used\nThere is handling for mixed requests - both simple annotation and parent/children will be accepted and handled together", "required": true, "content": {"application/json": {"schema": {"anyOf": [{"$ref": "#/components/schemas/APIAnnotationRequest"}, {"items": {"$ref": "#/components/schemas/APIAnnotationRequest"}, "type": "array"}], "description": "Annotation/s to be created\nIn the case of annotation parenting, annotation will need to include a parent - annotation request object and children - array of annotation request objects\nIn that case only the parent and children will be used\nThere is handling for mixed requests - both simple annotation and parent/children will be accepted and handled together"}}}}}}, "/datasets/{datasetId}/items/{itemId}/annotations-log": {"get": {"operationId": "List Dataset Item Annotation Logs", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Dictionary_APIAnnotationEvent-Array_"}}}}}, "description": "List all annotations of an item", "tags": ["Annotation Logs"], "security": [], "parameters": [{"description": "Item id", "in": "path", "name": "itemId", "required": true, "schema": {"type": "string"}}, {"description": "Dataset id", "in": "path", "name": "datasetId", "required": true, "schema": {"type": "string"}}]}}, "/datasets/{datasetId}/items/{itemId}/annotations/archiveAnnotationLogs": {"post": {"operationId": "Archive Dataset Item Annotation to Storage", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/APICommand"}}}}}, "tags": ["Dataset Item Annotations"], "security": [], "parameters": [{"in": "path", "name": "datasetId", "required": true, "schema": {"type": "string"}}, {"in": "path", "name": "itemId", "required": true, "schema": {"type": "string"}}], "requestBody": {"required": true, "content": {"application/json": {"schema": {"properties": {"concurrency": {"type": "number", "format": "double"}, "sampleSize": {"type": "number", "format": "double"}, "spec": {"$ref": "#/components/schemas/DQLResourceQuery"}}, "required": ["concurrency", "sampleSize", "spec"], "type": "object"}}}}}}, "/datasets/{datasetId}/items/{itemId}/annotations/restore-archived-annotation-logs": {"post": {"operationId": "Restore archived Dataset Item Annotation to DB", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/APICommand"}}}}}, "tags": ["Dataset Item Annotations"], "security": [], "parameters": [{"in": "path", "name": "datasetId", "required": true, "schema": {"type": "string"}}, {"in": "path", "name": "itemId", "required": true, "schema": {"type": "string"}}], "requestBody": {"required": true, "content": {"application/json": {"schema": {"properties": {"annotationLogId": {"type": "string"}, "annotationId": {"type": "string"}, "itemId": {"type": "string"}, "datasetId": {"type": "string"}}, "required": ["itemId", "datasetId"], "type": "object"}}}}}}, "/datasets/{datasetId}/items/{itemId}/annotations/{annotationId}": {"get": {"operationId": "Get Dataset Item Annotation", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/APIAnnotation"}}}}}, "description": "Get annotation by id", "tags": ["Dataset Item Annotations"], "security": [], "parameters": [{"description": "annotation id", "in": "path", "name": "annotationId", "required": true, "schema": {"type": "string"}}, {"in": "path", "name": "datasetId", "required": true, "schema": {"type": "string"}}, {"in": "path", "name": "itemId", "required": true, "schema": {"type": "string"}}]}, "delete": {"operationId": "Delete Dataset Item Annotation", "responses": {"204": {"description": "No content"}}, "description": "Delete an Annotation from an item", "tags": ["Dataset Item Annotations"], "security": [], "parameters": [{"description": "Annotation id", "in": "path", "name": "annotationId", "required": true, "schema": {"type": "string"}}, {"in": "path", "name": "datasetId", "required": true, "schema": {"type": "string"}}, {"in": "path", "name": "itemId", "required": true, "schema": {"type": "string"}}]}, "put": {"operationId": "Update Dataset Item Annotation", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/APIAnnotation"}}}}}, "description": "Update an item's annotation", "tags": ["Dataset Item Annotations"], "security": [], "parameters": [{"description": "Annotation id", "in": "path", "name": "annotationId", "required": true, "schema": {"type": "string"}}, {"description": "when specified - editing system space metadata is enabled", "in": "query", "name": "system", "required": false, "schema": {"type": "boolean"}}, {"in": "query", "name": "replace", "required": false, "schema": {"type": "boolean"}}, {"in": "path", "name": "datasetId", "required": true, "schema": {"type": "string"}}, {"in": "path", "name": "itemId", "required": true, "schema": {"type": "string"}}], "requestBody": {"description": "Updated annotation object", "required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/UpdateAnnotationRequest", "description": "Updated annotation object"}}}}}}, "/datasets/{datasetId}/items/{itemId}/annotations/{annotationId}/issue": {"put": {"operationId": "Dataset Item Annotation Issues", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/APIAnnotation"}}}}}, "description": "Update an item's annotation status to issue", "tags": ["Dataset Item Annotations"], "security": [], "parameters": [{"description": "Annotation id", "in": "path", "name": "annotationId", "required": true, "schema": {"type": "string"}}, {"in": "path", "name": "datasetId", "required": true, "schema": {"type": "string"}}, {"in": "path", "name": "itemId", "required": true, "schema": {"type": "string"}}]}}, "/datasets/{id}": {"get": {"operationId": "Get Dataset by ID", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/APIDataset"}}}}}, "description": "Get a specific Dataset", "tags": ["Datasets"], "security": [], "parameters": [{"description": "Dataset id", "in": "path", "name": "id", "required": true, "schema": {"type": "string"}}], "x-codeSamples": [{"lang": "Python", "source": "\n# \n# Get dataset by name or id.\n# \n# **Prerequisites**: You must be an *owner* or *developer* to use this method.\n# \n# You must provide at least ONE of the following params: dataset_id, dataset_name.\n# \n# :param str dataset_name: optional - search by name\n# :param str dataset_id: optional - search by id\n# :param bool checkout: set the dataset as a default dataset object (cookies)\n# :param bool fetch: optional - fetch entity from platform (True), default taken from cookie\n# :return: Dataset object\n# :rtype: dtlpy.entities.dataset.Dataset\n# \n# \n# dataset = project.datasets.get(dataset_id='dataset_id')\n# "}]}, "delete": {"operationId": "Delete Dataset", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"type": "number", "enum": [null], "nullable": true}}}}}, "description": "Delete a dataset", "tags": ["Datasets"], "security": [], "parameters": [{"description": "Dataset id", "in": "path", "name": "id", "required": true, "schema": {"type": "string"}}, {"in": "query", "name": "force", "required": false, "schema": {"type": "boolean"}}, {"in": "query", "name": "targetDeleteDate", "required": false, "schema": {"format": "date-time", "type": "string"}}], "x-codeSamples": [{"lang": "Python", "source": "\n# \n# Delete a dataset forever!\n# \n# **Prerequisites**: You must be an *owner* or *developer* to use this method.\n# \n# \n# is_deleted = project.datasets.delete(dataset_id='dataset_id', sure=True, really=True)\n# \n# :param str dataset_name: optional - search by name\n# :param str dataset_id: optional - search by id\n# :param bool sure: Are you sure you want to delete?\n# :param bool really: Really really sure?\n# :return: True is success\n# :rtype: bool\n# "}]}, "patch": {"operationId": "Patch Dataset", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/APIDataset"}}}}}, "description": "Update dataset properties", "tags": ["Datasets"], "security": [], "parameters": [{"description": "Dataset id", "in": "path", "name": "id", "required": true, "schema": {"type": "string"}}, {"description": "when specified - editing system space metadata is enabled", "in": "query", "name": "system", "required": false, "schema": {"type": "boolean"}}], "requestBody": {"description": "Properties to update on the dataset", "required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Partial_APIDatasetPayload_", "description": "Properties to update on the dataset"}}}}, "x-codeSamples": [{"lang": "Python", "source": "\n# \n# Update dataset field.\n# \n# **Prerequisites**: You must be an *owner* or *developer* to use this method.\n# \n# :param dtlpy.entities.dataset.Dataset dataset: dataset object\n# :param bool system_metadata: True, if you want to change metadata system\n# :param dict patch: Specific patch request\n# :return: Dataset object\n# :rtype: dtlpy.entities.dataset.Dataset\n# \n# \n# dataset = project.datasets.update(dataset='dataset_entity')\n# "}]}}, "/datasets/{id}/annotations": {"post": {"operationId": "Annotate Items By Dql", "responses": {"204": {"description": "No content"}}, "tags": ["Datasets"], "security": [], "parameters": [{"in": "path", "name": "id", "required": true, "schema": {"type": "string"}}], "requestBody": {"required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ClassifyFilteredItems"}}}}}}, "/datasets/{id}/annotations/json": {"get": {"operationId": "Get Dataset Annotations JSON", "responses": {"204": {"description": "No content"}}, "description": "Download a JSON file representing all annotations in the specified dataset", "tags": ["Datasets"], "security": [], "parameters": [{"description": "Dataset id", "in": "path", "name": "id", "required": true, "schema": {"type": "string"}}, {"in": "query", "name": "directory", "required": false, "schema": {"type": "string"}}]}}, "/datasets/{id}/annotations/labels": {"get": {"operationId": "Get Dataset Label Aggregation", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"items": {"properties": {}, "additionalProperties": {"anyOf": [{"type": "string"}, {"type": "number", "format": "double"}]}, "type": "object"}, "type": "array"}}}}}, "tags": ["Datasets"], "security": [], "parameters": [{"in": "path", "name": "id", "required": true, "schema": {"type": "string"}}, {"in": "query", "name": "taskId", "required": false, "schema": {"type": "string"}}, {"in": "query", "name": "assignmentId", "required": false, "schema": {"type": "string"}}]}, "post": {"operationId": "Get Filtered Dataset Label Aggregation", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"items": {"properties": {}, "additionalProperties": {"anyOf": [{"type": "string"}, {"type": "number", "format": "double"}]}, "type": "object"}, "type": "array"}}}}}, "tags": ["Datasets"], "security": [], "parameters": [{"in": "path", "name": "id", "required": true, "schema": {"type": "string"}}], "requestBody": {"required": true, "content": {"application/json": {"schema": {"properties": {"assignmentId": {"type": "string"}, "taskId": {"type": "string"}, "creators": {"items": {"type": "string"}, "type": "array"}}, "type": "object"}}}}}}, "/datasets/{id}/annotations/types": {"post": {"operationId": "Get Filtered Dataset Type Aggregation", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"items": {"properties": {}, "additionalProperties": {"anyOf": [{"type": "string"}, {"type": "number", "format": "double"}]}, "type": "object"}, "type": "array"}}}}}, "tags": ["Datasets"], "security": [], "parameters": [{"in": "path", "name": "id", "required": true, "schema": {"type": "string"}}], "requestBody": {"required": true, "content": {"application/json": {"schema": {"properties": {"assignmentId": {"type": "string"}, "taskId": {"type": "string"}, "creators": {"items": {"type": "string"}, "type": "array"}}, "type": "object"}}}}}}, "/datasets/{id}/annotations/zip": {"get": {"operationId": "Get Dataset Annotations Zip", "responses": {"204": {"description": "No content"}}, "description": "Download a zip archive containing all annotations in the specified dataset\nDirectory structure is preserved in the zip archive\nEach item will be represented by a json file containing it's annotations", "tags": ["Datasets"], "security": [], "parameters": [{"description": "Dataset id", "in": "path", "name": "id", "required": true, "schema": {"type": "string"}}, {"in": "query", "name": "directory", "required": false, "schema": {"type": "string"}}]}}, "/datasets/{id}/annotations/zip/chunks": {"get": {"operationId": "Get Dataset Annotations Zip Chunks", "responses": {"204": {"description": "No content"}}, "tags": ["Datasets"], "security": [], "parameters": [{"in": "path", "name": "id", "required": true, "schema": {"type": "string"}}]}}, "/datasets/{id}/clone": {"post": {"operationId": "Clone Dataset", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/APICommand"}, "examples": {"Example 1": {"value": {"name": "", "filter": {"filter": {}}, "cloneDatasetParams": {"withItemsAnnotations": true, "withMetadata": true}}}}}}}, "400": {"description": "Missing argument"}}, "tags": ["Datasets"], "security": [], "parameters": [{"in": "path", "name": "id", "required": true, "schema": {"type": "string"}}], "requestBody": {"required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/CloneDatasetRequest"}}}}, "x-codeSamples": [{"lang": "Python", "source": "\n# \n# Clone a dataset. Read more about cloning datatsets and items in our `documentation <https://dataloop.ai/docs/clone-merge-dataset#cloned-dataset>`_ and `SDK documentation <https://developers.dataloop.ai/tutorials/data_management/data_versioning/chapter/>`_.\n# \n# **Prerequisites**: You must be in the role of an *owner* or *developer*.\n# \n# :param str dataset_id: id of the dataset you wish to clone\n# :param str clone_name: new dataset name\n# :param dtlpy.entities.filters.Filters filters: Filters entity or a query dict\n# :param bool with_items_annotations: true to clone with items annotations\n# :param bool with_metadata: true to clone with metadata\n# :param bool with_task_annotations_status: true to clone with task annotations' status\n# :param str dst_dataset_id: destination dataset id\n# :param str target_directory: target directory\n# :return: dataset object\n# :rtype: dtlpy.entities.dataset.Dataset\n# \n# \n# dataset = project.datasets.clone(dataset_id='dataset_id',\n# clone_name='dataset_clone_name',\n# with_metadata=True,\n# with_items_annotations=False,\n# with_task_annotations_status=False)\n# "}]}}, "/datasets/{id}/counters": {"delete": {"operationId": "Reset Dataset Counters", "responses": {"204": {"description": "No content"}}, "description": "Reset dataset counters (items count, anntotated count, etc...)", "tags": ["Datasets"], "security": [], "parameters": [{"description": "Dataset to be reset", "in": "path", "name": "id", "required": true, "schema": {"type": "string"}}]}}, "/datasets/{id}/directoryTree": {"get": {"operationId": "Get Dataset Directory Tree", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/DatasetDirectoryTree"}}}}}, "description": "Get a directory tree of the dataset", "tags": ["Datasets"], "security": [], "parameters": [{"description": "Dataset id", "in": "path", "name": "id", "required": true, "schema": {"type": "string"}}], "x-codeSamples": [{"lang": "Python", "source": "# \n# Get dataset's directory tree.\n# \n# **Prerequisites**: You must be an *owner* or *developer* to use this method.\n# \n# You must provide at least ONE of the following params: dataset, dataset_name, dataset_id.\n# \n# :param dtlpy.entities.dataset.Dataset dataset: dataset object\n# :param str dataset_name: The Name of the dataset\n# :param str dataset_id: The Id of the dataset\n# :return: DirectoryTree\n# \n# \n# directory_tree = dataset.directory_tree\n# directory_tree = project.datasets.directory_tree(dataset='dataset_entity')\n# "}]}}, "/datasets/{id}/export": {"post": {"operationId": "Export Dataset As Zip", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {}}}}}, "tags": ["Datasets"], "security": [], "parameters": [{"in": "path", "name": "id", "required": true, "schema": {"type": "string"}}], "requestBody": {"required": false, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ExportDatasetOptions"}}}}, "x-codeSamples": [{"lang": "Python", "source": "# \n# Export dataset items and annotations.\n# \n# **Prerequisites**: You must be an *owner* or *developer* to use this method.\n# \n# You must provide at least ONE of the following params: dataset, dataset_name, dataset_id.\n# \n# **Export Behavior by Parameter Combination:**\n# \n# The behavior of this method depends on the combination of `export_type` and `output_export_type`:\n# \n# **When export_type = ExportType.JSON:**\n# \n# - **output_export_type = OutputExportType.JSON (default when None):**\n# - Exports data in JSON format, split into subsets of max 500 items\n# - Downloads all subset JSON files and concatenates them into a single `result.json` file\n# - Returns the path to the concatenated JSON file\n# - Cleans up individual subset files after concatenation\n# \n# - **output_export_type = OutputExportType.ZIP:**\n# - Same as JSON export, but zips the final `result.json` file\n# - Returns the path to the zipped file (`result.json.zip`)\n# - Cleans up the unzipped JSON file after zipping\n# \n# - **output_export_type = OutputExportType.FOLDERS:**\n# - Exports data in JSON format, split into subsets of max 500 items\n# - Downloads all subset JSON files and creates individual JSON files for each item\n# - Creates a folder structure mirroring the remote dataset structure\n# - Returns the path to the base directory containing the folder structure\n# - Each item gets its own JSON file named after the original filename\n# \n# **When export_type = ExportType.ZIP:**\n# \n# - **output_export_type = OutputExportType.ZIP:**\n# - Exports data as a ZIP file containing the dataset\n# - Returns the downloaded ZIP item directly\n# - No additional processing or concatenation\n# \n# - **output_export_type = OutputExportType.JSON:**\n# - **NOT SUPPORTED** - Raises NotImplementedError\n# - Use export_type=ExportType.JSON instead for JSON output\n# \n# - **output_export_type = OutputExportType.FOLDERS:**\n# - **NOT SUPPORTED** - Raises NotImplementedError\n# - Use export_type=ExportType.JSON instead for folder output\n# \n# **When output_export_type = None (legacy behavior):**\n# - Defaults to OutputExportType.JSON\n# - Maintains backward compatibility with existing code\n# \n# :param dtlpy.entities.dataset.Dataset dataset: Dataset object\n# :param str dataset_name: The name of the dataset\n# :param str dataset_id: The ID of the dataset\n# :param str local_path: Local path to save the exported dataset\n# :param Union[dict, dtlpy.entities.filters.Filters] filters: Filters entity or a query dictionary\n# :param dtlpy.entities.filters.Filters annotation_filters: Filters entity to filter annotations for export\n# :param dtlpy.entities.filters.Filters feature_vector_filters: Filters entity to filter feature vectors for export\n# :param bool include_feature_vectors: Include item feature vectors in the export\n# :param bool include_annotations: Include item annotations in the export\n# :param bool dataset_lock: Make dataset readonly during the export\n# :param bool export_summary: Get Summary of the dataset export\n# :param int lock_timeout_sec: Timeout for locking the dataset during export in seconds\n# :param entities.ExportType export_type: Type of export ('json' or 'zip')\n# :param entities.OutputExportType output_export_type: Output format ('json', 'zip', or 'folders'). If None, defaults to 'json'\n# :param int timeout: Maximum time in seconds to wait for the export to complete\n# :return: Path to exported file/directory, or None if export result is empty\n# :rtype: Optional[str]\n# "}]}}, "/datasets/{id}/imports": {"post": {"operationId": "Import Items To Dataset", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"items": {"anyOf": [{"$ref": "#/components/schemas/APIDatasetFileItem"}, {"$ref": "#/components/schemas/APIDatasetDirectoryItem"}]}, "type": "array"}}}}}, "tags": ["Datasets"], "security": [], "parameters": [{"in": "path", "name": "id", "required": true, "schema": {"type": "string"}}], "requestBody": {"required": true, "content": {"application/json": {"schema": {"anyOf": [{"items": {"$ref": "#/components/schemas/ImportItemRequest"}, "type": "array"}, {"properties": {"imports": {"items": {"$ref": "#/components/schemas/ImportItemRequest"}, "type": "array"}, "forceRescan": {"type": "boolean"}}, "required": ["imports"], "type": "object"}]}}}}}, "delete": {"operationId": "Detach Items From Dataset", "responses": {"204": {"description": "No content"}}, "tags": ["Datasets"], "security": [], "parameters": [{"in": "path", "name": "id", "required": true, "schema": {"type": "string"}}], "requestBody": {"required": true, "content": {"application/json": {"schema": {"items": {"type": "string"}, "type": "array"}}}}}}, "/datasets/{id}/items/bulk-update-metadata": {"post": {"x-codeSamples": [{"lang": "Python", "source": "# \n# Bulk update ML subset assignment for selected items.\n# If subset is None, remove subsets. Otherwise, assign the specified subset.\n# \n# :param str dataset_id: ID of the dataset\n# :param dict items_query: DQLResourceQuery (filters) for selecting items\n# :param str subset: 'train', 'validation', 'test' or None to remove all\n# :return: True if success\n# :rtype: bool\n# "}]}}, "/datasets/{id}/query": {"post": {"operationId": "Query Dataset", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/CursorPage_APIAnnotation-or-APIDataset-or-APIDatasetFileItem-or-APIDatasetDirectoryItem_"}}}}}, "description": "Detailed information about DQL can be found at https://dataloop.ai/docs/dql", "tags": ["Datasets"], "security": [], "parameters": [{"description": "Dataset to be queried", "in": "path", "name": "id", "required": true, "schema": {"type": "string"}}], "requestBody": {"description": "Query JSON", "required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/DQLResourceQuery", "description": "Query JSON"}}}}, "x-codeSamples": [{"lang": "Python", "source": "\n# \n# List items in a dataset.\n# \n# **Prerequisites**: You must be in the role of an *owner* or *developer*.\n# \n# :param dtlpy.entities.filters.Filters filters: Filters entity or a dictionary containing filters parameters\n# :param int page_offset: start page\n# :param int page_size: page size\n# :return: Pages object\n# :rtype: dtlpy.entities.paged_entities.PagedEntities\n# \n# \n# dataset.items.list(page_offset=0, page_size=100)\n# "}]}}, "/datasets/{id}/schema": {"get": {"operationId": "Get Dataset Schema Information", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"anyOf": [{"$ref": "#/components/schemas/Dataset"}, {"$ref": "#/components/schemas/APIDatasetSchema"}]}}}}}, "tags": ["Datasets"], "security": [], "parameters": [{"in": "path", "name": "id", "required": true, "schema": {"type": "string"}}]}}, "/datasets/{id}/schema/items": {"post": {"operationId": "Update dataset items schema", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"anyOf": [{"$ref": "#/components/schemas/APICommand"}, {"type": "string"}]}}}}}, "tags": ["Datasets"], "security": [], "parameters": [{"in": "path", "name": "id", "required": true, "schema": {"type": "string"}}], "requestBody": {"required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/UpdateItemsSchemaInput"}}}}}}, "/datasets/{id}/schema/items/mode": {"post": {"operationId": "Update dataset items schema mode", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"anyOf": [{"$ref": "#/components/schemas/APICommand"}, {"$ref": "#/components/schemas/Dataset"}]}}}}}, "tags": ["Datasets"], "security": [], "parameters": [{"in": "path", "name": "id", "required": true, "schema": {"type": "string"}}], "requestBody": {"required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/EditItemsSchemaModeInput"}}}}}}, "/datasets/{id}/split": {"post": {"operationId": "Split ML Operation", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/APICommand"}}}}}, "tags": ["Datasets"], "security": [], "parameters": [{"in": "path", "name": "id", "required": true, "schema": {"type": "string"}}], "requestBody": {"required": true, "content": {"application/json": {"schema": {"properties": {"MLSplitList": {"$ref": "#/components/schemas/Record_MLSplitListKeys.number_"}, "itemsQuery": {"$ref": "#/components/schemas/DQLResourceQuery"}}, "required": ["MLSplitList", "itemsQuery"], "type": "object"}}}}, "x-codeSamples": [{"lang": "Python", "source": "# \n# Split dataset items into ML subsets.\n# \n# :param str dataset_id: The ID of the dataset.\n# :param dict items_query: Query to select items.\n# :param dict ml_split_list: Dictionary with 'train', 'validation', 'test' keys and integer percentages.\n# :return: True if the split operation was successful.\n# :rtype: bool\n# :raises: PlatformException on failure and ValueError if percentages do not sum to 100 or invalid keys/values.\n# "}]}}, "/datasets/{id}/sync": {"post": {"operationId": "Sync Dataset", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/APICommand"}}}}}, "description": "Synchronize missing files from storage", "tags": ["Datasets"], "security": [], "parameters": [{"description": "Dataset id", "in": "path", "name": "id", "required": true, "schema": {"type": "string"}}], "x-codeSamples": [{"lang": "Python", "source": "\n# \n# Sync dataset with external storage.\n# \n# **Prerequisites**: You must be in the role of an *owner* or *developer*.\n# \n# :param str dataset_id: The Id of the dataset to sync\n# :param bool wait: wait for the command to finish\n# :return: True if success\n# :rtype: bool\n# \n# \n# success = project.datasets.sync(dataset_id='dataset_id')\n# "}]}}, "/datasets/{id}/unlock": {"patch": {"operationId": "Unlock Dataset", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/APIDataset"}}}}}, "tags": ["Datasets"], "security": [], "parameters": [{"in": "path", "name": "id", "required": true, "schema": {"type": "string"}}], "x-codeSamples": [{"lang": "Python", "source": "\n# \n# Unlock dataset.\n# \n# **Prerequisites**: You must be an *owner* or *developer* to use this method.\n# \n# :param dtlpy.entities.dataset.Dataset dataset: dataset object\n# :return: Dataset object\n# :rtype: dtlpy.entities.dataset.Dataset\n# \n# \n# dataset = project.datasets.unlock(dataset='dataset_entity')\n# "}]}}, "/drivers": {"get": {"operationId": "List Storage Drivers", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"items": {"$ref": "#/components/schemas/APIDriverConfiguration"}, "type": "array"}}}}}, "description": "List storage drivers", "tags": ["Storage Drivers"], "security": [], "parameters": [{"description": "- when specified - filter drivers by project", "in": "query", "name": "projectId", "required": false, "schema": {"type": "string"}}, {"in": "query", "name": "integrationId", "required": false, "schema": {"type": "string"}}], "x-codeSamples": [{"lang": "Python", "source": "\n# \n# Get the project's drivers list.\n# \n# **Prerequisites**: You must be in the role of an *owner* or *developer*.\n# \n# :return: List of Drivers objects\n# :rtype: list\n# \n# \n# project.drivers.list()\n# \n# "}]}, "post": {"operationId": "Create Storage Driver", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/APIDriverConfiguration"}}}}}, "description": "Create a new storage driver", "tags": ["Storage Drivers"], "security": [], "parameters": [], "requestBody": {"description": ": driver payload", "required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/DriverPayload", "description": ": driver payload"}}}}, "x-codeSamples": [{"lang": "Python", "source": "# \n# Create a driver on the platform using the provided payload.\n# \n# :param dict payload: The driver creation payload\n# :return: The created driver object\n# :rtype: dtlpy.entities.driver.Driver\n# :raises PlatformException: If the driver creation fails\n# "}]}}, "/drivers/byIntegration/{integrationId}": {"get": {"operationId": "Get Storage Drivers By Integration Id", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"type": "number", "format": "double"}}}}}, "description": "Get Amount of drivers by integrationId", "tags": ["Storage Drivers"], "security": [], "parameters": [{"in": "path", "name": "integrationId", "required": true, "schema": {"type": "string"}}]}}, "/drivers/test": {"post": {"operationId": "Test Storage Driver", "responses": {"204": {"description": "No content"}}, "description": "Test external storage access", "tags": ["Storage Drivers"], "security": [], "parameters": [], "requestBody": {"description": ": driver payload", "required": true, "content": {"application/json": {"schema": {"description": ": driver payload"}}}}}}, "/drivers/validateDrivers": {"post": {"operationId": "Check Storage Drivers Integration By Integration Id", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/APICommand"}}}}}, "description": "Check storage driver integration by integration Id", "tags": ["Storage Drivers"], "security": [], "parameters": [], "requestBody": {"required": true, "content": {"application/json": {"schema": {"properties": {"integrationId": {"type": "string"}}, "required": ["integrationId"], "type": "object"}}}}}}, "/drivers/{id}": {"get": {"operationId": "Get Storage Driver", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/APIDriverConfiguration"}}}}}, "description": "Get storage driver configuration", "tags": ["Storage Drivers"], "security": [], "parameters": [{"description": "driver id", "in": "path", "name": "id", "required": true, "schema": {"type": "string"}}], "x-codeSamples": [{"lang": "Python", "source": "\n# \n# Get a Driver object to use in your code.\n# \n# **Prerequisites**: You must be in the role of an *owner* or *developer*.\n# \n# You must provide at least ONE of the following params: driver_name, driver_id.\n# \n# :param str driver_name: optional - search by name\n# :param str driver_id: optional - search by id\n# :return: Driver object\n# :rtype: dtlpy.entities.driver.Driver\n# \n# \n# project.drivers.get(driver_id='driver_id')\n# "}]}, "patch": {"operationId": "Update Storage Driver", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/APIDriverConfiguration"}}}}}, "description": "Update storage driver configuration", "tags": ["Storage Drivers"], "security": [], "parameters": [{"description": ": driverId", "in": "path", "name": "id", "required": true, "schema": {"type": "string"}}], "requestBody": {"description": ": fields to update", "required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/PartialDriverPayload", "description": ": fields to update"}}}}}, "delete": {"operationId": "Delete Storage Driver", "responses": {"204": {"description": "No content"}}, "description": "Delete storage driver\nNOTICE: datasets using the deleted driver will not be able to access storage after deletion", "tags": ["Storage Drivers"], "security": [], "parameters": [{"in": "path", "name": "id", "required": true, "schema": {"type": "string"}}], "x-codeSamples": [{"lang": "Python", "source": "\n# \n# Delete a driver forever!\n# \n# **Prerequisites**: You must be an *owner* or *developer* to use this method.\n# \n# \n# project.drivers.delete(dataset_id='dataset_id', sure=True, really=True)\n# \n# :param str driver_name: optional - search by name\n# :param str driver_id: optional - search by id\n# :param bool sure: Are you sure you want to delete?\n# :param bool really: Really really sure?\n# :return: True if success\n# :rtype: bool\n# "}]}}, "/drivers/{id}/test": {"get": {"operationId": "Test Storage Driver Permissions", "responses": {"204": {"description": "No content"}}, "description": "Test external storage access", "tags": ["Storage Drivers"], "security": [], "parameters": [{"in": "path", "name": "id", "required": true, "schema": {"type": "string"}}]}}, "/drivers/{projectId}/drivers-by-provider": {"get": {"operationId": "List Storage Drivers By Provider", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/APIDriversByProviderResponse"}}}}}, "tags": ["Storage Drivers"], "security": [], "parameters": [{"in": "path", "name": "projectId", "required": true, "schema": {"type": "string"}}]}}, "/executions": {"get": {"operationId": "_listExecutions", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ExecutionsPage"}}}}}, "description": "List service executions.", "tags": ["Executions"], "security": [], "parameters": [{"description": "The project id", "in": "query", "name": "projectsQuery", "required": false, "schema": {"type": "string"}}, {"description": "The service name which the execution was running of", "in": "query", "name": "service", "required": false, "schema": {"type": "string"}}, {"description": "The trigger name that has create the execution", "in": "query", "name": "trigger", "required": false, "schema": {"type": "string"}}, {"description": "The function name", "in": "query", "name": "functionName", "required": false, "schema": {"type": "string"}}, {"in": "query", "name": "orderByType", "required": false, "schema": {"$ref": "#/components/schemas/ExecutionsOrderByType"}}, {"in": "query", "name": "orderByDirection", "required": false, "schema": {"$ref": "#/components/schemas/ExecutionsOrderByDirection"}}, {"in": "query", "name": "createdAfter", "required": false, "schema": {"type": "string"}}, {"in": "query", "name": "createdBefore", "required": false, "schema": {"type": "string"}}, {"description": "The execution status", "in": "query", "name": "status", "required": false, "schema": {"$ref": "#/components/schemas/ExecutionStatusName"}}, {"description": "The resourceType should be executions", "in": "query", "name": "resourceType", "required": false, "schema": {"$ref": "#/components/schemas/PackageResourceType"}}, {"in": "query", "name": "resourceId", "required": false, "schema": {"type": "string"}}, {"in": "query", "name": "pageOffset", "required": false, "schema": {"format": "double", "type": "number"}}, {"in": "query", "name": "pageSize", "required": false, "schema": {"format": "double", "type": "number"}}]}}, "/executions/counters": {"get": {"operationId": "_getExecutionCounters", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"properties": {}, "additionalProperties": {"type": "number", "format": "double"}, "type": "object"}}}}}, "tags": ["Executions"], "security": [], "parameters": [{"in": "query", "name": "filter", "required": false, "schema": {"type": "string"}}]}}, "/executions/rerun": {"post": {"operationId": "_rerunExecutionQuery", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/APICommand"}}}}}, "description": "Rerun batch execution.", "tags": ["Executions"], "security": [], "parameters": [], "requestBody": {"description": "Rerun options.", "required": true, "content": {"application/json": {"schema": {"description": "Rerun options."}}}}, "x-codeSamples": [{"lang": "Python", "source": "\n# \n# rerun a executions on an existing service\n# \n# **Prerequisites**: You must be in the role of an *owner* or *developer*. You must have a Filter.\n# \n# :param filters: Filters entity for a filtering before rerun\n# :param str service_id: service id to rerun on\n# :param bool wait: wait until create task finish\n# :return: rerun command\n# :rtype: dtlpy.entities.command.Command\n# \n# \n# command = service.executions.rerun_batch(\n# filters=dl.Filters(field='id', values=['executionId'], operator=dl.FiltersOperations.IN, resource=dl.FiltersResource.EXECUTION))\n# "}]}}, "/executions/workload": {"post": {"operationId": "_getWorkload", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"items": {"$ref": "#/components/schemas/APIExecution"}, "type": "array"}}}}}, "description": "Get Workload.", "tags": ["Executions"], "security": [], "parameters": [], "requestBody": {"required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/WorkloadParams"}}}}}}, "/executions/{executionId}/rerun": {"post": {"operationId": "_rerunExecution", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"anyOf": [{"$ref": "#/components/schemas/APIExecution"}, {"$ref": "#/components/schemas/PiperSettingsCommands"}]}}}}}, "description": "Rerun execution.", "tags": ["Executions"], "security": [], "parameters": [{"description": "Execution id", "in": "path", "name": "executionId", "required": true, "schema": {"type": "string"}}, {"description": "Wait for the execution to finish", "in": "query", "name": "waitUntilExecutionIsFinished", "required": true, "schema": {"type": "boolean"}}], "x-codeSamples": [{"lang": "Python", "source": "\n# \n# Rerun execution\n# \n# **Prerequisites**: You must be in the role of an *owner* or *developer*. You must have a service.\n# \n# :param dtlpy.entities.execution.Execution execution:\n# :param bool sync: wait for the execution to finish\n# :return: Execution object\n# :rtype: dtlpy.entities.execution.Execution\n# \n# \n# service.executions.rerun(execution='execution_entity')\n# "}]}}, "/executions/{id}": {"get": {"operationId": "_getExecution", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/APIExecution"}}}}}, "description": "Get an execution by id.", "tags": ["Executions"], "security": [], "parameters": [{"description": "Execution id", "in": "path", "name": "id", "required": true, "schema": {"type": "string"}}, {"description": "if true, wait for the execution to finish", "in": "query", "name": "sync", "required": true, "schema": {"type": "boolean"}}], "x-codeSamples": [{"lang": "Python", "source": "\n# \n# Get Service execution object\n# \n# **Prerequisites**: You must be in the role of an *owner* or *developer*. You must have a service.\n# \n# :param str execution_id: execution id\n# :param bool sync: if true, wait for the execution to finish\n# :return: Service execution object\n# :rtype: dtlpy.entities.execution.Execution\n# \n# \n# service.executions.get(execution_id='execution_id')\n# "}]}, "patch": {"operationId": "_updateExecution", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/APIExecution"}}}}}, "description": "Update execution changes to platform.", "tags": ["Executions"], "security": [], "parameters": [{"description": "Execution id", "in": "path", "name": "id", "required": true, "schema": {"type": "string"}}], "requestBody": {"required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/APIExecutionPatch"}}}}, "x-codeSamples": [{"lang": "Python", "source": "\n# \n# Update execution changes to platform\n# \n# **Prerequisites**: You must be in the role of an *owner* or *developer*. You must have a service.\n# \n# :param dtlpy.entities.execution.Execution execution: execution entity\n# :return: Service execution object\n# :rtype: dtlpy.entities.execution.Execution\n# \n# \n# service.executions.update(execution='execution_entity')\n# "}]}}, "/executions/{id}/attempts": {"post": {"operationId": "_incrementExecutionAttempts", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"type": "number", "format": "double"}}}}}, "description": "Increment the number of attempts that an execution is allowed to attempt to run a service that is not responding.", "tags": ["Executions"], "security": [], "parameters": [{"description": "Execution id", "in": "path", "name": "id", "required": true, "schema": {"type": "string"}}]}}, "/executions/{id}/nack": {"post": {"operationId": "_nack", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"type": "boolean"}}}}}, "description": "Nack execution.", "tags": ["Executions"], "security": [], "parameters": [{"in": "path", "name": "id", "required": true, "schema": {"type": "string"}}], "requestBody": {"required": true, "content": {"application/json": {"schema": {"properties": {"agentId": {"type": "string"}}, "required": ["agentId"], "type": "object"}}}}}}, "/executions/{id}/progress": {"post": {"operationId": "_pushProgress", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Execution"}}}}}, "description": "Update Execution Progress.", "tags": ["Executions"], "security": [], "parameters": [{"description": "Execution id", "in": "path", "name": "id", "required": true, "schema": {"type": "string"}}], "requestBody": {"required": true, "content": {"application/json": {"schema": {"properties": {"duration": {"type": "number", "format": "double"}, "packageRevision": {"type": "string", "description": "package revision"}, "serviceVersion": {"type": "string", "description": "service version"}, "output": {"$ref": "#/components/schemas/Dictionary", "description": "the output of the execution"}, "error": {"type": "string"}, "percentComplete": {"type": "number", "format": "double", "description": "percent work done"}, "message": {"type": "string", "description": "message"}, "status": {"$ref": "#/components/schemas/ExecutionStatusName", "description": "Execution status"}, "timestamp": {"type": "string", "format": "date-time"}}, "required": ["percentComplete", "message", "status", "timestamp"], "type": "object"}}}}}}, "/executions/{id}/terminate": {"post": {"operationId": "_terminateExecution", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/APIExecution"}}}}}, "description": "Terminate Execution.", "tags": ["Executions"], "security": [], "parameters": [{"description": "Execution id", "in": "path", "name": "id", "required": true, "schema": {"type": "string"}}], "requestBody": {"required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ExecutionStatusReport"}}}}, "x-codeSamples": [{"lang": "Python", "source": "\n# \n# Terminate Execution\n# \n# **Prerequisites**: You must be in the role of an *owner* or *developer*. You must have a service.\n# \n# :param dtlpy.entities.execution.Execution execution:\n# :return: execution object\n# :rtype: dtlpy.entities.execution.Execution\n# \n# \n# service.executions.terminate(execution='execution_entity')\n# "}]}}, "/executions/{serviceId}": {"post": {"operationId": "_createExecution", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"anyOf": [{"$ref": "#/components/schemas/APIExecution"}, {"$ref": "#/components/schemas/APICommand"}]}}}}}, "description": "Execute a function on an existing service.", "tags": ["Executions"], "security": [], "parameters": [{"description": "Service id to execute on.", "in": "path", "name": "serviceId", "required": true, "schema": {"type": "string"}}, {"description": "if true, wait for function to end.", "in": "query", "name": "waitUntilExecutionIsFinished", "required": true, "schema": {"type": "boolean"}}], "requestBody": {"required": true, "content": {"application/json": {"schema": {"properties": {"mode": {"$ref": "#/components/schemas/ExecutionMode"}, "pipeline": {"$ref": "#/components/schemas/IPipelineExecution"}, "projectId": {"type": "string"}, "input": {"$ref": "#/components/schemas/Dictionary"}, "functionName": {"type": "string"}, "batch": {"$ref": "#/components/schemas/ExecuteOptionsBatch"}}, "required": ["projectId", "input", "functionName"], "type": "object"}}}}, "x-codeSamples": [{"lang": "Python", "source": "\n# \n# Execute a function on an existing service\n# \n# **Prerequisites**: You must be in the role of an *owner* or *developer*. You must have a service.\n# \n# :param str service_id: service id to execute on\n# :param filters: Filters entity for a filtering before execute\n# :param str function_name: function name to run\n# :param List[FunctionIO] or dict execution_inputs: input dictionary or list of FunctionIO entities, that represent the extra inputs of the function\n# :param bool wait: wait until create task finish\n# :return: execution object\n# :rtype: dtlpy.entities.execution.Execution\n# \n# \n# command = service.executions.create_batch(\n# execution_inputs=dl.FunctionIO(type=dl.PackageInputType.STRING, value='test', name='string'),\n# filters=dl.Filters(field='dir', values='/test'),\n# function_name='run')\n# "}]}}, "/features/set/{id}": {"patch": {"x-codeSamples": [{"lang": "Python", "source": "\n# \n# Update a Feature Set\n# \n# **Prerequisites**: You must be in the role of an *owner* or *developer*.\n# \n# :param dtlpy.entities.FeatureSet feature_set: FeatureSet object\n# :return: FeatureSet\n# :rtype: dtlpy.entities.FeatureSet\n# \n# \n# dl.feature_sets.update(feature_set='feature_set')\n# "}]}}, "/features/sets": {"post": {"operationId": "Add Feature Sets", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"items": {"$ref": "#/components/schemas/APIFeatureSet"}, "type": "array"}}}}, "400": {"description": "Missing argument"}}, "description": "Add a new feature set", "tags": ["Feature Sets"], "security": [], "parameters": [], "requestBody": {"description": "Feature set/s to be uploaded", "required": true, "content": {"application/json": {"schema": {"anyOf": [{"$ref": "#/components/schemas/FeatureSet"}, {"items": {"$ref": "#/components/schemas/FeatureSet"}, "type": "array"}], "description": "Feature set/s to be uploaded"}}}}, "x-codeSamples": [{"lang": "Python", "source": "# \n# Create a new Feature Set\n# \n# :param str name: the Feature name\n# :param int size: the length of a single vector in the set\n# :param str set_type: string of the feature type: 2d, 3d, modelFC, TSNE,PCA,FFT\n# :param entity_type: the entity that feature vector is linked to. Use the enum dl.FeatureEntityType\n# :param str project_id: the ID of the project where feature set will be created\n# :param str model_id: the ID of the model that creates the vectors\n# :param str org_id: the ID of the org where feature set will be created\n# :return: Feature Set object\n# "}]}}, "/features/sets/query": {"post": {"operationId": "List Feature Sets", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/CursorPage_APIFeatureSet_"}, "examples": {"Example 1": {"value": {"filter": {"$or": [{"name": {"$in": ["abc", "cde"]}}, {"$and": [{"size": {"$lte": 5}}, {"creator": "abc@dataloop.ai"}]}]}, "context": {"projects": [null]}, "page": 0, "pageSize": 100, "resource": "feature_sets"}}, "Example 2": {"value": {"hasNextPage": false, "items": [{"id": "64e688839d86c82809beca38", "creator": "assaf@dataloop.ai", "createdAt": "2021-08-25T22:00:00.000Z", "type": "test type", "entityType": "image", "updatedAt": "2021-08-25T22:00:00.000Z", "updatedBy": "assaf@dataloop.ai", "name": "feature set name", "size": 1, "url": "https://dev-gate.dataloop.ai/api/v1/features/vectors/64e688839d86c82809beca38", "authz": {"context": {"createdAt": "2021-08-25T22:00:00.000Z", "creator": "assaf@dataloop.ai", "org": "org-1", "updatedAt": "2021-08-25T22:00:00.000Z"}}}], "totalItemsCount": 1, "totalPagesCount": 1}}}}}}}, "description": "List feature sets", "tags": ["Feature Sets"], "security": [], "parameters": [], "requestBody": {"required": true, "content": {"application/json": {"schema": {"allOf": [{"$ref": "#/components/schemas/DQLResourceQuery"}, {"$ref": "#/components/schemas/FilterQuery"}]}}}}, "x-codeSamples": [{"lang": "Python", "source": "# \n# List Feature Sets\n# \n# :param dtlpy.entities.filters.Filters filters: Filters entity or a dictionary containing filters parameters\n# :return: Paged entity\n# :rtype: dtlpy.entities.paged_entities.PagedEntities\n# "}]}}, "/features/sets/{id}": {"get": {"operationId": "Get Feature Set", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/APIFeatureSet"}}}}}, "description": "Get a feature set by id", "tags": ["Feature Sets"], "security": [], "parameters": [{"in": "path", "name": "id", "required": true, "schema": {"type": "string"}}], "x-codeSamples": [{"lang": "Python", "source": "# \n# Get Feature Set object\n# \n# :param str feature_set_name: name of the feature set\n# :param str feature_set_id: id of the feature set\n# :return: Feature object\n# "}]}, "delete": {"operationId": "Delete Feature Set", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"properties": {}, "type": "object"}}}}}, "description": "Delete a feature set by id", "tags": ["Feature Sets"], "security": [], "parameters": [{"in": "path", "name": "id", "required": true, "schema": {"type": "string"}}], "x-codeSamples": [{"lang": "Python", "source": "# \n# Delete feature vector\n# \n# :param str feature_set_id: feature set id to delete\n# :return: success\n# :rtype: bool\n# "}]}, "patch": {"operationId": "Edit Feature Sets", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/APIFeatureSet"}}}}}, "description": "Update a feature set by id", "tags": ["Feature Sets"], "security": [], "parameters": [{"in": "path", "name": "id", "required": true, "schema": {"type": "string"}}], "requestBody": {"description": "partial feature set to update", "required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/PartialFeatureSet", "description": "partial feature set to update"}}}}}}, "/features/vectors": {"get": {"operationId": "Get Feature Vectors", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"items": {"$ref": "#/components/schemas/APIFeatureVector"}, "type": "array"}}}}}, "description": "Get feature vectors by creator", "tags": ["Feature Vectors"], "security": [], "parameters": [{"in": "query", "name": "pageSize", "required": false, "schema": {"format": "double", "type": "number"}}, {"in": "query", "name": "page", "required": false, "schema": {"format": "double", "type": "number"}}]}, "post": {"operationId": "Add Feature Vectors", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"items": {"$ref": "#/components/schemas/APIFeatureVector"}, "type": "array"}}}}, "400": {"description": "Missing argument"}}, "description": "Add new feature vector/s", "tags": ["Feature Vectors"], "security": [], "parameters": [], "requestBody": {"description": "feature vector/s to be uploaded", "required": true, "content": {"application/json": {"schema": {"anyOf": [{"$ref": "#/components/schemas/FeatureVector"}, {"items": {"$ref": "#/components/schemas/FeatureVector"}, "type": "array"}], "description": "feature vector/s to be uploaded"}}}}, "x-codeSamples": [{"lang": "Python", "source": "# \n# Create a new Feature vector\n# \n# :param immutable value: actual vector - immutable (list of floats [1,2,3]) or list of lists of floats\n# :param str project_id: the id of the project where feature will be created\n# :param str feature_set_id: ref to a featureSet this vector is a part of\n# :param entity: the entity the featureVector is linked to (item, annotation, etc) or list of entities\n# :param str version: version of the featureSet generator\n# :param str parent_id: optional: parent FeatureSet id - used when FeatureVector is a subFeature\n# :param str org_id: the id of the org where featureVector will be created\n# :return: Feature vector:\n# "}]}}, "/features/vectors/project-count-aggregation": {"post": {"operationId": "Aggregate feature vectors in project by featur sets and datasets", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/AggregateProjectVectorsCountResult"}}}}}, "tags": ["Feature Vectors"], "security": [], "parameters": [], "requestBody": {"required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/AggregateProjectVectorsCountInput"}}}}}}, "/features/vectors/query": {"post": {"operationId": "Query Feature Vectors", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/CursorPage_APIFeatureVector_"}, "examples": {"Example 1": {"value": {"filter": {"value": {"$euclid": {"input": [1, 2, 3], "$euclidFilter": {"$eq": 89}, "$euclidSort": {"eu_dist": "descending"}}}, "featureSetId": "64e38482f084e62ddd555e46"}, "context": {"projects": [null]}, "page": 0, "pageSize": 100, "resource": "feature_vectors"}}, "Example 2": {"value": {"hasNextPage": false, "items": [{"id": "64e688839d86c82809beca38", "entityId": "entityTest", "creator": "assaf@dataloop.ai", "createdAt": "2021-08-25T22:00:00.000Z", "value": [90], "featureSetId": "64e688839d86c82809beca36", "datasetId": "64e688839d86c82809beca36", "url": "https://dev-gate.dataloop.ai/api/v1/features/vectors/64e688839d86c82809beca38", "authz": {"context": {"createdAt": "2021-08-25T22:00:00.000Z", "creator": "assaf@dataloop.ai", "org": "org-1", "updatedAt": "2021-08-25T22:00:00.000Z"}}}], "totalItemsCount": 1, "totalPagesCount": 1}}}}}}}, "description": "Query feature vectors via common DQL filter, sort, limit etc.\nQuerying supports joins on items and annotations, sorting only available by \"eu_dist\" field.\nThe route also could calculate euclid distance using $euclid operator, for details see examples.\nLowest role to successfully query Feature vector is Annotation manager, all below will got thrown 403.", "tags": ["Feature Vectors"], "security": [], "parameters": [], "requestBody": {"description": "query to filter features by", "required": true, "content": {"application/json": {"schema": {"allOf": [{"$ref": "#/components/schemas/DQLResourceQuery"}, {"$ref": "#/components/schemas/FilterQuery"}], "description": "query to filter features by"}}}}}}, "/features/vectors/{id}": {"get": {"operationId": "Get Feature Vector", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/APIFeatureVector"}}}}}, "description": "Get a feature vector by id", "tags": ["Feature Vectors"], "security": [], "parameters": [{"in": "path", "name": "id", "required": true, "schema": {"type": "string"}}], "x-codeSamples": [{"lang": "Python", "source": "# \n# Get Feature object\n# \n# :param str feature_id: feature id\n# :return: Feature object\n# "}]}, "delete": {"operationId": "Delete Feature Vector", "responses": {"204": {"description": "No content"}}, "description": "Delete a feature vector by id", "tags": ["Feature Vectors"], "security": [], "parameters": [{"in": "path", "name": "id", "required": true, "schema": {"type": "string"}}], "x-codeSamples": [{"lang": "Python", "source": "# \n# Delete feature vector\n# \n# :param str feature_id: feature id to delete\n# :return: success\n# :rtype: bool\n# "}]}}, "/groups": {"get": {"operationId": "Find Groups", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"items": {"$ref": "#/components/schemas/APIGroup"}, "type": "array"}}}}}, "description": "Get all groups a user is a member of", "tags": ["Groups"], "security": [], "parameters": []}, "post": {"operationId": "Create Group", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/APIGroup"}, "examples": {"Example 1": {"value": {"name": "My_Group", "orgId": "someOrgId"}}}}}}}, "description": "create a new group", "tags": ["Groups"], "security": [], "parameters": [], "requestBody": {"required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/CreateGroupPayload"}}}}}}, "/groups/{groupId}": {"get": {"operationId": "Find Group", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/APIGroup"}}}}}, "description": "Get a group by id", "tags": ["Groups"], "security": [], "parameters": [{"in": "path", "name": "groupId", "required": true, "schema": {"type": "string"}}]}, "patch": {"operationId": "Update Group", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/APIGroup"}, "examples": {"Example 1": {"value": {"name": "newGroupName"}}}}}}}, "description": "Update a groups name", "tags": ["Groups"], "security": [], "parameters": [{"in": "path", "name": "groupId", "required": true, "schema": {"type": "string"}}], "requestBody": {"required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/PatchGroupPayload"}}}}}, "delete": {"operationId": "Destroy Group", "responses": {"204": {"description": "No content"}}, "description": "Delete a group", "tags": ["Groups"], "security": [], "parameters": [{"in": "path", "name": "groupId", "required": true, "schema": {"type": "string"}}]}}, "/groups/{groupId}/members": {"get": {"operationId": "Get Group Members", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"items": {"$ref": "#/components/schemas/AuthUserAttributes"}, "type": "array"}}}}}, "description": "List all members of a group", "tags": ["Groups"], "security": [], "parameters": [{"in": "path", "name": "groupId", "required": true, "schema": {"type": "string"}}]}, "post": {"operationId": "Add Group Member", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"items": {"$ref": "#/components/schemas/AuthUserAttributes"}, "type": "array"}, "examples": {"Example 1": {"value": {"user_id": "newGroupMemberId"}}}}}}}, "description": "Add a member to a group", "tags": ["Groups"], "security": [], "parameters": [{"in": "path", "name": "groupId", "required": true, "schema": {"type": "string"}}], "requestBody": {"required": true, "content": {"application/json": {"schema": {"properties": {"user_id": {"type": "string"}}, "required": ["user_id"], "type": "object"}}}}}}, "/groups/{groupId}/members/{memberId}": {"delete": {"operationId": "Remove Group Member", "responses": {"204": {"description": "No content"}}, "description": "Remove a member from a group", "tags": ["Groups"], "security": [], "parameters": [{"in": "path", "name": "groupId", "required": true, "schema": {"type": "string"}}, {"in": "path", "name": "memberId", "required": true, "schema": {"type": "string"}}]}}, "/groups/{groupId}/owner": {"patch": {"operationId": "Update Group Owner", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/APIGroup"}, "examples": {"Example 1": {"value": {"newGroupOwnerId": "someUserId"}}}}}}}, "description": "Update the group's owner", "tags": ["Groups"], "security": [], "parameters": [{"in": "path", "name": "groupId", "required": true, "schema": {"type": "string"}}], "requestBody": {"required": true, "content": {"application/json": {"schema": {"properties": {"newGroupOwnerId": {"type": "string"}}, "required": ["newGroupOwnerId"], "type": "object"}}}}}}, "/groups/{groupId}/subgroups": {"get": {"operationId": "Get Sub Groups", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"items": {"$ref": "#/components/schemas/APIGroup"}, "type": "array"}}}}}, "description": "Get all subgroups of a group", "tags": ["Groups"], "security": [], "parameters": [{"in": "path", "name": "groupId", "required": true, "schema": {"type": "string"}}]}, "post": {"operationId": "Add Sub Group", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"items": {"$ref": "#/components/schemas/APIGroup"}, "type": "array"}, "examples": {"Example 1": {"value": {"sub_group_id": "newChildGroupId"}}}}}}}, "description": "Add a group as a child group to another group.\nIf the parent group has a role in a project, the child group members will inherit that role.", "tags": ["Groups"], "security": [], "parameters": [{"in": "path", "name": "groupId", "required": true, "schema": {"type": "string"}}], "requestBody": {"required": true, "content": {"application/json": {"schema": {"properties": {"sub_group_id": {"type": "string"}}, "required": ["sub_group_id"], "type": "object"}}}}}}, "/groups/{groupId}/subgroups/{subGroupId}": {"delete": {"operationId": "Remove Sub Group", "responses": {"204": {"description": "No content"}}, "description": "Remove a group as a child group from another group.", "tags": ["Groups"], "security": [], "parameters": [{"in": "path", "name": "groupId", "required": true, "schema": {"type": "string"}}, {"in": "path", "name": "subGroupId", "required": true, "schema": {"type": "string"}}]}}, "/groups/{groupId}/tree": {"get": {"operationId": "Get Sub Group Tree", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/APIGroup"}}}}}, "tags": ["Groups"], "security": [], "parameters": [{"in": "path", "name": "groupId", "required": true, "schema": {"type": "string"}}]}}, "/instance_catalog": {"get": {"operationId": "_getInstanceCatalog", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {}}}}}, "tags": ["InstanceCatalog"], "security": [], "parameters": []}}, "/integrations/{integrationId}": {"get": {"operationId": "Get integration", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/APIIntegration"}}}}}, "description": "get a specific integration information", "tags": ["Integrations"], "security": [], "parameters": [{"in": "path", "name": "integrationId", "required": true, "schema": {"type": "string"}}]}}, "/invoices": {"get": {"operationId": "List Account Invoices", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"items": {"$ref": "#/components/schemas/Invoice"}, "type": "array"}}}}, "400": {"description": "Bad Request"}, "403": {"description": "Forbidden"}, "500": {"description": "Internal Server Error"}}, "tags": ["Invoices"], "security": [], "parameters": [{"description": "DL account ID", "in": "query", "name": "account", "required": true, "schema": {"type": "string"}}, {"description": "Invoice status, one of 'submitted', 'paid', 'partiallyPaid', 'debt', 'Failed Payment'", "in": "query", "name": "status", "required": false, "schema": {"type": "string"}}, {"description": "Date string, format: 'YYYY-MM-DD'. '2022-06-30' will be June 30th 2022", "in": "query", "name": "fromDate", "required": false, "schema": {"type": "string"}}, {"description": "Date string, format: 'YYYY-MM-DD'. '2022-06-30' will be June 30th 2022", "in": "query", "name": "toDate", "required": false, "schema": {"type": "string"}}]}}, "/invoices/{id}": {"get": {"operationId": "Get Invoice", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Invoice"}}}}, "400": {"description": "Bad Request"}, "401": {"description": "Unauthorized"}, "403": {"description": "Forbidden"}, "404": {"description": "Not Found"}, "500": {"description": "Internal Server Error"}}, "description": "Retrieves the details of an invoice.\n\nSupply the unique invoice ID to fetch its details.", "tags": ["Invoices"], "security": [], "parameters": [{"description": "ID of the invoice to fetch", "in": "path", "name": "id", "required": true, "schema": {"type": "string"}}]}}, "/invoices/{id}/stream": {"get": {"operationId": "Stream Invoice Pdf", "responses": {"204": {"description": "No content"}}, "tags": ["Invoices"], "security": [], "parameters": [{"in": "path", "name": "id", "required": true, "schema": {"type": "string"}}]}}, "/items/{id}": {"get": {"operationId": "Get Item", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"anyOf": [{"$ref": "#/components/schemas/APIDatasetFileItem"}, {"$ref": "#/components/schemas/APIDatasetDirectoryItem"}]}}}}}, "tags": ["Items"], "security": [], "parameters": [{"in": "path", "name": "id", "required": true, "schema": {"type": "string"}}], "x-codeSamples": [{"lang": "Python", "source": "\n# \n# Get Item object\n# \n# **Prerequisites**: You must be in the role of an *owner* or *developer*.\n# \n# :param str filepath: optional - search by remote path\n# :param str item_id: optional - search by id\n# :param bool fetch: optional - fetch entity from platform, default taken from cookie\n# :param bool is_dir: True if you want to get an item from dir type\n# :return: Item object\n# :rtype: dtlpy.entities.item.Item\n# \n# \n# dataset.items.get(item_id='item_id')\n# "}]}, "delete": {"operationId": "Remove Item", "responses": {"204": {"description": "No content"}}, "tags": ["Items"], "security": [], "parameters": [{"in": "path", "name": "id", "required": true, "schema": {"type": "string"}}], "x-codeSamples": [{"lang": "Python", "source": "\n# \n# Delete item from platform.\n# \n# **Prerequisites**: You must be in the role of an *owner* or *developer*.\n# \n# You must provide at least ONE of the following params: item id, filename, filters.\n# \n# :param str filename: optional - search item by remote path\n# :param str item_id: optional - search item by id\n# :param dtlpy.entities.filters.Filters filters: optional - delete items by filter\n# :return: True if success\n# :rtype: bool\n# \n# \n# dataset.items.delete(item_id='item_id')\n# "}]}, "patch": {"operationId": "Edit Item", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"anyOf": [{"$ref": "#/components/schemas/APIDatasetFileItem"}, {"$ref": "#/components/schemas/APIDatasetDirectoryItem"}]}}}}}, "tags": ["Items"], "security": [], "parameters": [{"in": "path", "name": "id", "required": true, "schema": {"type": "string"}}, {"in": "query", "name": "system", "required": false, "schema": {"type": "boolean"}}], "requestBody": {"required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/PartialAPIDatasetItem"}}}}, "x-codeSamples": [{"lang": "Python", "source": "\n# \n# Update item metadata.\n# \n# **Prerequisites**: You must be in the role of an *owner* or *developer*.\n# \n# You must provide at least ONE of the following params: update_values, system_update_values.\n# \n# :param dtlpy.entities.item.Item item: Item object\n# :param dtlpy.entities.filters.Filters filters: optional update filtered items by given filter\n# :param update_values: optional field to be updated and new values\n# :param system_update_values: values in system metadata to be updated\n# :param bool system_metadata: True, if you want to update the metadata system\n# :return: Item object\n# :rtype: dtlpy.entities.item.Item\n# \n# \n# dataset.items.update(item='item_entity')\n# "}]}}, "/items/{id}/clone": {"post": {"operationId": "Clone Item", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/APICommand"}}}}}, "tags": ["Items"], "security": [], "parameters": [{"in": "path", "name": "id", "required": true, "schema": {"type": "string"}}], "requestBody": {"required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ItemCloneRequest"}}}}, "x-codeSamples": [{"lang": "Python", "source": "\n# \n# Clone item. Read more about cloning datatsets and items in our `documentation <https://dataloop.ai/docs/clone-merge-dataset#cloned-dataset>`_ and `SDK documentation <https://developers.dataloop.ai/tutorials/data_management/data_versioning/chapter/>`_.\n# \n# **Prerequisites**: You must be in the role of an *owner* or *developer*.\n# \n# :param str item_id: item to clone\n# :param str dst_dataset_id: destination dataset id\n# :param str remote_filepath: complete filepath\n# :param dict metadata: new metadata to add\n# :param bool with_annotations: clone annotations\n# :param bool with_metadata: clone metadata\n# :param bool with_task_annotations_status: clone task annotations status\n# :param bool allow_many: `bool` if True, using multiple clones in single dataset is allowed, (default=False)\n# :param bool wait: wait for the command to finish\n# :return: Item object\n# :rtype: dtlpy.entities.item.Item\n# \n# \n# dataset.items.clone(item_id='item_id',\n# dst_dataset_id='dist_dataset_id',\n# with_metadata=True,\n# with_task_annotations_status=False,\n# with_annotations=False)\n# "}]}}, "/items/{id}/items": {"get": {"operationId": "Get Directory Child Items", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/APIDatasetItemCursor"}}}}}, "tags": ["Items"], "security": [], "parameters": [{"in": "path", "name": "id", "required": true, "schema": {"type": "string"}}, {"in": "query", "name": "pageOffset", "required": false, "schema": {"format": "double", "type": "number"}}, {"in": "query", "name": "pageSize", "required": false, "schema": {"format": "double", "type": "number"}}]}}, "/items/{id}/revisions": {"post": {"operationId": "Create Item Revision", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/APIDatasetFileItem"}}}}}, "tags": ["Items"], "security": [], "parameters": [{"in": "path", "name": "id", "required": true, "schema": {"type": "string"}}]}}, "/items/{id}/snapshots": {"post": {"operationId": "Create Item Snapshot", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/APIDatasetFileItem"}}}}}, "description": "Create a new snapshot on an existing item\nOrder is important - FILE MUST BE LAST FIELD OF THE FORM", "tags": ["Items"], "security": [], "parameters": [{"in": "path", "name": "id", "required": true, "schema": {"type": "string"}}]}}, "/items/{id}/stream": {"get": {"operationId": "Stream Item", "responses": {"204": {"description": "No content"}}, "tags": ["Items"], "security": [], "parameters": [{"in": "path", "name": "id", "required": true, "schema": {"type": "string"}}]}}, "/items/{id}/thumbnail": {"get": {"operationId": "Stream Item Thumbnail", "responses": {"204": {"description": "No content"}}, "tags": ["Items"], "security": [], "parameters": [{"in": "path", "name": "id", "required": true, "schema": {"type": "string"}}, {"in": "query", "name": "width", "required": false, "schema": {"format": "double", "type": "number"}}, {"in": "query", "name": "height", "required": false, "schema": {"format": "double", "type": "number"}}, {"in": "query", "name": "annotations", "required": false, "schema": {"type": "boolean"}}, {"in": "query", "name": "annotationsV2", "required": false, "schema": {"type": "boolean"}}, {"in": "query", "name": "queryHash", "required": false, "schema": {"type": "string"}}]}}, "/items/{itemId}/annotations": {"get": {"operationId": "List Item Annotations", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"items": {"$ref": "#/components/schemas/APIAnnotation"}, "type": "array"}}}}}, "description": "List all annotations of an item", "tags": ["Item Annotations"], "security": [], "parameters": [{"description": "Item id", "in": "path", "name": "itemId", "required": true, "schema": {"type": "string"}}]}, "post": {"operationId": "Create Annotations", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"anyOf": [{"$ref": "#/components/schemas/APIAnnotation"}, {"items": {"$ref": "#/components/schemas/APIAnnotation"}, "type": "array"}]}}}}}, "description": "Create an annotation for an item", "tags": ["Item Annotations"], "security": [], "parameters": [{"description": "Item id", "in": "path", "name": "itemId", "required": true, "schema": {"type": "string"}}], "requestBody": {"description": "Annotations to be created", "required": true, "content": {"application/json": {"schema": {"anyOf": [{"$ref": "#/components/schemas/APIAnnotationRequest"}, {"items": {"$ref": "#/components/schemas/APIAnnotationRequest"}, "type": "array"}], "description": "Annotations to be created"}}}}, "x-codeSamples": [{"lang": "Python", "source": "\n# \n# Upload a new annotation/annotations. You must first create the annotation using the annotation *builder* method.\n# \n# **Prerequisites**: Any user can upload annotations.\n# \n# :param List[dtlpy.entities.annotation.Annotation] or dtlpy.entities.annotation.Annotation annotations: list or\n# single annotation of type Annotation\n# :param bool merge: optional - merge the new binary annotations with the existing annotations\n# :return: list of annotation objects\n# :rtype: entities.AnnotationCollection\n# \n# \n# annotations = item.annotations.upload(annotations='builder')\n# "}]}}, "/items/{itemId}/annotations/archiveAnnotationLogs": {"post": {"operationId": "Archive Item Annotation to Storage", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/APICommand"}}}}}, "tags": ["Item Annotations"], "security": [], "parameters": [{"in": "path", "name": "itemId", "required": true, "schema": {"type": "string"}}], "requestBody": {"required": true, "content": {"application/json": {"schema": {"properties": {"concurrency": {"type": "number", "format": "double"}, "sampleSize": {"type": "number", "format": "double"}, "spec": {"$ref": "#/components/schemas/DQLResourceQuery"}}, "required": ["concurrency", "sampleSize", "spec"], "type": "object"}}}}}}, "/items/{itemId}/annotations/restore-archived-annotation-logs": {"post": {"operationId": "Restore archived Item Annotation to DB", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/APICommand"}}}}}, "tags": ["Item Annotations"], "security": [], "parameters": [{"in": "path", "name": "itemId", "required": true, "schema": {"type": "string"}}], "requestBody": {"required": true, "content": {"application/json": {"schema": {"properties": {"annotationLogId": {"type": "string"}, "annotationId": {"type": "string"}, "itemId": {"type": "string"}, "datasetId": {"type": "string"}}, "required": ["itemId", "datasetId"], "type": "object"}}}}}}, "/items/{itemId}/annotations/{annotationId}": {"get": {"operationId": "Get Item Annotation", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/APIAnnotation"}}}}}, "description": "Get annotation by id", "tags": ["Item Annotations"], "security": [], "parameters": [{"description": "annotation id", "in": "path", "name": "annotationId", "required": true, "schema": {"type": "string"}}, {"in": "path", "name": "itemId", "required": true, "schema": {"type": "string"}}]}, "delete": {"operationId": "Delete Item Annotation", "responses": {"204": {"description": "No content"}}, "description": "Delete an Annotation from an item", "tags": ["Item Annotations"], "security": [], "parameters": [{"description": "Annotation id", "in": "path", "name": "annotationId", "required": true, "schema": {"type": "string"}}, {"in": "path", "name": "itemId", "required": true, "schema": {"type": "string"}}]}, "put": {"operationId": "Update Item Annotation", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/APIAnnotation"}}}}}, "description": "Update an item's annotation", "tags": ["Item Annotations"], "security": [], "parameters": [{"description": "Annotation id", "in": "path", "name": "annotationId", "required": true, "schema": {"type": "string"}}, {"description": "when specified - editing system space metadata is enabled", "in": "query", "name": "system", "required": false, "schema": {"type": "boolean"}}, {"in": "query", "name": "replace", "required": false, "schema": {"type": "boolean"}}, {"in": "path", "name": "itemId", "required": true, "schema": {"type": "string"}}], "requestBody": {"description": "Updated annotation object", "required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/UpdateAnnotationRequest", "description": "Updated annotation object"}}}}}}, "/items/{itemId}/annotations/{annotationId}/issue": {"put": {"operationId": "Item Annotation Issues", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/APIAnnotation"}}}}}, "description": "Update an item's annotation status to issue", "tags": ["Item Annotations"], "security": [], "parameters": [{"description": "Annotation id", "in": "path", "name": "annotationId", "required": true, "schema": {"type": "string"}}, {"in": "path", "name": "itemId", "required": true, "schema": {"type": "string"}}]}}, "/logins": {"post": {"operationId": "List past logins", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/CursorPage_APILogin_"}}}}}, "security": [], "parameters": [], "requestBody": {"required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/LoginsLogQuery"}}}}}}, "/ml/metrics/precisionRecall": {"post": {"operationId": "Calaculate The Precision And Recall For a Model", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {}, "examples": {"Example 1": {"value": {"modelId": "modelId", "datasetId": "datasetId", "iouThreshold": 0.5}}}}}}, "400": {"description": "Bad Request"}, "401": {"description": "Unauthorized"}, "403": {"description": "Forbidden"}, "404": {"description": "Not Found"}, "500": {"description": "Internal Server Error"}}, "description": "Get Model Precision Recall\n\nCalaculate the precision and recall for a model", "tags": ["Model Metrics"], "security": [], "parameters": [], "requestBody": {"description": "The model and the dataset to calculate precision and recall for by confThreshold and iouThreshold", "required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/PrecisionRecallInputRequest", "description": "The model and the dataset to calculate precision and recall for by confThreshold and iouThreshold"}}}}}}, "/ml/metrics/publish": {"post": {"operationId": "Publish Model Metrics", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"properties": {"errorMap": {"properties": {}, "additionalProperties": {"$ref": "#/components/schemas/Error"}, "type": "object"}, "failed": {"type": "number", "format": "double"}, "succeeded": {"type": "number", "format": "double"}}, "required": ["failed", "succeeded"], "type": "object"}, "examples": {"Example 1": {"value": {"modelId": "modelId", "datasetId": "datasetId", "figure": "figure", "legend": "legend", "data": {"x": 1, "y": 1}}}}}}}, "400": {"description": "Bad Request"}, "401": {"description": "Unauthorized"}, "403": {"description": "Forbidden"}, "404": {"description": "Not Found"}, "500": {"description": "Internal Server Error"}}, "description": "Publish Model Metrics\n\nSupply single or multiple metrics to publish", "tags": ["Model Metrics"], "security": [], "parameters": [], "requestBody": {"description": "The metric or metrics to publish", "required": true, "content": {"application/json": {"schema": {"anyOf": [{"$ref": "#/components/schemas/MetricRequest"}, {"items": {"$ref": "#/components/schemas/MetricRequest"}, "type": "array"}], "description": "The metric or metrics to publish"}}}}}}, "/ml/metrics/query": {"post": {"operationId": "Query Model Metrics", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/CursorPageAPISetting"}, "examples": {"Example 1": {"value": {"filter": {"modelId": "modelId"}, "page": 1, "pageSize": 10}}}}}}, "400": {"description": "Bad Request"}, "401": {"description": "Unauthorized"}, "403": {"description": "Forbidden"}, "404": {"description": "Not Found"}, "500": {"description": "Internal Server Error"}}, "description": "Query Model Metrics\n\nSupply the query requested to query Metrics", "tags": ["Model Metrics"], "security": [], "parameters": [], "requestBody": {"description": "The query", "required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/QueryModel", "description": "The query"}}}}}}, "/ml/metrics/shebang": {"post": {"operationId": "Generate Model Metrics Report", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"items": {"$ref": "#/components/schemas/Dictionary"}, "type": "array"}, "examples": {"Example 1": {"value": {"modelIds": ["modelId"], "datasetIds": ["datasetId"]}}}}}}, "400": {"description": "Bad Request"}, "401": {"description": "Unauthorized"}, "403": {"description": "Forbidden"}, "404": {"description": "Not Found"}, "500": {"description": "Internal Server Error"}}, "description": "Generate Model Metrics Report\n\nSupply single or multiple Model ids to generate report for", "tags": ["Model Metrics"], "security": [], "parameters": [], "requestBody": {"required": true, "content": {"application/json": {"schema": {"properties": {"datasetIds": {"anyOf": [{"type": "string"}, {"items": {"type": "string"}, "type": "array"}], "description": "The dataset or datasets to generate report for"}, "modelIds": {"anyOf": [{"type": "string"}, {"items": {"type": "string"}, "type": "array"}], "description": "The models to generate report for"}}, "required": ["modelIds"], "type": "object"}}}}}}, "/ml/metrics/{id}": {"delete": {"operationId": "Delete Metric", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"type": "string"}}}}, "400": {"description": "Bad Request"}, "401": {"description": "Unauthorized"}, "403": {"description": "Forbidden"}, "404": {"description": "Not Found"}, "500": {"description": "Internal Server Error"}}, "description": "Delete a Metric\n\nSupply the unique id of the Metric to delete", "tags": ["Model Metrics"], "security": [], "parameters": [{"description": "ID of the Metric to Delete", "in": "path", "name": "id", "required": true, "schema": {"type": "string"}}]}}, "/ml/models": {"get": {"operationId": "List Models", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/CursorPageAPISetting"}}}}, "400": {"description": "Bad Request"}, "401": {"description": "Unauthorized"}, "403": {"description": "Forbidden"}, "404": {"description": "Not Found"}, "500": {"description": "Internal Server Error"}}, "description": "Retrieves Models.\n\nSupply query parameters to filter the list.", "tags": ["Models"], "security": [], "parameters": [{"description": "filter: accepts any string", "in": "query", "name": "filter", "required": false, "schema": {"type": "string"}}, {"description": "sort: accepts any string", "in": "query", "name": "sort", "required": false, "schema": {"type": "string"}}, {"description": "page: accepts any number", "in": "query", "name": "page", "required": false, "schema": {"format": "double", "type": "number"}}, {"description": "pageSize: accepts any number", "in": "query", "name": "pageSize", "required": false, "schema": {"format": "double", "type": "number"}}]}, "post": {"operationId": "Create Model", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/APIModel"}, "examples": {"Example 1": {"value": {"name": "My Model", "description": "My Model Description", "packageId": "packageId", "projectId": "projectId"}}}}}}, "400": {"description": "Bad Request"}, "401": {"description": "Unauthorized"}, "403": {"description": "Forbidden"}, "404": {"description": "Not Found"}, "500": {"description": "Internal Server Error"}}, "description": "Creates a new Model.\n\nSupply the appropriate Create Request object in order to create a Model.", "tags": ["Models"], "security": [], "parameters": [], "requestBody": {"description": "The Model to create", "required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/CreateModelRequest", "description": "The Model to create"}}}}}}, "/ml/models/datasets/count": {"get": {"operationId": "Models Datasets Count", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"properties": {"datasetsCount": {"type": "number", "format": "double"}}, "required": ["datasetsCount"], "type": "object"}}}}, "400": {"description": "Bad Request"}, "401": {"description": "Unauthorized"}, "403": {"description": "Forbidden"}, "404": {"description": "Not Found"}, "500": {"description": "Internal Server Error"}}, "description": "Models Datasets Count\n\nThis will return the total dataset count that models have been assigned to", "tags": ["Models"], "security": [], "parameters": []}}, "/ml/models/executions": {"post": {"operationId": "Models Executions", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ModelJoinMap"}, "examples": {"Example 1": {"value": {"filter": {"status": "success"}, "page": 1, "pageSize": 10}}}}}}, "400": {"description": "Bad Request"}, "401": {"description": "Unauthorized"}, "403": {"description": "Forbidden"}, "404": {"description": "Not Found"}, "500": {"description": "Internal Server Error"}}, "description": "Models Executions\n\nThis will return latest 1000 models executions", "tags": ["Models"], "security": [], "parameters": [], "requestBody": {"description": "The query", "required": true, "content": {"application/json": {"schema": {"properties": {"joinFilter": {"$ref": "#/components/schemas/Dictionary"}, "query": {"$ref": "#/components/schemas/QueryModel"}}, "required": ["query"], "type": "object", "description": "The query"}}}}}}, "/ml/models/query": {"post": {"operationId": "Query Models", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/CursorPageAPISetting"}, "examples": {"Example 1": {"value": {"filter": {"status": "deployed"}, "page": 1, "pageSize": 10}}}}}}, "400": {"description": "Bad Request"}, "401": {"description": "Unauthorized"}, "403": {"description": "Forbidden"}, "404": {"description": "Not Found"}, "500": {"description": "Internal Server Error"}}, "description": "Query Models\n\nSupply the query requested to query Models", "tags": ["Models"], "security": [], "parameters": [], "requestBody": {"description": "The query", "required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/QueryModel", "description": "The query"}}}}}}, "/ml/models/services": {"post": {"operationId": "Models Services", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ModelJoinMap"}, "examples": {"Example 1": {"value": {"filter": {"name": "mgmt"}, "page": 1, "pageSize": 10}}}}}}, "400": {"description": "Bad Request"}, "401": {"description": "Unauthorized"}, "403": {"description": "Forbidden"}, "404": {"description": "Not Found"}, "500": {"description": "Internal Server Error"}}, "description": "Models Services\n\nThis will return latest 1000 models servuces", "tags": ["Models"], "security": [], "parameters": [], "requestBody": {"description": "The query", "required": true, "content": {"application/json": {"schema": {"properties": {"joinFilter": {"$ref": "#/components/schemas/Dictionary"}, "query": {"$ref": "#/components/schemas/QueryModel"}}, "required": ["query"], "type": "object", "description": "The query"}}}}}}, "/ml/models/{id}": {"get": {"operationId": "Get Model", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/APIModel"}}}}, "400": {"description": "Bad Request"}, "401": {"description": "Unauthorized"}, "403": {"description": "Forbidden"}, "404": {"description": "Not Found"}, "500": {"description": "Internal Server Error"}}, "description": "Retrieves the details of a Model.\n\nSupply the unique Model ID to fetch it's details.", "tags": ["Models"], "security": [], "parameters": [{"description": "ID of the Model to fetch", "in": "path", "name": "id", "required": true, "schema": {"type": "string"}}]}, "patch": {"operationId": "Update Model", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/APIModel"}, "examples": {"Example 1": {"value": {"name": "My Model", "description": "My Model Description", "status": "deployed"}}}}}}, "400": {"description": "Bad Request"}, "401": {"description": "Unauthorized"}, "403": {"description": "Forbidden"}, "404": {"description": "Not Found"}, "500": {"description": "Internal Server Error"}}, "description": "Update a Model\n\nSupply the unique id of the Model to update and an object describing which fields update", "tags": ["Models"], "security": [], "parameters": [{"description": "ID of the Model to Update", "in": "path", "name": "id", "required": true, "schema": {"type": "string"}}, {"in": "query", "name": "system", "required": false, "schema": {"type": "boolean"}}, {"in": "query", "name": "reloadServices", "required": false, "schema": {"type": "boolean"}}], "requestBody": {"description": "The values to update with", "required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/PatchModelRequest", "description": "The values to update with"}}}}}, "delete": {"operationId": "Delete Model", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"type": "string"}}}}, "400": {"description": "Bad Request"}, "401": {"description": "Unauthorized"}, "403": {"description": "Forbidden"}, "404": {"description": "Not Found"}, "500": {"description": "Internal Server Error"}}, "description": "Delete a Model\n\nSupply the unique id of the Model to delete", "tags": ["Models"], "security": [], "parameters": [{"description": "ID of the Model to Delete", "in": "path", "name": "id", "required": true, "schema": {"type": "string"}}]}}, "/ml/models/{id}/clone": {"post": {"operationId": "Clone Model", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"anyOf": [{"$ref": "#/components/schemas/APIModel"}, {"$ref": "#/components/schemas/APICommand"}]}, "examples": {"Example 1": {"value": {"name": "My Model", "description": "My Model Description", "packageId": "packageId", "projectId": "projectId"}}}}}}, "400": {"description": "Bad Request"}, "500": {"description": "Internal Server Error"}}, "description": "Clone Model\n\nthis will either clone or create a copy both dataset and model and create new instances of them\n\nProvide the model ID of the Model to clone from\n\nAlso provide the Clone spec to clone a dataset with a filter and the model\nOr provide parameters to overwrite the current values in the model you want to clone", "tags": ["Models"], "security": [], "parameters": [{"description": "ID of the Model to clone from", "in": "path", "name": "id", "required": true, "schema": {"type": "string"}}], "requestBody": {"description": "Provide the Clone spec to clone a dataset with a filter and the model\nOr Provide parameters to overwrite the current values in the model you want to clone", "required": true, "content": {"application/json": {"schema": {"anyOf": [{"$ref": "#/components/schemas/Partial_CreateModelRequest_"}, {"$ref": "#/components/schemas/APICopyEnvironmentSpec"}], "description": "Provide the Clone spec to clone a dataset with a filter and the model\nOr Provide parameters to overwrite the current values in the model you want to clone"}}}}}}, "/ml/models/{id}/deploy": {"post": {"operationId": "Deploy Model", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {}, "examples": {"Example 1": {"value": {"serviceConfig": {"runtime": {"podType": "regular-xs", "runnerImage": "jjanzic/docker-python3-opencv"}}}}}}}}, "400": {"description": "Bad Request"}, "401": {"description": "Unauthorized"}, "403": {"description": "Forbidden"}, "404": {"description": "Not Found"}, "500": {"description": "Internal Server Error"}}, "description": "Deploy Model\n\nSupply the model id to deploy it as a service\nYou can also supply specific config for the deployed service", "tags": ["Models"], "security": [], "parameters": [{"description": "ID of the Model to train", "in": "path", "name": "id", "required": true, "schema": {"type": "string"}}], "requestBody": {"description": "Service Configuration", "required": true, "content": {"application/json": {"schema": {"properties": {"deployOperation": {"$ref": "#/components/schemas/ModelOperationTypes"}, "serviceReference": {"$ref": "#/components/schemas/EntityReference"}, "pipeline": {"$ref": "#/components/schemas/ExecutionPipelineStateReference"}, "serviceConfig": {"$ref": "#/components/schemas/Dictionary"}}, "type": "object", "description": "Service Configuration"}}}}}}, "/ml/models/{id}/deployment": {"patch": {"operationId": "Update Model Deployment", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Dictionary"}, "examples": {"Example 1": {"value": {"deploymentType": "train", "deploymentConfig": {"runtime": {"podType": "regular-xs", "runnerImage": "jjanzic/docker-python3-opencv"}}}}}}}}, "400": {"description": "Bad Request"}, "500": {"description": "Internal Server Error"}}, "description": "Update Model Deployment\n\nthis will allow you to update a models deployment configuration\n\nProvide the model ID, the deployment configuration and the deployment Type", "tags": ["Models"], "security": [], "parameters": [{"description": "ID of the Model to clone from", "in": "path", "name": "id", "required": true, "schema": {"type": "string"}}], "requestBody": {"description": "Provide the deployment configuration and the deployment Type", "required": true, "content": {"application/json": {"schema": {"properties": {"deploymentConfig": {"$ref": "#/components/schemas/Dictionary"}, "deploymentType": {"$ref": "#/components/schemas/ModelOperationTypes"}}, "required": ["deploymentConfig", "deploymentType"], "type": "object", "description": "Provide the deployment configuration and the deployment Type"}}}}}}, "/ml/models/{id}/embed": {"post": {"operationId": "Extract Item Features", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Execution"}, "examples": {"Example 1": {"value": {"input": {"itemIds": ["item1", "item2"]}, "serviceConfig": {"runtime": {"podType": "regular-xs", "runnerImage": "jjanzic/docker-python3-opencv"}}}}}}}}, "400": {"description": "Bad Request"}, "401": {"description": "Unauthorized"}, "403": {"description": "Forbidden"}, "404": {"description": "Not Found"}, "500": {"description": "Internal Server Error"}}, "tags": ["Models"], "security": [], "parameters": [{"description": "ID of the Model to train", "in": "path", "name": "id", "required": true, "schema": {"type": "string"}}], "requestBody": {"required": true, "content": {"application/json": {"schema": {"properties": {"config": {"properties": {"serviceReference": {"$ref": "#/components/schemas/EntityReference"}, "serviceId": {"type": "string"}, "pipeline": {"$ref": "#/components/schemas/ExecutionPipelineStateReference"}, "serviceConfig": {"$ref": "#/components/schemas/Dictionary"}}, "type": "object", "description": "Service Configuration"}, "input": {"properties": {"datasetQuery": {"$ref": "#/components/schemas/Dictionary"}, "datasetId": {"type": "string"}, "itemIds": {"anyOf": [{"type": "string"}, {"items": {"type": "string"}, "type": "array"}]}}, "type": "object", "description": "embed input"}}, "required": ["input"], "type": "object"}}}}}}, "/ml/models/{id}/embed/datasets": {"post": {"operationId": "Embed Datasets", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"anyOf": [{"$ref": "#/components/schemas/APIModel"}, {"$ref": "#/components/schemas/APICommand"}]}, "examples": {"Example 1": {"value": {"datasetIds": ["datasetId1", "datasetId2"], "config": {"serviceConfig": {"runtime": {"podType": "regular-xs", "runnerImage": "jjanzic/docker-python3-opencv"}}}}}}}}}, "400": {"description": "Bad Request"}, "500": {"description": "Internal Server Error"}}, "description": "Embed Datasets\n\nthis will run embed on the datasets\n\nProvide the model ID of the Model to embed from\n\nAlso provide the a list of dataset IDs to embed", "tags": ["Models"], "security": [], "parameters": [{"description": "ID of the Model to clone from", "in": "path", "name": "id", "required": true, "schema": {"type": "string"}}], "requestBody": {"description": "Provide the Clone spec to clone a dataset with a filter and the model\nOr Provide parameters to overwrite the current values in the model you want to clone", "required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Partial_APIEmbedDatasetsSpec_", "description": "Provide the Clone spec to clone a dataset with a filter and the model\nOr Provide parameters to overwrite the current values in the model you want to clone"}}}}}}, "/ml/models/{id}/evaluate": {"post": {"operationId": "Evaluate Model", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Execution"}, "examples": {"Example 1": {"value": {"input": {"datasetId": "datasetId"}, "serviceConfig": {"runtime": {"podType": "regular-xs", "runnerImage": "jjanzic/docker-python3-opencv"}}}}}}}}, "400": {"description": "Bad Request"}, "401": {"description": "Unauthorized"}, "403": {"description": "Forbidden"}, "404": {"description": "Not Found"}, "500": {"description": "Internal Server Error"}}, "description": "Evaluate Model\n\nSupply data to evaluate the model on\nYou can also supply specific config for the deployed service", "tags": ["Models"], "security": [], "parameters": [{"description": "ID of the Model to train", "in": "path", "name": "id", "required": true, "schema": {"type": "string"}}], "requestBody": {"required": true, "content": {"application/json": {"schema": {"properties": {"config": {"properties": {"serviceReference": {"$ref": "#/components/schemas/EntityReference"}, "pipeline": {"$ref": "#/components/schemas/ExecutionPipelineStateReference"}, "serviceConfig": {"$ref": "#/components/schemas/Dictionary"}}, "type": "object", "description": "Service Configuration"}, "input": {"properties": {"datasetQuery": {"$ref": "#/components/schemas/Dictionary"}, "datasetId": {"type": "string"}}, "type": "object", "description": "Evaluate input"}}, "required": ["input"], "type": "object"}}}}}}, "/ml/models/{id}/predict": {"post": {"operationId": "Model Prediction", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Execution"}, "examples": {"Example 1": {"value": {"input": {"itemIds": ["item1", "item2"]}, "serviceConfig": {"runtime": {"podType": "regular-xs", "runnerImage": "jjanzic/docker-python3-opencv"}}}}}}}}, "400": {"description": "Bad Request"}, "401": {"description": "Unauthorized"}, "403": {"description": "Forbidden"}, "404": {"description": "Not Found"}, "500": {"description": "Internal Server Error"}}, "description": "Model Prediction\n\nSupply the resource to perform prediction on\nYou can also supply specific config for the deployed service", "tags": ["Models"], "security": [], "parameters": [{"description": "ID of the Model to train", "in": "path", "name": "id", "required": true, "schema": {"type": "string"}}], "requestBody": {"required": true, "content": {"application/json": {"schema": {"properties": {"config": {"properties": {"serviceReference": {"$ref": "#/components/schemas/EntityReference"}, "serviceId": {"type": "string"}, "pipeline": {"$ref": "#/components/schemas/ExecutionPipelineStateReference"}, "serviceConfig": {"$ref": "#/components/schemas/Dictionary"}}, "type": "object", "description": "Service Configuration"}, "input": {"properties": {"datasetQuery": {"$ref": "#/components/schemas/Dictionary"}, "datasetId": {"type": "string"}, "itemIds": {"anyOf": [{"type": "string"}, {"items": {"type": "string"}, "type": "array"}]}}, "type": "object", "description": "Predict input"}}, "required": ["input"], "type": "object"}}}}}}, "/ml/models/{id}/train": {"post": {"operationId": "Train Model", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Execution"}, "examples": {"Example 1": {"value": {"serviceConfig": {"runtime": {"podType": "regular-xs", "runnerImage": "jjanzic/docker-python3-opencv"}}}}}}}}, "400": {"description": "Bad Request"}, "401": {"description": "Unauthorized"}, "403": {"description": "Forbidden"}, "404": {"description": "Not Found"}, "500": {"description": "Internal Server Error"}}, "description": "Train Model\n\nSupply the model id to initiate a training session\nYou can also supply specific config for the deployed service", "tags": ["Models"], "security": [], "parameters": [{"description": "ID of the Model to train", "in": "path", "name": "id", "required": true, "schema": {"type": "string"}}], "requestBody": {"description": "Service Configuration", "required": true, "content": {"application/json": {"schema": {"properties": {"serviceReference": {"$ref": "#/components/schemas/EntityReference"}, "pipeline": {"$ref": "#/components/schemas/ExecutionPipelineStateReference"}, "serviceConfig": {"$ref": "#/components/schemas/Dictionary"}}, "type": "object", "description": "Service Configuration"}}}}}}, "/ontologies": {"post": {"operationId": "Create Ontology", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"anyOf": [{"$ref": "#/components/schemas/APIOntologyV2"}, {"$ref": "#/components/schemas/APIOntology"}]}}}}}, "description": "Create a new Ontology", "tags": ["Ontologies"], "security": [], "parameters": [], "requestBody": {"description": ": Ontology creation payload", "required": true, "content": {"application/json": {"schema": {"anyOf": [{"$ref": "#/components/schemas/CreateOntologyPayloadV2"}, {"$ref": "#/components/schemas/CreateOntologyPayload"}], "description": ": Ontology creation payload"}}}}, "x-codeSamples": [{"lang": "Python", "source": "\n# \n# Create a new ontology.\n# \n# **Prerequisites**: You must be in the role of an *owner* or *developer*.\n# \n# :param labels: recipe tags\n# :param str title: ontology title, name\n# :param list project_ids: recipe project/s\n# :param list attributes: recipe attributes\n# :return: Ontology object\n# :rtype: dtlpy.entities.ontology.Ontology\n# \n# \n# recipe.ontologies.create(labels='labels_entity',\n# title='new_ontology',\n# project_ids='project_ids')\n# "}]}, "get": {"operationId": "Find Ontologies", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/APIOntologyCursor"}}}}}, "description": "Find ontologies by query", "tags": ["Ontologies"], "security": [], "parameters": [{"description": "- An array of project IDs", "in": "query", "name": "projects", "required": false, "schema": {"type": "array", "items": {"type": "string"}}}, {"description": "- System flag", "in": "query", "name": "system", "required": false, "schema": {"type": "boolean"}}, {"in": "query", "name": "ids", "required": false, "schema": {"type": "array", "items": {"type": "string"}}}, {"description": "- The number of pages to skip from the start", "in": "query", "name": "pageOffset", "required": false, "schema": {"format": "double", "type": "number"}}, {"description": "- How many ontologies in one page", "in": "query", "name": "pageSize", "required": false, "schema": {"format": "double", "type": "number"}}]}}, "/ontologies/{id}": {"put": {"operationId": "Update Ontology", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"anyOf": [{"$ref": "#/components/schemas/APIOntologyV2"}, {"$ref": "#/components/schemas/APIOntology"}]}}}}}, "description": "Update an existing Ontology", "tags": ["Ontologies"], "security": [], "parameters": [{"in": "path", "name": "id", "required": true, "schema": {"type": "string"}}], "requestBody": {"required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/APIOntologyConfigurationV2"}}}}, "x-codeSamples": [{"lang": "Python", "source": "\n# \n# Update the Ontology metadata.\n# \n# **Prerequisites**: You must be in the role of an *owner* or *developer*.\n# \n# :param dtlpy.entities.ontology.Ontology ontology: Ontology object\n# :param bool system_metadata: bool - True, if you want to change metadata system\n# :return: Ontology object\n# :rtype: dtlpy.entities.ontology.Ontology\n# \n# \n# recipe.ontologies.delete(ontology='ontology_entity')\n# "}]}, "get": {"operationId": "Get Ontology", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"anyOf": [{"$ref": "#/components/schemas/APIOntologyV2"}, {"$ref": "#/components/schemas/APIOntology"}]}}}}, "400": {"description": "Missing or Invalid id"}, "404": {"description": "Ontology not found"}}, "description": "Get a specific Ontology", "tags": ["Ontologies"], "security": [], "parameters": [{"description": ": Ontology ID", "in": "path", "name": "id", "required": true, "schema": {"type": "string"}}], "x-codeSamples": [{"lang": "Python", "source": "\n# \n# Get Ontology object to use in your code.\n# \n# **Prerequisites**: You must be in the role of an *owner* or *developer*.\n# \n# :param str ontology_id: ontology id\n# :return: Ontology object\n# :rtype: dtlpy.entities.ontology.Ontology\n# \n# \n# recipe.ontologies.get(ontology_id='ontology_id')\n# "}]}, "delete": {"operationId": "Delete Ontology", "responses": {"204": {"description": "No content"}}, "description": "Delete an Ontology", "tags": ["Ontologies"], "security": [], "parameters": [{"description": ": Ontology ID", "in": "path", "name": "id", "required": true, "schema": {"type": "string"}}], "x-codeSamples": [{"lang": "Python", "source": "\n# \n# Delete Ontology from the platform.\n# \n# **Prerequisites**: You must be in the role of an *owner* or *developer*.\n# \n# :param ontology_id: ontology id\n# :return: True if success\n# :rtype: bool\n# \n# \n# recipe.ontologies.delete(ontology_id='ontology_id')\n# "}]}}, "/ontologies/{id}/addLabels": {"patch": {"operationId": "Add Labels", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/APIOntology"}}}}}, "description": "Update an existing Ontology", "tags": ["Ontologies"], "security": [], "parameters": [{"in": "path", "name": "id", "required": true, "schema": {"type": "string"}}], "requestBody": {"required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/AddLabelsNodePayload"}}}}}}, "/ontologies/{id}/attributes": {"patch": {"operationId": "Update Attributes", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/APIOntology"}}}}}, "description": "Update an existing Ontology", "tags": ["Ontologies"], "security": [], "parameters": [{"in": "path", "name": "id", "required": true, "schema": {"type": "string"}}], "requestBody": {"required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/UpsertRequestPayload_AttributeCreationPayload_"}}}}}, "delete": {"operationId": "Delete Attributes", "responses": {"204": {"description": "No content"}}, "description": "Delete a bulk of attributes", "tags": ["Ontologies"], "security": [], "parameters": [{"description": ": Ontology ID", "in": "path", "name": "id", "required": true, "schema": {"type": "string"}}], "requestBody": {"required": true, "content": {"application/json": {"schema": {"properties": {"keys": {"items": {"type": "string"}, "type": "array"}}, "required": ["keys"], "type": "object"}}}}}, "post": {"operationId": "Create Attribute Section", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/APIAttributeSection"}}}}}, "tags": ["Ontologies"], "security": [], "parameters": [{"in": "path", "name": "id", "required": true, "schema": {"type": "string"}}], "requestBody": {"required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/CreateAttributePayload"}}}}}}, "/ontologies/{id}/attributes/query": {"post": {"operationId": "Query Ontology Attributes", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/CursorPage_APIAttributeSection_"}}}}}, "tags": ["Ontologies"], "security": [], "parameters": [{"in": "path", "name": "id", "required": true, "schema": {"type": "string"}}], "requestBody": {"required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/FilterQueryInput"}}}}}}, "/ontologies/{id}/attributes/{attributeId}": {"patch": {"operationId": "Update Attribute Section", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/APIAttributeSection"}}}}}, "tags": ["Ontologies"], "security": [], "parameters": [{"in": "path", "name": "attributeId", "required": true, "schema": {"type": "string"}}, {"in": "path", "name": "id", "required": true, "schema": {"type": "string"}}], "requestBody": {"required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/APIUpdateAttributePayload"}}}}}, "delete": {"operationId": "Delete Attribute Section", "responses": {"204": {"description": "No content"}}, "tags": ["Ontologies"], "security": [], "parameters": [{"in": "path", "name": "attributeId", "required": true, "schema": {"type": "string"}}, {"in": "path", "name": "id", "required": true, "schema": {"type": "string"}}]}}, "/ontologies/{id}/labels": {"patch": {"operationId": "Update Labels", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/APIOntology"}}}}}, "description": "Update an existing Ontology", "tags": ["Ontologies"], "security": [], "parameters": [{"in": "path", "name": "id", "required": true, "schema": {"type": "string"}}], "requestBody": {"required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/UpdateLabelsNodePayload"}}}}}}, "/ontologies/{ontologyId}/labels": {"post": {"operationId": "Create or Update Labels", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"items": {"$ref": "#/components/schemas/APILabelTreeNodeV2"}, "type": "array"}}}}}, "tags": ["Labels"], "security": [], "parameters": [{"in": "path", "name": "ontologyId", "required": true, "schema": {"type": "string"}}], "requestBody": {"required": true, "content": {"application/json": {"schema": {"items": {"$ref": "#/components/schemas/CreateLabelPayload"}, "type": "array"}}}}}, "patch": {"operationId": "Update Labels", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"items": {"$ref": "#/components/schemas/APILabelTreeNodeV2"}, "type": "array"}}}}}, "tags": ["Labels"], "security": [], "parameters": [{"in": "path", "name": "ontologyId", "required": true, "schema": {"type": "string"}}], "requestBody": {"required": true, "content": {"application/json": {"schema": {"items": {"$ref": "#/components/schemas/UpdateLabelNodePayload"}, "type": "array"}}}}}}, "/ontologies/{ontologyId}/labels/query": {"post": {"operationId": "Query Ontology Labels", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/CursorPage_APILabelTreeNodeV2_"}}}}}, "tags": ["Labels"], "security": [], "parameters": [{"in": "path", "name": "ontologyId", "required": true, "schema": {"type": "string"}}], "requestBody": {"required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/FilterQueryInput"}}}}}}, "/ontologies/{ontologyId}/labels/{id}": {"delete": {"operationId": "DeleteLabel", "responses": {"204": {"description": "No content"}}, "tags": ["Labels"], "security": [], "parameters": [{"in": "path", "name": "id", "required": true, "schema": {"type": "string"}}, {"in": "path", "name": "ontologyId", "required": true, "schema": {"type": "string"}}]}}, "/ontologies/{ontologyId}/structures": {"post": {"operationId": "Create Structure", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/APIStructure"}}}}}, "tags": ["Structures"], "security": [], "parameters": [{"in": "path", "name": "ontologyId", "required": true, "schema": {"type": "string"}}], "requestBody": {"required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/CreateStructurePayload"}}}}}}, "/ontologies/{ontologyId}/structures/query": {"post": {"operationId": "Query Ontology Structures", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/CursorPage_APIStructure_"}}}}}, "tags": ["Structures"], "security": [], "parameters": [{"in": "path", "name": "ontologyId", "required": true, "schema": {"type": "string"}}], "requestBody": {"required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/FilterQueryInput"}}}}}}, "/ontologies/{ontologyId}/structures/{id}": {"patch": {"operationId": "Update Structure", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/APIStructure"}}}}}, "tags": ["Structures"], "security": [], "parameters": [{"in": "path", "name": "id", "required": true, "schema": {"type": "string"}}, {"in": "path", "name": "ontologyId", "required": true, "schema": {"type": "string"}}], "requestBody": {"required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/APIUpdateStructurePayload"}}}}}, "delete": {"operationId": "Delete Structure", "responses": {"204": {"description": "No content"}}, "tags": ["Structures"], "security": [], "parameters": [{"in": "path", "name": "id", "required": true, "schema": {"type": "string"}}, {"in": "path", "name": "ontologyId", "required": true, "schema": {"type": "string"}}]}}, "/orgs": {"get": {"operationId": "Find orgs", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"items": {"$ref": "#/components/schemas/APIOrg"}, "type": "array"}}}}}, "description": "Get all user's organizations", "tags": ["Organizations"], "security": [], "parameters": [], "x-codeSamples": [{"lang": "Python", "source": "\n# \n# Lists all the organizations in Dataloop.\n# \n# **Prerequisites**: You must be a **superuser** to use this method.\n# \n# :return: List of Organization objects\n# :rtype: list\n# \n# \n# organizations = dl.organizations.list()\n# "}]}, "post": {"operationId": "Create org", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/APIOrg"}, "examples": {"Example 1": {"value": {"name": "MyNewOrg", "account": "someAccount"}}}}}}}, "description": "Create a new organization", "tags": ["Organizations"], "security": [], "parameters": [], "requestBody": {"required": true, "content": {"application/json": {"schema": {"properties": {"logoUrl": {"type": "string"}, "industry": {"$ref": "#/components/schemas/OrgIndustry"}, "size": {"$ref": "#/components/schemas/OrgSize"}, "account": {"type": "string"}, "name": {"type": "string"}}, "required": ["name"], "type": "object"}}}}}}, "/orgs/{orgId}": {"get": {"operationId": "Find org", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/APIOrg"}}}}}, "description": "Find an organization by id", "tags": ["Organizations"], "security": [], "parameters": [{"in": "path", "name": "orgId", "required": true, "schema": {"type": "string"}}], "x-codeSamples": [{"lang": "Python", "source": "\n# \n# Get Organization object to be able to use it in your code.\n# \n# **Prerequisites**: You must be a **superuser** to use this method.\n# \n# You must provide at least ONE of the following params: organization_name or organization_id.\n# \n# :param str organization_id: optional - search by id\n# :param str organization_name: optional - search by name\n# :param fetch: optional - fetch entity from platform, default taken from cookie\n# :return: Organization object\n# :rtype: dtlpy.entities.organization.Organization\n# \n# \n# org = dl.organizations.get(organization_id='organization_id')\n# "}]}, "patch": {"operationId": "Patch org", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/APIOrg"}, "examples": {"Example 1": {"value": {"name": "NewOrgName"}}}}}}}, "description": "Change an organization's name", "tags": ["Organizations"], "security": [], "parameters": [{"in": "path", "name": "orgId", "required": true, "schema": {"type": "string"}}], "requestBody": {"required": true, "content": {"application/json": {"schema": {"properties": {"name": {"type": "string"}}, "required": ["name"], "type": "object"}}}}}}, "/orgs/{orgId}/accounts": {"get": {"operationId": "Get org accounts", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"items": {"$ref": "#/components/schemas/APIAccount"}, "type": "array"}}}}}, "description": "Get the organization's account", "tags": ["Organizations"], "security": [], "parameters": [{"in": "path", "name": "orgId", "required": true, "schema": {"type": "string"}}]}}, "/orgs/{orgId}/accounts/{accountId}": {"post": {"operationId": "Add account to org", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/APIOrg"}, "examples": {"Example 1": {"value": {"accountId": "newAccountId"}}}}}}}, "description": "Add an account to an organization", "tags": ["Organizations"], "security": [], "parameters": [{"in": "path", "name": "orgId", "required": true, "schema": {"type": "string"}}, {"in": "path", "name": "accountId", "required": true, "schema": {"type": "string"}}]}, "delete": {"operationId": "Remove account from org", "responses": {"204": {"description": "No content"}}, "description": "Remove an account from an organization", "tags": ["Organizations"], "security": [], "parameters": [{"in": "path", "name": "orgId", "required": true, "schema": {"type": "string"}}, {"in": "path", "name": "accountId", "required": true, "schema": {"type": "string"}}]}}, "/orgs/{orgId}/availableIntegrations": {"get": {"operationId": "Get available integrations", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"items": {"anyOf": [{"properties": {"options": {"items": {"properties": {"required": {"type": "boolean"}, "displayName": {"type": "string"}, "type": {"type": "string"}, "name": {"type": "string"}}, "required": ["required", "displayName", "type", "name"], "type": "object"}, "type": "array"}, "displayName": {"type": "string"}, "type": {"$ref": "#/components/schemas/IntegrationType"}}, "required": ["options", "displayName", "type"], "type": "object"}, {"properties": {"options": {"items": {"properties": {"required": {"type": "boolean"}, "displayName": {"type": "string"}, "type": {"type": "string"}, "name": {"type": "string"}}, "required": ["required", "displayName", "type", "name"], "type": "object"}, "type": "array"}, "iconUrl": {"type": "string"}, "displayName": {"type": "string"}, "type": {"type": "string"}}, "required": ["options", "iconUrl", "displayName", "type"], "type": "object"}]}, "type": "array"}}}}}, "description": "List all type of integrations available for the organization to create", "tags": ["Organizations"], "security": [], "parameters": []}}, "/orgs/{orgId}/groups": {"get": {"operationId": "Get org groups", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"items": {"$ref": "#/components/schemas/APIGroup"}, "type": "array"}}}}}, "description": "Get all organization groups", "tags": ["Organizations"], "security": [], "parameters": [{"in": "path", "name": "orgId", "required": true, "schema": {"type": "string"}}]}}, "/orgs/{orgId}/integrations": {"get": {"operationId": "Get org integrations", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"items": {"$ref": "#/components/schemas/APIIntegration"}, "type": "array"}}}}}, "description": "Get all organization's integrations", "tags": ["OrgIntegrations"], "security": [], "parameters": [{"in": "path", "name": "orgId", "required": true, "schema": {"type": "string"}}], "x-codeSamples": [{"lang": "Python", "source": "\n# \n# List all the organization's integrations with external storage.\n# \n# **Prerequisites**: You must be an *owner* in the organization.\n# \n# :param bool only_available: if True list only the available integrations.\n# :param str organization_id: organization id\n# :return: groups list\n# :rtype: list\n# \n# \n# project.integrations.list(only_available=True)\n# "}]}, "post": {"operationId": "Create integration", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/APIIntegration"}, "examples": {"Example 1": {"value": {"type": "azureblob", "name": "My Azure Blob Integration", "options": {"clientId": "<client_id>", "secret": "<client_secret>", "key": "<storage_key>", "tenantId": "<tenant_id>"}}}}}}}}, "description": "Create a new Integration", "tags": ["OrgIntegrations"], "security": [], "parameters": [{"in": "path", "name": "orgId", "required": true, "schema": {"type": "string"}}], "requestBody": {"required": true, "content": {"application/json": {"schema": {"properties": {"metadata": {"allOf": [{"$ref": "#/components/schemas/IntegrationTypeMetadata"}], "nullable": true}, "options": {"$ref": "#/components/schemas/Dictionary"}, "name": {"type": "string"}, "type": {"$ref": "#/components/schemas/INTEGRATION_TYPE"}}, "required": ["options", "name", "type"], "type": "object"}}}}, "x-codeSamples": [{"lang": "Python", "source": "\n# \n# Create an integration between an external storage and the organization.\n# \n# **Examples for options include**:\n# s3 - {key: \"\", secret: \"\"};\n# gcs - {key: \"\", secret: \"\", content: \"\"};\n# azureblob - {key: \"\", secret: \"\", clientId: \"\", tenantId: \"\"};\n# key_value - {key: \"\", value: \"\"}\n# aws-sts - {key: \"\", secret: \"\", roleArns: \"\"}\n# aws-cross - {}\n# gcp-cross - {}\n# gcp-workload-identity-federation - {\"secret\": \"\", \"content\": \"{}\", \"clientId\": \"\"}\n# private-registry (ECR) - can use generate_ecr_options to generate the options\n# private-registry (GAR) - use generate_gar_options to generate the options\n# private-registry (ACR) - use generate_azure_container_registry_options to generate the options\n# private-registry (DockerHub) - use generate_docker_hub_options to generate the options\n# \n# **Prerequisites**: You must be an *owner* in the organization.\n# \n# :param IntegrationType integrations_type: integrations type dl.IntegrationType\n# :param str name: integrations name\n# :param dict options: dict of storage secrets\n# :param dict metadata: metadata\n# :param str organization_id: organization id\n# :return: success\n# :rtype: bool\n# \n# \n# project.integrations.create(integrations_type=dl.IntegrationType.S3,\n# name='S3Integration',\n# options={key: \"Access key ID\", secret: \"Secret access key\"})\n# "}]}, "patch": {"operationId": "Update integration", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/APIIntegration"}, "examples": {"Example 1": {"value": {"integrationId": "someIntegrationId", "credentials": {"type": "azureblob", "options": {"clientId": "newClientId"}}}}}}}}}, "description": "update an existing integration configuration", "tags": ["OrgIntegrations"], "security": [], "parameters": [{"in": "path", "name": "orgId", "required": true, "schema": {"type": "string"}}], "requestBody": {"required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/IntegrationBody"}}}}, "x-codeSamples": [{"lang": "Python", "source": "\n# \n# Update the integration's name.\n# \n# **Prerequisites**: You must be an *owner* in the organization.\n# \n# :param str new_name: new name\n# :param str integrations_id: integrations id\n# :param Integration integration: integration object\n# :param dict new_options: new value\n# :param str organization_id: organization id\n# :param bool reload_services: reload services associated with this integration\n# :return: Integration object\n# :rtype: dtlpy.entities.integration.Integration\n# \n# **Examples for options include**:\n# s3 - {key: \"\", secret: \"\"};\n# gcs - {key: \"\", secret: \"\", content: \"\"};\n# azureblob - {key: \"\", secret: \"\", clientId: \"\", tenantId: \"\"};\n# key_value - {key: \"\", value: \"\"}\n# aws-sts - {key: \"\", secret: \"\", roleArns: \"\"}\n# aws-cross - {roleArn: \"\"}\n# gcp-cross - {\"email: \"\", \"resourceName\": \"\"}\n# \n# \n# project.integrations.update(integrations_id='integrations_id', new_options={roleArn: \"\"})\n# "}]}}, "/orgs/{orgId}/integrations/{integrationId}": {"get": {"operationId": "Get integration", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/APIIntegration"}}}}}, "description": "get a specific integration information", "tags": ["OrgIntegrations"], "security": [], "parameters": [{"in": "path", "name": "orgId", "required": true, "schema": {"type": "string"}}, {"in": "path", "name": "integrationId", "required": true, "schema": {"type": "string"}}], "x-codeSamples": [{"lang": "Python", "source": "\n# \n# Get organization integrations. Use this method to access your integration and be able to use it in your code.\n# \n# **Prerequisites**: You must be an *owner* in the organization.\n# \n# :param str integrations_id: integrations id\n# :param str organization_id: organization id\n# :return: Integration object\n# :rtype: dtlpy.entities.integration.Integration\n# \n# \n# project.integrations.get(integrations_id='integrations_id')\n# "}]}, "delete": {"operationId": "Remove integration", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"items": {"$ref": "#/components/schemas/APIIntegration"}, "type": "array"}}}}}, "description": "Delete an integration", "tags": ["OrgIntegrations"], "security": [], "parameters": [{"in": "path", "name": "orgId", "required": true, "schema": {"type": "string"}}, {"in": "path", "name": "integrationId", "required": true, "schema": {"type": "string"}}], "x-codeSamples": [{"lang": "Python", "source": "\n# \n# Delete integrations from the organization.\n# \n# **Prerequisites**: You must be an organization *owner* to delete an integration.\n# \n# :param organization_id: organization id\n# :param str integrations_id: integrations id\n# :param bool sure: Are you sure you want to delete?\n# :param bool really: Really really sure?\n# :return: success\n# :rtype: bool\n# \n# \n# project.integrations.delete(integrations_id='integrations_id', sure=True, really=True)\n# "}]}}, "/orgs/{orgId}/members": {"get": {"operationId": "Get org members", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"items": {"$ref": "#/components/schemas/APIUser"}, "type": "array"}}}}}, "description": "Get all organization members", "tags": ["Organizations"], "security": [], "parameters": [{"in": "path", "name": "orgId", "required": true, "schema": {"type": "string"}}], "x-codeSamples": [{"lang": "Python", "source": "\n# \n# List all organization members.\n# \n# **Prerequisites**: You must be an organization *owner* to use this method.\n# \n# You must provide at least ONE of the following params: organization_id, organization_name, or organization.\n# \n# :param entities.Organization organization: Organization object\n# :param str organization_id: Organization id\n# :param str organization_name: Organization name\n# :param entities.MemberOrgRole role: MemberOrgRole.ADMIN, MemberOrgRole.OWNER, MemberOrgRole.MEMBER, MemberOrgRole.WORKER\n# :return: projects list\n# :rtype: list\n# \n# \n# list_members = dl.organizations.list_members(organization='organization-entity',\n# role=dl.MemberOrgRole.MEMBER)\n# "}]}, "post": {"operationId": "Add org members", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"items": {"$ref": "#/components/schemas/APIOrgUser"}, "type": "array"}, "examples": {"Example 1": {"value": {"emails": ["user1@example.com", "user2@example.com"], "role": "member"}}}}}}}, "description": "Add a new member to an organization", "tags": ["Organizations"], "security": [], "parameters": [{"in": "path", "name": "orgId", "required": true, "schema": {"type": "string"}}], "requestBody": {"required": true, "content": {"application/json": {"schema": {"properties": {"role": {"$ref": "#/components/schemas/OrgRole"}, "emails": {"items": {"type": "string"}, "type": "array"}}, "required": ["role", "emails"], "type": "object"}}}}, "x-codeSamples": [{"lang": "Python", "source": "\n# \n# Add members to your organization. Read about members and groups `here <https://dataloop.ai/docs/org-members-groups>`_.\n# \n# **Prerequisities**: To add members to an organization, you must be an *owner* in that organization.\n# \n# You must provide at least ONE of the following params: organization, organization_name, or organization_id.\n# \n# :param str email: the member's email\n# :param str role: MemberOrgRole.ADMIN, MemberOrgRole.OWNER, MemberOrgRole.MEMBER, MemberOrgRole.WORKER\n# :param str organization_id: Organization id\n# :param str organization_name: Organization name\n# :param entities.Organization organization: Organization object\n# :return: True if successful or error if unsuccessful\n# :rtype: bool\n# \n# \n# success = dl.organizations.add_member(email='user@domain.com',\n# organization_id='organization_id',\n# role=dl.MemberOrgRole.MEMBER)\n# "}]}, "patch": {"operationId": "Patch org member", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"items": {"$ref": "#/components/schemas/APIUser"}, "type": "array"}, "examples": {"Example 1": {"value": {"email": "user@example.com", "role": "member"}}}}}}}, "description": "Change a member's role in an organization", "tags": ["Organizations"], "security": [], "parameters": [{"in": "path", "name": "orgId", "required": true, "schema": {"type": "string"}}], "requestBody": {"required": true, "content": {"application/json": {"schema": {"properties": {"default_project_role": {"$ref": "#/components/schemas/Role"}, "role": {"$ref": "#/components/schemas/OrgRole"}, "email": {"type": "string"}}, "required": ["role", "email"], "type": "object"}}}}, "x-codeSamples": [{"lang": "Python", "source": "\n# \n# Update member role.\n# \n# **Prerequisites**: You must be an organization *owner* to update a member's role.\n# \n# You must provide at least ONE of the following params: organization, organization_name, or organization_id.\n# \n# :param str email: the member's email\n# :param str role: MemberOrgRole.ADMIN, MemberOrgRole.OWNER, MemberOrgRole.MEMBER, MemberOrgRole.WORKER\n# :param str organization_id: Organization id\n# :param str organization_name: Organization name\n# :param entities.Organization organization: Organization object\n# :return: json of the member fields\n# :rtype: dict\n# \n# \n# member_json = dl.organizations.update_member(email='user@domain.com',\n# organization_id='organization_id',\n# role=dl.MemberOrgRole.MEMBER)\n# "}]}}, "/orgs/{orgId}/members/{memberId}": {"delete": {"operationId": "Remove org member", "responses": {"204": {"description": "No content"}}, "description": "Remove a member from an organization", "tags": ["Organizations"], "security": [], "parameters": [{"in": "path", "name": "orgId", "required": true, "schema": {"type": "string"}}, {"in": "path", "name": "memberId", "required": true, "schema": {"type": "string"}}], "x-codeSamples": [{"lang": "Python", "source": "\n# \n# Delete member from the Organization.\n# \n# **Prerequisites**: Must be an organization *owner* to delete members.\n# \n# You must provide at least ONE of the following params: organization_id, organization_name, organization.\n# \n# :param str user_id: user id\n# :param str organization_id: Organization id\n# :param str organization_name: Organization name\n# :param entities.Organization organization: Organization object\n# :param bool sure: Are you sure you want to delete?\n# :param bool really: Really really sure?\n# :return: True if success and error if not\n# :rtype: bool\n# \n# \n# success = dl.organizations.delete_member(user_id='user_id',\n# organization_id='organization_id',\n# sure=True,\n# really=True)\n# "}]}}, "/orgs/{orgId}/members/{userId}/projects": {"get": {"operationId": "Get Member Projects", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"items": {"$ref": "#/components/schemas/APIProject"}, "type": "array"}}}}}, "description": "List all projects of a given organization member", "tags": ["Organizations"], "security": [], "parameters": [{"in": "path", "name": "orgId", "required": true, "schema": {"type": "string"}}, {"in": "path", "name": "userId", "required": true, "schema": {"type": "string"}}, {"in": "query", "name": "excludeContributors", "required": false, "schema": {"default": false, "type": "boolean"}}]}}, "/orgs/{orgId}/members/{userId}/related": {"get": {"operationId": "Is Org Member Related To Projects", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"type": "boolean"}}}}}, "tags": ["Organizations"], "security": [], "parameters": [{"in": "path", "name": "orgId", "required": true, "schema": {"type": "string"}}, {"in": "path", "name": "userId", "required": true, "schema": {"type": "string"}}, {"in": "query", "name": "excludeContributors", "required": false, "schema": {"default": false, "type": "boolean"}}]}}, "/orgs/{orgId}/plan": {"patch": {"operationId": "Update org plan", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/APIOrg"}}}}}, "description": "Update an organization's plan", "tags": ["Organizations"], "security": [], "parameters": [{"in": "path", "name": "orgId", "required": true, "schema": {"type": "string"}}], "requestBody": {"required": true, "content": {"application/json": {"schema": {"properties": {"plan": {"type": "string"}}, "required": ["plan"], "type": "object"}}}}}}, "/orgs/{orgId}/projects": {"get": {"operationId": "Get Org Projects", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"items": {"$ref": "#/components/schemas/APIProject"}, "type": "array"}}}}}, "description": "Get all organization projects", "tags": ["Organizations"], "security": [], "parameters": [{"in": "path", "name": "orgId", "required": true, "schema": {"type": "string"}}]}}, "/packages": {"get": {"operationId": "_listPackages", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/PackagesPage"}}}}}, "tags": ["Packages"], "security": [], "parameters": [{"in": "query", "name": "projectsQuery", "required": false, "schema": {"type": "string"}}, {"in": "query", "name": "name", "required": false, "schema": {"type": "string"}}, {"in": "query", "name": "creator", "required": false, "schema": {"type": "string"}}, {"in": "query", "name": "pageOffset", "required": false, "schema": {"format": "double", "type": "number"}}, {"in": "query", "name": "pageSize", "required": false, "schema": {"format": "double", "type": "number"}}]}, "post": {"operationId": "_createPackage", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/APIPackage"}}}}}, "description": "Create new package.", "tags": ["Packages"], "security": [], "parameters": [], "requestBody": {"required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/APIPackage"}}}}, "x-codeSamples": [{"lang": "Python", "source": "\n# \n# Push your local package to the UI.\n# \n# **Prerequisites**: You must be in the role of an *owner* or *developer*.\n# \n# Project will be taken in the following hierarchy:\n# project(input) -> project_id(input) -> self.project(context) -> checked out\n# \n# :param dtlpy.entities.project.Project project: optional - project entity to deploy to. default from context or checked-out\n# :param str project_id: optional - project id to deploy to. default from context or checked-out\n# :param str package_name: package name\n# :param str src_path: path to package codebase\n# :param dtlpy.entities.codebase.Codebase codebase: codebase object\n# :param list modules: list of modules PackageModules of the package\n# :param bool is_global: is package is global or local\n# :param bool checkout: checkout package to local dir\n# :param str revision_increment: optional - str - version bumping method - major/minor/patch - default = None\n# :param str version: semver version f the package\n# :param bool ignore_sanity_check: NOT RECOMMENDED - skip code sanity check before pushing\n# :param bool service_update: optional - bool - update the service\n# :param dict service_config : Service object as dict. Contains the spec of the default service to create.\n# :param list slots: optional - list of slots PackageSlot of the package\n# :param list requirements: requirements - list of package requirements\n# :param str package_type: default 'faas', options: 'app', 'ml\n# :param dict metadata: dictionary of system and user metadata\n# \n# :return: Package object\n# :rtype: dtlpy.entities.package.Package\n# \n# \n# project.packages.push(package_name='package_name',\n# modules=[module],\n# version='1.0.0',\n# src_path=os.getcwd()\n# )\n# "}]}}, "/packages/{ids}": {"delete": {"operationId": "_deletePackages", "responses": {"204": {"description": "No content"}}, "description": "Delete Package object.", "tags": ["Packages"], "security": [], "parameters": [{"description": "List of Package id.", "in": "path", "name": "ids", "required": true, "schema": {"type": "string"}}]}}, "/packages/{id}": {"get": {"operationId": "_getPackage", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/APIPackage"}}}}}, "description": "Get package by id.", "tags": ["Packages"], "security": [], "parameters": [{"description": "Package id", "in": "path", "name": "id", "required": true, "schema": {"type": "string"}}, {"description": "The package version", "in": "query", "name": "version", "required": false, "schema": {"type": "string"}}], "x-codeSamples": [{"lang": "Python", "source": "\n# \n# Get Package object to use in your code.\n# \n# **Prerequisites**: You must be in the role of an *owner* or *developer*.\n# \n# :param str package_id: package id\n# :param str package_name: package name\n# :param bool checkout: set the package as a default package object (cookies)\n# :param fetch: optional - fetch entity from platform, default taken from cookie\n# :param bool log_error: log error if package not found\n# :return: Package object\n# :rtype: dtlpy.entities.package.Package\n# \n# \n# project.packages.get(package_id='package_id')\n# "}]}, "patch": {"operationId": "_updatePackage", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/APIPackage"}}}}}, "description": "Update package changes.", "tags": ["Packages"], "security": [], "parameters": [{"description": "package id.", "in": "path", "name": "id", "required": true, "schema": {"type": "string"}}], "requestBody": {"required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/APIPackage"}}}}, "x-codeSamples": [{"lang": "Python", "source": "\n# \n# Update Package changes to the platform.\n# \n# **Prerequisites**: You must be in the role of an *owner* or *developer*.\n# \n# :param dtlpy.entities.package.Package package:\n# :param revision_increment: optional - str - version bumping method - major/minor/patch - default = None\n# :return: Package object\n# :rtype: dtlpy.entities.package.Package\n# \n# \n# project.packages.delete(package='package_entity')\n# "}]}, "delete": {"x-codeSamples": [{"lang": "Python", "source": "\n# \n# Delete a Package object.\n# \n# **Prerequisites**: You must be in the role of an *owner* or *developer*.\n# \n# :param dtlpy.entities.package.Package package: package entity\n# :param str package_id: package id\n# :param str package_name: package name\n# :return: True if success\n# :rtype: bool\n# \n# \n# project.packages.delete(package_name='package_name')\n# "}]}}, "/packages/{id}/revisions": {"get": {"operationId": "_getPackageRevisions", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"items": {"$ref": "#/components/schemas/APIPackage"}, "type": "array"}}}}}, "description": "Get package revisions by id.", "tags": ["Packages"], "security": [], "parameters": [{"description": "package id.", "in": "path", "name": "id", "required": true, "schema": {"type": "string"}}], "x-codeSamples": [{"lang": "Python", "source": "\n# \n# Get the package revision history.\n# \n# **Prerequisites**: You must be in the role of an *owner* or *developer*.\n# \n# :param dtlpy.entities.package.Package package: package entity\n# :param str package_id: package id\n# \n# \n# project.packages.revisions(package='package_entity')\n# "}]}}, "/pipelines": {"post": {"operationId": "_create", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/APIPipeline"}}}}}, "description": "Create a pipeline.", "tags": ["pipelines"], "security": [], "parameters": [], "requestBody": {"required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/IPostPipeline"}}}}, "x-codeSamples": [{"lang": "Python", "source": "\n# \n# Create a new pipeline.\n# \n# **prerequisites**: You must be an *owner* or *developer* to use this method.\n# \n# :param str name: pipeline name\n# :param str project_id: project id\n# :param dict pipeline_json: json containing the pipeline fields\n# :return: Pipeline object\n# :rtype: dtlpy.entities.pipeline.Pipeline\n# \n# \n# pipeline = project.pipelines.create(name='pipeline_name')\n# "}]}, "get": {"operationId": "_list", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/CursorPageAPIPipeline"}}}}}, "description": "Retrieves pipelines.\n\nSupply query parameters to filter the list.", "tags": ["pipelines"], "security": [], "parameters": [{"description": "filter: accepts any string", "in": "query", "name": "filter", "required": true, "schema": {"type": "string"}}, {"description": "sort: accepts any string", "in": "query", "name": "sort", "required": true, "schema": {"type": "string"}}, {"description": "page: accepts any number", "in": "query", "name": "page", "required": true, "schema": {"format": "double", "type": "number"}}, {"description": "pageSize: accepts any number", "in": "query", "name": "pageSize", "required": false, "schema": {"format": "double", "type": "number"}}]}}, "/pipelines/categories": {"get": {"operationId": "_getPipelineNodeCategories", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/PipelineNodeCategory"}}}}}, "tags": ["pipelines"], "security": [], "parameters": []}}, "/pipelines/query": {"post": {"operationId": "_query", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/CursorPageT"}}}}}, "tags": ["pipelines/query"], "security": [], "parameters": [], "requestBody": {"required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/QueryString"}}}}, "x-codeSamples": [{"lang": "Python", "source": "\n# \n# List project pipeline executions.\n# \n# **prerequisites**: You must be an *owner* or *developer* to use this method.\n# \n# :param dtlpy.entities.filters.Filters filters: Filters entity or a dictionary containing filters parameters\n# :return: Paged entity\n# :rtype: dtlpy.entities.paged_entities.PagedEntities\n# \n# \n# pipeline_executions = pipeline.pipeline_executions.list()\n# "}]}}, "/pipelines/query/table": {"post": {"operationId": "_queryPipelineTable", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"items": {"properties": {"template": {"properties": {"state": {"$ref": "#/components/schemas/PipelineFromTemplateState"}, "id": {"type": "string"}}, "required": ["state", "id"], "type": "object"}, "resetTimestamp": {"type": "string", "format": "date-time"}, "variables": {"items": {"$ref": "#/components/schemas/PipelineVariable"}, "type": "array"}, "settings": {"$ref": "#/components/schemas/IPipelineSettings"}, "status": {"$ref": "#/components/schemas/CompositionStatus"}, "startNodes": {"items": {"$ref": "#/components/schemas/IStartNode"}, "type": "array"}, "preview": {"type": "string"}, "description": {"type": "string"}, "connections": {"items": {"$ref": "#/components/schemas/PipelineConnection"}, "type": "array"}, "nodes": {"items": {"$ref": "#/components/schemas/PipelineNodeDescriptor"}, "type": "array"}, "compositionId": {"type": "string"}, "orgId": {"type": "string"}, "projectId": {"type": "string"}, "updatedBy": {"type": "string"}, "updatedAt": {"type": "string", "format": "date-time"}, "createdAt": {"type": "string", "format": "date-time"}, "creator": {"type": "string"}, "name": {"type": "string"}, "url": {"type": "string"}, "id": {"type": "string"}, "pendingCycles": {}, "lastExecutionTime": {}}, "required": ["status", "preview", "description", "connections", "nodes", "orgId", "projectId", "updatedAt", "createdAt", "creator", "name", "url", "id", "pendingCycles", "lastExecutionTime"], "type": "object"}, "type": "array"}}}}}, "tags": ["pipelines/query"], "security": [], "parameters": [], "requestBody": {"required": true, "content": {"application/json": {"schema": {}}}}}}, "/pipelines/templates": {"post": {"operationId": "_create", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/APIPipeline"}}}}}, "tags": ["pipelines/templates"], "security": [], "parameters": [], "requestBody": {"required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/APIPipelineTemplate"}}}}}}, "/pipelines/templates/query": {"post": {"operationId": "_query", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/APITemplateQuery"}}}}}, "tags": ["pipelines/templates"], "security": [], "parameters": [{"in": "query", "name": "projectId", "required": false, "schema": {"type": "string"}}], "requestBody": {"required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/TemplateQuery"}}}}}}, "/pipelines/templates/{id}": {"get": {"operationId": "_get", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/APIPipeline"}}}}}, "tags": ["pipelines/templates"], "security": [], "parameters": [{"in": "path", "name": "id", "required": true, "schema": {"type": "string"}}]}}, "/pipelines/validate": {"post": {"x-codeSamples": [{"lang": "Python", "source": "\n# \n# Validate a pipeline configuration.\n# \n# **prerequisites**: You must be an *owner* or *developer* to use this method.\n# \n# :param dict pipeline_json: pipeline configuration as JSON dictionary\n# :return: Validation result\n# :rtype: dict\n# \n# \n# validation_result = project.pipelines.validate(pipeline_json={'name': 'my_pipeline', 'nodes': []})\n# "}]}}, "/pipelines/{id}/statistics": {"get": {"x-codeSamples": [{"lang": "Python", "source": "\n# \n# Get pipeline counters.\n# \n# **prerequisites**: You must be an *owner* or *developer* to use this method.\n# \n# :param dtlpy.entities.pipeline.Pipeline pipeline: pipeline entity - optional\n# :param str pipeline_id: pipeline_id -  optional\n# :param str pipeline_name: pipeline_name -  optional\n# :return: PipelineStats\n# :rtype: dtlpy.entities.pipeline.PipelineStats\n# \n# \n# pipeline_stats = project.pipelines.stats(pipeline='pipeline_entity')\n# "}]}}, "/pipelines/{pipelineId}": {"get": {"operationId": "_get", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/APIPipeline"}}}}}, "description": "Get pipeline by id.", "tags": ["pipelines"], "security": [], "parameters": [{"description": "pipeline id.", "in": "path", "name": "pipelineId", "required": true, "schema": {"type": "string"}}], "x-codeSamples": [{"lang": "Python", "source": "\n# \n# Get Pipeline object to use in your code.\n# \n# **prerequisites**: You must be an *owner* or *developer* to use this method.\n# \n# You must provide at least ONE of the following params: pipeline_name, pipeline_id.\n# \n# :param str pipeline_id: pipeline id\n# :param str pipeline_name: pipeline name\n# :param fetch: optional - fetch entity from platform, default taken from cookie\n# :return: Pipeline object\n# :rtype: dtlpy.entities.pipeline.Pipeline\n# \n# \n# pipeline = project.pipelines.get(pipeline_id='pipeline_id')\n# "}]}, "patch": {"operationId": "_update", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/APIPipeline"}}}}}, "description": "Update pipeline changes.", "tags": ["pipelines"], "security": [], "parameters": [{"description": "pipeline id.", "in": "path", "name": "pipelineId", "required": true, "schema": {"type": "string"}}], "requestBody": {"required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/IPostPipeline"}}}}, "x-codeSamples": [{"lang": "Python", "source": "\n# \n# Update pipeline changes to platform.\n# \n# **prerequisites**: You must be an *owner* or *developer* to use this method.\n# \n# :param dtlpy.entities.pipeline.Pipeline pipeline: pipeline entity\n# :return: Pipeline object\n# :rtype: dtlpy.entities.pipeline.Pipeline\n# \n# \n# pipeline = project.pipelines.update(pipeline='pipeline_entity')\n# "}]}}, "/pipelines/{pipelineId}/execute": {"post": {"operationId": "_execute", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"anyOf": [{"$ref": "#/components/schemas/APIPipelineState"}, {"$ref": "#/components/schemas/APICommand"}]}}}}}, "description": "Execute a pipeline and return the pipeline execution as an object - or command in case batch is defined on the body.", "tags": ["pipelines"], "security": [], "parameters": [{"description": "pipeline id.", "in": "path", "name": "pipelineId", "required": true, "schema": {"type": "string"}}], "requestBody": {"required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ExecuteOptions"}}}}, "x-codeSamples": [{"lang": "Python", "source": "\n# \n# Create batch executions of a pipeline.\n# \n# **prerequisites**: You must be an *owner* or *developer* to use this method.\n# \n# :param pipeline_id: pipeline id\n# :param filters: Filters entity for a filtering before execute\n# :param execution_inputs: list of the dl.FunctionIO or dict of pipeline input - example {'item': 'item_id'}, that represent the extra inputs of the function\n# :param bool wait: wait until create task finish\n# :return: entities.PipelineExecution object\n# :rtype: dtlpy.entities.pipeline_execution.PipelineExecution\n# \n# \n# command = pipeline.pipeline_executions.create_batch(\n# execution_inputs=dl.FunctionIO(type=dl.PackageInputType.STRING, value='test', name='string'),\n# filters=dl.Filters(field='dir', values='/test'))\n# "}]}}, "/pipelines/{pipelineId}/executions": {"get": {"operationId": "_executions", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/CursorPageAPIPipelineState"}}}}}, "tags": ["pipelines"], "security": [], "parameters": [{"in": "query", "name": "filter", "required": false, "schema": {"type": "string"}}, {"in": "query", "name": "sort", "required": false, "schema": {"type": "string"}}, {"in": "query", "name": "page", "required": false, "schema": {"type": "string"}}, {"in": "query", "name": "pageSize", "required": false, "schema": {"type": "string"}}, {"in": "path", "name": "pipelineId", "required": true, "schema": {"type": "string"}}]}}, "/pipelines/{pipelineId}/executions/rerun": {"post": {"operationId": "_rerun", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/APICommand"}}}}}, "tags": ["pipelines"], "security": [], "parameters": [{"in": "path", "name": "pipelineId", "required": true, "schema": {"type": "string"}}], "requestBody": {"required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/IRerunCycleBatchOptions"}}}}, "x-codeSamples": [{"lang": "Python", "source": "\n# \n# Get Pipeline Execution object\n# \n# **prerequisites**: You must be an *owner* or *developer* to use this method.\n# \n# :param str pipeline_id: pipeline id\n# :param str method: method to run\n# :param list start_nodes_ids: list of start nodes ids\n# :param filters: Filters entity for a filtering before execute\n# :param bool wait: wait until rerun finish\n# :return: True if success\n# :rtype: bool\n# \n# \n# pipeline.pipeline_executions.rerun(pipeline_id='pipeline_id', method=dl.CycleRerunMethod.START_FROM_BEGINNING)\n# "}]}}, "/pipelines/{pipelineId}/executions/terminate": {"post": {"operationId": "_terminate", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"properties": {"message": {"type": "string"}}, "required": ["message"], "type": "object"}}}}}, "tags": ["pipelines"], "security": [], "parameters": [{"in": "path", "name": "pipelineId", "required": true, "schema": {"type": "string"}}], "requestBody": {"required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Dictionary"}}}}}}, "/pipelines/{pipelineId}/install": {"post": {"operationId": "_install", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/APIPipeline"}}}}}, "tags": ["pipelines"], "security": [], "parameters": [{"in": "path", "name": "pipelineId", "required": true, "schema": {"type": "string"}}], "requestBody": {"required": true, "content": {"application/json": {"schema": {"properties": {"resumeOption": {"$ref": "#/components/schemas/ResumePipelineOption"}}, "type": "object"}}}}, "x-codeSamples": [{"lang": "Python", "source": "\n# \n# Install (start) a pipeline.\n# \n# **prerequisites**: You must be an *owner* or *developer* to use this method.\n# \n# :param dtlpy.entities.pipeline.Pipeline pipeline: pipeline entity\n# :param dtlpy.entities.pipeline.PipelineResumeOption resume_option: optional - resume pipeline method (what to do with existing cycles)\n# :return: Composition object\n# \n# \n# project.pipelines.install(pipeline='pipeline_entity')\n# "}]}}, "/pipelines/{pipelineId}/nodes/{nodeId}": {"get": {"operationId": "_getNode", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/NodeDescriptor"}}}}}, "description": "get one of pipeline nodes by pipeline id and node id.", "tags": ["pipelines"], "security": [], "parameters": [{"description": "pipeline id.", "in": "path", "name": "pipelineId", "required": true, "schema": {"type": "string"}}, {"in": "path", "name": "nodeId", "required": true, "schema": {"type": "string"}}]}}, "/pipelines/{pipelineId}/purge": {"post": {"operationId": "_purge", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Boolean"}}}}}, "tags": ["pipelines"], "security": [], "parameters": [{"in": "path", "name": "pipelineId", "required": true, "schema": {"type": "string"}}]}}, "/pipelines/{pipelineId}/reset": {"post": {"operationId": "_reset", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/APIPipeline"}}}}}, "description": "Reset pipeline counters.", "tags": ["pipelines"], "security": [], "parameters": [{"description": "pipeline id.", "in": "path", "name": "pipelineId", "required": true, "schema": {"type": "string"}}], "x-codeSamples": [{"lang": "Python", "source": "\n# \n# Reset pipeline counters.\n# \n# **prerequisites**: You must be an *owner* or *developer* to use this method.\n# \n# :param dtlpy.entities.pipeline.Pipeline pipeline: pipeline entity - optional\n# :param str pipeline_id: pipeline_id -  optional\n# :param str pipeline_name: pipeline_name -  optional\n# :param bool stop_if_running: If the pipeline is installed it will stop the pipeline and reset the counters.\n# :return: bool\n# \n# \n# success = project.pipelines.reset(pipeline='pipeline_entity')\n# "}]}}, "/pipelines/{pipelineId}/settings": {"patch": {"operationId": "_updateSettings", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/APIPipeline"}}}}}, "tags": ["pipelines"], "security": [], "parameters": [{"in": "path", "name": "pipelineId", "required": true, "schema": {"type": "string"}}], "requestBody": {"required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/IPipelineSettings"}}}}, "x-codeSamples": [{"lang": "Python", "source": "\n# \n# Update pipeline settings.\n# \n# **prerequisites**: You must be an *owner* or *developer* to use this method.\n# \n# :param dtlpy.entities.pipeline.Pipeline pipeline: pipeline entity\n# :param dtlpy.entities.pipeline.PipelineSettings settings: settings entity\n# :return: Pipeline object\n# :rtype: dtlpy.entities.pipeline.Pipeline\n# \n# \n# pipeline = project.pipelines.update_settings(pipeline='pipeline_entity', settings=dl.PipelineSettings(keep_triggers_active=True))\n# "}]}}, "/pipelines/{pipelineId}/statistics": {"get": {"operationId": "_getStatistics", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/IPipelineStatistics"}}}}}, "description": "Get pipeline counters.", "tags": ["pipelines"], "security": [], "parameters": [{"description": "pipeline id.", "in": "path", "name": "pipelineId", "required": true, "schema": {"type": "string"}}]}}, "/pipelines/{pipelineId}/terminate": {"delete": {"operationId": "_terminate", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"type": "string"}}}}}, "description": "Delete the pipeline, should terminate the composition.", "tags": ["pipelines"], "security": [], "parameters": [{"description": "pipeline id.", "in": "path", "name": "pipelineId", "required": true, "schema": {"type": "string"}}]}}, "/pipelines/{pipelineId}/test": {"post": {"operationId": "_test", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/APIPipeline"}}}}}, "tags": ["pipelines"], "security": [], "parameters": [{"in": "path", "name": "pipelineId", "required": true, "schema": {"type": "string"}}]}}, "/pipelines/{pipelineId}/uninstall": {"post": {"operationId": "_uninstall", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/APIPipeline"}}}}}, "tags": ["pipelines"], "security": [], "parameters": [{"in": "path", "name": "pipelineId", "required": true, "schema": {"type": "string"}}], "requestBody": {"required": true, "content": {"application/json": {"schema": {"type": "boolean"}}}}, "x-codeSamples": [{"lang": "Python", "source": "\n# \n# Pause a pipeline.\n# \n# **prerequisites**: You must be an *owner* or *developer* to use this method.\n# \n# :param dtlpy.entities.pipeline.Pipeline pipeline: pipeline entity\n# :param bool keep_triggers_active: Do we want the triggers to stay active and collect events\n# :return: Composition object\n# \n# \n# project.pipelines.pause(pipeline='pipeline_entity')\n# "}]}}, "/pipelines/{pipelineId}/variables": {"patch": {"operationId": "_updateVariables", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/APIPipeline"}}}}}, "tags": ["pipelines"], "security": [], "parameters": [{"in": "path", "name": "pipelineId", "required": true, "schema": {"type": "string"}}], "requestBody": {"required": true, "content": {"application/json": {"schema": {"items": {"$ref": "#/components/schemas/PipelineVariable"}, "type": "array"}}}}}}, "/pipelines/{piplineId}/logs": {"post": {"operationId": "_logs", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"items": {"$ref": "#/components/schemas/PipelineExecutionLogs"}, "type": "array"}}}}}, "tags": ["pipelines"], "security": [], "parameters": [{"in": "path", "name": "piplineId", "required": true, "schema": {"type": "string"}}], "requestBody": {"required": true, "content": {"application/json": {"schema": {"properties": {"query": {"$ref": "#/components/schemas/QueryString"}, "logsOptions": {"$ref": "#/components/schemas/LogQuery"}}, "required": ["query", "logsOptions"], "type": "object"}}}}}}, "/pipelines/{projectId}/compositionStatus": {"get": {"operationId": "_compositionStatus", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/CompositionStatusDescriptor"}}}}}, "description": "get composition status.", "tags": ["pipelines"], "security": [], "parameters": [{"description": "project id.", "in": "path", "name": "projectId", "required": true, "schema": {"type": "string"}}]}}, "/piper-misc/naming/packages/{name}": {"get": {"operationId": "_validatePackageName", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"type": "boolean"}}}}}, "tags": ["PiperMisc"], "security": [], "parameters": [{"in": "path", "name": "name", "required": true, "schema": {"type": "string"}}]}}, "/piper-misc/naming/services/{name}": {"get": {"operationId": "_validateServiceName", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"type": "boolean"}}}}}, "tags": ["PiperMisc"], "security": [], "parameters": [{"in": "path", "name": "name", "required": true, "schema": {"type": "string"}}]}}, "/piper-misc/naming/triggers/{name}": {"get": {"operationId": "_validateTriggerName", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"type": "boolean"}}}}}, "tags": ["PiperMisc"], "security": [], "parameters": [{"in": "path", "name": "name", "required": true, "schema": {"type": "string"}}]}}, "/plans": {"get": {"operationId": "List All Plans", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"items": {"$ref": "#/components/schemas/Plan"}, "type": "array"}}}}}, "tags": ["Plans"], "security": [], "parameters": []}}, "/plans/store/metrics": {"get": {"operationId": "List All Plan Metrics", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"items": {"$ref": "#/components/schemas/APIBillableResource"}, "type": "array"}}}}}, "tags": ["Plans"], "security": [], "parameters": []}}, "/plans/store/metrics/query": {"post": {"operationId": "Query Billing Metrics", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"items": {"$ref": "#/components/schemas/APIBillableResource"}, "type": "array"}}}}}, "tags": ["Plans"], "security": [], "parameters": [], "requestBody": {"required": true, "content": {"application/json": {"schema": {"properties": {"keys": {"items": {"type": "string"}, "type": "array"}}, "required": ["keys"], "type": "object"}}}}}}, "/plans/{id}": {"get": {"operationId": "Get Plan", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Plan"}}}}}, "tags": ["Plans"], "security": [], "parameters": [{"in": "path", "name": "id", "required": true, "schema": {"type": "string"}}]}}, "/project/{projectId}/guests": {"get": {"operationId": "List project guests", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"items": {"$ref": "#/components/schemas/APIGuest"}, "type": "array"}}}}}, "tags": ["Guests"], "security": [], "parameters": [{"in": "path", "name": "projectId", "required": true, "schema": {"type": "string"}}]}, "post": {"operationId": "Create project guest", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"items": {"$ref": "#/components/schemas/APIGuest"}, "type": "array"}, "examples": {"Example 1": {"value": {"guestEmail": "guest@example.com", "name": "Great Company", "type": "labeling", "denyMembersManagement": false}}}}}}}, "description": "Create a guest company in a project", "tags": ["Guests"], "security": [], "parameters": [{"in": "path", "name": "projectId", "required": true, "schema": {"type": "string"}}], "requestBody": {"required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/CreateGuestPayload"}}}}}}, "/project/{projectId}/guests/{guestId}": {"get": {"operationId": "Get project guest", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/APIProjectGuest"}}}}}, "description": "Get information about a guest company in a project", "tags": ["Guests"], "security": [], "parameters": [{"in": "path", "name": "projectId", "required": true, "schema": {"type": "string"}}, {"in": "path", "name": "guestId", "required": true, "schema": {"type": "string"}}]}, "patch": {"operationId": "Update project guest", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"items": {"$ref": "#/components/schemas/APIGuest"}, "type": "array"}, "examples": {"Example 1": {"value": {"name": "Better Company Name", "type": "labeling"}}}}}}}, "description": "Change a given guest company name of type", "tags": ["Guests"], "security": [], "parameters": [{"in": "path", "name": "projectId", "required": true, "schema": {"type": "string"}}, {"in": "path", "name": "guestId", "required": true, "schema": {"type": "string"}}], "requestBody": {"required": true, "content": {"application/json": {"schema": {"properties": {"type": {"$ref": "#/components/schemas/GuestType"}, "name": {"type": "string"}}, "required": ["type", "name"], "type": "object"}}}}}, "delete": {"operationId": "Remove project guest", "responses": {"204": {"description": "No content"}}, "description": "Remove a guest company from a project", "tags": ["Guests"], "security": [], "parameters": [{"in": "path", "name": "projectId", "required": true, "schema": {"type": "string"}}, {"in": "path", "name": "guestId", "required": true, "schema": {"type": "string"}}]}}, "/project/{projectId}/guests/{guestId}/addOrg": {"patch": {"operationId": "Add org to guest", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/APIGuest"}, "examples": {"Example 1": {"value": {"org_id": "someOrgId"}}}}}}}, "description": "Add an org to a guest company", "tags": ["Guests"], "security": [], "parameters": [{"in": "path", "name": "guestId", "required": true, "schema": {"type": "string"}}], "requestBody": {"required": true, "content": {"application/json": {"schema": {"properties": {"org_id": {"type": "string"}}, "required": ["org_id"], "type": "object"}}}}}}, "/projects": {"get": {"operationId": "Get My Projects", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"items": {"$ref": "#/components/schemas/APIProject"}, "type": "array"}}}}}, "description": "Get all my projects", "tags": ["Projects"], "security": [], "parameters": [{"in": "query", "name": "excludeContributors", "required": false, "schema": {"type": "boolean"}}], "x-codeSamples": [{"lang": "Python", "source": "\n# \n# Get the user's project list\n# \n# **Prerequisites**: You must be a **superuser** to list all users' projects.\n# \n# :return: List of Project objects\n# \n# \n# projects = dl.projects.list()\n# "}]}, "post": {"operationId": "Create Project", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/APIProject"}, "examples": {"Example 1": {"value": {"name": "New Project Name"}}}}}}}, "description": "Creates a new project", "tags": ["Projects"], "security": [], "parameters": [], "requestBody": {"required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/CreateProjectPayload"}}}}, "x-codeSamples": [{"lang": "Python", "source": "\n# \n# Create a new project.\n# \n# **Prerequisites**: Any user can create a project.\n# \n# :param str project_name: The Name of the project\n# :param bool checkout: set the project as a default project object (cookies)\n# :return: Project object\n# :rtype: dtlpy.entities.project.Project\n# \n# \n# project = dl.projects.create(project_name='project_name')\n# "}]}}, "/projects/{projectId}": {"get": {"operationId": "Get Project", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/APIProject"}}}}}, "description": "Returns details of a specific project", "tags": ["Projects"], "security": [], "parameters": [{"in": "path", "name": "projectId", "required": true, "schema": {"type": "string"}}], "x-codeSamples": [{"lang": "Python", "source": "\n# \n# Get a Project object.\n# \n# **Prerequisites**: You must be in the role of an *owner* to get a project object.\n# \n# You must check out to a project or provide at least one of the following params: project_id, project_name\n# \n# :param str project_name: optional - search by name\n# :param str project_id: optional - search by id\n# :param bool checkout: set the project as a default project object (cookies)\n# :param bool fetch: optional - fetch entity from platform (True), default taken from cookie\n# :param bool log_error: optional - show the logs errors\n# :return: Project object\n# :rtype: dtlpy.entities.project.Project\n# \n# \n# project = dl.projects.get(project_id='project_id')\n# "}]}, "patch": {"operationId": "Patch Project", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/APIProject"}, "examples": {"Example 1": {"value": {"name": "New Project Name"}}}}}}}, "description": "Change a project's name", "tags": ["Projects"], "security": [], "parameters": [{"in": "path", "name": "projectId", "required": true, "schema": {"type": "string"}}], "requestBody": {"required": true, "content": {"application/json": {"schema": {"properties": {"name": {"type": "string"}}, "required": ["name"], "type": "object"}}}}, "x-codeSamples": [{"lang": "Python", "source": "\n# \n# Update a project information (e.g., name, member roles, etc.).\n# \n# **Prerequisites**: You must be in the role of an *owner* to add a member to a project.\n# \n# :param dtlpy.entities.project.Project project: project object\n# :param bool system_metadata: optional - True, if you want to change metadata system\n# :return: Project object\n# :rtype: dtlpy.entities.project.Project\n# \n# \n# project = dl.projects.delete(project='project_entity')\n# "}]}, "delete": {"operationId": "Delete Project", "responses": {"204": {"description": "No content"}}, "description": "Delete a project", "tags": ["Projects"], "security": [], "parameters": [{"in": "path", "name": "projectId", "required": true, "schema": {"type": "string"}}], "x-codeSamples": [{"lang": "Python", "source": "\n# \n# Delete a project forever!\n# \n# **Prerequisites**: You must be in the role of an *owner* to delete a project.\n# \n# :param str project_name: optional - search by name\n# :param str project_id: optional - search by id\n# :param bool sure: Are you sure you want to delete?\n# :param bool really: Really really sure?\n# :return: True if success, error if not\n# :rtype: bool\n# \n# \n# is_deleted = dl.projects.delete(project_id='project_id', sure=True, really=True)\n# "}]}}, "/projects/{projectId}/accounts": {"post": {"operationId": "Set Project Account", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/APIProject"}, "examples": {"Example 1": {"value": {"account": "newAccountId"}}}}}}}, "description": "Add an account to a project", "tags": ["Projects"], "security": [], "parameters": [{"in": "path", "name": "projectId", "required": true, "schema": {"type": "string"}}], "requestBody": {"required": true, "content": {"application/json": {"schema": {"properties": {"account": {"type": "string"}}, "required": ["account"], "type": "object"}}}}}}, "/projects/{projectId}/members": {"post": {"operationId": "Add Members To Project", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"anyOf": [{"items": {"$ref": "#/components/schemas/APIMembership"}, "type": "array"}, {}]}, "examples": {"Example 1": {"value": {"role": "annotator", "users": ["user1@example.com", "user2@example.com"]}}}}}}}, "description": "add multiple members to a project with a given role", "tags": ["Projects"], "security": [], "parameters": [{"in": "path", "name": "projectId", "required": true, "schema": {"type": "string"}}], "requestBody": {"required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/AddMembersBatchPayload"}}}}}, "get": {"operationId": "Get Project Members", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"items": {"$ref": "#/components/schemas/APIUser"}, "type": "array"}}}}}, "description": "Get project's members", "tags": ["Projects"], "security": [], "parameters": [{"in": "path", "name": "projectId", "required": true, "schema": {"type": "string"}}], "x-codeSamples": [{"lang": "Python", "source": "\n# \n# Get a list of the project members.\n# \n# **Prerequisites**: You must be in the role of an *owner* to list project members.\n# \n# :param dtlpy.entities.project.Project project: Project object\n# :param role: The required role for the user. Use the enum dl.MemberRole\n# :return: list of the project members\n# :rtype: list\n# \n# \n# users_jsons_list = dl.projects.list_members(project_id='project_id', role=dl.MemberRole.DEVELOPER)\n# "}]}}, "/projects/{projectId}/members/{userId}": {"post": {"operationId": "Add Member To Project", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"anyOf": [{"items": {"$ref": "#/components/schemas/ClientContributor"}, "type": "array"}, {}]}, "examples": {"Example 1": {"value": {"role": "annotator"}}}}}}}, "description": "Add a single member to a project", "tags": ["Projects"], "security": [], "parameters": [{"in": "path", "name": "projectId", "required": true, "schema": {"type": "string"}}, {"in": "path", "name": "userId", "required": true, "schema": {"type": "string"}}, {"in": "query", "name": "allowUpdate", "required": false, "schema": {"type": "boolean"}}], "requestBody": {"required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/AddMemberPayload"}}}}, "x-codeSamples": [{"lang": "Python", "source": "\n# \n# Add a member to the project.\n# \n# **Prerequisites**: You must be in the role of an *owner* to add a member to a project.\n# \n# :param str email: member email\n# :param str project_id: The Id of the project\n# :param role: The required role for the user. Use the enum dl.MemberRole\n# :return: dict that represent the user\n# :rtype: dict\n# \n# \n# user_json = dl.projects.add_member(project_id='project_id', email='user@dataloop.ai', role=dl.MemberRole.DEVELOPER)\n# "}]}, "patch": {"operationId": "Change Member Project Role", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"items": {"$ref": "#/components/schemas/ClientContributor"}, "type": "array"}, "examples": {"Example 1": {"value": {"role": "engineer"}}}}}}}, "description": "Change a member's role in a project", "tags": ["Projects"], "security": [], "parameters": [{"in": "path", "name": "projectId", "required": true, "schema": {"type": "string"}}, {"in": "path", "name": "userId", "required": true, "schema": {"type": "string"}}], "requestBody": {"required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/PatchMemberPayload"}}}}, "x-codeSamples": [{"lang": "Python", "source": "\n# \n# Update member's information/details in the project.\n# \n# **Prerequisites**: You must be in the role of an *owner* to update a member.\n# \n# :param str email: member email\n# :param str project_id: The Id of the project\n# :param role: The required role for the user. Use the enum dl.MemberRole\n# :return: dict that represent the user\n# :rtype: dict\n# \n# \n# user_json = = dl.projects.update_member(project_id='project_id', email='user@dataloop.ai', role=dl.MemberRole.DEVELOPER)\n# "}]}, "delete": {"operationId": "Remove Member from Project", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"items": {"$ref": "#/components/schemas/ClientContributor"}, "type": "array"}}}}}, "description": "Remove a member from a project", "tags": ["Projects"], "security": [], "parameters": [{"in": "path", "name": "projectId", "required": true, "schema": {"type": "string"}}, {"in": "path", "name": "userId", "required": true, "schema": {"type": "string"}}], "x-codeSamples": [{"lang": "Python", "source": "\n# \n# Remove a member from the project.\n# \n# **Prerequisites**: You must be in the role of an *owner* to delete a member from a project.\n# \n# :param str email: member email\n# :param str project_id: The Id of the project\n# :return: dict that represents the user\n# :rtype: dict\n# \n# \n# user_json = dl.projects.remove_member(project_id='project_id', email='user@dataloop.ai')\n# "}]}}, "/projects/{projectId}/org": {"patch": {"operationId": "Add Org To Project", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/APIProject"}, "examples": {"Example 1": {"value": {"org_id": "newOrgId"}}}}}}}, "description": "add or update a project's organization", "tags": ["Projects"], "security": [], "parameters": [{"in": "path", "name": "projectId", "required": true, "schema": {"type": "string"}}], "requestBody": {"required": true, "content": {"application/json": {"schema": {"properties": {"org_id": {"type": "string"}}, "required": ["org_id"], "type": "object"}}}}}}, "/projects/{projectId}/subgroups": {"get": {"operationId": "Get Groups", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"items": {"$ref": "#/components/schemas/APIGroup"}, "type": "array"}}}}}, "description": "Get all project's groups", "tags": ["Projects"], "security": [], "parameters": [{"in": "path", "name": "projectId", "required": true, "schema": {"type": "string"}}]}}, "/projects/{projectId}/subgroups/{groupId}": {"post": {"operationId": "Add Group", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"items": {"$ref": "#/components/schemas/APIGroup"}, "type": "array"}, "examples": {"Example 1": {"value": {"role": "annotator"}}}}}}}, "description": "Add a group to a project with a given role", "tags": ["Projects"], "security": [], "parameters": [{"in": "path", "name": "projectId", "required": true, "schema": {"type": "string"}}, {"in": "path", "name": "groupId", "required": true, "schema": {"type": "string"}}], "requestBody": {"required": true, "content": {"application/json": {"schema": {"properties": {"role": {"$ref": "#/components/schemas/Role"}}, "required": ["role"], "type": "object"}}}}}, "patch": {"operationId": "Update Group", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"items": {"$ref": "#/components/schemas/APIGroup"}, "type": "array"}, "examples": {"Example 1": {"value": {"role": "engineer"}}}}}}}, "description": "Change a groups role in a project", "tags": ["Projects"], "security": [], "parameters": [{"in": "path", "name": "projectId", "required": true, "schema": {"type": "string"}}, {"in": "path", "name": "groupId", "required": true, "schema": {"type": "string"}}], "requestBody": {"required": true, "content": {"application/json": {"schema": {"properties": {"role": {"$ref": "#/components/schemas/Role"}}, "required": ["role"], "type": "object"}}}}}, "delete": {"operationId": "Remove Group", "responses": {"204": {"description": "No content"}}, "description": "Remove a group from a project", "tags": ["Projects"], "security": [], "parameters": [{"in": "path", "name": "projectId", "required": true, "schema": {"type": "string"}}, {"in": "path", "name": "groupId", "required": true, "schema": {"type": "string"}}]}}, "/projects/{projectName}/name": {"get": {"operationId": "Get Project By Name", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"items": {"$ref": "#/components/schemas/APIProject"}, "type": "array"}}}}}, "description": "Query the user's projects by name", "tags": ["Projects"], "security": [], "parameters": [{"in": "path", "name": "projectName", "required": true, "schema": {"type": "string"}}]}}, "/query/faas": {"post": {"operationId": "QueryEntities", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {}}}}}, "tags": ["Query"], "security": [], "parameters": [], "requestBody": {"required": true, "content": {"application/json": {"schema": {"properties": {"pageSize": {"type": "number", "format": "double"}, "page": {"type": "number", "format": "double"}, "sort": {}, "filter": {}, "resource": {"type": "string"}}, "required": ["pageSize", "page", "sort", "filter", "resource"], "type": "object"}}}}, "x-codeSamples": [{"lang": "Python", "source": "\n# \n# List service executions\n# \n# **Prerequisites**: You must be in the role of an *owner* or *developer*. You must have a service.\n# \n# :param dtlpy.entities.filters.Filters filters: dl.Filters entity to filters items\n# :return: Paged entity\n# :rtype: dtlpy.entities.paged_entities.PagedEntities\n# \n# \n# service.executions.list()\n# "}]}}, "/recipes": {"post": {"operationId": "Create Recipe", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"anyOf": [{"$ref": "#/components/schemas/APIRecipeV2"}, {"$ref": "#/components/schemas/APIRecipe"}]}}}}}, "description": "Create a new Recipe", "tags": ["Recipes"], "security": [], "parameters": [], "requestBody": {"description": ": Recipe creation payload", "required": true, "content": {"application/json": {"schema": {"anyOf": [{"$ref": "#/components/schemas/RecipeV2Input"}, {"$ref": "#/components/schemas/RecipeInput"}], "description": ": Recipe creation payload"}}}}, "x-codeSamples": [{"lang": "Python", "source": "\n# \n# Create a new Recipe.\n# Note: If the param ontology_ids is None, an ontology will be created first.\n# \n# **Prerequisites**: You must be in the role of an *owner* or *developer*.\n# \n# :param str project_ids: project ids\n# :param str or list ontology_ids: ontology ids\n# :param labels: labels\n# :param str recipe_name: recipe name\n# :param attributes: attributes\n# :param str annotation_instruction_file: file path or url of the recipe instruction\n# :return: Recipe entity\n# :rtype: dtlpy.entities.recipe.Recipe\n# \n# \n# dataset.recipes.create(recipe_name='My Recipe', labels=labels))\n# "}]}, "get": {"operationId": "FindRecipes", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/CursorPage_APIRecipeV2-or-APIRecipe_"}}}}}, "description": "Find recipes by query", "tags": ["Recipes"], "security": [], "parameters": [{"description": "- An array of project IDs", "in": "query", "name": "projects", "required": false, "schema": {"type": "array", "items": {"type": "string"}}}, {"description": "- Filter by creator", "in": "query", "name": "creator", "required": false, "schema": {"type": "string"}}, {"description": "- Find by title", "in": "query", "name": "title", "required": false, "schema": {"type": "string"}}, {"description": "- An array of ontology IDs", "in": "query", "name": "ontologies", "required": false, "schema": {"type": "array", "items": {"type": "string"}}}, {"description": "- The number of pages to skip from the start", "in": "query", "name": "pageOffset", "required": false, "schema": {"format": "double", "type": "number"}}, {"description": "- How many recipes in one page", "in": "query", "name": "pageSize", "required": false, "schema": {"format": "double", "type": "number"}}]}}, "/recipes/{id}": {"patch": {"operationId": "Update Recipe", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"anyOf": [{"$ref": "#/components/schemas/APIRecipeV2"}, {"$ref": "#/components/schemas/APIRecipe"}]}}}}}, "description": "Update an existing recipe", "tags": ["Recipes"], "security": [], "parameters": [{"description": ": Recipe ID", "in": "path", "name": "id", "required": true, "schema": {"type": "string"}}], "requestBody": {"description": ": The fields to update", "required": true, "content": {"application/json": {"schema": {"anyOf": [{"$ref": "#/components/schemas/PartialRecipePayloadV2"}, {"$ref": "#/components/schemas/PartialRecipePayload"}], "description": ": The fields to update"}}}}, "x-codeSamples": [{"lang": "Python", "source": "\n# \n# Update recipe.\n# \n# **Prerequisites**: You must be in the role of an *owner* or *developer*.\n# \n# :param dtlpy.entities.recipe.Recipe recipe: Recipe object\n# :param bool system_metadata: True, if you want to change metadata system\n# :return: Recipe object\n# :rtype: dtlpy.entities.recipe.Recipe\n# \n# \n# dataset.recipes.update(recipe='recipe_entity')\n# "}]}, "get": {"operationId": "Get Recipe", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"anyOf": [{"$ref": "#/components/schemas/APIRecipeV2"}, {"$ref": "#/components/schemas/APIRecipe"}]}}}}, "400": {"description": "Missing or Invalid id"}, "404": {"description": "Recipe not found"}}, "description": "Get a specific recipe", "tags": ["Recipes"], "security": [], "parameters": [{"description": ": Recipe ID", "in": "path", "name": "id", "required": true, "schema": {"type": "string"}}], "x-codeSamples": [{"lang": "Python", "source": "\n# \n# Get a Recipe object to use in your code.\n# \n# **Prerequisites**: You must be in the role of an *owner* or *developer*.\n# \n# :param str recipe_id: recipe id\n# :return: Recipe object\n# :rtype: dtlpy.entities.recipe.Recipe\n# \n# \n# dataset.recipes.get(recipe_id='recipe_id')\n# "}]}, "delete": {"operationId": "Delete Recipe", "responses": {"204": {"description": "No content"}}, "description": "Delete a recipe", "tags": ["Recipes"], "security": [], "parameters": [{"description": ": Recipe ID", "in": "path", "name": "id", "required": true, "schema": {"type": "string"}}, {"in": "query", "name": "force", "required": false, "schema": {"type": "boolean"}}], "x-codeSamples": [{"lang": "Python", "source": "\n# \n# Delete recipe from platform.\n# \n# **Prerequisites**: You must be in the role of an *owner* or *developer*.\n# \n# :param str recipe_id: recipe id\n# :param bool force: force delete recipe\n# :return: True if success\n# :rtype: bool\n# \n# \n# dataset.recipes.delete(recipe_id='recipe_id')\n# "}]}}, "/recipes/{id}/clone": {"post": {"operationId": "Clone Recipe", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"anyOf": [{"$ref": "#/components/schemas/APIRecipeV2"}, {"$ref": "#/components/schemas/APIRecipe"}]}}}}}, "tags": ["Recipes"], "security": [], "parameters": [{"in": "path", "name": "id", "required": true, "schema": {"type": "string"}}], "requestBody": {"required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/CloneRecipePayload"}}}}, "x-codeSamples": [{"lang": "Python", "source": "\n# \n# Clone recipe.\n# \n# **Prerequisites**: You must be in the role of an *owner* or *developer*.\n# \n# :param dtlpy.entities.recipe.Recipe recipe: Recipe object\n# :param str recipe_id: Recipe id\n# :param bool shallow: If True, link to existing ontology, clones all ontologies that are linked to the recipe as well\n# :return: Cloned ontology object\n# :rtype: dtlpy.entities.recipe.Recipe\n# \n# \n# dataset.recipes.clone(recipe_id='recipe_id')\n# "}]}}, "/scores": {"post": {"operationId": "Create Scores", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"items": {"$ref": "#/components/schemas/APIScore"}, "type": "array"}}}}}, "tags": ["Scores"], "security": [], "parameters": [], "requestBody": {"required": true, "content": {"application/json": {"schema": {"properties": {"scores": {"items": {"$ref": "#/components/schemas/Score"}, "type": "array"}}, "required": ["scores"], "type": "object"}}}}}, "delete": {"operationId": "Delete Scores", "responses": {"204": {"description": "No content"}}, "tags": ["Scores"], "security": [], "parameters": [], "requestBody": {"required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/DeleteTaskItemScoresPayload"}}}}}}, "/scores/average": {"post": {"operationId": "Query Average", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {}}}}}, "tags": ["Scores"], "security": [], "parameters": [], "requestBody": {"required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ScoreParameters"}}}}}}, "/scores/confusion": {"post": {"operationId": "Query Confusion", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"properties": {"confusionMatrix": {"items": {"items": {"type": "number", "format": "double"}, "type": "array"}, "type": "array"}, "labels": {"items": {"type": "string"}, "type": "array"}}, "required": ["confusionMatrix", "labels"], "type": "object"}}}}}, "tags": ["Scores"], "security": [], "parameters": [], "requestBody": {"required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ScoreParameters"}}}}}}, "/scores/histogram": {"post": {"operationId": "Query Histogram", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"items": {}, "type": "array"}}}}}, "tags": ["Scores"], "security": [], "parameters": [], "requestBody": {"required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ScoreParameters"}}}}}}, "/scores/tasks/{taskId}": {"get": {"operationId": "Get Task Scores", "responses": {"200": {"description": "An array of scores for the specified task item.", "content": {"application/json": {"schema": {"properties": {"hasNextPage": {"type": "boolean"}, "totalPagesCount": {"type": "number", "format": "double"}, "totalItemsCount": {"type": "number", "format": "double"}, "items": {"items": {"$ref": "#/components/schemas/APIScore"}, "type": "array"}}, "required": ["hasNextPage", "totalPagesCount", "totalItemsCount", "items"], "type": "object"}}}}}, "description": "Retrieves scores for a specific task.", "tags": ["Scores"], "security": [], "parameters": [{"description": "- The ID of the task", "in": "path", "name": "taskId", "required": true, "schema": {"type": "string"}}, {"description": "- The page number for pagination (default is 0)", "in": "query", "name": "page", "required": false, "schema": {"default": 0, "format": "double", "type": "number"}}, {"description": "- The number of scores per page (default is 100)", "in": "query", "name": "pageSize", "required": false, "schema": {"default": 100, "format": "double", "type": "number"}}]}}, "/scores/tasks/{taskId}/annotations/{annotationId}": {"get": {"operationId": "Get Task Annotation Scores", "responses": {"200": {"description": "An array of scores for the specified task annotation.", "content": {"application/json": {"schema": {"properties": {"hasNextPage": {"type": "boolean"}, "totalPagesCount": {"type": "number", "format": "double"}, "totalItemsCount": {"type": "number", "format": "double"}, "items": {"items": {"$ref": "#/components/schemas/APIScore"}, "type": "array"}}, "required": ["hasNextPage", "totalPagesCount", "totalItemsCount", "items"], "type": "object"}}}}}, "description": "Retrieves scores for a specific task annotation.", "tags": ["Scores"], "security": [], "parameters": [{"description": "- The ID of the task", "in": "path", "name": "taskId", "required": true, "schema": {"type": "string"}}, {"description": "- The ID of the annotation", "in": "path", "name": "annotationId", "required": true, "schema": {"type": "string"}}, {"description": "- The page number for pagination (default is 0)", "in": "query", "name": "page", "required": false, "schema": {"default": 0, "format": "double", "type": "number"}}, {"description": "- The number of scores per page (default is 100)", "in": "query", "name": "pageSize", "required": false, "schema": {"default": 100, "format": "double", "type": "number"}}]}}, "/scores/tasks/{taskId}/items/{itemId}": {"get": {"operationId": "Get Task Item Scores", "responses": {"200": {"description": "An array of scores for the specified task item.", "content": {"application/json": {"schema": {"properties": {"hasNextPage": {"type": "boolean"}, "totalPagesCount": {"type": "number", "format": "double"}, "totalItemsCount": {"type": "number", "format": "double"}, "items": {"items": {"$ref": "#/components/schemas/APIScore"}, "type": "array"}}, "required": ["hasNextPage", "totalPagesCount", "totalItemsCount", "items"], "type": "object"}}}}}, "description": "Retrieves scores for a specific task item.", "tags": ["Scores"], "security": [], "parameters": [{"description": "- The ID of the task", "in": "path", "name": "taskId", "required": true, "schema": {"type": "string"}}, {"description": "- The ID of the item", "in": "path", "name": "itemId", "required": true, "schema": {"type": "string"}}, {"description": "- The page number for pagination (default is 0)", "in": "query", "name": "page", "required": false, "schema": {"default": 0, "format": "double", "type": "number"}}, {"description": "- The number of scores per page (default is 100)", "in": "query", "name": "pageSize", "required": false, "schema": {"default": 100, "format": "double", "type": "number"}}]}}, "/serviceDrivers": {"post": {"operationId": "_create", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/APIServiceDriver"}}}}}, "description": "Create Service Driver.", "tags": ["serviceDrivers"], "security": [], "parameters": [], "requestBody": {"required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/APIServiceDriver"}}}}}}, "/serviceDrivers/default": {"patch": {"operationId": "_setDefault", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/APIServiceDriver"}}}}}, "description": "Set Service Driver.", "tags": ["serviceDrivers"], "security": [], "parameters": [], "requestBody": {"required": true, "content": {"application/json": {"schema": {"properties": {"driverName": {"type": "string"}, "organizationId": {"type": "string"}, "updateExistingServices": {"type": "boolean"}}, "required": ["driverName", "organizationId"], "type": "object"}}}}}}, "/serviceDrivers/{id}": {"patch": {"operationId": "_update", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/APIServiceDriver"}}}}}, "description": "Update Service Driver.", "tags": ["serviceDrivers"], "security": [], "parameters": [{"in": "path", "name": "id", "required": true, "schema": {"type": "string"}}], "requestBody": {"required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/APIServiceDriver"}}}}}, "get": {"operationId": "_get", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/APIServiceDriver"}}}}}, "description": "Get Service Driver.", "tags": ["serviceDrivers"], "security": [], "parameters": [{"in": "path", "name": "id", "required": true, "schema": {"type": "string"}}, {"in": "query", "name": "archived", "required": false, "schema": {"default": false, "type": "boolean"}}]}, "delete": {"operationId": "_delete", "responses": {"204": {"description": "No content"}}, "description": "Delete Service Driver.", "tags": ["serviceDrivers"], "security": [], "parameters": [{"in": "path", "name": "id", "required": true, "schema": {"type": "string"}}]}}, "/services": {"get": {"operationId": "_listServices", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ServicesPage"}}}}}, "description": "Retrieves services.\n\nSupply query parameters to filter the list.", "tags": ["Services"], "security": [], "parameters": [{"description": "projects: array of project id", "in": "query", "name": "projects", "required": false, "schema": {"type": "string"}}, {"description": "name: service name", "in": "query", "name": "name", "required": false, "schema": {"type": "string"}}, {"description": "packageId: the package that service related to", "in": "query", "name": "packageId", "required": false, "schema": {"type": "string"}}, {"description": "pageOffset: accepts any number", "in": "query", "name": "pageOffset", "required": false, "schema": {"format": "double", "type": "number"}}, {"description": "pageSize: accepts any number", "in": "query", "name": "pageSize", "required": false, "schema": {"format": "double", "type": "number"}}]}, "post": {"operationId": "_createService", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/APIService"}}}}}, "description": "Create new package.", "tags": ["Services"], "security": [], "parameters": [], "requestBody": {"required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/APIService"}}}}, "x-codeSamples": [{"lang": "Python", "source": "\n# \n# Deploy service.\n# \n# **Prerequisites**: You must be in the role of an *owner* or *developer*. You must have a package.\n# \n# :param str service_name: name\n# :param dtlpy.entities.package.Package package: package entity\n# :param str bot: bot email\n# :param str revision: package revision of version\n# :param init_input: config to run at startup\n# :param dict runtime: runtime resources\n# :param str pod_type: pod type dl.InstanceCatalog\n# :param str sdk_version:  - optional - string - sdk version\n# :param str agent_versions: - dictionary - - optional -versions of sdk\n# :param bool verify: if true, verify the inputs\n# :param bool checkout: if true, checkout (switch) to service\n# :param str module_name: module name\n# :param str project_id: project id\n# :param str driver_id: driver id\n# :param Callable func: function to deploy\n# :param bool run_execution_as_process: if true, run execution as process\n# :param int execution_timeout: execution timeout in seconds\n# :param int drain_time: drain time in seconds\n# :param int max_attempts: maximum execution retries in-case of a service reset\n# :param str on_reset: what happens on reset\n# :param bool force: optional - if true, terminate old replicas immediately\n# :param list secrets: list of the integrations ids\n# :param list integrations: list of the integrations\n# :param bool active: if true, activate the service\n# :param kwargs: list of additional arguments\n# :return: Service object\n# :rtype: dtlpy.entities.service.Service\n# \n# \n# service = package.services.deploy(service_name=package_name,\n# execution_timeout=3 * 60 * 60,\n# module_name=module.name,\n# runtime=dl.KubernetesRuntime(\n# concurrency=10,\n# pod_type=dl.InstanceCatalog.REGULAR_S,\n# autoscaler=dl.KubernetesRabbitmqAutoscaler(\n# min_replicas=1,\n# max_replicas=20,\n# queue_length=20\n# )\n# )\n# )\n# "}]}}, "/services-metric/{id}/scaler": {"get": {"operationId": "_getServiceScaler", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/IServiceScaler"}}}}}, "tags": ["services-metric"], "security": [], "parameters": [{"in": "path", "name": "id", "required": true, "schema": {"type": "string"}}]}}, "/services/cache": {"post": {"operationId": "_cache", "responses": {"204": {"description": "No content"}}, "description": "Add or remove Cache for the org.", "tags": ["Services"], "security": [], "parameters": [{"description": "Cache request mode", "in": "query", "name": "mode", "required": true, "schema": {"$ref": "#/components/schemas/ECacheMode"}}], "requestBody": {"required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ICacheOptions"}}}}}}, "/services/fs-cache": {"post": {"operationId": "_fsCache", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {}}}}}, "tags": ["Services"], "security": [], "parameters": [{"in": "query", "name": "mode", "required": true, "schema": {"$ref": "#/components/schemas/ECacheMode"}}], "requestBody": {"required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ICacheOptions"}}}}}}, "/services/global": {"post": {"operationId": "_getGlobalServices", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"items": {"properties": {"global": {"type": "boolean"}, "_id": {"$ref": "#/components/schemas/ObjectID"}}, "required": ["global", "_id"], "type": "object"}, "type": "array"}}}}}, "description": "Get all global services\nby using list of projectId and service name\n\nExample: [{ projectId: 'my-project-id', name: 'my-service-name' },\n              { projectId: 'my-project-id2', name: 'my-service-name2' }, ... ]\n\n the server will search in the db for the service with the name my-service-name belonging to the project 'my-project-id\n also the service with the name my-service-name2 belonging to the project 'my-project-id2\n and so on...", "tags": ["Services"], "security": [], "parameters": [], "requestBody": {"required": false, "content": {"application/json": {"schema": {"items": {"properties": {"name": {"type": "string"}, "projectId": {"type": "string"}}, "required": ["name", "projectId"], "type": "object"}, "type": "array"}}}}}}, "/services/logs": {"post": {"operationId": "_getLogs", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ServiceLogsPage"}}}}}, "description": "Get logs for pipelines.", "tags": ["Services"], "security": [], "parameters": [{"in": "query", "name": "verbose", "required": true, "schema": {"type": "string"}}], "requestBody": {"required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/LogQuery"}}}}, "x-codeSamples": [{"lang": "Python", "source": "\n# \n# Get service logs.\n# \n# **Prerequisites**: You must be in the role of an *owner* or *developer*. You must have a package.\n# \n# :param dtlpy.entities.service.Service service: service object\n# :param int size: size\n# :param dict checkpoint: the information from the lst point checked in the service\n# :param str start: iso format time\n# :param str end: iso format time\n# :param bool follow: if true, keep stream future logs\n# :param str text: text\n# :param str execution_id: execution id\n# :param str function_name: function name\n# :param str replica_id: replica id\n# :param bool system: system\n# :param bool view: if true, print out all the logs\n# :param bool until_completed: wait until completed\n# :param str log_level: the log level to display dl.LoggingLevel\n# :param str model_id: model id\n# :param str model_operation: model operation action\n# :param str project_id: project id\n# :return: ServiceLog entity\n# :rtype: ServiceLog\n# \n# \n# service_logs = package.services.log(service='service_entity')\n# "}]}}, "/services/reload": {"post": {"operationId": "_reloadServices", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/APICommand"}}}}}, "description": "Reload Services.", "tags": ["Services"], "security": [], "parameters": [], "requestBody": {"required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Dictionary"}}}}}}, "/services/status": {"get": {"operationId": "_getServicesStatus", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"properties": {}, "additionalProperties": {"$ref": "#/components/schemas/APIServiceStatus"}, "type": "object"}}}}}, "description": "Get Services Status.", "tags": ["Services"], "security": [], "parameters": [{"in": "query", "name": "ids", "required": true, "schema": {"type": "string"}}]}}, "/services/{id}": {"get": {"operationId": "_getService", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/APIService"}}}}}, "description": "Get service by id and version.", "tags": ["Services"], "security": [], "parameters": [{"description": "Service id", "in": "path", "name": "id", "required": true, "schema": {"type": "string"}}, {"description": "The service version", "in": "query", "name": "version", "required": false, "schema": {"type": "string"}}], "x-codeSamples": [{"lang": "Python", "source": "\n# \n# Get service to use in your code.\n# \n# **Prerequisites**: You must be in the role of an *owner* or *developer*. You must have a package.\n# \n# :param str service_name: optional - search by name\n# :param str service_id: optional - search by id\n# :param bool checkout: if true, checkout (switch) to service\n# :param fetch: optional - fetch entity from platform, default taken from cookie\n# :return: Service object\n# :rtype: dtlpy.entities.service.Service\n# \n# \n# service = package.services.get(service_id='service_id')\n# "}]}, "patch": {"operationId": "_updateService", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"anyOf": [{"$ref": "#/components/schemas/APIService"}, {"type": "string"}]}}}}}, "description": "Update service changes.", "tags": ["Services"], "security": [], "parameters": [{"description": "service id.", "in": "path", "name": "id", "required": true, "schema": {"type": "string"}}, {"description": "optional - force updated old replicas immediately\nif the value has set is true, it will go to services driver(kubernetes...) and restarting all the replicas without waiting", "in": "query", "name": "force", "required": false, "schema": {"type": "string"}}], "requestBody": {"required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/APIServicePatch"}}}}, "x-codeSamples": [{"lang": "Python", "source": "\n# \n# Update service changes to platform.\n# \n# **Prerequisites**: You must be in the role of an *owner* or *developer*. You must have a package.\n# \n# :param dtlpy.entities.service.Service service: Service entity\n# :param bool force: optional - terminate old replicas immediately\n# :return: Service entity\n# :rtype: dtlpy.entities.service.Service\n# \n# \n# service = package.services.update(service='service_entity')\n# "}]}, "delete": {"operationId": "_deleteService", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/APICommand"}}}}}, "description": "Delete Service.", "tags": ["Services"], "security": [], "parameters": [{"description": "Service id.", "in": "path", "name": "id", "required": true, "schema": {"type": "string"}}, {"in": "query", "name": "force", "required": false, "schema": {"type": "boolean"}}], "x-codeSamples": [{"lang": "Python", "source": "\n# \n# Delete Service object\n# \n# **Prerequisites**: You must be in the role of an *owner* or *developer*. You must have a package.\n# \n# You must provide at least ONE of the following params: service_id, service_name.\n# \n# :param force:\n# :param str service_name: by name\n# :param str service_id: by id\n# :return: True\n# :rtype: bool\n# \n# \n# is_deleted = package.services.delete(service_id='service_id')\n# "}]}}, "/services/{id}/debug": {"post": {"operationId": "_serviceDebug", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/APIService"}}}}}, "description": "Service debug stream", "tags": ["Services"], "security": [], "parameters": [{"in": "path", "name": "id", "required": true, "schema": {"type": "string"}}, {"in": "query", "name": "force", "required": true, "schema": {"type": "string"}}], "requestBody": {"required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/DebugSession"}}}}}}, "/services/{id}/debug(*)?": {"get": {"operationId": "_serviceStream", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"properties": {"token": {"type": "string"}, "url": {"type": "string"}}, "required": ["token", "url"], "type": "object"}}}}}, "description": "Service debug stream", "tags": ["Services"], "security": [], "parameters": [{"in": "path", "name": "id", "required": true, "schema": {"type": "string"}}]}}, "/services/{id}/integration-env": {"get": {"operationId": "_getServiceIntegrationEnv", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"properties": {"env": {"items": {"properties": {"value": {"type": "string"}, "key": {"type": "string"}}, "required": ["value", "key"], "type": "object"}, "type": "array"}}, "required": ["env"], "type": "object"}}}}}, "description": "Returns only the env key-values for the integrations listed in service.integrations.\nCallable by service bot or sudo with Piper auth (direct).", "tags": ["Services"], "security": [], "parameters": [{"in": "path", "name": "id", "required": true, "schema": {"type": "string"}}]}}, "/services/{id}/logs": {"post": {"operationId": "_getServiceLogs", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ServiceLogsPage"}}}}}, "description": "Get service logs.", "tags": ["Services"], "security": [], "parameters": [{"description": "Service id.", "in": "path", "name": "id", "required": true, "schema": {"type": "string"}}, {"in": "query", "name": "verbose", "required": true, "schema": {"type": "string"}}], "requestBody": {"required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/LogQuery"}}}}}}, "/services/{id}/notify": {"post": {"operationId": "_notify", "responses": {"204": {"description": "No content"}}, "tags": ["Services"], "security": [], "parameters": [{"in": "path", "name": "id", "required": true, "schema": {"type": "string"}}], "requestBody": {"required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/AgentNotificationPayload"}}}}}}, "/services/{id}/reports": {"post": {"operationId": "_receiveReports", "responses": {"204": {"description": "No content"}}, "description": "Receive a list of reports.", "tags": ["Services"], "security": [], "parameters": [{"in": "path", "name": "id", "required": true, "schema": {"type": "string"}}], "requestBody": {"required": true, "content": {"application/json": {"schema": {"items": {"$ref": "#/components/schemas/BaseReportMessage"}, "type": "array"}}}}}}, "/services/{id}/restart": {"post": {"operationId": "_restartService", "responses": {"204": {"description": "No content"}}, "description": "Restart service.", "tags": ["Services"], "security": [], "parameters": [{"description": "Service id.", "in": "path", "name": "id", "required": true, "schema": {"type": "string"}}, {"description": "Optional replica name.", "in": "query", "name": "replicaName", "required": false, "schema": {"type": "string"}}]}}, "/services/{id}/resume": {"post": {"operationId": "_resumeService", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"anyOf": [{"$ref": "#/components/schemas/APIService"}, {"type": "string"}]}}}}}, "description": "Resume service.", "tags": ["Services"], "security": [], "parameters": [{"description": "Service id.", "in": "path", "name": "id", "required": true, "schema": {"type": "string"}}, {"in": "query", "name": "force", "required": false, "schema": {"type": "string"}}], "x-codeSamples": [{"lang": "Python", "source": "\n# \n# Resume service.\n# \n# **Prerequisites**: You must be in the role of an *owner* or *developer*. You must have a package.\n# \n# You must provide at least ONE of the following params: service_id, service_name.\n# \n# :param str service_name: service name\n# :param str service_id: service id\n# :param bool force: optional - terminate old replicas immediately\n# :return: json of the service\n# :rtype: dict\n# \n# \n# service_json = package.services.resume(service_id='service_id')\n# "}]}}, "/services/{id}/revisions": {"get": {"operationId": "_getServiceRevisions", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"items": {"$ref": "#/components/schemas/APIService"}, "type": "array"}}}}}, "description": "Get service revisions by id.", "tags": ["Services"], "security": [], "parameters": [{"description": "service id.", "in": "path", "name": "id", "required": true, "schema": {"type": "string"}}], "x-codeSamples": [{"lang": "Python", "source": "\n# \n# Get service revisions history.\n# \n# **Prerequisites**: You must be in the role of an *owner* or *developer*. You must have a package.\n# \n# You must provide at leats ONE of the following params: service, service_id\n# \n# :param dtlpy.entities.service.Service service: Service entity\n# :param str service_id: service id\n# \n# \n# service_revision = package.services.revisions(service_id='service_id')\n# "}]}}, "/services/{id}/rollout": {"post": {"operationId": "_rolloutService", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/APIService"}}}}}, "description": "Rolling out service.", "tags": ["Services"], "security": [], "parameters": [{"description": "Service id.", "in": "path", "name": "id", "required": true, "schema": {"type": "string"}}], "requestBody": {"required": true, "content": {"application/json": {"schema": {"properties": {"version": {"type": "string"}}, "required": ["version"], "type": "object"}}}}}}, "/services/{id}/status": {"post": {"operationId": "_updateReplicaStatus", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/APIReplicaStatusUpdate"}}}}}, "description": "Update Replica Status.", "tags": ["Services"], "security": [], "parameters": [{"description": "Service id.", "in": "path", "name": "id", "required": true, "schema": {"type": "string"}}], "requestBody": {"required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/APIReplicaStatusUpdate"}}}}, "x-codeSamples": [{"lang": "Python", "source": "\n# \n# Get service status.\n# \n# **Prerequisites**: You must be in the role of an *owner* or *developer*. You must have a package.\n# \n# You must provide at least ONE of the following params: service_id, service_name\n# \n# :param str service_name: service name\n# :param str service_id: service id\n# :return: status json\n# :rtype: dict\n# \n# \n# status_json = package.services.status(service_id='service_id')\n# "}]}, "get": {"operationId": "_getServiceStatus", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/APIServiceStatus"}}}}}, "description": "Get service status.", "tags": ["Services"], "security": [], "parameters": [{"description": "Service id.", "in": "path", "name": "id", "required": true, "schema": {"type": "string"}}]}}, "/services/{id}/stop": {"post": {"operationId": "_stopService", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"anyOf": [{"$ref": "#/components/schemas/APIService"}, {"type": "string"}]}}}}}, "description": "Pause service.", "tags": ["Services"], "security": [], "parameters": [{"description": "Service id.", "in": "path", "name": "id", "required": true, "schema": {"type": "string"}}, {"description": "optional - terminate old replicas immediately", "in": "query", "name": "force", "required": false, "schema": {"type": "string"}}], "x-codeSamples": [{"lang": "Python", "source": "\n# \n# Pause service.\n# \n# **Prerequisites**: You must be in the role of an *owner* or *developer*. You must have a package.\n# \n# You must provide at least ONE of the following params: service_id, service_name\n# \n# :param str service_name: service name\n# :param str service_id: service id\n# :param bool force: optional - terminate old replicas immediately\n# :return: True if success\n# :rtype: bool\n# \n# \n# success = package.services.pause(service_id='service_id')\n# "}]}}, "/settings": {"post": {"operationId": "Create Setting", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"anyOf": [{"$ref": "#/components/schemas/APIFeatureFlag"}, {"$ref": "#/components/schemas/APIUserSetting"}]}}}}, "400": {"description": "Bad Request"}, "401": {"description": "Unauthorized"}, "403": {"description": "Forbidden"}, "404": {"description": "Not Found"}, "500": {"description": "Internal Server Error"}}, "description": "Creates a new Setting.\n\nSupply the appropriate Create Request object for either Feature flag or User setting.", "tags": ["Settings"], "security": [], "parameters": [], "requestBody": {"description": "The setting to create", "required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/CreateSettingRequest", "description": "The setting to create"}}}}}}, "/settings/query": {"post": {"operationId": "Query Settings", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/CursorPageAPISetting"}}}}, "400": {"description": "Bad Request"}, "401": {"description": "Unauthorized"}, "403": {"description": "Forbidden"}, "404": {"description": "Not Found"}, "500": {"description": "Internal Server Error"}}, "description": "Query settings\n\nSupply the query requested to query settings", "tags": ["Settings"], "security": [], "parameters": [], "requestBody": {"description": "The query", "required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/QueryModel", "description": "The query"}}}}}}, "/settings/resolve": {"post": {"operationId": "Resolve Settings", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"items": {"anyOf": [{"$ref": "#/components/schemas/APIFeatureFlag"}, {"$ref": "#/components/schemas/APIUserSetting"}]}, "type": "array"}}}}, "400": {"description": "Bad Request"}, "500": {"description": "Internal Server Error"}}, "description": "Resolves the relevant settings for a specific Context.\n\nSupply the specific Context to resolve by", "tags": ["Settings"], "security": [], "parameters": [], "requestBody": {"description": "The context to resolve by", "required": true, "content": {"application/json": {"schema": {"anyOf": [{"$ref": "#/components/schemas/ResolverPayload"}, {"$ref": "#/components/schemas/IUserContext"}], "description": "The context to resolve by"}}}}}}, "/settings/{id}": {"get": {"operationId": "Get Setting", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"anyOf": [{"$ref": "#/components/schemas/APIFeatureFlag"}, {"$ref": "#/components/schemas/APIUserSetting"}]}}}}, "400": {"description": "Bad Request"}, "401": {"description": "Unauthorized"}, "403": {"description": "Forbidden"}, "404": {"description": "Not Found"}, "500": {"description": "Internal Server Error"}}, "description": "Retrieves the details of a setting.\n\nSupply the unique setting ID to fetch it's details.", "tags": ["Settings"], "security": [], "parameters": [{"description": "ID of the Setting to fetch", "in": "path", "name": "id", "required": true, "schema": {"type": "string"}}]}, "patch": {"operationId": "Update Setting", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"anyOf": [{"$ref": "#/components/schemas/APIFeatureFlag"}, {"$ref": "#/components/schemas/APIUserSetting"}]}}}}, "400": {"description": "Bad Request"}, "401": {"description": "Unauthorized"}, "403": {"description": "Forbidden"}, "404": {"description": "Not Found"}, "500": {"description": "Internal Server Error"}}, "description": "Update a setting\n\nSupply the unique id of the setting to update and an object describing which fields update", "tags": ["Settings"], "security": [], "parameters": [{"description": "ID of the Setting to update", "in": "path", "name": "id", "required": true, "schema": {"type": "string"}}], "requestBody": {"description": "The values to update with", "required": true, "content": {"application/json": {"schema": {"anyOf": [{"$ref": "#/components/schemas/PatchFeatureFlagRequest"}, {"$ref": "#/components/schemas/PatchUserSettingRequest"}], "description": "The values to update with"}}}}}, "delete": {"operationId": "Delete Setting", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"type": "string"}}}}, "400": {"description": "Bad Request"}, "401": {"description": "Unauthorized"}, "403": {"description": "Forbidden"}, "404": {"description": "Not Found"}, "500": {"description": "Internal Server Error"}}, "description": "Delete a setting\n\nSupply the unique id of the setting to delete", "tags": ["Settings"], "security": [], "parameters": [{"description": "ID of the Setting to delete", "in": "path", "name": "id", "required": true, "schema": {"type": "string"}}], "requestBody": {"required": false, "content": {"application/json": {"schema": {"properties": {"force": {"type": "boolean"}}, "type": "object"}}}}}}, "/subscriptions": {"get": {"operationId": "List Subscriptions", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/CursorPage_APISubscription_"}}}}}, "tags": ["Subscriptions"], "security": [], "parameters": [{"in": "query", "name": "account", "required": false, "schema": {"type": "string"}}, {"in": "query", "name": "org", "required": false, "schema": {"type": "string"}}, {"in": "query", "name": "pageOffset", "required": false, "schema": {"format": "double", "type": "number"}}, {"in": "query", "name": "pageSize", "required": false, "schema": {"format": "double", "type": "number"}}, {"in": "query", "name": "status", "required": false, "schema": {"type": "string"}}]}}, "/subscriptions/{id}": {"get": {"operationId": "Get Subscription", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/APISubscription"}}}}}, "tags": ["Subscriptions"], "security": [], "parameters": [{"in": "path", "name": "id", "required": true, "schema": {"type": "string"}}]}}, "/tasks": {"post": {"operationId": "Create Task", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"anyOf": [{"$ref": "#/components/schemas/APITask"}, {"$ref": "#/components/schemas/APICommand"}]}}}}}, "description": "Create a new Task", "tags": ["Tasks"], "security": [], "parameters": [], "requestBody": {"description": ": Task creation payload", "required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/TaskPayload", "description": ": Task creation payload"}}}}}, "get": {"operationId": "Find Tasks", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/APITaskCursor"}}}}}, "description": "Find tasks by query", "tags": ["Tasks"], "security": [], "parameters": [{"description": "- An array of project IDs", "in": "query", "name": "projects", "required": false, "schema": {"type": "array", "items": {"type": "string"}}}, {"description": "- Find by dataset", "in": "query", "name": "dataset", "required": false, "schema": {"type": "string"}}, {"description": "- Find by recipe", "in": "query", "name": "recipe", "required": false, "schema": {"type": "string"}}, {"description": "- Find by task status", "in": "query", "name": "status", "required": false, "schema": {"type": "string"}}, {"description": "- Filter by creator", "in": "query", "name": "creator", "required": false, "schema": {"type": "string"}}, {"description": "- Filter by task owner", "in": "query", "name": "taskOwner", "required": false, "schema": {"type": "string"}}, {"description": "- Find by task name", "in": "query", "name": "name", "required": false, "schema": {"type": "string"}}, {"description": "- Due date lower limit", "in": "query", "name": "minDate", "required": false, "schema": {"format": "double", "type": "number"}}, {"description": "- Due date upper limit", "in": "query", "name": "maxDate", "required": false, "schema": {"format": "double", "type": "number"}}, {"description": "- An array of assignment IDs", "in": "query", "name": "assignments", "required": false, "schema": {"type": "array", "items": {"type": "string"}}}, {"description": "- The number of pages to skip from the start", "in": "query", "name": "pageOffset", "required": false, "schema": {"format": "double", "type": "number"}}, {"description": "- How many tasks in one page", "in": "query", "name": "pageSize", "required": false, "schema": {"format": "double", "type": "number"}}, {"description": "- Filter by parent task", "in": "query", "name": "parentTaskId", "required": false, "schema": {"type": "string"}}, {"description": "- Filter by task type - Annotation or QA", "in": "query", "name": "type", "required": false, "schema": {"type": "string"}}, {"in": "query", "name": "archive", "required": false, "schema": {"type": "boolean"}}]}}, "/tasks/count": {"post": {"operationId": "Get Projects Active Counters", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/APITaskCounters"}}}}}, "description": "For org admin / owner:\nGet active counters for projects", "tags": ["Tasks"], "security": [], "parameters": [], "requestBody": {"required": true, "content": {"application/json": {"schema": {"properties": {"datasetId": {"type": "string"}, "projectIds": {"items": {"type": "string"}, "type": "array"}}, "required": ["projectIds"], "type": "object"}}}}}}, "/tasks/projects/{projectId}/counters": {"post": {"operationId": "Get counters for project", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/WorkflowsCounters"}}}}}, "description": "Get counters for project", "tags": ["Tasks"], "security": [], "parameters": [{"description": ": Project id", "in": "path", "name": "projectId", "required": true, "schema": {"type": "string"}}], "requestBody": {"required": true, "content": {"application/json": {"schema": {"properties": {"contributors": {"items": {"type": "string"}, "type": "array"}}, "type": "object"}}}}}}, "/tasks/projects/{projectId}/datasets/{datasetId}/actions": {"get": {"operationId": "Get Dataset Actions", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"items": {"$ref": "#/components/schemas/ItemAction"}, "type": "array"}}}}, "400": {"description": "Missing or Invalid dataset id"}, "404": {"description": "Dataset not found"}}, "description": "Get all actions(statuses) related to the required dataset", "tags": ["Tasks"], "security": [], "parameters": [{"description": ": Project ID", "in": "path", "name": "projectId", "required": true, "schema": {"type": "string"}}, {"description": ": Dataset ID", "in": "path", "name": "datasetId", "required": true, "schema": {"type": "string"}}]}}, "/tasks/query": {"post": {"operationId": "Query Tasks", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/CursorPage_any_"}}}}}, "tags": ["Tasks"], "security": [], "parameters": [], "requestBody": {"required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/QueryFilter"}}}}}}, "/tasks/{id}": {"patch": {"operationId": "Update Task", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/APITask"}}}}}, "description": "Update an existing task", "tags": ["Tasks"], "security": [], "parameters": [{"description": ": Task ID", "in": "path", "name": "id", "required": true, "schema": {"type": "string"}}], "requestBody": {"description": ": The fields to update", "required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/PartialTaskPayload", "description": ": The fields to update"}}}}}, "get": {"operationId": "Get Task", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/APITask"}}}}, "400": {"description": "Missing or Invalid id"}, "404": {"description": "Task not found"}}, "description": "Get a specific task", "tags": ["Tasks"], "security": [], "parameters": [{"description": ": Task ID", "in": "path", "name": "id", "required": true, "schema": {"type": "string"}}]}, "delete": {"operationId": "Delete Task", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"anyOf": [{}, {"$ref": "#/components/schemas/APICommand"}]}}}}}, "description": "Delete a task", "tags": ["Tasks"], "security": [], "parameters": [{"description": ": Task ID", "in": "path", "name": "id", "required": true, "schema": {"type": "string"}}], "requestBody": {"required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/DeleteTaskPayload"}}}}}}, "/tasks/{id}/addToTask": {"post": {"operationId": "Add Items to Task", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"anyOf": [{"$ref": "#/components/schemas/APITask"}, {"$ref": "#/components/schemas/APICommand"}]}}}}}, "description": "Add work to an existing Task", "tags": ["Tasks"], "security": [], "parameters": [{"in": "path", "name": "id", "required": true, "schema": {"type": "string"}}], "requestBody": {"description": ": Task update payload", "required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/AddToTaskPayload", "description": ": Task update payload"}}}}}}, "/tasks/{id}/contributors": {"post": {"operationId": "Update Task Contributors", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/APITask"}}}}}, "description": "Update task contributors", "tags": ["Tasks"], "security": [], "parameters": [{"description": ": Task ID", "in": "path", "name": "id", "required": true, "schema": {"type": "string"}}], "requestBody": {"description": ": Task update payload", "required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/UpdateContributorsPayload", "description": ": Task update payload"}}}}}}, "/tasks/{id}/queue": {"get": {"operationId": "Get Task Queue Details", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/TaskQueueDetails"}}}}, "400": {"description": "Missing or Invalid id"}, "404": {"description": "Task not found"}}, "description": "Get a specific task's queue details", "tags": ["Tasks"], "security": [], "parameters": [{"description": ": Task ID", "in": "path", "name": "id", "required": true, "schema": {"type": "string"}}]}}, "/tasks/{id}/relatives": {"get": {"operationId": "Get Task Relatives", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"items": {"$ref": "#/components/schemas/TaskRelativeInput"}, "type": "array"}}}}, "400": {"description": "Missing or Invalid id"}, "404": {"description": "Task not found"}}, "description": "Get the relative task names of a specific task", "tags": ["Tasks"], "security": [], "parameters": [{"description": ": Task ID", "in": "path", "name": "id", "required": true, "schema": {"type": "string"}}]}}, "/tasks/{id}/removeFromTask": {"post": {"operationId": "Remove Items from Task", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"anyOf": [{"$ref": "#/components/schemas/APICommand"}, {"$ref": "#/components/schemas/APITask"}]}}}}}, "description": "Remove work from an existing Task", "tags": ["Tasks"], "security": [], "parameters": [{"in": "path", "name": "id", "required": true, "schema": {"type": "string"}}], "requestBody": {"description": ": Task update payload", "required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/RemoveFromTaskPayload", "description": ": Task update payload"}}}}}}, "/trigger-resource-information": {"post": {"operationId": "_queryTriggerResourceInformation", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/TriggerResourceInformationPage"}}}}}, "tags": ["TriggerResourceInformation"], "security": [], "parameters": [{"in": "query", "name": "pageOffset", "required": false, "schema": {"format": "double", "type": "number"}}, {"in": "query", "name": "pageSize", "required": false, "schema": {"format": "double", "type": "number"}}], "requestBody": {"required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/TriggerResourceInformationQuery"}}}}}}, "/triggers": {"get": {"operationId": "_listTriggers", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/TriggersPage"}}}}}, "description": "Retrieves services.\n\nSupply query parameters to filter the list.", "tags": ["Triggers"], "security": [], "parameters": [{"in": "query", "name": "type", "required": false, "schema": {"$ref": "#/components/schemas/TriggerType"}}, {"in": "query", "name": "name", "required": false, "schema": {"type": "string"}}, {"in": "query", "name": "projectsQuery", "required": false, "schema": {"type": "string"}}, {"in": "query", "name": "resource", "required": false, "schema": {"type": "string"}}, {"in": "query", "name": "active", "required": false, "schema": {"type": "boolean"}}, {"in": "query", "name": "executionMode", "required": false, "schema": {"type": "string"}}, {"in": "query", "name": "serviceId", "required": false, "schema": {"type": "string"}}, {"in": "query", "name": "webhookId", "required": false, "schema": {"type": "string"}}, {"in": "query", "name": "operationType", "required": false, "schema": {"type": "string"}}, {"in": "query", "name": "entity", "required": false, "schema": {"type": "string"}}, {"in": "query", "name": "action", "required": false, "schema": {"type": "string"}}, {"in": "query", "name": "pageOffset", "required": false, "schema": {"format": "double", "type": "number"}}, {"in": "query", "name": "pageSize", "required": false, "schema": {"format": "double", "type": "number"}}]}, "post": {"operationId": "_createTrigger", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/APITrigger"}}}}}, "description": "Create a Trigger. Can create two types: a cron trigger or an event trigger.\nInputs are different for each type", "tags": ["Triggers"], "security": [], "parameters": [], "requestBody": {"required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/CreateTriggerRequest"}}}}, "x-codeSamples": [{"lang": "Python", "source": "\n# \n# Create a Trigger. Can create two types: a cron trigger or an event trigger.\n# Inputs are different for each type\n# \n# **Prerequisites**: You must be in the role of an *owner* or *developer*. You must have a service.\n# \n# Inputs for all types:\n# \n# :param str service_id: Id of services to be triggered\n# :param str trigger_type: can be cron or event. use enum dl.TriggerType for the full list\n# :param str name: name of the trigger\n# :param str webhook_id: id for webhook to be called\n# :param str  function_name: the function name to be called when triggered (must be defined in the package)\n# :param str  project_id: project id where trigger will work\n# :param bool active: optional - True/False, default = True, if true trigger is active\n# \n# Inputs for event trigger:\n# :param dtlpy.entities.filters.Filters filters: optional - Item/Annotation metadata filters, default = none\n# :param str resource: optional - Dataset/Item/Annotation/ItemStatus, default = Item\n# :param str actions: optional - Created/Updated/Deleted, default = create\n# :param str execution_mode: how many times trigger should be activated; default is \"Once\". enum dl.TriggerExecutionMode\n# \n# Inputs for cron trigger:\n# :param start_at: iso format date string to start activating the cron trigger\n# :param end_at: iso format date string to end the cron activation\n# :param inputs: dictionary \"name\":\"val\" of inputs to the function\n# :param str cron: cron spec specifying when it should run. more information: https://en.wikipedia.org/wiki/Cron\n# :param str pipeline_id: Id of pipeline to be triggered\n# :param pipeline: pipeline entity to be triggered\n# :param str pipeline_node_id: Id of pipeline root node to be triggered\n# :param root_node_namespace: namespace of pipeline root node to be triggered\n# \n# :return: Trigger entity\n# :rtype: dtlpy.entities.trigger.Trigger\n# \n# \n# service.triggers.create(name='triggername',\n# execution_mode=dl.TriggerExecutionMode.ONCE,\n# resource='Item',\n# actions='Created',\n# function_name='run',\n# filters={'$and': [{'hidden': False},\n# {'type': 'file'}]}\n# )\n# "}]}}, "/triggers/{id}": {"get": {"operationId": "_getTrigger", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/APITrigger"}}}}}, "description": "Get trigger by id.\nSupply query parameters to filter the list.", "tags": ["Triggers"], "security": [], "parameters": [{"description": "Trigger id.", "in": "path", "name": "id", "required": true, "schema": {"type": "string"}}], "x-codeSamples": [{"lang": "Python", "source": "\n# \n# Get Trigger object\n# \n# **Prerequisites**: You must be in the role of an *owner* or *developer*. You must have a service.\n# \n# :param str trigger_id: trigger id\n# :param str  trigger_name: trigger name\n# :return: Trigger entity\n# :rtype: dtlpy.entities.trigger.Trigger\n# \n# \n# service.triggers.get(trigger_id='trigger_id')\n# "}]}, "patch": {"operationId": "_updateTrigger", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/APITrigger"}}}}}, "description": "Update trigger.", "tags": ["Triggers"], "security": [], "parameters": [{"description": "Trigger Id.", "in": "path", "name": "id", "required": true, "schema": {"type": "string"}}], "requestBody": {"required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/APITrigger"}}}}, "x-codeSamples": [{"lang": "Python", "source": "\n# \n# Update trigger\n# \n# **Prerequisites**: You must be in the role of an *owner* or *developer*. You must have a service.\n# \n# :param dtlpy.entities.trigger.Trigger trigger: Trigger entity\n# :return: Trigger entity\n# :rtype: dtlpy.entities.trigger.Trigger\n# \n# \n# service.triggers.update(trigger='trigger_entity')\n# "}]}, "delete": {"operationId": "_deleteTriggers", "responses": {"204": {"description": "No content"}}, "description": "Delete Trigger.", "tags": ["Triggers"], "security": [], "parameters": [{"description": "Trigger Id.", "in": "path", "name": "id", "required": true, "schema": {"type": "string"}}], "x-codeSamples": [{"lang": "Python", "source": "\n# \n# Delete Trigger object\n# \n# **Prerequisites**: You must be in the role of an *owner* or *developer*. You must have a service.\n# \n# :param str trigger_id: trigger id\n# :param str trigger_name: trigger name\n# :return: True is successful error if not\n# :rtype: bool\n# \n# \n# service.triggers.delete(trigger_id='trigger_id')\n# "}]}}, "/ui-status": {"get": {"operationId": "Get OA Version", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/IVersion"}}}}}, "description": "Retrieves the latest OA versions.", "tags": ["Version"], "security": [], "parameters": []}}, "/usage/accounts/{id}": {"get": {"operationId": "Get Account Usage Report", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"items": {"$ref": "#/components/schemas/UsageReport"}, "type": "array"}}}}}, "tags": ["Usage"], "security": [], "parameters": [{"in": "path", "name": "id", "required": true, "schema": {"type": "string"}}, {"in": "query", "name": "startDate", "required": true, "schema": {"type": "string"}}, {"in": "query", "name": "endDate", "required": true, "schema": {"type": "string"}}]}}, "/usage/accounts/{id}/resources": {"get": {"operationId": "Get Account Usage Resources Report", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/UsageResourcesReport"}}}}}, "tags": ["Usage"], "security": [], "parameters": [{"in": "path", "name": "id", "required": true, "schema": {"type": "string"}}, {"in": "query", "name": "startDate", "required": true, "schema": {"type": "string"}}, {"in": "query", "name": "endDate", "required": true, "schema": {"type": "string"}}]}}, "/usage/orgs/{id}": {"get": {"operationId": "Get Org Usage CSV", "responses": {"204": {"description": "No content"}}, "tags": ["Usage"], "security": [], "parameters": [{"in": "path", "name": "id", "required": true, "schema": {"type": "string"}}, {"in": "query", "name": "startDate", "required": true, "schema": {"type": "string"}}, {"in": "query", "name": "endDate", "required": true, "schema": {"type": "string"}}]}}, "/users/groupsProjects": {"get": {"operationId": "Get my group projects", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"items": {"properties": {"role": {"$ref": "#/components/schemas/Role"}, "project": {"type": "string"}}, "required": ["role", "project"], "type": "object"}, "type": "array"}}}}}, "tags": ["Users"], "security": [], "parameters": []}}, "/users/me": {"get": {"operationId": "Get me", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/APIUser"}}}}}, "tags": ["Users"], "security": [], "parameters": []}, "post": {"operationId": "Update my details", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/APIUser"}, "examples": {"Example 1": {"value": {"org": "myActiveOrgId"}}}}}}}, "tags": ["Users"], "security": [], "parameters": [], "requestBody": {"required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/updateMyDetailsPayload"}}}}}}, "/users/orgs": {"get": {"operationId": "Get my orgs", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"items": {"$ref": "#/components/schemas/APIOrgUser"}, "type": "array"}}}}}, "tags": ["Users"], "security": [], "parameters": []}}, "/users/{userId}": {"get": {"operationId": "Get user", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/APIUser"}}}}}, "description": "Returns details of the logged in user", "tags": ["Users"], "security": [], "parameters": [{"in": "path", "name": "userId", "required": true, "schema": {"type": "string"}}]}}, "/users/{userId}/org": {"patch": {"operationId": "Update user org", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"anyOf": [{"$ref": "#/components/schemas/APIUser"}, {}]}, "examples": {"Example 1": {"value": {"org_id": "myActiveOrgId", "skipResponse": true}}}}}}}, "description": "Change or add org to user", "tags": ["Users"], "security": [], "parameters": [{"in": "path", "name": "userId", "required": true, "schema": {"type": "string"}}], "requestBody": {"required": true, "content": {"application/json": {"schema": {"properties": {"skipResponse": {"type": "boolean"}, "org_id": {"type": "string"}}, "required": ["skipResponse", "org_id"], "type": "object"}}}}}}, "/webhooks": {"get": {"operationId": "_listWebHooks", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/WebHooksPage"}}}}}, "tags": ["WebHooks"], "security": [], "parameters": [{"in": "query", "name": "pageOffset", "required": false, "schema": {"format": "double", "type": "number"}}, {"in": "query", "name": "pageSize", "required": false, "schema": {"format": "double", "type": "number"}}]}, "post": {"operationId": "_createWebHook", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/APIWebHook"}}}}}, "tags": ["WebHooks"], "security": [], "parameters": [], "requestBody": {"required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/CreateWebHookDTO"}}}}}}, "/webhooks/{ids}": {"delete": {"operationId": "_deleteWebHooks", "responses": {"204": {"description": "No content"}}, "tags": ["WebHooks"], "security": [], "parameters": [{"in": "path", "name": "ids", "required": true, "schema": {"type": "string"}}]}}, "/webhooks/{id}": {"get": {"operationId": "_getWebHook", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/APIWebHook"}}}}}, "tags": ["WebHooks"], "security": [], "parameters": [{"in": "path", "name": "id", "required": true, "schema": {"type": "string"}}]}, "patch": {"operationId": "_updateWebHook", "responses": {"200": {"description": "Ok", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/APIWebHook"}}}}}, "tags": ["WebHooks"], "security": [], "parameters": [{"in": "path", "name": "id", "required": true, "schema": {"type": "string"}}], "requestBody": {"required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/UpdateWebHookDTO"}}}}}}}, "servers": [{"url": "https://gate.dataloop.ai/api/v1", "description": "Main Dataloop Gateway"}], "basePath": "/api/v1", "host": "gate.dataloop.ai", "schemes": ["https"], "security": [{"bearerAuth": []}]}