Skip to content
This repository has been archived by the owner on Jul 24, 2023. It is now read-only.

Latest commit

 

History

History
2170 lines (1462 loc) · 74.2 KB

AIAPI.md

File metadata and controls

2170 lines (1462 loc) · 74.2 KB

AIAPI

All URIs are relative to https://elements.local

Method HTTP request Description
abortAIDatasetModelCreation POST /api/2/ai/models/{id}/abort
activateAIModel POST /api/2/ai/models/{id}/activate
createAIAnnotationTrack POST /api/2/ai/annotations/tracks/create
createAICategory POST /api/2/ai/categories
createAIDataset POST /api/2/ai/datasets
createAIDatasetModel POST /api/2/ai/models/create
createAIMetadata POST /api/2/ai/metadata/create
createAIModel POST /api/2/ai/models
deleteAIAnnotation DELETE /api/2/ai/annotations/{id}
deleteAIAnnotationTrack DELETE /api/2/ai/annotations/tracks/{id}
deleteAICategory DELETE /api/2/ai/categories/{id}
deleteAIDataset DELETE /api/2/ai/datasets/{id}
deleteAIModel DELETE /api/2/ai/models/{id}
exportAIDataset POST /api/2/ai/datasets/{id}/export
exportAIModel POST /api/2/ai/models/{id}/export
getAIAnnotation GET /api/2/ai/annotations/{id}
getAIAnnotationImage GET /api/2/ai/annotations/{id}/image
getAICategory GET /api/2/ai/categories/{id}
getAIConnection GET /api/2/ai/connections/{id}
getAIDataset GET /api/2/ai/datasets/{id}
getAIImage GET /api/2/ai/images/{id}
getAIImageContent GET /api/2/ai/images/{id}/content
getAIMetadata GET /api/2/ai/metadata/{id}
getAIModel GET /api/2/ai/models/{id}
getAllAIAnnotationTracks GET /api/2/ai/annotations/tracks
getAllAIAnnotations GET /api/2/ai/annotations
getAllAICategories GET /api/2/ai/categories
getAllAIConnections GET /api/2/ai/connections
getAllAIDatasets GET /api/2/ai/datasets
getAllAIImages GET /api/2/ai/images
getAllAIMetadata GET /api/2/ai/metadata
getAllAIModels GET /api/2/ai/models
importAIDatasets POST /api/2/ai/datasets/import
importAIModels POST /api/2/ai/datasets/{id}/import-models
patchAIAnnotation PATCH /api/2/ai/annotations/{id}
patchAICategory PATCH /api/2/ai/categories/{id}
patchAIDataset PATCH /api/2/ai/datasets/{id}
patchAIModel PATCH /api/2/ai/models/{id}
runAIModelInference POST /api/2/ai/models/{id}/inference
updateAIAnnotation PUT /api/2/ai/annotations/{id}
updateAICategory PUT /api/2/ai/categories/{id}
updateAIDataset PUT /api/2/ai/datasets/{id}
updateAIModel PUT /api/2/ai/models/{id}
uploadAIImage POST /api/2/ai/images/upload

abortAIDatasetModelCreation

    open class func abortAIDatasetModelCreation( id: UUID) -> Promise<Void>

Required permissions * User account permission: media:access (read) / media:roots:manage (write)

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let id = 987 // UUID | A UUID string identifying this AI Model.

AIAPI.abortAIDatasetModelCreation(id: id).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
id UUID A UUID string identifying this AI Model.

Return type

Void (empty response body)

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

activateAIModel

    open class func activateAIModel( id: UUID) -> Promise<Void>

Required permissions * User account permission: media:access (read) / media:roots:manage (write)

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let id = 987 // UUID | A UUID string identifying this AI Model.

AIAPI.activateAIModel(id: id).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
id UUID A UUID string identifying this AI Model.

Return type

Void (empty response body)

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

createAIAnnotationTrack

    open class func createAIAnnotationTrack( aIAnnotationCreateRequest: AIAnnotationCreateRequest) -> Promise<[AIAnnotation]>

Required permissions * User account permission: None (read) / media:roots:manage (write)

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let aIAnnotationCreateRequest = AIAnnotationCreateRequest(proxy: 123, category: 123, frame: 123, relativeLeft: 123, relativeTop: 123, relativeWidth: 123, relativeHeight: 123) // AIAnnotationCreateRequest | 

AIAPI.createAIAnnotationTrack(aIAnnotationCreateRequest: aIAnnotationCreateRequest).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
aIAnnotationCreateRequest AIAnnotationCreateRequest

Return type

[AIAnnotation]

Authorization

Bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

createAICategory

    open class func createAICategory( aICategoryDetailUpdate: AICategoryDetailUpdate) -> Promise<AICategoryDetail>

Required permissions * User account permission: None (read) / media:roots:manage (write)

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let aICategoryDetailUpdate = AICategoryDetailUpdate(dataset: AIDatasetDetailReference(id: 123, trainingModel: AIModel(id: 123, state: 123, progress: AIModelProgress(status: "TODO", eta: Date()), dataset: AIDatasetReference(id: 123, name: "name_example", type: "type_example", connection: 123), parameters: "TODO", logPath: "logPath_example", name: "name_example", createdAt: Date(), active: false, trainingTaskId: "trainingTaskId_example", threshold: 123, epoch: 123, preprocessingTask: "preprocessingTask_example"), lastFinishedModel: nil, lastChange: Date(), name: "name_example", type: "type_example", connection: 123), name: "name_example") // AICategoryDetailUpdate | 

AIAPI.createAICategory(aICategoryDetailUpdate: aICategoryDetailUpdate).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
aICategoryDetailUpdate AICategoryDetailUpdate

Return type

AICategoryDetail

Authorization

Bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

createAIDataset

    open class func createAIDataset( aIDatasetWithPreviewUpdate: AIDatasetWithPreviewUpdate) -> Promise<AIDatasetWithPreview>

Required permissions * User account permission: None (read) / media:roots:manage (write)

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let aIDatasetWithPreviewUpdate = AIDatasetWithPreviewUpdate(name: "name_example", type: "type_example", connection: 123) // AIDatasetWithPreviewUpdate | 

AIAPI.createAIDataset(aIDatasetWithPreviewUpdate: aIDatasetWithPreviewUpdate).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
aIDatasetWithPreviewUpdate AIDatasetWithPreviewUpdate

Return type

AIDatasetWithPreview

Authorization

Bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

createAIDatasetModel

    open class func createAIDatasetModel( aIModelTrainingRequest: AIModelTrainingRequest) -> Promise<AIModel>

Required permissions * User account permission: media:access (read) / media:roots:manage (write)

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let aIModelTrainingRequest = AIModelTrainingRequest(name: "name_example", dataset: 123, categories: [123], continueFrom: 123, parameters: "TODO") // AIModelTrainingRequest | 

AIAPI.createAIDatasetModel(aIModelTrainingRequest: aIModelTrainingRequest).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
aIModelTrainingRequest AIModelTrainingRequest

Return type

AIModel

Authorization

Bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

createAIMetadata

    open class func createAIMetadata( aIProcessingRequest: AIProcessingRequest) -> Promise<Void>

Required permissions * User account permission: media:access

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let aIProcessingRequest = AIProcessingRequest(assets: [123], directories: [123], datasets: [123], preferredProxyProfile: 123) // AIProcessingRequest | 

AIAPI.createAIMetadata(aIProcessingRequest: aIProcessingRequest).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
aIProcessingRequest AIProcessingRequest

Return type

Void (empty response body)

Authorization

Bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

createAIModel

    open class func createAIModel( aIModelUpdate: AIModelUpdate) -> Promise<AIModel>

Required permissions * User account permission: media:access (read) / media:roots:manage (write)

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let aIModelUpdate = AIModelUpdate(dataset: AIDatasetReference(id: 123, name: "name_example", type: "type_example", connection: 123), parameters: "TODO", name: "name_example", trainingTaskId: "trainingTaskId_example", threshold: 123, epoch: 123, preprocessingTask: "preprocessingTask_example") // AIModelUpdate | 

AIAPI.createAIModel(aIModelUpdate: aIModelUpdate).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
aIModelUpdate AIModelUpdate

Return type

AIModel

Authorization

Bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

deleteAIAnnotation

    open class func deleteAIAnnotation( id: UUID) -> Promise<Void>

Required permissions * User account permission: None (read) / media:roots:manage (write)

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let id = 987 // UUID | A UUID string identifying this AI Annotation.

AIAPI.deleteAIAnnotation(id: id).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
id UUID A UUID string identifying this AI Annotation.

Return type

Void (empty response body)

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

deleteAIAnnotationTrack

    open class func deleteAIAnnotationTrack( id: UUID) -> Promise<Void>

Required permissions * User account permission: None (read) / media:roots:manage (write)

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let id = 987 // UUID | A UUID string identifying this AI Annotation.

AIAPI.deleteAIAnnotationTrack(id: id).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
id UUID A UUID string identifying this AI Annotation.

Return type

Void (empty response body)

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

deleteAICategory

    open class func deleteAICategory( id: UUID) -> Promise<Void>

Required permissions * User account permission: None (read) / media:roots:manage (write)

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let id = 987 // UUID | A UUID string identifying this AI Category.

AIAPI.deleteAICategory(id: id).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
id UUID A UUID string identifying this AI Category.

Return type

Void (empty response body)

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

deleteAIDataset

    open class func deleteAIDataset( id: UUID) -> Promise<Void>

Required permissions * User account permission: None (read) / media:roots:manage (write)

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let id = 987 // UUID | A UUID string identifying this AI Dataset.

AIAPI.deleteAIDataset(id: id).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
id UUID A UUID string identifying this AI Dataset.

Return type

Void (empty response body)

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

deleteAIModel

    open class func deleteAIModel( id: UUID) -> Promise<Void>

Required permissions * User account permission: media:access (read) / media:roots:manage (write)

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let id = 987 // UUID | A UUID string identifying this AI Model.

AIAPI.deleteAIModel(id: id).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
id UUID A UUID string identifying this AI Model.

Return type

Void (empty response body)

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

exportAIDataset

    open class func exportAIDataset( id: UUID,  aIDatasetExportRequest: AIDatasetExportRequest) -> Promise<AIDatasetExportResponse>

Required permissions * User account permission: None (read) / media:roots:manage (write)

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let id = 987 // UUID | A UUID string identifying this AI Dataset.
let aIDatasetExportRequest = AIDatasetExportRequest(path: "path_example") // AIDatasetExportRequest | 

AIAPI.exportAIDataset(id: id, aIDatasetExportRequest: aIDatasetExportRequest).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
id UUID A UUID string identifying this AI Dataset.
aIDatasetExportRequest AIDatasetExportRequest

Return type

AIDatasetExportResponse

Authorization

Bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

exportAIModel

    open class func exportAIModel( id: UUID,  aIModelExportRequest: AIModelExportRequest) -> Promise<AIModelExportResponse>

Required permissions * User account permission: media:access (read) / media:roots:manage (write)

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let id = 987 // UUID | A UUID string identifying this AI Model.
let aIModelExportRequest = AIModelExportRequest(path: "path_example") // AIModelExportRequest | 

AIAPI.exportAIModel(id: id, aIModelExportRequest: aIModelExportRequest).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
id UUID A UUID string identifying this AI Model.
aIModelExportRequest AIModelExportRequest

Return type

AIModelExportResponse

Authorization

Bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getAIAnnotation

    open class func getAIAnnotation( id: UUID,  includeTransformsForAsset: Int? = nil) -> Promise<AIAnnotation>

Required permissions * User account permission: None (read) / media:roots:manage (write)

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let id = 987 // UUID | A UUID string identifying this AI Annotation.
let includeTransformsForAsset = 987 // Int |  (optional)

AIAPI.getAIAnnotation(id: id, includeTransformsForAsset: includeTransformsForAsset).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
id UUID A UUID string identifying this AI Annotation.
includeTransformsForAsset Int [optional]

Return type

AIAnnotation

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getAIAnnotationImage

    open class func getAIAnnotationImage( id: UUID) -> Promise<Void>

Required permissions * User account permission: None (read) / media:roots:manage (write)

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let id = 987 // UUID | A UUID string identifying this AI Annotation.

AIAPI.getAIAnnotationImage(id: id).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
id UUID A UUID string identifying this AI Annotation.

Return type

Void (empty response body)

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getAICategory

    open class func getAICategory( id: UUID) -> Promise<AICategoryDetail>

Required permissions * User account permission: None (read) / media:roots:manage (write)

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let id = 987 // UUID | A UUID string identifying this AI Category.

AIAPI.getAICategory(id: id).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
id UUID A UUID string identifying this AI Category.

Return type

AICategoryDetail

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getAIConnection

    open class func getAIConnection( id: Int) -> Promise<AIConnection>

Required permissions * <class 'rest_framework.permissions.AllowAny'>

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let id = 987 // Int | A unique integer value identifying this AI Connection.

AIAPI.getAIConnection(id: id).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
id Int A unique integer value identifying this AI Connection.

Return type

AIConnection

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getAIDataset

    open class func getAIDataset( id: UUID) -> Promise<AIDatasetWithPreview>

Required permissions * User account permission: None (read) / media:roots:manage (write)

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let id = 987 // UUID | A UUID string identifying this AI Dataset.

AIAPI.getAIDataset(id: id).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
id UUID A UUID string identifying this AI Dataset.

Return type

AIDatasetWithPreview

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getAIImage

    open class func getAIImage( id: UUID) -> Promise<AIImage>

Required permissions * User account permission: None (read) / media:roots:manage (write)

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let id = 987 // UUID | A UUID string identifying this AI Image.

AIAPI.getAIImage(id: id).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
id UUID A UUID string identifying this AI Image.

Return type

AIImage

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getAIImageContent

    open class func getAIImageContent( id: UUID) -> Promise<Void>

Required permissions * User account permission: None (read) / media:roots:manage (write)

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let id = 987 // UUID | A UUID string identifying this AI Image.

AIAPI.getAIImageContent(id: id).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
id UUID A UUID string identifying this AI Image.

Return type

Void (empty response body)

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getAIMetadata

    open class func getAIMetadata( id: Int) -> Promise<AIMetadata>

Required permissions * User account permission: media:access

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let id = 987 // Int | A unique integer value identifying this AI Metadata.

AIAPI.getAIMetadata(id: id).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
id Int A unique integer value identifying this AI Metadata.

Return type

AIMetadata

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getAIModel

    open class func getAIModel( id: UUID) -> Promise<AIModel>

Required permissions * User account permission: media:access (read) / media:roots:manage (write)

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let id = 987 // UUID | A UUID string identifying this AI Model.

AIAPI.getAIModel(id: id).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
id UUID A UUID string identifying this AI Model.

Return type

AIModel

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getAllAIAnnotationTracks

    open class func getAllAIAnnotationTracks( category: String? = nil,  imageDataset: String? = nil,  track: String? = nil,  image: String? = nil,  ordering: String? = nil,  limit: Int? = nil,  offset: Int? = nil) -> Promise<[AIAnnotation]>

Required permissions * User account permission: None (read) / media:roots:manage (write)

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let category = "category_example" // String | Filter the returned list by `category`. (optional)
let imageDataset = "imageDataset_example" // String | Filter the returned list by `image__dataset`. (optional)
let track = "track_example" // String | Filter the returned list by `track`. (optional)
let image = "image_example" // String | Filter the returned list by `image`. (optional)
let ordering = "ordering_example" // String | Which field to use when ordering the results. (optional)
let limit = 987 // Int | Number of results to return per page. (optional)
let offset = 987 // Int | The initial index from which to return the results. (optional)

AIAPI.getAllAIAnnotationTracks(category: category, imageDataset: imageDataset, track: track, image: image, ordering: ordering, limit: limit, offset: offset).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
category String Filter the returned list by `category`. [optional]
imageDataset String Filter the returned list by `image__dataset`. [optional]
track String Filter the returned list by `track`. [optional]
image String Filter the returned list by `image`. [optional]
ordering String Which field to use when ordering the results. [optional]
limit Int Number of results to return per page. [optional]
offset Int The initial index from which to return the results. [optional]

Return type

[AIAnnotation]

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getAllAIAnnotations

    open class func getAllAIAnnotations( category: String? = nil,  imageDataset: String? = nil,  imageAsset: Double? = nil,  track: String? = nil,  image: String? = nil,  ordering: String? = nil,  limit: Int? = nil,  offset: Int? = nil,  includeTransformsForAsset: Int? = nil) -> Promise<[AIAnnotation]>

Required permissions * User account permission: None (read) / media:roots:manage (write)

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let category = "category_example" // String | Filter the returned list by `category`. (optional)
let imageDataset = "imageDataset_example" // String | Filter the returned list by `image__dataset`. (optional)
let imageAsset = 987 // Double | Filter the returned list by `image__asset`. (optional)
let track = "track_example" // String | Filter the returned list by `track`. (optional)
let image = "image_example" // String | Filter the returned list by `image`. (optional)
let ordering = "ordering_example" // String | Which field to use when ordering the results. (optional)
let limit = 987 // Int | Number of results to return per page. (optional)
let offset = 987 // Int | The initial index from which to return the results. (optional)
let includeTransformsForAsset = 987 // Int |  (optional)

AIAPI.getAllAIAnnotations(category: category, imageDataset: imageDataset, imageAsset: imageAsset, track: track, image: image, ordering: ordering, limit: limit, offset: offset, includeTransformsForAsset: includeTransformsForAsset).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
category String Filter the returned list by `category`. [optional]
imageDataset String Filter the returned list by `image__dataset`. [optional]
imageAsset Double Filter the returned list by `image__asset`. [optional]
track String Filter the returned list by `track`. [optional]
image String Filter the returned list by `image`. [optional]
ordering String Which field to use when ordering the results. [optional]
limit Int Number of results to return per page. [optional]
offset Int The initial index from which to return the results. [optional]
includeTransformsForAsset Int [optional]

Return type

[AIAnnotation]

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getAllAICategories

    open class func getAllAICategories( dataset: String? = nil,  name: String? = nil,  ordering: String? = nil,  limit: Int? = nil,  offset: Int? = nil) -> Promise<[AICategory]>

Required permissions * User account permission: None (read) / media:roots:manage (write)

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let dataset = "dataset_example" // String | Filter the returned list by `dataset`. (optional)
let name = "name_example" // String | Filter the returned list by `name`. (optional)
let ordering = "ordering_example" // String | Which field to use when ordering the results. (optional)
let limit = 987 // Int | Number of results to return per page. (optional)
let offset = 987 // Int | The initial index from which to return the results. (optional)

AIAPI.getAllAICategories(dataset: dataset, name: name, ordering: ordering, limit: limit, offset: offset).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
dataset String Filter the returned list by `dataset`. [optional]
name String Filter the returned list by `name`. [optional]
ordering String Which field to use when ordering the results. [optional]
limit Int Number of results to return per page. [optional]
offset Int The initial index from which to return the results. [optional]

Return type

[AICategory]

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getAllAIConnections

    open class func getAllAIConnections( ordering: String? = nil,  limit: Int? = nil,  offset: Int? = nil) -> Promise<[AIConnection]>

Required permissions * <class 'rest_framework.permissions.AllowAny'>

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let ordering = "ordering_example" // String | Which field to use when ordering the results. (optional)
let limit = 987 // Int | Number of results to return per page. (optional)
let offset = 987 // Int | The initial index from which to return the results. (optional)

AIAPI.getAllAIConnections(ordering: ordering, limit: limit, offset: offset).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
ordering String Which field to use when ordering the results. [optional]
limit Int Number of results to return per page. [optional]
offset Int The initial index from which to return the results. [optional]

Return type

[AIConnection]

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getAllAIDatasets

    open class func getAllAIDatasets( connection: Double? = nil,  name: String? = nil,  ordering: String? = nil,  limit: Int? = nil,  offset: Int? = nil) -> Promise<[AIDatasetWithPreview]>

Required permissions * User account permission: None (read) / media:roots:manage (write)

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let connection = 987 // Double | Filter the returned list by `connection`. (optional)
let name = "name_example" // String | Filter the returned list by `name`. (optional)
let ordering = "ordering_example" // String | Which field to use when ordering the results. (optional)
let limit = 987 // Int | Number of results to return per page. (optional)
let offset = 987 // Int | The initial index from which to return the results. (optional)

AIAPI.getAllAIDatasets(connection: connection, name: name, ordering: ordering, limit: limit, offset: offset).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
connection Double Filter the returned list by `connection`. [optional]
name String Filter the returned list by `name`. [optional]
ordering String Which field to use when ordering the results. [optional]
limit Int Number of results to return per page. [optional]
offset Int The initial index from which to return the results. [optional]

Return type

[AIDatasetWithPreview]

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getAllAIImages

    open class func getAllAIImages( dataset: String? = nil,  ordering: String? = nil,  limit: Int? = nil,  offset: Int? = nil) -> Promise<[AIImage]>

Required permissions * User account permission: None (read) / media:roots:manage (write)

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let dataset = "dataset_example" // String | Filter the returned list by `dataset`. (optional)
let ordering = "ordering_example" // String | Which field to use when ordering the results. (optional)
let limit = 987 // Int | Number of results to return per page. (optional)
let offset = 987 // Int | The initial index from which to return the results. (optional)

AIAPI.getAllAIImages(dataset: dataset, ordering: ordering, limit: limit, offset: offset).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
dataset String Filter the returned list by `dataset`. [optional]
ordering String Which field to use when ordering the results. [optional]
limit Int Number of results to return per page. [optional]
offset Int The initial index from which to return the results. [optional]

Return type

[AIImage]

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getAllAIMetadata

    open class func getAllAIMetadata( asset: Double? = nil,  id: Double? = nil,  ordering: String? = nil,  limit: Int? = nil,  offset: Int? = nil) -> Promise<[AIMetadata]>

Required permissions * User account permission: media:access

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let asset = 987 // Double | Filter the returned list by `asset`. (optional)
let id = 987 // Double | Filter the returned list by `id`. (optional)
let ordering = "ordering_example" // String | Which field to use when ordering the results. (optional)
let limit = 987 // Int | Number of results to return per page. (optional)
let offset = 987 // Int | The initial index from which to return the results. (optional)

AIAPI.getAllAIMetadata(asset: asset, id: id, ordering: ordering, limit: limit, offset: offset).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
asset Double Filter the returned list by `asset`. [optional]
id Double Filter the returned list by `id`. [optional]
ordering String Which field to use when ordering the results. [optional]
limit Int Number of results to return per page. [optional]
offset Int The initial index from which to return the results. [optional]

Return type

[AIMetadata]

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getAllAIModels

    open class func getAllAIModels( dataset: String? = nil,  ordering: String? = nil,  limit: Int? = nil,  offset: Int? = nil) -> Promise<[AIModel]>

Required permissions * User account permission: media:access (read) / media:roots:manage (write)

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let dataset = "dataset_example" // String | Filter the returned list by `dataset`. (optional)
let ordering = "ordering_example" // String | Which field to use when ordering the results. (optional)
let limit = 987 // Int | Number of results to return per page. (optional)
let offset = 987 // Int | The initial index from which to return the results. (optional)

AIAPI.getAllAIModels(dataset: dataset, ordering: ordering, limit: limit, offset: offset).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
dataset String Filter the returned list by `dataset`. [optional]
ordering String Which field to use when ordering the results. [optional]
limit Int Number of results to return per page. [optional]
offset Int The initial index from which to return the results. [optional]

Return type

[AIModel]

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

importAIDatasets

    open class func importAIDatasets( importAIDatasetRequest: ImportAIDatasetRequest) -> Promise<ImportAIDatasetResponse>

Required permissions * User account permission: None (read) / media:roots:manage (write)

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let importAIDatasetRequest = ImportAIDatasetRequest(connection: 123, path: "path_example", replace: false, rename: "rename_example") // ImportAIDatasetRequest | 

AIAPI.importAIDatasets(importAIDatasetRequest: importAIDatasetRequest).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
importAIDatasetRequest ImportAIDatasetRequest

Return type

ImportAIDatasetResponse

Authorization

Bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

importAIModels

    open class func importAIModels( id: UUID,  importAIModelRequest: ImportAIModelRequest) -> Promise<ImportAIModelResponse>

Required permissions * User account permission: None (read) / media:roots:manage (write)

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let id = 987 // UUID | A UUID string identifying this AI Dataset.
let importAIModelRequest = ImportAIModelRequest(path: "path_example") // ImportAIModelRequest | 

AIAPI.importAIModels(id: id, importAIModelRequest: importAIModelRequest).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
id UUID A UUID string identifying this AI Dataset.
importAIModelRequest ImportAIModelRequest

Return type

ImportAIModelResponse

Authorization

Bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

patchAIAnnotation

    open class func patchAIAnnotation( id: UUID,  aIAnnotationPartialUpdate: AIAnnotationPartialUpdate) -> Promise<AIAnnotation>

Required permissions * User account permission: None (read) / media:roots:manage (write)

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let id = 987 // UUID | A UUID string identifying this AI Annotation.
let aIAnnotationPartialUpdate = AIAnnotationPartialUpdate(image: AIImageReference(id: 123, asset: 123, proxy: 123, frame: 123, filename: "filename_example", dataset: 123, width: 123, height: 123), category: AICategoryMiniReference(id: 123, name: "name_example"), relativeLeft: 123, relativeTop: 123, relativeWidth: 123, relativeHeight: 123, track: 123, createdBy: 123) // AIAnnotationPartialUpdate | 

AIAPI.patchAIAnnotation(id: id, aIAnnotationPartialUpdate: aIAnnotationPartialUpdate).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
id UUID A UUID string identifying this AI Annotation.
aIAnnotationPartialUpdate AIAnnotationPartialUpdate

Return type

AIAnnotation

Authorization

Bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

patchAICategory

    open class func patchAICategory( id: UUID,  aICategoryDetailPartialUpdate: AICategoryDetailPartialUpdate) -> Promise<AICategoryDetail>

Required permissions * User account permission: None (read) / media:roots:manage (write)

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let id = 987 // UUID | A UUID string identifying this AI Category.
let aICategoryDetailPartialUpdate = AICategoryDetailPartialUpdate(dataset: AIDatasetDetailReference(id: 123, trainingModel: AIModel(id: 123, state: 123, progress: AIModelProgress(status: "TODO", eta: Date()), dataset: AIDatasetReference(id: 123, name: "name_example", type: "type_example", connection: 123), parameters: "TODO", logPath: "logPath_example", name: "name_example", createdAt: Date(), active: false, trainingTaskId: "trainingTaskId_example", threshold: 123, epoch: 123, preprocessingTask: "preprocessingTask_example"), lastFinishedModel: nil, lastChange: Date(), name: "name_example", type: "type_example", connection: 123), name: "name_example") // AICategoryDetailPartialUpdate | 

AIAPI.patchAICategory(id: id, aICategoryDetailPartialUpdate: aICategoryDetailPartialUpdate).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
id UUID A UUID string identifying this AI Category.
aICategoryDetailPartialUpdate AICategoryDetailPartialUpdate

Return type

AICategoryDetail

Authorization

Bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

patchAIDataset

    open class func patchAIDataset( id: UUID,  aIDatasetWithPreviewPartialUpdate: AIDatasetWithPreviewPartialUpdate) -> Promise<AIDatasetWithPreview>

Required permissions * User account permission: None (read) / media:roots:manage (write)

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let id = 987 // UUID | A UUID string identifying this AI Dataset.
let aIDatasetWithPreviewPartialUpdate = AIDatasetWithPreviewPartialUpdate(name: "name_example", type: "type_example", connection: 123) // AIDatasetWithPreviewPartialUpdate | 

AIAPI.patchAIDataset(id: id, aIDatasetWithPreviewPartialUpdate: aIDatasetWithPreviewPartialUpdate).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
id UUID A UUID string identifying this AI Dataset.
aIDatasetWithPreviewPartialUpdate AIDatasetWithPreviewPartialUpdate

Return type

AIDatasetWithPreview

Authorization

Bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

patchAIModel

    open class func patchAIModel( id: UUID,  aIModelPartialUpdate: AIModelPartialUpdate) -> Promise<AIModel>

Required permissions * User account permission: media:access (read) / media:roots:manage (write)

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let id = 987 // UUID | A UUID string identifying this AI Model.
let aIModelPartialUpdate = AIModelPartialUpdate(dataset: AIDatasetReference(id: 123, name: "name_example", type: "type_example", connection: 123), parameters: "TODO", name: "name_example", trainingTaskId: "trainingTaskId_example", threshold: 123, epoch: 123, preprocessingTask: "preprocessingTask_example") // AIModelPartialUpdate | 

AIAPI.patchAIModel(id: id, aIModelPartialUpdate: aIModelPartialUpdate).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
id UUID A UUID string identifying this AI Model.
aIModelPartialUpdate AIModelPartialUpdate

Return type

AIModel

Authorization

Bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

runAIModelInference

    open class func runAIModelInference( id: UUID,  aIModelInferenceRequest: AIModelInferenceRequest) -> Promise<AIModelInferenceResponse>

Required permissions * User account permission: media:access (read) / media:roots:manage (write)

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let id = 987 // UUID | A UUID string identifying this AI Model.
let aIModelInferenceRequest = AIModelInferenceRequest(proxy: 123, frameStart: 123, frameEnd: 123, frameStep: 123, skipStep: 123, combineThreshold: 123) // AIModelInferenceRequest | 

AIAPI.runAIModelInference(id: id, aIModelInferenceRequest: aIModelInferenceRequest).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
id UUID A UUID string identifying this AI Model.
aIModelInferenceRequest AIModelInferenceRequest

Return type

AIModelInferenceResponse

Authorization

Bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

updateAIAnnotation

    open class func updateAIAnnotation( id: UUID,  aIAnnotationUpdate: AIAnnotationUpdate) -> Promise<AIAnnotation>

Required permissions * User account permission: None (read) / media:roots:manage (write)

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let id = 987 // UUID | A UUID string identifying this AI Annotation.
let aIAnnotationUpdate = AIAnnotationUpdate(image: AIImageReference(id: 123, asset: 123, proxy: 123, frame: 123, filename: "filename_example", dataset: 123, width: 123, height: 123), category: AICategoryMiniReference(id: 123, name: "name_example"), relativeLeft: 123, relativeTop: 123, relativeWidth: 123, relativeHeight: 123, track: 123, createdBy: 123) // AIAnnotationUpdate | 

AIAPI.updateAIAnnotation(id: id, aIAnnotationUpdate: aIAnnotationUpdate).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
id UUID A UUID string identifying this AI Annotation.
aIAnnotationUpdate AIAnnotationUpdate

Return type

AIAnnotation

Authorization

Bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

updateAICategory

    open class func updateAICategory( id: UUID,  aICategoryDetailUpdate: AICategoryDetailUpdate) -> Promise<AICategoryDetail>

Required permissions * User account permission: None (read) / media:roots:manage (write)

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let id = 987 // UUID | A UUID string identifying this AI Category.
let aICategoryDetailUpdate = AICategoryDetailUpdate(dataset: AIDatasetDetailReference(id: 123, trainingModel: AIModel(id: 123, state: 123, progress: AIModelProgress(status: "TODO", eta: Date()), dataset: AIDatasetReference(id: 123, name: "name_example", type: "type_example", connection: 123), parameters: "TODO", logPath: "logPath_example", name: "name_example", createdAt: Date(), active: false, trainingTaskId: "trainingTaskId_example", threshold: 123, epoch: 123, preprocessingTask: "preprocessingTask_example"), lastFinishedModel: nil, lastChange: Date(), name: "name_example", type: "type_example", connection: 123), name: "name_example") // AICategoryDetailUpdate | 

AIAPI.updateAICategory(id: id, aICategoryDetailUpdate: aICategoryDetailUpdate).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
id UUID A UUID string identifying this AI Category.
aICategoryDetailUpdate AICategoryDetailUpdate

Return type

AICategoryDetail

Authorization

Bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

updateAIDataset

    open class func updateAIDataset( id: UUID,  aIDatasetWithPreviewUpdate: AIDatasetWithPreviewUpdate) -> Promise<AIDatasetWithPreview>

Required permissions * User account permission: None (read) / media:roots:manage (write)

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let id = 987 // UUID | A UUID string identifying this AI Dataset.
let aIDatasetWithPreviewUpdate = AIDatasetWithPreviewUpdate(name: "name_example", type: "type_example", connection: 123) // AIDatasetWithPreviewUpdate | 

AIAPI.updateAIDataset(id: id, aIDatasetWithPreviewUpdate: aIDatasetWithPreviewUpdate).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
id UUID A UUID string identifying this AI Dataset.
aIDatasetWithPreviewUpdate AIDatasetWithPreviewUpdate

Return type

AIDatasetWithPreview

Authorization

Bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

updateAIModel

    open class func updateAIModel( id: UUID,  aIModelUpdate: AIModelUpdate) -> Promise<AIModel>

Required permissions * User account permission: media:access (read) / media:roots:manage (write)

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let id = 987 // UUID | A UUID string identifying this AI Model.
let aIModelUpdate = AIModelUpdate(dataset: AIDatasetReference(id: 123, name: "name_example", type: "type_example", connection: 123), parameters: "TODO", name: "name_example", trainingTaskId: "trainingTaskId_example", threshold: 123, epoch: 123, preprocessingTask: "preprocessingTask_example") // AIModelUpdate | 

AIAPI.updateAIModel(id: id, aIModelUpdate: aIModelUpdate).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
id UUID A UUID string identifying this AI Model.
aIModelUpdate AIModelUpdate

Return type

AIModel

Authorization

Bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

uploadAIImage

    open class func uploadAIImage( uploadAIImageRequest: UploadAIImageRequest) -> Promise<AIImage>

Required permissions * User account permission: None (read) / media:roots:manage (write)

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let uploadAIImageRequest = UploadAIImageRequest(content: "content_example", category: 123) // UploadAIImageRequest | 

AIAPI.uploadAIImage(uploadAIImageRequest: uploadAIImageRequest).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
uploadAIImageRequest UploadAIImageRequest

Return type

AIImage

Authorization

Bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]