apiModelVersion
{
"type": "object",
"title": "ModelVersion",
"properties": {
"id": {
"type": "string"
},
"appId": {
"type": "string",
"description": "The app the model version belongs to."
},
"status": {
"$ref": "#/components/schemas/apistatusStatus"
},
"userId": {
"type": "string",
"description": "The user the model version belongs to."
},
"license": {
"type": "string"
},
"metrics": {
"$ref": "#/components/schemas/apiEvalMetrics"
},
"metadata": {
"type": "object",
"title": "To handle arbitrary json metadata you can use a struct field:\nhttps://github.com/google/protobuf/blob/master/src/google/protobuf/struct.proto"
},
"trainLog": {
"type": "string",
"title": "Contains the training logs if available"
},
"buildInfo": {
"$ref": "#/components/schemas/apiBuildInfo"
},
"createdAt": {
"type": "string",
"format": "date-time",
"description": "When the version was created."
},
"inputInfo": {
"$ref": "#/components/schemas/apiInputInfo"
},
"trainInfo": {
"$ref": "#/components/schemas/apiTrainInfo"
},
"importInfo": {
"$ref": "#/components/schemas/apiImportInfo"
},
"modifiedAt": {
"type": "string",
"title": "When this model version was last modified",
"format": "date-time"
},
"outputInfo": {
"$ref": "#/components/schemas/apiOutputInfo"
},
"visibility": {
"$ref": "#/components/schemas/clarifaiapiVisibility"
},
"completedAt": {
"type": "string",
"format": "date-time",
"description": "When training of this version was completed."
},
"description": {
"type": "string",
"title": "Description about this version"
},
"totalInputCount": {
"type": "integer",
"title": "number of inputs in the model version",
"format": "int64"
},
"activeConceptCount": {
"type": "integer",
"format": "int64"
},
"inferenceComputeInfo": {
"$ref": "#/components/schemas/apiComputeInfo"
},
"pretrainedModelConfig": {
"$ref": "#/components/schemas/apiPretrainedModelConfig"
}
}
}
apiModelVersionExport
{
"type": "object",
"properties": {
"url": {
"type": "string",
"description": "url is the URL from where the model version export can be downloaded."
},
"size": {
"type": "string",
"title": "size of model file",
"format": "int64"
},
"status": {
"$ref": "#/components/schemas/apistatusStatus"
}
},
"description": "ModelVersionExport contains metadata for a single Model version export."
}
apiModelVersionInputExample
{
"type": "object",
"title": "ModelVersionInputExample",
"properties": {
"id": {
"type": "string",
"title": "user unique id"
},
"data": {
"$ref": "#/components/schemas/apiData"
},
"name": {
"type": "string",
"title": "name of link for display"
},
"modelId": {
"type": "string",
"title": "external id of model"
},
"description": {
"type": "string",
"title": "description of link contents"
},
"modelVersionId": {
"type": "string",
"title": "external id of model version"
}
}
}
apiModelVersionPublishRequest
{
"type": "object",
"title": "ModelVersionPublishRequest",
"properties": {
"versionId": {
"type": "string"
}
}
}
apiModelVersionUnpublishRequest
{
"type": "object",
"title": "ModelVersionUnpublishRequest",
"properties": {
"versionId": {
"type": "string"
}
}
}
apiModule
{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "A unique ID for this app module."
},
"appId": {
"type": "string",
"description": "The app_id this module was created in."
},
"image": {
"$ref": "#/components/schemas/apiImage"
},
"userId": {
"type": "string",
"description": "The creator of the app module."
},
"metadata": {
"type": "object",
"description": "To handle arbitrary json metadata you can use a struct field:\nhttps://github.com/google/protobuf/blob/master/src/google/protobuf/struct.proto\nThis is an optional arg."
},
"createdAt": {
"type": "string",
"format": "date-time",
"description": "When the app module was created."
},
"isStarred": {
"type": "boolean",
"title": "Is starred by the requesting user (only showed on get/list requests)\nPlease use PostModuleStars/DeleteModuleStars endpoints to star/unstar a module"
},
"starCount": {
"type": "integer",
"title": "How many users have starred the module (only showed on get/list requests)\nComputed value, not editable",
"format": "int32"
},
"modifiedAt": {
"type": "string",
"format": "date-time",
"description": "When the app module was last modified."
},
"visibility": {
"$ref": "#/components/schemas/clarifaiapiVisibility"
},
"description": {
"type": "string",
"description": "A short description for this app module to be used in grids of modules."
},
"moduleVersion": {
"$ref": "#/components/schemas/apiModuleVersion"
},
"bookmarkOrigin": {
"$ref": "#/components/schemas/apiBookmarkOrigin"
}
},
"description": "An app module that a user created in our app module marketplace."
}
apiModuleVersion
{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "A name for this version like 1_0, 1_1_0, etc."
},
"appId": {
"type": "string",
"description": "The app_id this module version belongs to."
},
"notes": {
"type": "string",
"description": "A markdown formatted string to detailed description of the app module.\nThis is within each version so that it can be change version to version."
},
"userId": {
"type": "string",
"description": "The user_id this module version belongs to."
},
"approved": {
"type": "boolean",
"description": "A boolean to mark if Clarifai has approved this app version.\nThis cannot be set in the request to True."
},
"metadata": {
"type": "object",
"description": "To handle arbitrary json metadata you can use a struct field:\nhttps://github.com/google/protobuf/blob/master/src/google/protobuf/struct.proto\nThis is an optional arg."
},
"moduleId": {
"type": "string",
"description": "The module this version belongs to."
},
"createdAt": {
"type": "string",
"format": "date-time",
"description": "When the app module version was created."
},
"moduleNav": {
"$ref": "#/components/schemas/ModuleVersionModuleNav"
},
"modifiedAt": {
"type": "string",
"format": "date-time",
"description": "When the app module version was last modified."
},
"visibility": {
"$ref": "#/components/schemas/clarifaiapiVisibility"
},
"description": {
"type": "string",
"description": "A short description for this version."
},
"gitCommitUrl": {
"type": "string",
"title": "The code repo of the streamlit app.\nIf you are still developing your Module you should create a ModuleVersion\nwith an empty git_commit_url and then create an InstalledModuleVersion\nwith a pre-deployed deploy_url (such as localhost or streamlit cloud).\nOnce you are ready to create a production, create a new ModuleVersion with\nthe ready git url to a specific commit that you would like to be reviewed by the\nClarifai team for approval within our community. You cannot publish a ModuleVersion\nis reviewed and approved. Please only provide the git_commit_url when you're\nready for a review. This url needs to include a specific commit, for example:\nhttps://github.com/user/repo/commit/767ff9c08ba3429c8e7b8825da148555"
}
},
"description": "A specific version of an app module that is available for assigning to apps."
}
apiMultiAnnotationFilterResponse
{
"type": "object",
"title": "MultiAnnotationFilterResponse",
"properties": {
"status": {
"$ref": "#/components/schemas/apistatusStatus"
},
"annotationFilters": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiAnnotationFilter"
}
}
}
}
apiMultiAnnotationResponse
{
"type": "object",
"title": "MultiAnnotationResponse",
"properties": {
"status": {
"$ref": "#/components/schemas/apistatusStatus"
},
"annotations": {
"type": "array",
"items": {
"$ref": "#/components/schemas/clarifaiapiAnnotation"
}
}
}
}
apiMultiAnnotationSearchMetricsResponse
{
"type": "object",
"title": "MultiAnnotationSearchMetricsResponse",
"properties": {
"status": {
"$ref": "#/components/schemas/apistatusStatus"
},
"annotationSearchMetrics": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiAnnotationSearchMetrics"
}
}
}
}
apiMultiAppDuplicationsResponse
{
"type": "object",
"title": "MultiAppDuplicationsResponse",
"properties": {
"status": {
"$ref": "#/components/schemas/apistatusStatus"
},
"appDuplications": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiAppDuplication"
}
}
}
}
apiMultiAppResponse
{
"type": "object",
"title": "MultiAppResponse",
"properties": {
"apps": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiApp"
}
},
"status": {
"$ref": "#/components/schemas/apistatusStatus"
}
}
}
apiMultiBulkOperationsResponse
{
"type": "object",
"title": "MultiBulkOperationsResponse",
"properties": {
"status": {
"$ref": "#/components/schemas/apistatusStatus"
},
"bulkOperation": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiBulkOperation"
}
}
}
}
apiMultiCollaborationsResponse
{
"type": "object",
"title": "MultiCollaborationsResponse",
"properties": {
"status": {
"$ref": "#/components/schemas/apistatusStatus"
},
"collaborations": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiCollaboration"
}
}
}
}
apiMultiCollaboratorsResponse
{
"type": "object",
"title": "MultiCollaboratorsResponse",
"properties": {
"status": {
"$ref": "#/components/schemas/apistatusStatus"
},
"appOwner": {
"$ref": "#/components/schemas/apiUser"
},
"collaborators": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiCollaborator"
}
}
}
}
apiMultiCollectorResponse
{
"type": "object",
"properties": {
"status": {
"$ref": "#/components/schemas/apistatusStatus"
},
"collectors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiCollector"
}
}
},
"description": "Response with multiple Collectors."
}
apiMultiConceptCountResponse
{
"type": "object",
"title": "MultiConceptCountResponse",
"properties": {
"status": {
"$ref": "#/components/schemas/apistatusStatus"
},
"conceptCounts": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiConceptCount"
},
"description": "The returned concept counts."
}
}
}
apiMultiConceptLanguageResponse
{
"type": "object",
"title": "MultiConceptLanguageResponse",
"properties": {
"status": {
"$ref": "#/components/schemas/apistatusStatus"
},
"conceptLanguages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiConceptLanguage"
}
}
}
}
apiMultiConceptMappingJobResponse
{
"type": "object",
"title": "MultiConceptMappingJobResponse",
"properties": {
"ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "The ids of the concept mapping jobs underway."
},
"status": {
"$ref": "#/components/schemas/apistatusStatus"
}
}
}
apiMultiConceptRelationResponse
{
"type": "object",
"title": "MultiConceptRelationResponse",
"properties": {
"status": {
"$ref": "#/components/schemas/apistatusStatus"
},
"conceptRelations": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiConceptRelation"
},
"description": "The returned concept relations."
}
}
}
apiMultiConceptResponse
{
"type": "object",
"title": "MultiConceptResponse",
"properties": {
"status": {
"$ref": "#/components/schemas/apistatusStatus"
},
"concepts": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiConcept"
},
"description": "The returned concepts."
}
}
}
apiMultiDatasetInputResponse
{
"type": "object",
"title": "MultiDatasetInputResponse",
"properties": {
"status": {
"$ref": "#/components/schemas/apistatusStatus"
},
"bulkOperation": {
"$ref": "#/components/schemas/apiBulkOperation"
},
"datasetInputs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiDatasetInput"
}
}
}
}
apiMultiDatasetResponse
{
"type": "object",
"title": "MultiDatasetResponse",
"properties": {
"status": {
"$ref": "#/components/schemas/apistatusStatus"
},
"datasets": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiDataset"
}
}
}
}
apiMultiDatasetVersionExportResponse
{
"type": "object",
"properties": {
"status": {
"$ref": "#/components/schemas/apistatusStatus"
},
"exports": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiDatasetVersionExport"
}
}
}
}
apiMultiDatasetVersionMetricsGroupResponse
{
"type": "object",
"properties": {
"status": {
"$ref": "#/components/schemas/apistatusStatus"
},
"datasetVersionMetricsGroups": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiDatasetVersionMetricsGroup"
}
}
}
}
apiMultiDatasetVersionResponse
{
"type": "object",
"properties": {
"status": {
"$ref": "#/components/schemas/apistatusStatus"
},
"datasetVersions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiDatasetVersion"
}
}
}
}
apiMultiEvalMetricsResponse
{
"type": "object",
"properties": {
"status": {
"$ref": "#/components/schemas/apistatusStatus"
},
"evalMetrics": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiEvalMetrics"
}
}
}
}
apiMultiInputAnnotationResponse
{
"type": "object",
"title": "MultiInputAnnotationResponse",
"properties": {
"hits": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiHit"
}
},
"status": {
"$ref": "#/components/schemas/apistatusStatus"
}
}
}
apiMultiInputResponse
{
"type": "object",
"title": "MultiInputResponse",
"properties": {
"inputs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiInput"
}
},
"status": {
"$ref": "#/components/schemas/apistatusStatus"
},
"inputsAddJob": {
"$ref": "#/components/schemas/apiInputsAddJob"
}
}
}
apiMultiInputsAddJobResponse
{
"type": "object",
"title": "MultiInputsAddJobResponse",
"properties": {
"status": {
"$ref": "#/components/schemas/apistatusStatus"
},
"inputsAddJobs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiInputsAddJob"
}
}
}
}
apiMultiInputsExtractionJobResponse
{
"type": "object",
"properties": {
"status": {
"$ref": "#/components/schemas/apistatusStatus"
},
"inputsExtractionJobs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiInputsExtractionJob"
}
}
}
}
apiMultiInstalledModuleVersionResponse
{
"type": "object",
"title": "MultiInstalledModuleVersionResponse",
"properties": {
"status": {
"$ref": "#/components/schemas/apistatusStatus"
},
"installedModuleVersions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiInstalledModuleVersion"
}
}
}
}
apiMultiKeyResponse
{
"type": "object",
"title": "MultiKeyResponse",
"properties": {
"keys": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiKey"
}
},
"status": {
"$ref": "#/components/schemas/apistatusStatus"
}
}
}
apiMultiKnowledgeGraphResponse
{
"type": "object",
"title": "MultiKnowledgeGraphResponse",
"properties": {
"status": {
"$ref": "#/components/schemas/apistatusStatus"
},
"knowledgeGraphs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiKnowledgeGraph"
},
"description": "The returned knowledge graphs."
}
}
}
apiMultiLabelOrderResponse
{
"type": "object",
"properties": {
"status": {
"$ref": "#/components/schemas/apistatusStatus"
},
"labelOrders": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiLabelOrder"
}
}
},
"description": "Response with multiple label order."
}
apiMultiModelCheckConsentResponse
{
"type": "object",
"properties": {
"status": {
"$ref": "#/components/schemas/apistatusStatus"
},
"checkConsents": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
apiMultiModelLanguageResponse
{
"type": "object",
"properties": {
"status": {
"$ref": "#/components/schemas/apistatusStatus"
},
"languages": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
apiMultiModelReferenceResponse
{
"type": "object",
"title": "MultiModelReferenceResponse",
"properties": {
"status": {
"$ref": "#/components/schemas/apistatusStatus"
},
"modelReferences": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiModelReference"
}
}
}
}
apiMultiModelResponse
{
"type": "object",
"title": "MultiModelResponse",
"properties": {
"models": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiModel"
}
},
"status": {
"$ref": "#/components/schemas/apistatusStatus"
}
}
}
apiMultiModelToolkitResponse
{
"type": "object",
"properties": {
"status": {
"$ref": "#/components/schemas/apistatusStatus"
},
"toolkits": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
apiMultiModelTypeResponse
{
"type": "object",
"title": "MultiModelTypeResponse",
"properties": {
"status": {
"$ref": "#/components/schemas/apistatusStatus"
},
"modelTypes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiModelType"
},
"description": "List of ModelType objects."
},
"modelImporters": {
"$ref": "#/components/schemas/apiModelTypeField"
},
"tritonCondaEnvsInfo": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiTritonCondaEnvInfo"
},
"title": "Triton model envs that can be used for model upload"
}
}
}
apiMultiModelUseCaseResponse
{
"type": "object",
"properties": {
"status": {
"$ref": "#/components/schemas/apistatusStatus"
},
"usecases": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
apiMultiModelVersionInputExampleResponse
{
"type": "object",
"title": "MultiModelVersionInputExampleResponse",
"properties": {
"status": {
"$ref": "#/components/schemas/apistatusStatus"
},
"modelVersionInputExamples": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiModelVersionInputExample"
},
"title": "model input example messages"
}
}
}
apiMultiModelVersionResponse
{
"type": "object",
"title": "MultiModelVersionResponse",
"properties": {
"status": {
"$ref": "#/components/schemas/apistatusStatus"
},
"modelVersions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiModelVersion"
}
}
}
}
apiMultiModuleResponse
{
"type": "object",
"title": "MultiModuleResponse",
"properties": {
"status": {
"$ref": "#/components/schemas/apistatusStatus"
},
"modules": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiModule"
}
}
}
}
apiMultiModuleVersionResponse
{
"type": "object",
"title": "MultiModuleVersionResponse",
"properties": {
"status": {
"$ref": "#/components/schemas/apistatusStatus"
},
"moduleVersions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiModuleVersion"
}
}
}
}
apiMultiOutputResponse
{
"type": "object",
"title": "MultiOutputResponse",
"properties": {
"status": {
"$ref": "#/components/schemas/apistatusStatus"
},
"outputs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiOutput"
},
"description": "For each input processed during model prediction we create one output."
}
}
}
apiMultiRunnerItemOutputResponse
{
"type": "object",
"properties": {
"status": {
"$ref": "#/components/schemas/apistatusStatus"
},
"runnerItemOutputs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiRunnerItemOutput"
}
}
}
}
apiMultiRunnerItemResponse
{
"type": "object",
"title": "MultiRunnerItemResponse",
"properties": {
"status": {
"$ref": "#/components/schemas/apistatusStatus"
},
"runnerItems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiRunnerItem"
}
}
}
}
apiMultiRunnerResponse
{
"type": "object",
"title": "MultiRunnerResponse",
"properties": {
"status": {
"$ref": "#/components/schemas/apistatusStatus"
},
"runners": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiRunner"
}
}
}
}