object V2PatchConceptLanguages2Request
{
  "type": "object",
  "properties": {
    "action": {
      "type": "string",
      "description": "The action to perform with the objects in the PATCH."
    },
    "userAppId": {
      "$ref": "#/components/schemas/apiUserAppIDSet"
    },
    "conceptLanguages": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/apiConceptLanguage"
      }
    }
  },
  "description": "PATCH multiple concept languages for the given concept."
}
object V2PatchConceptLanguagesRequest
{
  "type": "object",
  "properties": {
    "action": {
      "type": "string",
      "description": "The action to perform with the objects in the PATCH."
    },
    "userAppId": {
      "type": "object",
      "description": "Common message to identify the app in a url endpoint."
    },
    "conceptLanguages": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/apiConceptLanguage"
      }
    }
  },
  "description": "PATCH multiple concept languages for the given concept."
}
object V2PatchConceptsRequest
{
  "type": "object",
  "title": "PatchConceptsRequest",
  "properties": {
    "action": {
      "type": "string",
      "title": "The action to perform on the patched objects\nFor now ony action 'overwrite' is supported"
    },
    "concepts": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/apiConcept"
      },
      "description": "The concepts to patch."
    },
    "userAppId": {
      "type": "object",
      "description": "Common message to identify the app in a url endpoint."
    }
  }
}
object V2PatchDatasetVersions2Request
{
  "type": "object",
  "properties": {
    "action": {
      "type": "string",
      "title": "The action to perform on the patched objects\nFor now, only 'overwrite' action is supported"
    },
    "userAppId": {
      "$ref": "#/components/schemas/apiUserAppIDSet"
    },
    "datasetVersions": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/apiDatasetVersion"
      },
      "description": "List of dataset versions that are requested to be updated."
    }
  },
  "description": "Request to patch several dataset versions."
}
object V2PatchDatasetVersionsRequest
{
  "type": "object",
  "properties": {
    "action": {
      "type": "string",
      "title": "The action to perform on the patched objects\nFor now, only 'overwrite' action is supported"
    },
    "userAppId": {
      "type": "object",
      "description": "Common message to identify the app in a url endpoint."
    },
    "datasetVersions": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/apiDatasetVersion"
      },
      "description": "List of dataset versions that are requested to be updated."
    }
  },
  "description": "Request to patch several dataset versions."
}
object V2PatchDatasetsRequest
{
  "type": "object",
  "properties": {
    "action": {
      "type": "string",
      "description": "The action to perform on the patched objects\nSupported values: 'overwrite', 'merge', and 'remove'.\n\nNote that 'remove' can only be used to remove the dataset image by setting\n'image.url' in the request to the current value returned for that dataset."
    },
    "datasets": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/apiDataset"
      },
      "description": "List of datasets that are requested to be updated."
    },
    "userAppId": {
      "type": "object",
      "description": "Common message to identify the app in a url endpoint."
    }
  },
  "description": "Request to patch several datasets."
}
object V2PatchInputsRequest
{
  "type": "object",
  "title": "PatchInputsRequest",
  "properties": {
    "action": {
      "type": "string",
      "title": "The action to perform on the patched objects\nFor now actions 'merge', 'overwrite', and 'remove' are supported"
    },
    "inputs": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/apiInput"
      },
      "title": "List of inputs to patch.\nInputs are identified by id field.\nFor each input, the following fields are patchable:\n* data"
    },
    "userAppId": {
      "type": "object",
      "description": "Common message to identify the app in a url endpoint."
    }
  }
}
object V2PatchKeysRequest
{
  "type": "object",
  "title": "PatchKeysRequest",
  "properties": {
    "keys": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/apiKey"
      }
    },
    "action": {
      "type": "string",
      "title": "The action to perform on the patched objects\nFor now only action 'overwrite' is supported"
    },
    "userAppId": {
      "type": "object",
      "properties": {
        "appId": {
          "type": "string"
        }
      },
      "description": "Common message to identify the app in a url endpoint."
    }
  }
}
object V2PatchLabelOrdersRequest
{
  "type": "object",
  "properties": {
    "action": {
      "type": "string",
      "title": "The action to perform on the patched objects\nFor now actions 'merge', 'overwrite', and 'remove' are supported"
    },
    "userAppId": {
      "type": "object",
      "description": "Common message to identify the app in a url endpoint."
    },
    "labelOrders": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/apiLabelOrder"
      }
    }
  },
  "description": "Request to patch a list of label orders."
}
object V2PatchModelCheckConsents2Request
{
  "type": "object",
  "title": "PatchModelCheckConsentsRequest",
  "properties": {
    "action": {
      "type": "string",
      "title": "overwrite supported"
    },
    "userAppId": {
      "$ref": "#/components/schemas/apiUserAppIDSet"
    },
    "checkConsents": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "title": "the consents"
    }
  }
}
object V2PatchModelCheckConsentsRequest
{
  "type": "object",
  "title": "PatchModelCheckConsentsRequest",
  "properties": {
    "action": {
      "type": "string",
      "title": "overwrite supported"
    },
    "userAppId": {
      "type": "object",
      "description": "Common message to identify the app in a url endpoint."
    },
    "checkConsents": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "title": "the consents"
    }
  }
}
object V2PatchModelIdsRequest
{
  "type": "object",
  "title": "PatchModelIdsRequest",
  "properties": {
    "ids": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/apiIdUpdateSource"
      },
      "title": "Array containing 1 entry"
    },
    "action": {
      "type": "string",
      "title": "The action to perform on the patched objects\nOnly 'overwrite' is supported"
    },
    "userAppId": {
      "type": "object",
      "description": "Common message to identify the app in a url endpoint."
    }
  }
}
object V2PatchModelLanguages2Request
{
  "type": "object",
  "properties": {
    "action": {
      "type": "string",
      "title": "Only overwrite supported"
    },
    "languages": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "userAppId": {
      "$ref": "#/components/schemas/apiUserAppIDSet"
    }
  }
}
object V2PatchModelLanguagesRequest
{
  "type": "object",
  "properties": {
    "action": {
      "type": "string",
      "title": "Only overwrite supported"
    },
    "languages": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "userAppId": {
      "type": "object",
      "description": "Common message to identify the app in a url endpoint."
    }
  }
}
object V2PatchModelToolkits2Request
{
  "type": "object",
  "properties": {
    "action": {
      "type": "string",
      "title": "overwrite supported"
    },
    "toolkits": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "userAppId": {
      "$ref": "#/components/schemas/apiUserAppIDSet"
    }
  }
}
object V2PatchModelToolkitsRequest
{
  "type": "object",
  "properties": {
    "action": {
      "type": "string",
      "title": "overwrite supported"
    },
    "toolkits": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "userAppId": {
      "type": "object",
      "description": "Common message to identify the app in a url endpoint."
    }
  }
}
object V2PatchModelUseCases2Request
{
  "type": "object",
  "properties": {
    "action": {
      "type": "string",
      "title": "overwrite supported"
    },
    "usecases": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "userAppId": {
      "$ref": "#/components/schemas/apiUserAppIDSet"
    }
  }
}
object V2PatchModelUseCasesRequest
{
  "type": "object",
  "properties": {
    "action": {
      "type": "string",
      "title": "overwrite supported"
    },
    "usecases": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "userAppId": {
      "type": "object",
      "description": "Common message to identify the app in a url endpoint."
    }
  }
}
object V2PatchModelVersionsRequest
{
  "type": "object",
  "title": "PatchModelVersionsRequest",
  "properties": {
    "action": {
      "type": "string",
      "title": "The action to perform on the patched objects\nFor now actions 'merge', 'overwrite', and 'remove' are supported"
    },
    "userAppId": {
      "type": "object",
      "description": "Common message to identify the app in a url endpoint."
    },
    "modelVersions": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/apiModelVersion"
      }
    }
  }
}
object V2PatchModelsRequest
{
  "type": "object",
  "title": "PatchModelsRequest",
  "properties": {
    "action": {
      "type": "string",
      "title": "The action to perform on the patched objects\nFor now actions 'merge', 'overwrite', and 'remove' are supported",
      "description": "Note that 'remove' can be used to remove the model image by setting\n'image.url' in the request to the current value returned for that model.\nThis cannot be used in a request that is patching other fields as well."
    },
    "models": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/apiModel"
      }
    },
    "userAppId": {
      "type": "object",
      "description": "Common message to identify the app in a url endpoint."
    }
  }
}
object V2PatchModuleVersionsRequest
{
  "type": "object",
  "title": "PatchModuleVersionsRequest",
  "properties": {
    "action": {
      "type": "string",
      "title": "The action to perform on the patched objects\nFor now only action 'merge' is supported"
    },
    "userAppId": {
      "type": "object",
      "description": "Common message to identify the app in a url endpoint."
    },
    "moduleVersions": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/apiModuleVersion"
      },
      "title": "This allows you to modify the module version details.\n########## Supported fields ##########\n- description\n- id\n- metadata.fields\n- module_nav.module_sub_navs[].query_key\n- module_nav.module_sub_navs[].query_value\n- module_nav.module_sub_navs[].title\n- module_nav.title\n- notes\n- visibility.gettable"
    }
  }
}
object V2PatchModulesRequest
{
  "type": "object",
  "title": "PatchModulesRequest",
  "properties": {
    "action": {
      "type": "string",
      "description": "The action to perform on the patched objects\nSupported values: 'overwrite' and 'remove'.\n\nNote that 'remove' can only be used to remove the module image by setting\n'image.url' in the request to the current value returned for that module."
    },
    "modules": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/apiModule"
      }
    },
    "userAppId": {
      "type": "object",
      "description": "Common message to identify the app in a url endpoint."
    }
  }
}
object V2PatchSearchesRequest
{
  "type": "object",
  "title": "PatchSearchesRequest",
  "properties": {
    "action": {
      "type": "string",
      "title": "The action to perform on the patched Search objects\nFor now only action 'overwrite' is supported"
    },
    "searches": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/apiSearch"
      },
      "title": "The searches to be patched"
    },
    "userAppId": {
      "type": "object",
      "title": "The user_id and app_id to query from.",
      "description": "The user_id and app_id to query from."
    }
  }
}
object V2PatchTasksRequest
{
  "type": "object",
  "properties": {
    "tasks": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/apiTask"
      }
    },
    "action": {
      "type": "string",
      "title": "The action to perform on the patched objects\nFor now actions 'merge', 'overwrite', and 'remove' are supported"
    },
    "userAppId": {
      "type": "object",
      "description": "Common message to identify the app in a url endpoint."
    }
  },
  "description": "Request to patch a list of tasks."
}
object V2PatchWorkflowIdsRequest
{
  "type": "object",
  "title": "PatchWorkflowIdsRequest",
  "properties": {
    "ids": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/apiIdUpdateSource"
      },
      "title": "Array containing 1 entry"
    },
    "action": {
      "type": "string",
      "title": "The action to perform on the patched objects\nOnly 'overwrite' is supported"
    },
    "userAppId": {
      "type": "object",
      "description": "Common message to identify the app in a url endpoint."
    }
  }
}
object V2PatchWorkflowVersions2Request
{
  "type": "object",
  "title": "PatchWorkflowVersionsRequest",
  "properties": {
    "action": {
      "type": "string",
      "title": "The action to perform on the patched objects\nFor now actions 'merge', 'overwrite', and 'remove' are supported"
    },
    "userAppId": {
      "$ref": "#/components/schemas/apiUserAppIDSet"
    },
    "workflowVersions": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/apiWorkflowVersion"
      },
      "description": "Patch these versions."
    }
  }
}
object V2PatchWorkflowVersionsRequest
{
  "type": "object",
  "title": "PatchWorkflowVersionsRequest",
  "properties": {
    "action": {
      "type": "string",
      "title": "The action to perform on the patched objects\nFor now actions 'merge', 'overwrite', and 'remove' are supported"
    },
    "userAppId": {
      "type": "object",
      "description": "Common message to identify the app in a url endpoint."
    },
    "workflowVersions": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/apiWorkflowVersion"
      },
      "description": "Patch these versions."
    }
  }
}
object V2PatchWorkflowsRequest
{
  "type": "object",
  "title": "PatchWorkflowsRequest",
  "properties": {
    "action": {
      "type": "string",
      "title": "The action to perform on the patched objects\nFor now actions 'merge', 'overwrite', and 'remove' are supported",
      "description": "Note that 'remove' can be used to remove the workflow image by setting\n'image.url' in the request to the current value returned for that workflow.\nThis cannot be used in a request that is patching other fields as well."
    },
    "userAppId": {
      "type": "object",
      "description": "Common message to identify the app in a url endpoint."
    },
    "workflows": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/apiWorkflow"
      }
    }
  }
}
object V2PostAnnotationFiltersRequest
{
  "type": "object",
  "properties": {
    "userAppId": {
      "type": "object",
      "description": "Common message to identify the app in a url endpoint."
    },
    "annotationFilters": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/apiAnnotationFilter"
      },
      "description": "List of annotation filters that are requested to be added."
    }
  },
  "description": "Request to add one or more annotation filters."
}
object V2PostAnnotationSearchMetricsRequest
{
  "type": "object",
  "title": "PostAnnotationSearchMetricsRequest",
  "properties": {
    "id": {
      "type": "string",
      "title": "A unique customer facing id to identify this eval request"
    },
    "data": {
      "$ref": "#/components/schemas/apiData"
    },
    "userAppId": {
      "type": "object",
      "description": "Common message to identify the app in a url endpoint."
    },
    "groundTruth": {
      "$ref": "#/components/schemas/apiSearch"
    },
    "searchToEval": {
      "$ref": "#/components/schemas/apiSearch"
    },
    "evaluationType": {
      "$ref": "#/components/schemas/apiEvaluationType"
    }
  }
}
object V2PostAnnotationsRequest
{
  "type": "object",
  "title": "PostAnnotationsRequest",
  "properties": {
    "userAppId": {
      "type": "object",
      "description": "Common message to identify the app in a url endpoint."
    },
    "annotations": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/clarifaiapiAnnotation"
      }
    }
  }
}
object V2PostAnnotationsSearchesRequest
{
  "type": "object",
  "title": "Execute a new annotation search and optionally save it\nannotation search over annotations using rank and filter proto",
  "properties": {
    "searches": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/apiSearch"
      },
      "title": "The searched to be executed or saved"
    },
    "userAppId": {
      "type": "object",
      "title": "The user_id and app_id to query from.",
      "description": "The user_id and app_id to query from."
    },
    "pagination": {
      "$ref": "#/components/schemas/apiPagination"
    }
  }
}
object V2PostAppDuplicationsRequest
{
  "type": "object",
  "properties": {
    "userAppId": {
      "type": "object",
      "title": "The user and application ID of the source application to duplicate.",
      "description": "The user and application ID of the source application to duplicate."
    },
    "appDuplications": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/apiAppDuplication"
      }
    }
  },
  "description": "Request to start app duplication jobs."
}
object V2PostAppsRequest
{
  "type": "object",
  "title": "PostAppsRequest",
  "properties": {
    "apps": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/apiApp"
      }
    },
    "userAppId": {
      "type": "object",
      "properties": {
        "appId": {
          "type": "string"
        }
      },
      "description": "Common message to identify the app in a url endpoint."
    }
  }
}
object V2PostAppsSearchesRequest
{
  "type": "object",
  "properties": {
    "appQuery": {
      "$ref": "#/components/schemas/apiAppQuery"
    },
    "userAppId": {
      "type": "object",
      "properties": {
        "appId": {
          "type": "string"
        }
      },
      "description": "Common message to identify the app in a url endpoint."
    },
    "pagination": {
      "$ref": "#/components/schemas/apiPagination"
    }
  },
  "description": "Search over the available applications."
}
object V2PostBulkOperationsRequest
{
  "type": "object",
  "properties": {
    "userAppId": {
      "type": "object",
      "description": "Common message to identify the app in a url endpoint."
    },
    "bulkOperations": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/apiBulkOperation"
      },
      "description": "List of bulk operation(s) to be performed e.g bulk update metadata or tags or labels etc."
    }
  },
  "description": "Request to perform bulk operations on a list of inputs based on input source."
}
object V2PostCollaboratorsRequest
{
  "type": "object",
  "title": "PostCollaboratorsRequest",
  "properties": {
    "userAppId": {
      "type": "object",
      "description": "Common message to identify the app in a url endpoint."
    },
    "collaborators": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/apiCollaborator"
      }
    }
  }
}
object V2PostCollectorsRequest
{
  "type": "object",
  "properties": {
    "userAppId": {
      "type": "object",
      "description": "Common message to identify the app in a url endpoint."
    },
    "collectors": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/apiCollector"
      }
    }
  },
  "description": "Request to create Collectors."
}
object V2PostConceptLanguages2Request
{
  "type": "object",
  "properties": {
    "userAppId": {
      "$ref": "#/components/schemas/apiUserAppIDSet"
    },
    "conceptLanguages": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/apiConceptLanguage"
      }
    }
  },
  "description": "POST multiple concept languages for the given concept."
}
object V2PostConceptLanguagesRequest
{
  "type": "object",
  "properties": {
    "userAppId": {
      "type": "object",
      "description": "Common message to identify the app in a url endpoint."
    },
    "conceptLanguages": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/apiConceptLanguage"
      }
    }
  },
  "description": "POST multiple concept languages for the given concept."
}
object V2PostConceptMappingJobsRequest
{
  "type": "object",
  "title": "Start concept mapping jobs",
  "properties": {
    "userAppId": {
      "type": "object",
      "title": "The user_id and app_id information.",
      "description": "The user_id and app_id information."
    },
    "conceptMappingJobs": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/apiConceptMappingJob"
      },
      "title": "The concept mapping jobs that are being started"
    }
  }
}
object V2PostConceptRelationsRequest
{
  "type": "object",
  "title": "POST new concept relations",
  "properties": {
    "userAppId": {
      "type": "object",
      "title": "The user_id and app_id information.",
      "description": "The user_id and app_id information."
    },
    "conceptRelations": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/apiConceptRelation"
      },
      "description": "The relationships you're going to add."
    }
  }
}
object V2PostConceptsRequest
{
  "type": "object",
  "title": "PostConceptsRequest",
  "properties": {
    "concepts": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/apiConcept"
      },
      "description": "The concepts to add."
    },
    "userAppId": {
      "type": "object",
      "description": "Common message to identify the app in a url endpoint."
    }
  }
}
object V2PostConceptsSearchesRequest
{
  "type": "object",
  "title": "PostConceptsSearchesRequest",
  "properties": {
    "extraInfo": {
      "$ref": "#/components/schemas/apiConceptExtraInfoRequest"
    },
    "userAppId": {
      "type": "object",
      "title": "Ids present in the url of the request.",
      "description": "Ids present in the url of the request."
    },
    "pagination": {
      "$ref": "#/components/schemas/apiPagination"
    },
    "conceptQuery": {
      "$ref": "#/components/schemas/apiConceptQuery"
    }
  }
}
object V2PostDatasetInputs2Request
{
  "type": "object",
  "properties": {
    "search": {
      "$ref": "#/components/schemas/apiSearch"
    },
    "userAppId": {
      "$ref": "#/components/schemas/apiUserAppIDSet"
    },
    "datasetInputs": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/apiDatasetInput"
      },
      "description": "List of inputs that are requested to be added to this dataset.\nIdentify each input by id field. All other inputs fields are ignored."
    }
  },
  "description": "Request to add one or more datasets."
}
object V2PostDatasetInputsRequest
{
  "type": "object",
  "properties": {
    "search": {
      "$ref": "#/components/schemas/apiSearch"
    },
    "userAppId": {
      "type": "object",
      "description": "Common message to identify the app in a url endpoint."
    },
    "datasetInputs": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/apiDatasetInput"
      },
      "description": "List of inputs that are requested to be added to this dataset.\nIdentify each input by id field. All other inputs fields are ignored."
    }
  },
  "description": "Request to add one or more datasets."
}
object V2PostDatasetVersions2Request
{
  "type": "object",
  "properties": {
    "userAppId": {
      "$ref": "#/components/schemas/apiUserAppIDSet"
    },
    "datasetVersions": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/apiDatasetVersion"
      },
      "description": "List of dataset versions that are requested to be added."
    }
  },
  "description": "Request to add one or more dataset versions."
}
object V2PostDatasetVersionsRequest
{
  "type": "object",
  "properties": {
    "userAppId": {
      "type": "object",
      "description": "Common message to identify the app in a url endpoint."
    },
    "datasetVersions": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/apiDatasetVersion"
      },
      "description": "List of dataset versions that are requested to be added."
    }
  },
  "description": "Request to add one or more dataset versions."
}
object V2PostDatasetsRequest
{
  "type": "object",
  "properties": {
    "datasets": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/apiDataset"
      },
      "description": "List of datasets that are requested to be added."
    },
    "userAppId": {
      "type": "object",
      "description": "Common message to identify the app in a url endpoint."
    }
  },
  "description": "Request to add one or more datasets."
}
object V2PostEvaluationsRequest
{
  "type": "object",
  "title": "Evaluate this model vesion",
  "properties": {
    "userAppId": {
      "type": "object",
      "description": "Common message to identify the app in a url endpoint."
    },
    "evalMetrics": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/apiEvalMetrics"
      },
      "description": "eval_info, id, model, and ground_truth_dataset will be used when creating the evaluation\nIf no dataset is provided, all app data that is annotated with concepts from the model will be used."
    }
  }
}
Load more schemas