openapi: 3.2.0 info: title: proto/clarifai/api/service.proto Users API version: version not set tags: - name: Users paths: /v2/users/{runner_selector.deployment.user_id}/deployments/{runner_selector.deployment.id}/outputs: post: summary: Get predicted outputs from the model operationId: V2_PostModelOutputs5 responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/apiMultiOutputResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: runner_selector.deployment.user_id description: The user who owns the deployment. These live in the user/org account. in: path required: true schema: type: string - name: runner_selector.deployment.id description: An id for this configured deployment. in: path required: true schema: type: string tags: - Users requestBody: content: application/json: schema: $ref: '#/components/schemas/V2PostModelOutputsBody' required: true /v2/users/{user_app_id.user_id_1}/compute_clusters/{compute_cluster_id}/nodepools/{nodepool_id}/runners: post: summary: Patch runners of a user operationId: V2_PatchRunners responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/apiMultiRunnerResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id_1 description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: compute_cluster_id in: path required: true schema: type: string - name: nodepool_id in: path required: true schema: type: string tags: - Users requestBody: content: application/json: schema: $ref: '#/components/schemas/V2PatchRunnersBody' required: true ? /v2/users/{user_app_id.user_id_1}/compute_clusters/{compute_cluster_id}/nodepools/{nodepool_id}/runners/{runner_id}/{log_type}/logs : get: operationId: V2_StreamLogEntries responses: '200': description: A successful response.(streaming responses) content: application/json: schema: type: object properties: result: $ref: '#/components/schemas/apiMultiLogEntryResponse' error: $ref: '#/components/schemas/googlerpcStatus' title: Stream result of apiMultiLogEntryResponse default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id_1 description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: compute_cluster_id in: path required: true schema: type: string - name: nodepool_id in: path required: true schema: type: string - name: runner_id in: path required: true schema: type: string - name: log_type description: 'The type of log entry. Examples: model, agent, build, training.' in: path required: true schema: type: string - name: user_app_id.app_id in: query required: false schema: type: string - name: model_id description: 'For models if you set log_type to "builder" then you get the model build logs. The Model ID, if a model produced the logs.' in: query required: false schema: type: string - name: model_version_id description: The Version ID, if a model version produced the logs. in: query required: false schema: type: string - name: workflow_id description: Workflow Id, if a workflow produced the logs. in: query required: false schema: type: string - name: compute_cluster_user_id description: Where the logs came from. in: query required: false schema: type: string - name: pipeline_id description: 'Pipelines that produced the logs with log_type: pipeline.version.run Must include user_app_id with user_id and app_id as well.' in: query required: false schema: type: string - name: pipeline_version_id in: query required: false schema: type: string - name: pipeline_version_run_id in: query required: false schema: type: string - name: pipeline_step_id description: 'During pipeline step build provide these IDs with log_type: builder Must include user_app_id with user_id and app_id as well.' in: query required: false schema: type: string - name: pipeline_step_version_id in: query required: false schema: type: string tags: - Users summary: V2 stream log entries x-summary-source: derived ? /v2/users/{user_app_id.user_id_1}/compute_clusters/{compute_cluster_user_id}/{compute_cluster_id}/nodepools/{nodepool_id}/versions/{model_version_id}/{log_type}/logs : get: operationId: V2_StreamLogEntries2 responses: '200': description: A successful response.(streaming responses) content: application/json: schema: type: object properties: result: $ref: '#/components/schemas/apiMultiLogEntryResponse' error: $ref: '#/components/schemas/googlerpcStatus' title: Stream result of apiMultiLogEntryResponse default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id_1 description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: compute_cluster_user_id description: Where the logs came from. in: path required: true schema: type: string - name: compute_cluster_id in: path required: true schema: type: string - name: nodepool_id in: path required: true schema: type: string - name: model_version_id description: The Version ID, if a model version produced the logs. in: path required: true schema: type: string - name: log_type description: 'The type of log entry. Examples: model, agent, build, training.' in: path required: true schema: type: string - name: user_app_id.app_id in: query required: false schema: type: string - name: model_id description: 'For models if you set log_type to "builder" then you get the model build logs. The Model ID, if a model produced the logs.' in: query required: false schema: type: string - name: workflow_id description: Workflow Id, if a workflow produced the logs. in: query required: false schema: type: string - name: runner_id in: query required: false schema: type: string - name: pipeline_id description: 'Pipelines that produced the logs with log_type: pipeline.version.run Must include user_app_id with user_id and app_id as well.' in: query required: false schema: type: string - name: pipeline_version_id in: query required: false schema: type: string - name: pipeline_version_run_id in: query required: false schema: type: string - name: pipeline_step_id description: 'During pipeline step build provide these IDs with log_type: builder Must include user_app_id with user_id and app_id as well.' in: query required: false schema: type: string - name: pipeline_step_version_id in: query required: false schema: type: string tags: - Users summary: V2 stream log entries2 x-summary-source: derived /v2/users/{user_app_id.user_id}: get: summary: Get user information operationId: V2_GetUser responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/apiSingleUserResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: user_app_id.app_id in: query required: false schema: type: string - name: additional_fields description: '(optional URL parameter) List of additional fields to be included in the response. Currently supported: all, stars' in: query required: false style: form explode: true schema: type: array items: type: string tags: - Users /v2/users/{user_app_id.user_id}/apps: get: summary: List all the apps operationId: V2_ListApps responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/apiMultiAppResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: user_app_id.app_id in: query required: false schema: type: string - name: page description: '(optional URL parameter) The page number. Pagination is used to split the results into chunks. Defaults to 1.' in: query required: false schema: type: integer format: int64 - name: per_page description: '(optional URL parameter) The number of results that will be contained in each page. Defaults to 128.' in: query required: false schema: type: integer format: int64 - name: additional_fields description: '(optional URL parameter) List of additional fields to be included in the response. Currently supported: all, stars, counts' in: query required: false style: form explode: true schema: type: array items: type: string - name: sort_ascending description: 'Sorting options: Whether to sort in ascending order. If false, will order in descending order.' in: query required: false schema: type: boolean - name: sort_by_name description: Whether to order by the name. in: query required: false schema: type: boolean - name: sort_by_modified_at description: 'Whether to order by the modified_at time. If none of the sort options is set to true, will sort by modified_at.' in: query required: false schema: type: boolean - name: sort_by_created_at description: Whether to order by the created_at time. in: query required: false schema: type: boolean - name: sort_by_star_count description: Whether to order by the number of users stared the app in: query required: false schema: type: boolean - name: sort_by_id description: Whether to order by the id in: query required: false schema: type: boolean - name: sort_by_relevance description: Whether to order by search query relevance. Can only be used if search is not empty. in: query required: false schema: type: boolean - name: featured_only description: 'Filtering options: If true, we only return apps that are handpicked by clarifai staff' in: query required: false schema: type: boolean - name: starred_only description: If true, we only return apps that are starred by the requesting user in: query required: false schema: type: boolean - name: template_only description: If true, we only return apps that are marked as a template by the app owner. in: query required: false schema: type: boolean - name: visibility.gettable description: " - UNKNOWN_VISIBILITY: Default value not allowed.\n - PRIVATE: PRIVATE requires collaborator or team permissions in order to GET this resource.\n - ORG: ORG requires you to be in the same org in order to GET this resource, but don't have to be a\nteammate or collaborator.\n - PUBLIC: PUBLIC opens up GET access to the resource to any user on the platform even if they are not\na teammate or collaborator." in: query required: false schema: type: string enum: - UNKNOWN_VISIBILITY - PRIVATE - ORG - PUBLIC default: UNKNOWN_VISIBILITY - name: search description: "Searching options:\nSpecify a search parameter in order to perform keyword search on the\nfollowing fields of the application:\n - id\n - name\n - description\n - notes\n - user_id (unless user_app_id.user_id is already set)\n\nKeywords are both normalized for search (so searching for \"satisfy\" matches \"satisfied\")\nand used for partial prefix-matching (so searching for \"clari\" matches \"clarifai\").\n\nNOTE: Both the list of fields searched and the exact keyword matching\nrules are subject to change and not guaranteed to be backwards-compatible." in: query required: false schema: type: string - name: query description: 'Query various text fields (id, name, description, and notes) that can contain the words in the query string Deprecated: use search instead.' in: query required: false schema: type: string - name: name description: 'Filter by the id, name and notes of the app. This supports wilcard queries like "gen*" to match "general" as an example. Deprecated: use search instead.' in: query required: false schema: type: string - name: id description: 'Filter by the user-unique-id of the app. This supports wilcard queries like "gen*" to match "general" as an example. Deprecated: use search instead.' in: query required: false schema: type: string tags: - Users post: summary: Add a app to an app. operationId: V2_PostApps responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/apiMultiAppResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string tags: - Users requestBody: content: application/json: schema: $ref: '#/components/schemas/V2PostAppsBody' required: true patch: summary: Patch one or more apps operationId: V2_PatchApps responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/apiMultiAppResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string tags: - Users requestBody: content: application/json: schema: $ref: '#/components/schemas/V2PatchAppsBody' required: true /v2/users/{user_app_id.user_id}/apps/ids: patch: summary: Patch apps ids operationId: V2_PatchAppsIds responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/apiMultiAppResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string tags: - Users requestBody: content: application/json: schema: $ref: '#/components/schemas/V2PatchAppsIdsBody' required: true /v2/users/{user_app_id.user_id}/apps/searches: post: summary: Search over the applications to find one or more you're looking for operationId: V2_PostAppsSearches responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/apiMultiAppResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string tags: - Users requestBody: content: application/json: schema: $ref: '#/components/schemas/V2PostAppsSearchesBody' required: true /v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}: get: summary: Get a specific app from an app operationId: V2_GetApp responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/apiSingleAppResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: user_app_id.app_id in: path required: true schema: type: string - name: additional_fields description: '(optional URL parameter) List of additional fields to be included in the response. Currently supported: all, stars, counts' in: query required: false style: form explode: true schema: type: array items: type: string tags: - Users delete: summary: Search over the apps to find one or more you're looking for. operationId: V2_DeleteApp responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/statusBaseResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: user_app_id.app_id in: path required: true schema: type: string tags: - Users patch: summary: Patch one app operationId: V2_PatchApp responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/apiSingleAppResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: user_app_id.app_id in: path required: true schema: type: string tags: - Users requestBody: content: application/json: schema: $ref: '#/components/schemas/V2PatchAppBody' required: true /v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/annotation_filters: get: summary: List all the annotation filters operationId: V2_ListAnnotationFilters responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/apiMultiAnnotationFilterResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: user_app_id.app_id in: path required: true schema: type: string - name: page description: '(optional URL parameter) The page number. Pagination is used to split the results into chunks. Defaults to 1.' in: query required: false schema: type: integer format: int64 - name: per_page description: '(optional URL parameter) The number of results that will be contained in each page. Defaults to 128.' in: query required: false schema: type: integer format: int64 tags: - Users delete: summary: Delete one or more annotation filters in a single request operationId: V2_DeleteAnnotationFilters responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/statusBaseResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: user_app_id.app_id in: path required: true schema: type: string tags: - Users requestBody: content: application/json: schema: $ref: '#/components/schemas/V2DeleteAnnotationFiltersBody' required: true post: summary: Add annotation filters operationId: V2_PostAnnotationFilters responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/apiMultiAnnotationFilterResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: user_app_id.app_id in: path required: true schema: type: string tags: - Users requestBody: content: application/json: schema: $ref: '#/components/schemas/V2PostAnnotationFiltersBody' required: true patch: summary: Patch one or more annotation filters operationId: V2_PatchAnnotationFilters responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/apiMultiAnnotationFilterResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: user_app_id.app_id in: path required: true schema: type: string tags: - Users requestBody: content: application/json: schema: $ref: '#/components/schemas/V2PatchAnnotationFiltersBody' required: true /v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/annotation_filters/{annotation_filter_id}: get: summary: Get a specific annotation filter operationId: V2_GetAnnotationFilter responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/apiSingleAnnotationFilterResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: user_app_id.app_id in: path required: true schema: type: string - name: annotation_filter_id description: Identify annotation filter by id. in: path required: true schema: type: string tags: - Users /v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/annotation_tracks: delete: summary: Delete multiple annotation tracks in one request operationId: V2_DeleteAnnotationTracks responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/statusBaseResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: user_app_id.app_id in: path required: true schema: type: string tags: - Users requestBody: content: application/json: schema: $ref: '#/components/schemas/V2DeleteAnnotationTracksBody' required: true /v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/annotations: get: summary: List all the annotation operationId: V2_ListAnnotations responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/apiMultiAnnotationResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: user_app_id.app_id in: path required: true schema: type: string - name: ids description: List annotations for these IDs in: query required: false style: form explode: true schema: type: array items: type: string - name: input_ids description: 'List annotations for these Input IDs Note that ''ids'' are optional but if the are provided the number and order in ''ids'' and ''input_ids'' should match If you do not specify ''ids'' all the annotations for ''input_ids'' are returned If a you do not specify both ''input_ids'' and ''ids'' all the annotations in the app are returned' in: query required: false style: form explode: true schema: type: array items: type: string - name: user_ids description: 'Only return the annotations that has one of these user IDs, effectively operating as an OR among them to filter down the results. If model_version_ids or workflow_version_ids are also provided, these user_ids are OR''d with them as well because we want the union of all worker (user, model or workflow) annotations in the results of ListAnnotations request. Setting user_ids does also set list_all_annotations=True.' in: query required: false style: form explode: true schema: type: array items: type: string - name: model_version_ids description: 'Only return the annotations that has one of these model version IDs, effectively operating as an OR among them to filter down the results. If user_ids or workflow_version_ids are also provided, these model_version_ids are OR''d with them as well because we want the union of all worker (user, model or workflow) annotations in the results of ListAnnotations request. Setting model_version_ids does also set list_all_annotations=True.' in: query required: false style: form explode: true schema: type: array items: type: string - name: workflow_version_ids description: 'Only return the annotations that has one of these workflow version IDs, effectively operating as an OR among them to filter down the results. If user_ids or model_version_ids are also provided, these workflow_version_ids are OR''d with them as well because we want the union of all worker (user, model or workflow) annotations in the results of ListAnnotations request. Setting workflow_version_ids does also set list_all_annotations=True.' in: query required: false style: form explode: true schema: type: array items: type: string - name: list_all_annotations description: 'Set this flag to list both trusted and not trusted annotations by default it''s listing only trusted annotations' in: query required: false schema: type: boolean - name: return_model_output description: Set this flag to return the model output for model annotations in the response. in: query required: false schema: type: boolean - name: page description: '(optional URL parameter) The page number. Pagination is used to split the results into chunks. Defaults to 1.' in: query required: false schema: type: integer format: int64 - name: per_page description: '(optional URL parameter) The number of results that will be contained in each page. Defaults to 128.' in: query required: false schema: type: integer format: int64 - name: task_id description: Flag to filter annotations by task_id in: query required: false schema: type: string tags: - Users delete: summary: Delete multiple annotations in one request operationId: V2_DeleteAnnotations3 responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/statusBaseResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: user_app_id.app_id in: path required: true schema: type: string tags: - Users requestBody: content: application/json: schema: $ref: '#/components/schemas/apiV2DeleteAnnotationsBody' required: true post: summary: Post annotations operationId: V2_PostAnnotations responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/apiMultiAnnotationResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: user_app_id.app_id in: path required: true schema: type: string tags: - Users requestBody: content: application/json: schema: $ref: '#/components/schemas/V2PostAnnotationsBody' required: true patch: summary: Patch one or more annotations operationId: V2_PatchAnnotations responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/apiMultiAnnotationResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: user_app_id.app_id in: path required: true schema: type: string tags: - Users requestBody: content: application/json: schema: $ref: '#/components/schemas/V2PatchAnnotationsBody' required: true /v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/annotations/searches: post: summary: Execute a search over annotations operationId: V2_PostAnnotationsSearches responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/apiMultiSearchResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: user_app_id.app_id in: path required: true schema: type: string tags: - Users requestBody: content: application/json: schema: $ref: '#/components/schemas/V2PostAnnotationsSearchesBody' required: true patch: summary: Patch saved annotations searches by ids operationId: V2_PatchAnnotationsSearches responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/apiMultiSearchResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: user_app_id.app_id in: path required: true schema: type: string tags: - Users requestBody: content: application/json: schema: $ref: '#/components/schemas/V2PatchAnnotationsSearchesBody' required: true /v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/annotations/workers: get: summary: ListAnnotationWorkers lists users, models, and workflows (collectively known as… operationId: V2_ListAnnotationWorkers responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/apiMultiWorkerResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: user_app_id.app_id in: path required: true schema: type: string - name: page description: '(optional URL parameter) The page number. Pagination is used to split the results into chunks. Defaults to 1.' in: query required: false schema: type: integer format: int64 - name: per_page description: '(optional URL parameter) The number of results that will be contained in each page. Defaults to 128.' in: query required: false schema: type: integer format: int64 - name: additional_fields description: '(optional URL parameter) List of additional fields to be included in the response. Currently supported: all, names' in: query required: false style: form explode: true schema: type: array items: type: string - name: trusted_only description: (optional URL parameter) Only list workers that have created trusted annotations. in: query required: false schema: type: boolean tags: - Users /v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/artifacts: get: operationId: V2_ListArtifacts responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/apiMultiArtifactResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: user_app_id.app_id in: path required: true schema: type: string - name: page description: '(optional URL parameter) The page number. Pagination is used to split the results into chunks. Defaults to 1.' in: query required: false schema: type: integer format: int64 - name: per_page description: '(optional URL parameter) The number of results that will be contained in each page. Defaults to 128.' in: query required: false schema: type: integer format: int64 tags: - Users summary: V2 list artifacts x-summary-source: derived delete: operationId: V2_DeleteArtifact responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/statusBaseResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: user_app_id.app_id in: path required: true schema: type: string tags: - Users requestBody: content: application/json: schema: $ref: '#/components/schemas/V2DeleteArtifactBody' required: true summary: V2 delete artifact x-summary-source: derived post: operationId: V2_PostArtifacts responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/apiMultiArtifactResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: user_app_id.app_id in: path required: true schema: type: string tags: - Users requestBody: content: application/json: schema: $ref: '#/components/schemas/V2PostArtifactsBody' required: true summary: V2 post artifacts x-summary-source: derived /v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/artifacts/{artifact_id}: get: operationId: V2_GetArtifact responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/apiSingleArtifactResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: user_app_id.app_id in: path required: true schema: type: string - name: artifact_id description: The id of the artifact to get in: path required: true schema: type: string tags: - Users summary: V2 get artifact x-summary-source: derived /v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/artifacts/{artifact_id}/versions: get: operationId: V2_ListArtifactVersions responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/apiMultiArtifactVersionResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: user_app_id.app_id in: path required: true schema: type: string - name: artifact_id description: List versions for the artifact identified by this id in: path required: true schema: type: string - name: page description: '(optional URL parameter) The page number. Pagination is used to split the results into chunks. Defaults to 1.' in: query required: false schema: type: integer format: int64 - name: per_page description: '(optional URL parameter) The number of results that will be contained in each page. Defaults to 128.' in: query required: false schema: type: integer format: int64 tags: - Users summary: V2 list artifact versions x-summary-source: derived delete: operationId: V2_DeleteArtifactVersion responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/statusBaseResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: user_app_id.app_id in: path required: true schema: type: string - name: artifact_id description: The id of the artifact for which versions are being deleted in: path required: true schema: type: string tags: - Users requestBody: content: application/json: schema: $ref: '#/components/schemas/V2DeleteArtifactVersionBody' required: true summary: V2 delete artifact version x-summary-source: derived /v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/artifacts/{artifact_id}/versions/{artifact_version_id}: get: operationId: V2_GetArtifactVersion responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/apiSingleArtifactVersionResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: user_app_id.app_id in: path required: true schema: type: string - name: artifact_id description: The id of the artifact that has the requested version. in: path required: true schema: type: string - name: artifact_version_id description: Get the artifact version identified by this id in: path required: true schema: type: string tags: - Users summary: V2 get artifact version x-summary-source: derived /v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/bulk_operations: get: summary: List all the bulk operations operationId: V2_ListBulkOperations responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/apiMultiBulkOperationsResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: user_app_id.app_id in: path required: true schema: type: string - name: page description: '(optional URL parameter) The page number. Pagination is used to split the results into chunks. Defaults to 1.' in: query required: false schema: type: integer format: int64 - name: per_page description: '(optional URL parameter) The number of results that will be contained in each page. Defaults to 128.' in: query required: false schema: type: integer format: int64 tags: - Users delete: summary: delete one or more terminated bulk operations operationId: V2_DeleteBulkOperations responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/statusBaseResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: user_app_id.app_id in: path required: true schema: type: string tags: - Users requestBody: content: application/json: schema: $ref: '#/components/schemas/V2DeleteBulkOperationsBody' required: true post: summary: Perform bulk operations on a list of inputs based on input source. operationId: V2_PostBulkOperations responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/apiMultiBulkOperationsResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: user_app_id.app_id in: path required: true schema: type: string tags: - Users requestBody: content: application/json: schema: $ref: '#/components/schemas/V2PostBulkOperationsBody' required: true patch: summary: Cancel one or more bulk operations operationId: V2_CancelBulkOperations responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/apiMultiBulkOperationsResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: user_app_id.app_id in: path required: true schema: type: string tags: - Users requestBody: content: application/json: schema: $ref: '#/components/schemas/V2CancelBulkOperationsBody' required: true /v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/bulk_operations/{id}: get: summary: Get the bulk operation details by ID operationId: V2_GetBulkOperation responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/apiSingleBulkOperationsResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: user_app_id.app_id in: path required: true schema: type: string - name: id description: The bulk operation id in: path required: true schema: type: string tags: - Users /v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/collaborators: get: summary: owner list users who the app is shared with operationId: V2_ListCollaborators responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/apiMultiCollaboratorsResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: user_app_id.app_id in: path required: true schema: type: string - name: list_all_collaborators description: 'Set this flag to list both deleted and not deleted collaborators by default it''s listing only not deleted collaborators' in: query required: false schema: type: boolean - name: page description: '(optional URL parameter) The page number. Pagination is used to split the results into chunks. Defaults to 1.' in: query required: false schema: type: integer format: int64 - name: per_page description: '(optional URL parameter) The number of results that will be contained in each page. Defaults to 128.' in: query required: false schema: type: integer format: int64 tags: - Users delete: summary: Delete existing collaborators operationId: V2_DeleteCollaborators responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/statusBaseResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: user_app_id.app_id in: path required: true schema: type: string tags: - Users requestBody: content: application/json: schema: $ref: '#/components/schemas/V2DeleteCollaboratorsBody' required: true post: summary: add collaborators to an app operationId: V2_PostCollaborators responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/apiMultiCollaboratorsResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: user_app_id.app_id in: path required: true schema: type: string tags: - Users requestBody: content: application/json: schema: $ref: '#/components/schemas/V2PostCollaboratorsBody' required: true patch: summary: Patch existing collaborators operationId: V2_PatchCollaborators responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/apiMultiCollaboratorsResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: user_app_id.app_id in: path required: true schema: type: string tags: - Users requestBody: content: application/json: schema: $ref: '#/components/schemas/V2PatchCollaboratorsBody' required: true /v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/concepts: get: summary: List all the concepts operationId: V2_ListConcepts responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/apiMultiConceptResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: user_app_id.app_id in: path required: true schema: type: string - name: page description: '(optional URL parameter) The page number. Pagination is used to split the results into chunks. Defaults to 1.' in: query required: false schema: type: integer format: int64 - name: per_page description: '(optional URL parameter) The number of results that will be contained in each page. Defaults to 128.' in: query required: false schema: type: integer format: int64 - name: id description: Fuzzy match on concept ID in: query required: false schema: type: string tags: - Users post: summary: Add a concept to an app operationId: V2_PostConcepts responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/apiMultiConceptResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: user_app_id.app_id in: path required: true schema: type: string tags: - Users requestBody: content: application/json: schema: $ref: '#/components/schemas/V2PostConceptsBody' required: true patch: summary: Patch one or more concepts operationId: V2_PatchConcepts responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/apiMultiConceptResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: user_app_id.app_id in: path required: true schema: type: string tags: - Users requestBody: content: application/json: schema: $ref: '#/components/schemas/V2PatchConceptsBody' required: true /v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/concepts/knowledge_graphs: get: summary: List all domain graphs operationId: V2_ListKnowledgeGraphs responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/apiMultiKnowledgeGraphResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: user_app_id.app_id in: path required: true schema: type: string tags: - Users post: summary: Post domain graphs operationId: V2_PostKnowledgeGraphs responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/apiMultiKnowledgeGraphResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: user_app_id.app_id in: path required: true schema: type: string tags: - Users requestBody: content: application/json: schema: $ref: '#/components/schemas/V2PostKnowledgeGraphsBody' required: true /v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/concepts/relations: get: summary: List concept relations between concepts in the platform. operationId: V2_ListConceptRelations2 responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/apiMultiConceptRelationResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: user_app_id.app_id in: path required: true schema: type: string - name: concept_id description: 'The subject concept id in your app to get all the relationships for. Leave as an empty string (GET /concepts/relations) to list ALL the relations in the app. When listing all the relations it will only return one direction of the relationship with the predicate acting on the subject and not the inverse like is done when providing a concept_id so that we can return a reliable page size always. When providing a concept_id, if a hyponym is present in the DB such as: ''honey'' (subject), ''hyponym'' (predicate for "is a kind of"), ''food'' (object) then you can list the concept relations for ''honey'' and get hyponym predicate with ''food'' object. But you can also list the concept relations for ''food'' and it will return the same hyponym relationship with ''honey'' as object and ''hypernym'' as predicate. Synonyms by nature are symmetrical relationships so either side can be the concept_id (subject) when listing the relations.' in: query required: false schema: type: string - name: predicate description: 'If predicate is provided then only list relations with that predicate. Note that if no subject is set in concept_id and predicate is set to ''hypernym'', then it will return any stored hyponyms as hypernyms with just the subject and object swapped since they are reversed relations. Valid predicates are: - ''hypernym'' - ''hyponym'' - ''synonym''' in: query required: false schema: type: string - name: knowledge_graph_id description: 'If knowledge_graph_id is provided then just list relations from that knowledge graph. If not provided then list relations from all knowledge graphs including the global one for this app one (ie. knowledge_graph "") and any specific ones in the app.' in: query required: false schema: type: string - name: page description: '(optional URL parameter) The page number. Pagination is used to split the results into chunks. Defaults to 1.' in: query required: false schema: type: integer format: int64 - name: per_page description: '(optional URL parameter) The number of results that will be contained in each page. Defaults to 128.' in: query required: false schema: type: integer format: int64 tags: - Users /v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/concepts/searches: post: summary: Search over the concepts to find one or more you're looking for. operationId: V2_PostConceptsSearches responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/apiMultiConceptResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: user_app_id.app_id in: path required: true schema: type: string tags: - Users requestBody: content: application/json: schema: $ref: '#/components/schemas/V2PostConceptsSearchesBody' required: true /v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/concepts/status: get: summary: List all the concepts with their positive and negative counts operationId: V2_GetConceptCounts responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/apiMultiConceptCountResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: user_app_id.app_id in: path required: true schema: type: string - name: page description: '(optional URL parameter) The page number. Pagination is used to split the results into chunks. Defaults to 1.' in: query required: false schema: type: integer format: int64 - name: per_page description: '(optional URL parameter) The number of results that will be contained in each page. Defaults to 128.' in: query required: false schema: type: integer format: int64 tags: - Users /v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/concepts/{concept_id}: get: summary: Get a specific concept from an app operationId: V2_GetConcept responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/apiSingleConceptResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: user_app_id.app_id in: path required: true schema: type: string - name: concept_id description: The concept's id. in: path required: true schema: type: string tags: - Users /v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/concepts/{concept_id}/languages: get: summary: List the concept in all the translated languages operationId: V2_ListConceptLanguages responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/apiMultiConceptLanguageResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: user_app_id.app_id in: path required: true schema: type: string - name: concept_id in: path required: true schema: type: string - name: page description: '(optional URL parameter) The page number. Pagination is used to split the results into chunks. Defaults to 1.' in: query required: false schema: type: integer format: int64 - name: per_page description: '(optional URL parameter) The number of results that will be contained in each page. Defaults to 128.' in: query required: false schema: type: integer format: int64 tags: - Users post: summary: Add a new translation for this concept operationId: V2_PostConceptLanguages responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/apiMultiConceptLanguageResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: user_app_id.app_id in: path required: true schema: type: string - name: concept_id in: path required: true schema: type: string tags: - Users requestBody: content: application/json: schema: $ref: '#/components/schemas/V2PostConceptLanguagesBody' required: true patch: summary: Patch the name for a given language names by passing in a list of concepts with… operationId: V2_PatchConceptLanguages responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/apiMultiConceptLanguageResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: user_app_id.app_id in: path required: true schema: type: string - name: concept_id in: path required: true schema: type: string tags: - Users requestBody: content: application/json: schema: $ref: '#/components/schemas/V2PatchConceptLanguagesBody' required: true /v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/concepts/{concept_id}/languages/{language}: get: summary: Get a specific concept from an app operationId: V2_GetConceptLanguage responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/apiSingleConceptLanguageResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: user_app_id.app_id in: path required: true schema: type: string - name: concept_id in: path required: true schema: type: string - name: language description: This is the language identifier. in: path required: true schema: type: string tags: - Users /v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/concepts/{concept_id}/relations: get: summary: List concept relations between concepts in the platform. operationId: V2_ListConceptRelations responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/apiMultiConceptRelationResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: user_app_id.app_id in: path required: true schema: type: string - name: concept_id description: 'The subject concept id in your app to get all the relationships for. Leave as an empty string (GET /concepts/relations) to list ALL the relations in the app. When listing all the relations it will only return one direction of the relationship with the predicate acting on the subject and not the inverse like is done when providing a concept_id so that we can return a reliable page size always. When providing a concept_id, if a hyponym is present in the DB such as: ''honey'' (subject), ''hyponym'' (predicate for "is a kind of"), ''food'' (object) then you can list the concept relations for ''honey'' and get hyponym predicate with ''food'' object. But you can also list the concept relations for ''food'' and it will return the same hyponym relationship with ''honey'' as object and ''hypernym'' as predicate. Synonyms by nature are symmetrical relationships so either side can be the concept_id (subject) when listing the relations.' in: path required: true schema: type: string - name: predicate description: 'If predicate is provided then only list relations with that predicate. Note that if no subject is set in concept_id and predicate is set to ''hypernym'', then it will return any stored hyponyms as hypernyms with just the subject and object swapped since they are reversed relations. Valid predicates are: - ''hypernym'' - ''hyponym'' - ''synonym''' in: query required: false schema: type: string - name: knowledge_graph_id description: 'If knowledge_graph_id is provided then just list relations from that knowledge graph. If not provided then list relations from all knowledge graphs including the global one for this app one (ie. knowledge_graph "") and any specific ones in the app.' in: query required: false schema: type: string - name: page description: '(optional URL parameter) The page number. Pagination is used to split the results into chunks. Defaults to 1.' in: query required: false schema: type: integer format: int64 - name: per_page description: '(optional URL parameter) The number of results that will be contained in each page. Defaults to 128.' in: query required: false schema: type: integer format: int64 tags: - Users delete: summary: Post concept relations to create relations between concepts in the platform operationId: V2_DeleteConceptRelations responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/statusBaseResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: user_app_id.app_id in: path required: true schema: type: string - name: concept_id description: The concept to delete relationship for. in: path required: true schema: type: string tags: - Users requestBody: content: application/json: schema: $ref: '#/components/schemas/V2DeleteConceptRelationsBody' required: true post: summary: Post concept relations to create relations between concepts in the platform operationId: V2_PostConceptRelations responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/apiMultiConceptRelationResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: user_app_id.app_id in: path required: true schema: type: string - name: concept_id description: The subject concept id you're going to add relations for. in: path required: true schema: type: string tags: - Users requestBody: content: application/json: schema: $ref: '#/components/schemas/V2PostConceptRelationsBody' required: true /v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/datasets: get: summary: List all the datasets operationId: V2_ListDatasets responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/apiMultiDatasetResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: user_app_id.app_id in: path required: true schema: type: string - name: page description: '(optional URL parameter) The page number. Pagination is used to split the results into chunks. Defaults to 1.' in: query required: false schema: type: integer format: int64 - name: per_page description: '(optional URL parameter) The number of results that will be contained in each page. Defaults to 128.' in: query required: false schema: type: integer format: int64 - name: additional_fields in: query required: false style: form explode: true schema: type: array items: type: string - name: sort_ascending description: 'Sorting options: Whether to sort in ascending order. If false, will order in descending order.' in: query required: false schema: type: boolean - name: sort_by_created_at description: Whether to order by the created_at time. in: query required: false schema: type: boolean - name: sort_by_star_count description: Whether to order by the number of users stared the app in: query required: false schema: type: boolean - name: sort_by_modified_at description: If neither sort option is set to true, will sort by modified_at. in: query required: false schema: type: boolean - name: sort_by_id description: Whether to order by the external id in: query required: false schema: type: boolean - name: sort_by_relevance description: Whether to order by search query relevance. Can only be used if search is not empty. in: query required: false schema: type: boolean - name: starred_only description: 'Filtering options:' in: query required: false schema: type: boolean - name: bookmark description: Filter datasets by bookmark. If set, only return bookmarked datasets. Otherwise none bookmarked datasets only. in: query required: false schema: type: boolean - name: search description: "Searching options:\nSpecify a search parameter in order to perform keyword search on the\nfollowing fields of the dataset:\n - id\n - description\n - notes\n - user_id (unless user_app_id.user_id is already set)\n\nKeywords are both normalized for search (so searching for \"satisfy\" matches \"satisfied\")\nand used for partial prefix-matching (so searching for \"clari\" matches \"clarifai\").\n\nNOTE: Both the list of fields searched and the exact keyword matching\nrules are subject to change and not guaranteed to be backwards-compatible." in: query required: false schema: type: string - name: id description: 'Fuzzy filter on dataset ID Deprecated: use search instead.' in: query required: false schema: type: string tags: - Users delete: summary: Delete one or more datasets in a single request operationId: V2_DeleteDatasets responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/statusBaseResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: user_app_id.app_id in: path required: true schema: type: string tags: - Users requestBody: content: application/json: schema: $ref: '#/components/schemas/V2DeleteDatasetsBody' required: true post: summary: Add datasets to an app. operationId: V2_PostDatasets responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/apiMultiDatasetResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: user_app_id.app_id in: path required: true schema: type: string tags: - Users requestBody: content: application/json: schema: $ref: '#/components/schemas/V2PostDatasetsBody' required: true patch: summary: Patch one or more datasets. operationId: V2_PatchDatasets responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/apiMultiDatasetResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: user_app_id.app_id in: path required: true schema: type: string tags: - Users requestBody: content: application/json: schema: $ref: '#/components/schemas/V2PatchDatasetsBody' required: true /v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/datasets/{dataset_id}: get: summary: Get a specific dataset operationId: V2_GetDataset responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/apiSingleDatasetResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: user_app_id.app_id in: path required: true schema: type: string - name: dataset_id description: Identify dataset by id. in: path required: true schema: type: string - name: additional_fields in: query required: false style: form explode: true schema: type: array items: type: string tags: - Users /v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/datasets/{dataset_id}/inputs: get: summary: List all the dataset inputs in a dataset operationId: V2_ListDatasetInputs responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/apiMultiDatasetInputResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: user_app_id.app_id in: path required: true schema: type: string - name: dataset_id description: Identify dataset by id. in: path required: true schema: type: string - name: page description: '(optional URL parameter) The page number. Pagination is used to split the results into chunks. Defaults to 1.' in: query required: false schema: type: integer format: int64 - name: per_page description: '(optional URL parameter) The number of results that will be contained in each page. Defaults to 128.' in: query required: false schema: type: integer format: int64 tags: - Users delete: summary: Delete one or more dataset inputs in a single request operationId: V2_DeleteDatasetInputs responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/statusBaseResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: user_app_id.app_id in: path required: true schema: type: string - name: dataset_id description: Identify dataset by id. in: path required: true schema: type: string tags: - Users requestBody: content: application/json: schema: $ref: '#/components/schemas/V2DeleteDatasetInputsBody' required: true post: summary: Add dataset inputs to a dataset. operationId: V2_PostDatasetInputs responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/apiMultiDatasetInputResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: user_app_id.app_id in: path required: true schema: type: string - name: dataset_id description: Identify dataset by id. in: path required: true schema: type: string tags: - Users requestBody: content: application/json: schema: $ref: '#/components/schemas/V2PostDatasetInputsBody' required: true /v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/datasets/{dataset_id}/inputs/{input_id}: get: summary: Get a specific dataset input operationId: V2_GetDatasetInput responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/apiSingleDatasetInputResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: user_app_id.app_id in: path required: true schema: type: string - name: dataset_id description: Identify dataset by id. in: path required: true schema: type: string - name: input_id description: Identify dataset input by id. in: path required: true schema: type: string tags: - Users /v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/datasets/{dataset_id}/versions: get: summary: List all the dataset versions operationId: V2_ListDatasetVersions responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/apiMultiDatasetVersionResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: user_app_id.app_id in: path required: true schema: type: string - name: dataset_id description: Identify dataset by id. in: path required: true schema: type: string - name: page description: '(optional URL parameter) The page number. Pagination is used to split the results into chunks. Defaults to 1.' in: query required: false schema: type: integer format: int64 - name: per_page description: '(optional URL parameter) The number of results that will be contained in each page. Defaults to 128.' in: query required: false schema: type: integer format: int64 - name: request_origins description: (optional URL parameter) Filter by origin of dataset version in: query required: false style: form explode: true schema: type: array items: type: string enum: - DATASET_VERSION_REQUEST_ORIGIN_NOT_SET - MANUAL - TRAINING - EVAL_GROUND_TRUTH - EVAL_PREDICTIONS tags: - Users delete: summary: Delete one or more dataset versions in a single request operationId: V2_DeleteDatasetVersions responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/statusBaseResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: user_app_id.app_id in: path required: true schema: type: string - name: dataset_id description: Identify dataset by id. in: path required: true schema: type: string tags: - Users requestBody: content: application/json: schema: $ref: '#/components/schemas/V2DeleteDatasetVersionsBody' required: true post: summary: Add dataset versions to a dataset operationId: V2_PostDatasetVersions responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/apiMultiDatasetVersionResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: user_app_id.app_id in: path required: true schema: type: string - name: dataset_id description: Identify dataset by id. in: path required: true schema: type: string tags: - Users requestBody: content: application/json: schema: $ref: '#/components/schemas/V2PostDatasetVersionsBody' required: true patch: summary: Patch one or more dataset versions operationId: V2_PatchDatasetVersions responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/apiMultiDatasetVersionResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: user_app_id.app_id in: path required: true schema: type: string - name: dataset_id description: Identify dataset by id. in: path required: true schema: type: string tags: - Users requestBody: content: application/json: schema: $ref: '#/components/schemas/V2PatchDatasetVersionsBody' required: true /v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/datasets/{dataset_id}/versions/{dataset_version_id}: get: summary: Get a specific dataset version operationId: V2_GetDatasetVersion responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/apiSingleDatasetVersionResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: user_app_id.app_id in: path required: true schema: type: string - name: dataset_id description: Identify dataset by id. in: path required: true schema: type: string - name: dataset_version_id description: Identify dataset version by id. in: path required: true schema: type: string tags: - Users /v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/datasets/{dataset_id}/versions/{dataset_version_id}/exports: put: summary: Create export of a dataset version operationId: V2_PutDatasetVersionExports responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/apiMultiDatasetVersionExportResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: user_app_id.app_id in: path required: true schema: type: string - name: dataset_id description: Identify dataset by id. in: path required: true schema: type: string - name: dataset_version_id description: Identify dataset version by id. in: path required: true schema: type: string tags: - Users requestBody: content: application/json: schema: $ref: '#/components/schemas/V2PutDatasetVersionExportsBody' required: true /v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/datasets/{dataset_id}/versions/{dataset_version_id}/metrics: get: operationId: V2_ListDatasetVersionMetricsGroups responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/apiMultiDatasetVersionMetricsGroupResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: user_app_id.app_id in: path required: true schema: type: string - name: dataset_id description: Identify dataset by id. in: path required: true schema: type: string - name: dataset_version_id description: Identify dataset version by id. in: path required: true schema: type: string - name: page description: '(optional URL parameter) The page number. Pagination is used to split the results into chunks. Defaults to 1.' in: query required: false schema: type: integer format: int64 - name: per_page description: '(optional URL parameter) The number of results that will be contained in each page. Defaults to 128.' in: query required: false schema: type: integer format: int64 - name: parent_paths description: Filter by parent path. Multiple parent paths are OR-ed. Empty list results in no filter. in: query required: false style: form explode: true schema: type: array items: type: string - name: types description: "Filter by parent type. Multiple types are OR-ed. Empty list results in no filter.\n\n - INPUT_TYPE: Group data examples by input type.\nExamples: images, videos, text, audio.\n - CONCEPT_ID: Group data examples by concept ID.\nExamples: inputs with cat concept, inputs with dog concept.\n - CONCEPTS_COUNT: Group data examples by concepts count.\nExamples: inputs with 20 concepts, inputs with 21 concepts.\n - BOUNDING_BOXES_COUNT: Group data examples by bounding boxes count.\nExamples: inputs with 20 bounding boxes, inputs with 21 bounding boxes.\n - POLYGONS_COUNT: Group data examples by polygons count.\nExamples: inputs with 20 polygons, inputs with 21 polygons.\n - POINTS_COUNT: Group data examples by points count.\nExamples: inputs with 20 points, inputs with 21 points.\n - MASKS_COUNT: Group data examples by masks count.\nExamples: inputs with 20 masks, inputs with 21 masks.\n - PIXELS_COUNT: Group data examples by pixels count.\nIn order to reduce the number of groups, we use bins.\nExamples for bin size = 400: inputs with [200000, 200400) pixels, inputs with [200400, 200800) pixels.\n - ASPECT_RATIO: Group data examples by aspect ratio.\nIn order to reduce the number of groups, we use bins.\nExamples for bin size = 0.1: inputs with [0.5, 0.6) aspect ratio, inputs with [0.6, 0.7) aspect ratio." in: query required: false style: form explode: true schema: type: array items: type: string enum: - DATASET_VERSION_METRICS_GROUP_TYPE_NOT_SET - INPUT_TYPE - CONCEPT_ID - CONCEPTS_COUNT - BOUNDING_BOXES_COUNT - POLYGONS_COUNT - POINTS_COUNT - MASKS_COUNT - PIXELS_COUNT - ASPECT_RATIO tags: - Users summary: V2 list dataset version metrics groups x-summary-source: derived /v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/duplications: post: summary: 'Deprecated: App duplication is no longer supported.' operationId: V2_PostAppDuplications responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/apiMultiAppDuplicationsResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: user_app_id.app_id in: path required: true schema: type: string tags: - Users requestBody: content: application/json: schema: $ref: '#/components/schemas/V2PostAppDuplicationsBody' required: true /v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/evaluations: get: operationId: V2_ListEvaluations responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/apiMultiEvalMetricsResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: user_app_id.app_id in: path required: true schema: type: string - name: page description: '(optional URL parameter) The page number. Pagination is used to split the results into chunks. Defaults to 1.' in: query required: false schema: type: integer format: int64 - name: per_page description: '(optional URL parameter) The number of results that will be contained in each page. Defaults to 128.' in: query required: false schema: type: integer format: int64 - name: sort_ascending description: If true, sort in ascending order, otherwise sort in descending order. in: query required: false schema: type: boolean - name: sort_by_app_id description: Whether to order by application id in: query required: false schema: type: boolean - name: sort_by_roc_auc description: Whether to order by eval metric summary.macro_avg_roc_auc in: query required: false schema: type: boolean - name: sort_by_f1 description: Whether to order by eval metric summary.f1 in: query required: false schema: type: boolean - name: sort_by_created_at description: Whether to order by when the metric was created in: query required: false schema: type: boolean - name: sort_by_mean_avg_precision description: Whether to order by eval metric summary.mean_avg_precision_iou_50 in: query required: false schema: type: boolean - name: sort_by_precision description: Whether to order by eval metric summary.macro_avg_precision in: query required: false schema: type: boolean - name: sort_by_recall description: Whether to order by eval metric summary.macro_avg_recall in: query required: false schema: type: boolean - name: sort_by_model_id in: query required: false schema: type: boolean - name: sort_by_eval_dataset_id in: query required: false schema: type: boolean - name: sort_by_train_dataset_id in: query required: false schema: type: boolean - name: model_type_id description: Filter on model type id in: query required: false schema: type: string - name: eval_dataset_ids description: Filter on dataset ID of the dataset version specified in the metric version in: query required: false style: form explode: true schema: type: array items: type: string - name: train_dataset_ids description: Filter on dataset ID of the dataset version specified by the model version in: query required: false style: form explode: true schema: type: array items: type: string - name: concept_ids description: Filter on concept IDs specified in the modele version's output_info in: query required: false style: form explode: true schema: type: array items: type: string - name: show_failed_metrics description: Whether to show failed metrics, defaults to false in: query required: false schema: type: boolean tags: - Users summary: V2 list evaluations x-summary-source: derived post: operationId: V2_PostEvaluations responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/apiMultiEvalMetricsResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: user_app_id.app_id in: path required: true schema: type: string tags: - Users requestBody: content: application/json: schema: $ref: '#/components/schemas/V2PostEvaluationsBody' required: true summary: V2 post evaluations x-summary-source: derived /v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/evaluations/{evaluation_id}: get: operationId: V2_GetEvaluation responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/apiSingleEvalMetricsResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: user_app_id.app_id in: path required: true schema: type: string - name: evaluation_id in: path required: true schema: type: string - name: fields.confusion_matrix in: query required: false schema: type: boolean - name: fields.cooccurrence_matrix in: query required: false schema: type: boolean - name: fields.label_counts in: query required: false schema: type: boolean - name: fields.binary_metrics in: query required: false schema: type: boolean - name: fields.test_set in: query required: false schema: type: boolean - name: fields.metrics_by_area in: query required: false schema: type: boolean - name: fields.metrics_by_class in: query required: false schema: type: boolean tags: - Users summary: V2 get evaluation x-summary-source: derived /v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/inputs: get: summary: List all the inputs operationId: V2_ListInputs responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/apiMultiInputResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: user_app_id.app_id in: path required: true schema: type: string - name: page description: '(optional URL parameter) The page number. Pagination is used to split the results into chunks. Defaults to 1.' in: query required: false schema: type: integer format: int64 - name: per_page description: '(optional URL parameter) The number of results that will be contained in each page. Defaults to 128.' in: query required: false schema: type: integer format: int64 - name: status.code description: "Status code from internal codes.\n\n - ZERO: to be revised and greatly expanded\n - SUCCESS: Generic\n - MOVED: Resource moved. Respond with Http status 307 and add new Location header to response\n - ACCEPTED: Request has been accepted. Respond with Http status 202.\n - CONN_ACCOUNT_ISSUES: Clarifai Connection Codes: 11xxx\n\nexpired cc, still in trial, feature not supported in your tier\n - CONN_TOKEN_INVALID: invalid auth token used. Deprecated: we should return CONN_KEY_INVALID instead now in all cases.\n - CONN_CREDENTIALS_INVALID: invalid auth credentials\n - CONN_EXCEED_HOURLY_LIMIT: throttle hourly limit exceeded\n - CONN_EXCEED_MONTHLY_LIMIT: throttle monthly limit exceeded\n - CONN_THROTTLED: throttler and billing stuff\n - CONN_EXCEEDS_LIMITS: throttler and billing stuff\n - CONN_INSUFFICIENT_SCOPES: api key has insufficient permissions\n - CONN_KEY_INVALID: api key is invalid\n - CONN_KEY_NOT_FOUND: api key not found\n - CONN_BAD_REQUEST_FORMAT: multipart form parsing, broken json, etc\n - CONN_DOES_NOT_EXIST: when path is bad\n - CONN_INVALID_REQUEST: something wrong with a header\n - CONN_METHOD_NOT_ALLOWED: when a request method is not allowed\n - CONN_NO_GDPR_CONSENT: lack GDPR consent\n - CONN_INVALID_RANGE: when invalid range of a resource is requested\n - CONN_AUTH_METHOD_DISABLED: authentication method is disabled\n - MODEL_TRAINED: Model/Custom Training related 20xxx\n\nCustom model has been already trained.\n - MODEL_TRAINING: Custom model is currently training.\n - MODEL_UNTRAINED: Custom model has not yet been trained.\n - MODEL_QUEUED_FOR_TRAINING: Custom model is currently in queue for training, waiting on assets to process first.\n - MODEL_TRAINING_FAILED: generic err msg for any type of model training err.\n - MODEL_BUILDING: For new V3 DockerInternalType models which are built images\n - MODEL_BUILDING_FAILED: Failed to build image for model.\n - MODEL_BUILD_UNEXPECTED_ERROR: Failed to build image for model.\n - MODEL_TRAINING_NO_DATA: Custom model training had no data. FIXME(yang): deprecate this. Use the 21106 + errStatusMsg\n - MODEL_TRAINING_NO_POSITIVES: Custom model training had no positive examples. FIXME(yang): deprecate this. Use the 21106 + errStatusMsg\n - MODEL_TRAINING_ONE_VS_N_SINGLE_CLASS: Custom model training was ONE_VS_N but with a single class. FIXME(yang): deprecate this. Use the 21106 + errStatusMsg\n - MODEL_TRAINING_TIMED_OUT: Training took longer than hard coded timeouts. FIXME(yang): deprecate this. Use the 21106 + errStatusMsg\n - MODEL_TRAINING_WAITING_ERROR: Training got error waiting on asset pipeline to finish. FIXME(yang): deprecate this. Use the 21106 + errStatusMsg\n - MODEL_TRAINING_UNKNOWN_ERROR: Training threw an unknown exception.\n - MODEL_TRAINING_MSG_REDELIVER: Training message was redelivered. FIXME(yang): deprecate this. Use the 21106 + errStatusMsg\n - MODEL_TRAINING_INSUFFICIENT_DATA: Training got error due to insufficient labelled data. FIXME(yang): deprecate this. Use the 21106 + errStatusMsg\n - MODEL_TRAINING_INVALID_PARAMS: FIXME(yang): deprecate this. Use the 21106 + errStatusMsg\n - MODEL_TRAINING_INVALID_DATA_TOLERANCE_EXCEEDED: Training is stopped because too much data was dropped. FIXME(yang): deprecate this. Use the 21106 + errStatusMsg\n - MODEL_EVALUATION_TIMED_OUT: Evaluation took longer than hard coded timeouts. FIXME(yang): deprecate this. Use the 21317 + errStatusMsg\n - MODEL_EVALUATION_WAITING_ERROR: Evaluation got error waiting on asset pipeline to finish.FIXME(yang): deprecate this. Use the 21317 + errStatusMsg\n - MODEL_EVALUATION_UNKNOWN_ERROR: EVALUATION THREW AN UNKNOWN EXCEPTION.\n - MODEL_EVALUATION_MSG_REDELIVER: Eval message was redelivered. FIXME(yang): deprecate this. Use the 21317 + errStatusMsg\n - MODEL_EVALUATION_NEED_LABELS: Don't have enough concepts labelled to perform evaluation. FIXME(yang): deprecate this. Use the 21317 + errStatusMsg\n - MODEL_EVALUATION_NEED_INPUTS: Don't have enough inputs per concept to perform evaluation. FIXME(yang): deprecate this. Use the 21317 + errStatusMsg\n - MODEL_EVALUATION_FAILED: Generic err code for eval failure.\n - MODEL_DEPLOYMENT_FAILED: Used when inference coordinator failed to deploy spire and throws an error\n - MODEL_DEPLOYING: Used when calling the inference coordinator to deploy a spire\n - MODEL_QUEUED_FOR_DEPLOYMENT: Used when training is completed\n - MODEL_NOT_DEPLOYED: Used when model spire deployment is manually taken down or due to inactivity\n - MODEL_LOADING: Used when the model pod is running, but not yet ready to serve requests.\n - MODEL_REFERENCE_INVALID_ARGUMENT: Used when a model reference field is not set properly\n - MODEL_EXAMPLE_INPUT_INVALID_ARGUMENT: Used when a model example input field is not set properly\n - MODEL_EXPORTED: Model Export status codes\n - WORKFLOW_NO_MATCHING_INPUT: specified model input not in workflow\n - WORKFLOW_REQUIRE_TRAINED_MODEL: specified model must be trained\n - WORKFLOW_INVALID_ARGUMENT: error in the request somewhere\n - WORKFLOW_INVALID_REQUEST: error in the request somewhere\n - CONCEPT_MODIFY_SUCCESS: Concept related 23xxx\n - ANNOTATION_SUCCESS: Annotation related 24xxx\n - ANNOTATION_AWAITING_REVIEW: Annotation is awaiting review from task REVIEWERS.\n - ANNOTATION_AWAITING_CONSENSUS_REVIEW: Annotation is awaiting consensus review from task LABELERS.\n - ANNOTATION_TRACK_IDLE: Annotation (video) tracks are groups of annotations per frame\nIDLE -> PROCESSING --> PENDING --> APPROVED --> (DELETED)\nPROCESSING --> FAILED --> (DELETED)\nPROCESSING --> (DELETED)\n - METADATA_INVALID_PATCH_ARGUMENTS: Metadata related 249xx\n - TRAINER_JOB_STATE_NONE: Training service related 25xxx\n - DATA_DUMP_SUCCESS: Data Dump related 251xx\n - DATA_DUMP_NO_DATA: DEPRECATED: Not used anymore. Now for an empty data dump, DATA_DUMP_SUCCESS is returned. To detect an empty data dump, check if the inptus count is 0.\n - APP_DUPLICATION_SUCCESS: Duplicate related 252xx - DEPRECATED: App duplication is no longer supported.\n - MODULE_DOES_NOT_EXIST: Module related codes 253xx\n - BULK_OPERATION_SUCCESS: Bulk Operation related codes 254xx\n - RUNNER_DOES_NOT_EXIST: Runner related codes 256xx\n - NODEPOOL_DOES_NOT_EXIST: Nodepool related codes 257xx\n - COMPUTE_CLUSTER_DOES_NOT_EXIST: ComputeCluster related codes 258xx\n - DEPLOYMENT_DOES_NOT_EXIST: Deployment related codes 259xx\n - DEPLOYMENT_DISABLED: The deployment is disabled and cannot serve traffic.\n - INSTANCE_TYPE_DOES_NOT_EXIST: InstanceType related codes 260xx\n - COMPUTE_PLANE_METRICS_INVALID_REQUEST: Compute plane related codes 261xx\n - PIPELINE_STEP_DOES_NOT_EXIST: PipelineStep related codes 262xx\n - PIPELINE_DOES_NOT_EXIST: Pipeline related codes 263xx\n - ARTIFACT_DOES_NOT_EXIST: Artifact related codes 264xx\n - INPUT_SUCCESS: Input:Image related 30xxx\n - INPUT_PENDING: when things are async, this is the default status.\n - INPUT_FAILED: any type of error downloading and processing\n - INPUT_DOWNLOAD_SUCCESS: use INPUT_SUCCESS, INPUT_PENDING, INPUT_FAILED, INPUT_IN_PROGRESS instead\nDOWNLOAD is no longer correct, but keep old statuses for backward compatibility\n - INPUT_VIDEO_DOWNLOAD_SUCCESS: Input:Video related 31xxx -- Deprecated\n - INPUT_WRITES_DISABLED_FOR_MAINTENANCE: deprecate this one. Use REQUEST_DISABLED_FOR_MAINTENANCE\n - PREDICT_INVALID_REQUEST: API formatting issues 4000x\n - DATABASE_DUPLICATE_KEY: Other related 400xx\n - EXTERNAL_CONNECTION_ERROR: could not connect to external services\n - QUEUE_CONN_ERROR: Queue related errors 41xxx\n - SQS_OVERLIMIT: SQS related errors 411xx\n - SEARCH_INTERNAL_FAILURE: Search related errors 43xxxx\n - EVALUATION_QUEUED: Workflow evaluation err code\n - STRIPE_EVENT_ERROR: Stripe 44xxx\n - CACHE_MISS: Redis/Cache 45xxx\n - SIGNUP_EVENT_ERROR: Sift Science 46xxx\n - APP_COUNT_INVALID_MESSAGE: Application counts related errors 470xx\n - MP_DOWNLOAD_ERROR: Media processor related errors 471xx -- DEPRECATED\n - DATATIER_CONN_ERROR: DataTier related error 472xx\n - USER_CONSENT_FACE: User legal consent stauts related 50xxx\n - WORKER_MISSING: Workers 51xxx\n - SSO_IDENTITY_PROVIDER_DOES_NOT_EXIST: SSO 53xxx\n - TASK_IN_PROGRESS: Tasks 54xxx\nThe task was created.\n - TASK_DONE: The task is completed.\n - TASK_WONT_DO: The task is marked as abandoned.\n - TASK_FAILED: An error occurred during add-task-annotations or add-auto-annotations pipeline.\n - TASK_IDLE: Task is waiting for user action.\nExamples:\n- When an Auto Annotation task job has finished processing its last batch and is waiting for more dataset assets.\n- When an Auto Annotation task job for a video livestream input is waiting for user to create a task deployment.\n - TASK_CONFLICT: The task operation is in conflict with the current state of the server.\n - TASK_NOT_IMPLEMENTED: Certain task-related scenarios are not implemented.\n - TASK_MISSING: Task was not found.\n - TASK_PERMISSION_DENIED: Not allowed to perform a task-related action.\n - TASK_ASSIGNMENT_SUCCESS: Task Assignments 542xx\n - TASK_ASSIGNMENT_REVIEW_SUCCESS: Task Assignment Reviews 543xx\n - LABEL_ORDER_PENDING: Label Order Related Status Code 55xxx\n - LICENSE_ACTIVE: License Related Status Code 600xx\nDEPRECATED: License feature is fully deprecated now.\n - LICENSE_DELETED: hidden state not reflected to users\n - PASSWORD_VALIDATION_SUCCESS: Password Related Status Code\n - FEATUREFLAG_CONFIG_NOT_FOUND: Feature flags status code\n - MAINTENANCE_SUCCESS: Maintenance status code\n - DATASET_VERSION_PENDING: Datasets 64xxx\nThe dataset version is pending to be processed.\n - DATASET_VERSION_IN_PROGRESS: The dataset version is currently being processed.\n - DATASET_VERSION_READY: The dataset version is ready to be used.\n - DATASET_VERSION_FAILURE: An error occurred during the dataset version processing.\n - DATASET_VERSION_UNEXPECTED_ERROR: An unexpected error occurred during the dataset version processing.\n - DATASET_VERSION_CONFLICT: An alteration to dataset version would create a conflict\n - DATASET_INPUT_SUCCESS: The dataset input was successfully added.\n - DATASET_INPUT_DUPLICATE: The dataset input is a duplicate.\nDeprecated: Unused.\n - DATASET_VERSION_EXPORT_SUCCESS: The dataset version export is completed.\n - DATASET_VERSION_EXPORT_PENDING: The dataset version is pending to be exported.\n - DATASET_VERSION_EXPORT_FAILED: An error occurred during the dataset version export.\n - DATASET_VERSION_EXPORT_IN_PROGRESS: The dataset version is currently being exported.\n - DATASET_VERSION_EXPORT_UNEXPECTED_ERROR: An unexpected error occurred during the dataset version export.\n - JOB_QUEUED: Generic Job status codes\n - AUTH_MISSING_IDP_ASSOC: auth issues\n\nTODO: Knowledge graph related 80xxx\n - UPLOAD_IN_PROGRESS: Multipart uploading status codes\n - BILLING_INVALID_INFO: Billing related issues: 69xxx\n - LOG_ENTRIES_INVALID_REQUEST: Logs related issues: 70000;\n - TWILIO_MAX_VERIFICATION_BEGIN_EXCEEDED: Twilio related issues: 71xxx\n - TWILIO_PHONE_NUMBER_BLOCKED: The provided phone number was rejected or blocked by Twilio.\n - INTERNAL_SERVER_ISSUE: Internal issues: 98xxx\n - CONN_UNCATEGORIZED: Uncategorized: 99xxx: move off as soon as known\n - BAD_REQUEST: Deprecated: migrate off to one of the internal issues\n - SERVER_ERROR: Deprecated: migrate off to one of the internal issues" in: query required: false schema: type: string enum: - ZERO - SUCCESS - MIXED_STATUS - FAILURE - TRY_AGAIN - NOT_IMPLEMENTED - MOVED - TEAPOT - ACCEPTED - CONN_ACCOUNT_ISSUES - CONN_TOKEN_INVALID - CONN_CREDENTIALS_INVALID - CONN_EXCEED_HOURLY_LIMIT - CONN_EXCEED_MONTHLY_LIMIT - CONN_THROTTLED - CONN_EXCEEDS_LIMITS - CONN_INSUFFICIENT_SCOPES - CONN_KEY_INVALID - CONN_KEY_NOT_FOUND - CONN_BAD_REQUEST_FORMAT - CONN_DOES_NOT_EXIST - CONN_INVALID_REQUEST - CONN_METHOD_NOT_ALLOWED - CONN_NO_GDPR_CONSENT - CONN_INVALID_RANGE - CONN_AUTH_METHOD_DISABLED - MODEL_TRAINED - MODEL_TRAINING - MODEL_UNTRAINED - MODEL_QUEUED_FOR_TRAINING - MODEL_UPLOADING - MODEL_UPLOADING_FAILED - MODEL_TRAINING_FAILED - MODEL_BUILDING - MODEL_BUILDING_FAILED - MODEL_BUILD_UNEXPECTED_ERROR - MODEL_TRAINING_NO_DATA - MODEL_TRAINING_NO_POSITIVES - MODEL_TRAINING_ONE_VS_N_SINGLE_CLASS - MODEL_TRAINING_TIMED_OUT - MODEL_TRAINING_WAITING_ERROR - MODEL_TRAINING_UNKNOWN_ERROR - MODEL_TRAINING_MSG_REDELIVER - MODEL_TRAINING_INSUFFICIENT_DATA - MODEL_TRAINING_INVALID_PARAMS - MODEL_TRAINING_INVALID_DATA_TOLERANCE_EXCEEDED - MODEL_MODIFY_SUCCESS - MODEL_MODIFY_PENDING - MODEL_MODIFY_FAILED - MODEL_DOES_NOT_EXIST - MODEL_PERMISSION_DENIED - MODEL_INVALID_ARGUMENT - MODEL_INVALID_REQUEST - MODEL_EVALUATED - MODEL_EVALUATING - MODEL_NOT_EVALUATED - MODEL_QUEUED_FOR_EVALUATION - MODEL_EVALUATION_TIMED_OUT - MODEL_EVALUATION_WAITING_ERROR - MODEL_EVALUATION_UNKNOWN_ERROR - MODEL_PREDICTION_FAILED - MODEL_EVALUATION_MSG_REDELIVER - MODEL_EVALUATION_NEED_LABELS - MODEL_EVALUATION_NEED_INPUTS - MODEL_EVALUATION_FAILED - MODEL_DEPLOYMENT_FAILED - MODEL_DEPLOYING - MODEL_QUEUED_FOR_DEPLOYMENT - MODEL_NOT_DEPLOYED - MODEL_BUSY_PLEASE_RETRY - MODEL_LOADING - MODEL_REFERENCE_INVALID_ARGUMENT - MODEL_EXAMPLE_INPUT_INVALID_ARGUMENT - MODEL_EXPORTED - MODEL_EXPORTING - MODEL_EXPORTING_FAILED - MODEL_EXPORT_PENDING - WORKFLOW_NO_MATCHING_INPUT - WORKFLOW_REQUIRE_TRAINED_MODEL - WORKFLOW_DUPLICATE - WORKFLOW_UNSUPPORTED_FORMAT - WORKFLOW_DOES_NOT_EXIST - WORKFLOW_PERMISSION_DENIED - WORKFLOW_INVALID_ARGUMENT - WORKFLOW_INVALID_RECIPE - WORKFLOW_INVALID_TEMPLATE - WORKFLOW_INVALID_GRAPH - WORKFLOW_INTERNAL_FAILURE - WORKFLOW_INVALID_REQUEST - WORKFLOW_MODIFY_SUCCESS - WORKFLOW_MODIFY_PENDING - WORKFLOW_MODIFY_FAILED - WORKFLOW_REINDEX_FAILED - CONCEPT_MODIFY_SUCCESS - CONCEPT_MODIFY_PENDING - CONCEPT_MODIFY_FAILED - ANNOTATION_SUCCESS - ANNOTATION_PENDING - ANNOTATION_FAILED - ANNOTATION_UNKNOWN_STATUS - ANNOTATION_INVALID_ARGUMENT - ANNOTATION_PERMISSION_DENIED - ANNOTATION_AWAITING_REVIEW - ANNOTATION_AWAITING_CONSENSUS_REVIEW - ANNOTATION_REVIEW_DENIED - ANNOTATION_MODIFY_SUCCESS - ANNOTATION_MODIFY_PENDING - ANNOTATION_MODIFY_FAILED - ANNOTATION_TRACK_IDLE - ANNOTATION_TRACK_IN_PROGRESS - ANNOTATION_TRACK_PENDING - ANNOTATION_TRACK_APPROVED - ANNOTATION_TRACK_FAILED - METADATA_INVALID_PATCH_ARGUMENTS - METADATA_PARSING_ISSUE - METADATA_MANIPULATION_ISSUE - TRAINER_JOB_STATE_NONE - TRAINER_JOB_STATE_QUEUED - TRAINER_JOB_STATE_RUNNING - TRAINER_JOB_STATE_COMPLETE - TRAINER_JOB_STATE_ERROR - DATA_DUMP_SUCCESS - DATA_DUMP_PENDING - DATA_DUMP_FAILED - DATA_DUMP_IN_PROGRESS - DATA_DUMP_NO_DATA - DATA_DUMP_UNEXPECTED_ERROR - DATA_DUMP_EXPORT_SUCCESS - DATA_DUMP_EXPORT_PENDING - DATA_DUMP_EXPORT_FAILED - DATA_DUMP_EXPORT_IN_PROGRESS - DATA_DUMP_EXPORT_UNEXPECTED_ERROR - APP_DUPLICATION_SUCCESS - APP_DUPLICATION_FAILED - APP_DUPLICATION_PENDING - APP_DUPLICATION_IN_PROGRESS - APP_DUPLICATION_INVALID_REQUEST - MODULE_DOES_NOT_EXIST - MODULE_PERMISSION_DENIED - MODULE_INVALID_ARGUMENT - MODULE_INVALID_REQUEST - BULK_OPERATION_SUCCESS - BULK_OPERATION_FAILED - BULK_OPERATION_PENDING - BULK_OPERATION_IN_PROGRESS - BULK_OPERATION_INVALID_REQUEST - BULK_OPERATION_CANCELLED - BULK_OPERATION_UNEXPECTED_ERROR - RUNNER_DOES_NOT_EXIST - RUNNER_PERMISSION_DENIED - RUNNER_INVALID_ARGUMENT - RUNNER_INVALID_REQUEST - RUNNER_NEEDS_RETRY - RUNNER_STREAM_START - RUNNER_STREAM_END - RUNNER_ITEM_CANCELLED - RUNNER_PROCESSING_FAILED - RUNNER_SPECIAL_HANDLING_NOT_COMPLETE - NODEPOOL_DOES_NOT_EXIST - NODEPOOL_INVALID_ARGUMENT - NODEPOOL_INVALID_REQUEST - COMPUTE_CLUSTER_DOES_NOT_EXIST - COMPUTE_CLUSTER_INVALID_ARGUMENT - COMPUTE_CLUSTER_INVALID_REQUEST - DEPLOYMENT_DOES_NOT_EXIST - DEPLOYMENT_INVALID_ARGUMENT - DEPLOYMENT_INVALID_REQUEST - DEPLOYMENT_DISABLED - INSTANCE_TYPE_DOES_NOT_EXIST - INSTANCE_TYPE_INVALID_ARGUMENT - INSTANCE_TYPE_INVALID_REQUEST - COMPUTE_PLANE_METRICS_INVALID_REQUEST - PIPELINE_STEP_DOES_NOT_EXIST - PIPELINE_STEP_INVALID_ARGUMENT - PIPELINE_STEP_INVALID_REQUEST - PIPELINE_STEP_UPLOADING - PIPELINE_STEP_UPLOADING_FAILED - PIPELINE_STEP_BUILDING - PIPELINE_STEP_BUILDING_FAILED - PIPELINE_STEP_BUILD_UNEXPECTED_ERROR - PIPELINE_STEP_READY - PIPELINE_STEP_NOT_READY - PIPELINE_DOES_NOT_EXIST - PIPELINE_INVALID_ARGUMENT - PIPELINE_INVALID_REQUEST - ARTIFACT_DOES_NOT_EXIST - ARTIFACT_INVALID_ARGUMENT - ARTIFACT_INVALID_REQUEST - ARTIFACT_VERSION_DOES_NOT_EXIST - ARTIFACT_VERSION_INVALID_ARGUMENT - ARTIFACT_VERSION_INVALID_REQUEST - INPUT_SUCCESS - INPUT_PENDING - INPUT_FAILED - INPUT_IN_PROGRESS - INPUT_DOWNLOAD_SUCCESS - INPUT_DOWNLOAD_PENDING - INPUT_DOWNLOAD_FAILED - INPUT_DOWNLOAD_IN_PROGRESS - INPUT_STATUS_UPDATE_FAILED - INPUT_DELETE_FAILED - INPUT_DUPLICATE - INPUT_UNSUPPORTED_FORMAT - INPUT_DOES_NOT_EXIST - INPUT_PERMISSION_DENIED - INPUT_INVALID_ARGUMENT - INPUT_OVER_LIMIT - INPUT_INVALID_URL - INPUT_MODIFY_SUCCESS - INPUT_MODIFY_PENDING - INPUT_MODIFY_FAILED - INPUT_STORAGE_HOST_FAILED - ALL_INPUT_INVALID_BYTES - INPUT_CLUSTER_SUCCESS - INPUT_CLUSTER_PENDING - INPUT_CLUSTER_FAILED - INPUT_CLUSTER_IN_PROGRESS - INPUT_REINDEX_SUCCESS - INPUT_REINDEX_PENDING - INPUT_REINDEX_FAILED - INPUT_REINDEX_IN_PROGRESS - INPUT_VIDEO_DOWNLOAD_SUCCESS - INPUT_VIDEO_DOWNLOAD_PENDING - INPUT_VIDEO_DOWNLOAD_FAILED - INPUT_VIDEO_DUPLICATE - INPUT_VIDEO_UNSUPPORTED_FORMAT - INPUT_VIDEO_DOES_NOT_EXIST - INPUT_VIDEO_PERMISSION_DENIED - INPUT_VIDEO_INVALID_ARGUMENT - INPUT_VIDEO_OVER_LIMIT - INPUT_VIDEO_INVALID_URL - INPUT_VIDEO_MODIFY_SUCCESS - INPUT_VIDEO_MODIFY_PENDING - INPUT_VIDEO_MODIFY_FAILED - INPUT_VIDEO_STORAGE_HOST_FAILED - ALL_INPUT_VIDEOS_INVALID_BYTES - INPUT_VIDEO_PROCESSING_SUCCESS - INPUT_VIDEO_PROCESSING_PENDING - INPUT_VIDEO_PROCESSING_FAILED - INPUT_VIDEO_STORAGE_INCONSISTENCY - INPUT_VIDEO_STORAGE_FAILURE - INPUT_VIDEO_URL_GENERATION_FAILURE - INPUT_CONNECTION_FAILED - REQUEST_DISABLED_FOR_MAINTENANCE - INPUT_WRITES_DISABLED_FOR_MAINTENANCE - INPUT_INVALID_REQUEST - PREDICT_INVALID_REQUEST - SEARCH_INVALID_REQUEST - CONCEPTS_INVALID_REQUEST - STATS_INVALID_REQUEST - DATABASE_DUPLICATE_KEY - DATABASE_STATEMENT_TIMEOUT - DATABASE_INVALID_ROWS_AFFECTED - DATABASE_DEADLOCK_DETECTED - DATABASE_FAIL_TASK - DATABASE_FAIL_TO_GET_CONNECTIONS - DATABASE_TOO_MANY_CLIENTS - DATABASE_CONSTRAINT_VIOLATED - DATABASE_CANCELED - ASYNC_WORKER_MULTI_ERRORS - RPC_REQUEST_QUEUE_FULL - RPC_SERVER_UNAVAILABLE - RPC_REQUEST_TIMEOUT - RPC_MAX_MESSAGE_SIZE_EXCEEDED - RPC_CANCELED - RPC_UNKNOWN_METHOD - REQUEST_CANCELED_BY_USER - CLUSTER_INTERNAL_FAILURE - EXTERNAL_CONNECTION_ERROR - QUERY_INVALID_SYNTAX - QUEUE_CONN_ERROR - QUEUE_CLOSE_REQUEST_TIMEOUT - QUEUE_CONN_CLOSED - QUEUE_PUBLISH_ACK_TIMEOUT - QUEUE_PUBLISH_ERROR - QUEUE_SUBSCRIPTION_TIMEOUT - QUEUE_SUBSCRIPTION_ERROR - QUEUE_MARSHALLING_FAILED - QUEUE_UNMARSHALLING_FAILED - QUEUE_MAX_MSG_REDELIVERY_EXCEEDED - QUEUE_ACK_FAILURE - SQS_OVERLIMIT - SQS_INVALID_RECEIPT_HANDLE - SQS_UNKNOWN - SEARCH_INTERNAL_FAILURE - SEARCH_PROJECTION_FAILURE - SEARCH_PREDICTION_FAILURE - SEARCH_BY_NOT_FULLY_INDEXED_INPUT - SAVED_SEARCH_MODIFY_FAILED - SEARCH_COUNTS_UNAVAILABLE - EVALUATION_QUEUED - EVALUATION_IN_PROGRESS - EVALUATION_SUCCESS - EVALUATION_FAILED_TO_RETRIEVE_DATA - EVALUATION_INVALID_ARGUMENT - EVALUATION_FAILED - EVALUATION_PENDING - EVALUATION_TIMED_OUT - EVALUATION_UNEXPECTED_ERROR - EVALUATION_MIXED - STRIPE_EVENT_ERROR - STRIPE_UNEXPECTED_ERROR - CACHE_MISS - REDIS_SCRIPT_EXITED_WITH_FAILURE - REDIS_STREAM_ERR - REDIS_NO_CONSUMERS - REDIS_STREAM_BACKOFF - REDIS_CHANNEL_ERR - SIGNUP_EVENT_ERROR - SIGNUP_FLAGGED - FILETYPE_UNSUPPORTED - LOGIN_EVENT_ERROR - SIFT_UNCATEGORIZED_ERROR - USER_FLAGGED - APP_COUNT_INVALID_MESSAGE - APP_COUNT_UPDATE_INCREMENT_FAILED - APP_COUNT_REBUILD_FAILED - APP_COUNT_INTERNAL_FAILURE - MP_DOWNLOAD_ERROR - MP_RESOLVE_DNS_ERROR - MP_DOWNLOAD_MAX_SIZE_EXCEEDED_ERROR - MP_IMAGE_DECODE_ERROR - MP_INVALID_ARGUMENT - MP_IMAGE_PROCESSING_ERROR - DATATIER_CONN_ERROR - USER_CONSENT_FACE - WORKER_MISSING - WORKER_ACTIVE - WORKER_INACTIVE - SSO_IDENTITY_PROVIDER_DOES_NOT_EXIST - TASK_IN_PROGRESS - TASK_DONE - TASK_WONT_DO - TASK_FAILED - TASK_IDLE - TASK_CONFLICT - TASK_NOT_IMPLEMENTED - TASK_MISSING - TASK_PERMISSION_DENIED - TASK_ASSIGNMENT_SUCCESS - TASK_ASSIGNMENT_PENDING - TASK_ASSIGNMENT_AWAITING_REVIEW - TASK_ASSIGNMENT_AWAITING_CONSENSUS_REVIEW - TASK_ASSIGNMENT_REJECTED - TASK_ASSIGNMENT_REVIEW_SUCCESS - TASK_ASSIGNMENT_REVIEW_PENDING - TASK_ASSIGNMENT_REVIEW_DISMISSED - LABEL_ORDER_PENDING - LABEL_ORDER_IN_PROGRESS - LABEL_ORDER_SUCCESS - LABEL_ORDER_CANCELED - LICENSE_ACTIVE - LICENSE_DOES_NOT_EXIST - LICENSE_NEED_UPDATE - LICENSE_EXPIRED - LICENSE_REVOKED - LICENSE_DELETED - LICENSE_VOLUME_EXCEEDED - PASSWORD_VALIDATION_SUCCESS - PASSWORD_VALIDATION_FAILED - PASSWORDPOLICY_INVALID_ARGUMENT - FEATUREFLAG_CONFIG_NOT_FOUND - FEATUREFLAG_INVALID_ARGUMENT - FEATUREFLAG_BLOCKED - FEATUREFLAG_NOT_FOUND - MAINTENANCE_SUCCESS - MAINTENANCE_FAILED - DATASET_VERSION_PENDING - DATASET_VERSION_IN_PROGRESS - DATASET_VERSION_READY - DATASET_VERSION_FAILURE - DATASET_VERSION_UNEXPECTED_ERROR - DATASET_VERSION_CONFLICT - DATASET_INPUT_SUCCESS - DATASET_INPUT_DUPLICATE - DATASET_VERSION_EXPORT_SUCCESS - DATASET_VERSION_EXPORT_PENDING - DATASET_VERSION_EXPORT_FAILED - DATASET_VERSION_EXPORT_IN_PROGRESS - DATASET_VERSION_EXPORT_UNEXPECTED_ERROR - JOB_QUEUED - JOB_RUNNING - JOB_COMPLETED - JOB_FAILED - JOB_CANCELLED - JOB_UNEXPECTED_ERROR - JOB_CONFLICT - JOB_PAUSED - AUTH_MISSING_IDP_ASSOC - LIST_OBJECTS_FAILED - ARCHIVE_EXTRACT_FAILED - UPLOAD_IN_PROGRESS - UPLOAD_DONE - UPLOAD_FAILED - UPLOAD_UNEXPECTED_ERROR - UPLOAD_EXPIRED - UPLOAD_CANCELED - UPLOAD_CONFLICT - BILLING_INVALID_INFO - BILLING_MISSING_TOKENS - LOG_ENTRIES_INVALID_REQUEST - TWILIO_MAX_VERIFICATION_BEGIN_EXCEEDED - TWILIO_MAX_VERIFICATION_CHECK_EXCEEDED - TWILIO_PHONE_NUMBER_BLOCKED - INTERNAL_SERVER_ISSUE - INTERNAL_FETCHING_ISSUE - INTERNAL_DATABASE_ISSUE - INTERNAL_CONTEXT_CANCELED - INTERNAL_UNEXPECTED_TIMEOUT - INTERNAL_UNEXPECTED_V1 - INTERNAL_UNEXPECTED_PANIC - INTERNAL_UNEXPECTED_SPIRE - INTERNAL_REDIS_UNAVAILABLE - INTERNAL_RESOURCE_EXHAUSTED - INTERNAL_REDIS_UNCATEGORIZED - INTERNAL_AWS_UNCATEGORIZED - INTERNAL_AZURE_UNCATEGORIZED - INTERNAL_VECTORDB_UNCATEGORIZED - INTERNAL_ORACLE_UNCATEGORIZED - INTERNAL_VULTR_UNCATEGORIZED - INTERNAL_GCP_UNCATEGORIZED - CONN_UNCATEGORIZED - MODEL_UNCATEGORIZED - INPUT_UNCATEGORIZED - ANNOTATION_UNCATEGORIZED - BILLING_UNCATEGORIZED - INTERNAL_UNCATEGORIZED - BAD_REQUEST - SERVER_ERROR default: ZERO - name: status.description description: A short description of the error. in: query required: false schema: type: string - name: status.details description: 'More details of the given error. These details may be exposed to non-technical users. For technical details, try to use developer_notes field.' in: query required: false schema: type: string - name: status.stack_trace description: 'For some environment we may return a stack trace to help debug any issues.' in: query required: false style: form explode: true schema: type: array items: type: string - name: status.percent_completed description: specifically for long running jobs in: query required: false schema: type: integer format: int64 - name: status.time_remaining description: if status is pending, how much time is remaining (in seconds) in: query required: false schema: type: integer format: int64 - name: status.req_id description: A request ID may be present, to help monitoring and tracking requests in: query required: false schema: type: string - name: status.internal_details description: Internal Annotation (do not set in production, for internal Clarifai use only). in: query required: false schema: type: string - name: status.redirect_info.url description: New location for the resource. Used to set response Location header. in: query required: false schema: type: string - name: status.redirect_info.resource_type description: Resource type in: query required: false schema: type: string - name: status.redirect_info.old_resource_id description: Old resource id in: query required: false schema: type: string - name: status.redirect_info.new_resource_id description: New resource id in: query required: false schema: type: string - name: status.developer_notes description: 'Notes for developer. These notes are rather technical details for developers how to interpret the status, e.g. why an error occurred and how to avoid getting the error.' in: query required: false schema: type: string - name: status.http_status_code description: The HTTP status code of the response. in: query required: false schema: type: integer format: int64 - name: ids in: query required: false style: form explode: true schema: type: array items: type: string tags: - Users delete: summary: Delete multiple inputs in one request. This call is asynchronous operationId: V2_DeleteInputs responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/statusBaseResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: user_app_id.app_id in: path required: true schema: type: string tags: - Users requestBody: content: application/json: schema: $ref: '#/components/schemas/V2DeleteInputsBody' required: true post: summary: PostInputs adds one or more inputs to the app. operationId: V2_PostInputs responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/apiMultiInputResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: user_app_id.app_id in: path required: true schema: type: string tags: - Users requestBody: content: application/json: schema: $ref: '#/components/schemas/V2PostInputsBody' required: true patch: summary: Patch one or more inputs operationId: V2_PatchInputs responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/apiMultiInputResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: user_app_id.app_id in: path required: true schema: type: string tags: - Users requestBody: content: application/json: schema: $ref: '#/components/schemas/V2PatchInputsBody' required: true /v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/inputs/annotations: delete: summary: Delete multiple annotations in one request operationId: V2_DeleteAnnotations responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/statusBaseResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: user_app_id.app_id in: path required: true schema: type: string tags: - Users requestBody: content: application/json: schema: $ref: '#/components/schemas/apiV2DeleteAnnotationsBody' required: true /v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/inputs/data_sources: post: summary: Initiates retrieval of inputs from cloud storage from a user provided data… description: 'The cloud URL will be treated as a filter prefix. For example s3:/bucket/images_folder/abc will process files in the images_folder beginning with abc or in a subfolder beginning with abc. For example: bucket/images_folder/abcImage.png bucket/images_folder/abc-1/Data.zip If given URL is for a private bucket or file, then credentials should be provided to access the bucket. Credentials should include rights to list the objects in the bucket, except when pointed directly at a file archive, in which case it only requires rights to access that particular file.' operationId: V2_PostInputsDataSources responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/apiMultiInputsAddJobResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: user_app_id.app_id in: path required: true schema: type: string tags: - Users requestBody: content: application/json: schema: $ref: '#/components/schemas/V2PostInputsDataSourcesBody' required: true /v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/inputs/jobs/add: get: summary: List all the inputs add jobs operationId: V2_ListInputsAddJobs responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/apiMultiInputsAddJobResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: user_app_id.app_id in: path required: true schema: type: string - name: page description: '(optional URL parameter) The page number. Pagination is used to split the results into chunks. Defaults to 1.' in: query required: false schema: type: integer format: int64 - name: per_page description: '(optional URL parameter) The number of results that will be contained in each page. Defaults to 128.' in: query required: false schema: type: integer format: int64 tags: - Users /v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/inputs/jobs/add/{id}: get: summary: Get the input add job details by ID operationId: V2_GetInputsAddJob responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/apiSingleInputsAddJobResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: user_app_id.app_id in: path required: true schema: type: string - name: id description: id of add inputs job in: path required: true schema: type: string tags: - Users patch: summary: cancel the input add job by ID operationId: V2_CancelInputsAddJob responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/apiSingleInputsAddJobResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: user_app_id.app_id in: path required: true schema: type: string - name: id description: id of add inputs job to be cancelled in: path required: true schema: type: string tags: - Users requestBody: content: application/json: schema: $ref: '#/components/schemas/V2CancelInputsAddJobBody' required: true /v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/inputs/jobs/extraction: get: summary: List all the input extraction jobs operationId: V2_ListInputsExtractionJobs responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/apiMultiInputsExtractionJobResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: user_app_id.app_id in: path required: true schema: type: string - name: page description: '(optional URL parameter) The page number. Pagination is used to split the results into chunks. Defaults to 1.' in: query required: false schema: type: integer format: int64 - name: per_page description: '(optional URL parameter) The number of results that will be contained in each page. Defaults to 128.' in: query required: false schema: type: integer format: int64 tags: - Users patch: operationId: V2_CancelInputsExtractionJobs responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/apiMultiInputsExtractionJobResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: user_app_id.app_id in: path required: true schema: type: string tags: - Users requestBody: content: application/json: schema: $ref: '#/components/schemas/V2CancelInputsExtractionJobsBody' required: true summary: V2 cancel inputs extraction jobs x-summary-source: derived /v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/inputs/jobs/extraction/{inputs_extraction_job_id}: get: summary: Get the input extraction job details by ID operationId: V2_GetInputsExtractionJob responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/apiSingleInputsExtractionJobResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: user_app_id.app_id in: path required: true schema: type: string - name: inputs_extraction_job_id in: path required: true schema: type: string tags: - Users /v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/inputs/searches: post: summary: Execute a search over inputs operationId: V2_PostInputsSearches responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/apiMultiSearchResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: user_app_id.app_id in: path required: true schema: type: string tags: - Users requestBody: content: application/json: schema: $ref: '#/components/schemas/V2PostInputsSearchesBody' required: true patch: summary: Patch saved inputs searches by ids operationId: V2_PatchInputsSearches responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/apiMultiSearchResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: user_app_id.app_id in: path required: true schema: type: string tags: - Users requestBody: content: application/json: schema: $ref: '#/components/schemas/V2PatchInputsSearchesBody' required: true /v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/inputs/status: get: summary: Get input count per status operationId: V2_GetInputCount responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/apiSingleInputCountResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: user_app_id.app_id in: path required: true schema: type: string tags: - Users /v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/inputs/stream: get: summary: Streams all the inputs starting from oldest assets operationId: V2_StreamInputs responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/apiMultiInputResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: user_app_id.app_id in: path required: true schema: type: string - name: per_page description: '(optional URL parameter) The number of results that will be contained in each page. Defaults to 20.' in: query required: false schema: type: integer format: int64 - name: last_id in: query required: false schema: type: string - name: order_by_id description: 'By default, the endpoint return inputs by the time when it is added. If this is set to true, we will return inputs by id.' in: query required: false schema: type: boolean - name: descending in: query required: false schema: type: boolean tags: - Users /v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/inputs/uploads: post: summary: Create new upload job with a file archive containing inputs (images, videos… operationId: V2_PostInputsUploads responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/apiMultiInputsAddJobResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: user_app_id.app_id in: path required: true schema: type: string tags: - Users requestBody: content: application/json: schema: $ref: '#/components/schemas/V2PostInputsUploadsBody' required: true /v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/inputs/{input_id}: get: summary: Get a specific input from an app operationId: V2_GetInput responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/apiSingleInputResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: user_app_id.app_id in: path required: true schema: type: string - name: input_id in: path required: true schema: type: string tags: - Users delete: summary: Delete a single input asynchronously operationId: V2_DeleteInput responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/statusBaseResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: user_app_id.app_id in: path required: true schema: type: string - name: input_id in: path required: true schema: type: string tags: - Users /v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/inputs/{input_id}/annotation_tracks: get: summary: List all the annotation tracks operationId: V2_ListAnnotationTracks responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/apiMultiAnnotationTrackResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: user_app_id.app_id in: path required: true schema: type: string - name: input_id in: path required: true schema: type: string - name: ids in: query required: false style: form explode: true schema: type: array items: type: string - name: page in: query required: false schema: type: integer format: int64 - name: per_page in: query required: false schema: type: integer format: int64 tags: - Users post: summary: Post annotation tracks operationId: V2_PostAnnotationTracks responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/apiMultiAnnotationTrackResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: user_app_id.app_id in: path required: true schema: type: string - name: input_id in: path required: true schema: type: string tags: - Users requestBody: content: application/json: schema: $ref: '#/components/schemas/V2PostAnnotationTracksBody' required: true patch: summary: Patch one or more annotation tracks operationId: V2_PatchAnnotationTracks responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/apiMultiAnnotationTrackResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: user_app_id.app_id in: path required: true schema: type: string - name: input_id in: path required: true schema: type: string tags: - Users requestBody: content: application/json: schema: $ref: '#/components/schemas/V2PatchAnnotationTracksBody' required: true /v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/inputs/{input_id}/annotations/stream/live: post: summary: Stream live video annotations as soon as they are available. operationId: V2_StreamLivestreamAnnotations responses: '200': description: A successful response.(streaming responses) content: application/json: schema: type: object properties: result: $ref: '#/components/schemas/apiSingleStreamAnnotationResponse' error: $ref: '#/components/schemas/googlerpcStatus' title: Stream result of apiSingleStreamAnnotationResponse default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: user_app_id.app_id in: path required: true schema: type: string - name: input_id description: The input ID containing the video being processed in: path required: true schema: type: string tags: - Users requestBody: content: application/json: schema: $ref: '#/components/schemas/V2StreamLivestreamAnnotationsBody' required: true /v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/inputs/{input_id}/annotations/{annotation_id}: get: summary: Get a specific annotation from an app operationId: V2_GetAnnotation responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/apiSingleAnnotationResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: user_app_id.app_id in: path required: true schema: type: string - name: input_id in: path required: true schema: type: string - name: annotation_id in: path required: true schema: type: string tags: - Users delete: summary: Delete a single annotation operationId: V2_DeleteAnnotation responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/statusBaseResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: user_app_id.app_id in: path required: true schema: type: string - name: input_id in: path required: true schema: type: string - name: annotation_id in: path required: true schema: type: string tags: - Users /v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/inputs/{input_id}/track_annotations/searches: post: summary: List video track annotations for a specific input operationId: V2_PostTrackAnnotationsSearches responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/apiMultiAnnotationResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: user_app_id.app_id in: path required: true schema: type: string - name: input_id description: The input ID containing the video track annotations to list in: path required: true schema: type: string tags: - Users requestBody: content: application/json: schema: $ref: '#/components/schemas/V2PostTrackAnnotationsSearchesBody' required: true /v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/inputs/{input_id}/track_annotations/searches/stream: post: summary: Stream annotations for a specific input one-by-one operationId: V2_StreamAnnotations responses: '200': description: A successful response.(streaming responses) content: application/json: schema: type: object properties: result: $ref: '#/components/schemas/apiSingleStreamAnnotationResponse' error: $ref: '#/components/schemas/googlerpcStatus' title: Stream result of apiSingleStreamAnnotationResponse default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: user_app_id.app_id in: path required: true schema: type: string - name: input_id description: The input ID containing the annotations to stream in: path required: true schema: type: string tags: - Users requestBody: content: application/json: schema: $ref: '#/components/schemas/V2StreamAnnotationsBody' required: true /v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/inputs/{input_id}/video_manifest: get: summary: Get a MPEG-DASH manifest for video-type inputs that were added via PostInputs… operationId: V2_GetInputVideoManifest responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/apiGetVideoManifestResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: user_app_id.app_id in: path required: true schema: type: string - name: input_id in: path required: true schema: type: string tags: - Users /v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/keys: get: summary: List keys by app_id operationId: V2_ListAppKeys responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/apiMultiKeyResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: user_app_id.app_id in: path required: true schema: type: string - name: page description: '(optional URL parameter) The page number. Pagination is used to split the results into chunks. Defaults to 1.' in: query required: false schema: type: integer format: int64 - name: per_page description: '(optional URL parameter) The number of results that will be contained in each page. Defaults to 128.' in: query required: false schema: type: integer format: int64 tags: - Users /v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/label_orders: get: summary: List label orders operationId: V2_ListLabelOrders responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/apiMultiLabelOrderResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: user_app_id.app_id in: path required: true schema: type: string - name: page description: '(optional URL parameter) The page number. Pagination is used to split the results into chunks. Defaults to 1.' in: query required: false schema: type: integer format: int64 - name: per_page description: '(optional URL parameter) The number of results that will be contained in each page. Defaults to 128.' in: query required: false schema: type: integer format: int64 tags: - Users delete: summary: Delete multiple label orders in one request. this do not change task status operationId: V2_DeleteLabelOrders responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/statusBaseResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: user_app_id.app_id in: path required: true schema: type: string tags: - Users requestBody: content: application/json: schema: $ref: '#/components/schemas/V2DeleteLabelOrdersBody' required: true post: summary: Add Label orders operationId: V2_PostLabelOrders responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/apiMultiLabelOrderResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: user_app_id.app_id in: path required: true schema: type: string tags: - Users requestBody: content: application/json: schema: $ref: '#/components/schemas/V2PostLabelOrdersBody' required: true patch: summary: Patch one or more label orders operationId: V2_PatchLabelOrders responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/apiMultiLabelOrderResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: user_app_id.app_id in: path required: true schema: type: string tags: - Users requestBody: content: application/json: schema: $ref: '#/components/schemas/V2PatchLabelOrdersBody' required: true /v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/label_orders/{label_order_id}: get: summary: Get a label order operationId: V2_GetLabelOrder responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/apiSingleLabelOrderResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: user_app_id.app_id in: path required: true schema: type: string - name: label_order_id in: path required: true schema: type: string tags: - Users /v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/models: get: summary: List all the models operationId: V2_ListModels responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/apiMultiModelResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: user_app_id.app_id in: path required: true schema: type: string - name: page description: '(optional URL parameter) The page number. Pagination is used to split the results into chunks. Defaults to 1.' in: query required: false schema: type: integer format: int64 - name: per_page description: '(optional URL parameter) The number of results that will be contained in each page. Defaults to 128.' in: query required: false schema: type: integer format: int64 - name: additional_fields description: '(optional URL parameter) List of additional fields to be included in the response. Currently supported: all, stars, outputs, presets, counts' in: query required: false style: form explode: true schema: type: array items: type: string - name: show_replicas description: If true, show replica counts for models. in: query required: false schema: type: boolean - name: sort_ascending description: 'Sorting options: Whether to sort in ascending order. If false, will order in descending order.' in: query required: false schema: type: boolean - name: sort_by_name description: Whether to order by the name in: query required: false schema: type: boolean - name: sort_by_num_inputs description: Whether to order by the number of training inputs in: query required: false schema: type: boolean - name: sort_by_modified_at description: 'Whether to order by the modified_at time of the latest model version. If none of the sort options is set to true, will sort by modified_at.' in: query required: false schema: type: boolean - name: sort_by_created_at description: Whether to order by the created_at in: query required: false schema: type: boolean - name: sort_by_star_count description: Whether to order by count of stars in: query required: false schema: type: boolean - name: sort_by_relevance description: Whether to order by search query relevance. Can only be used if search is not empty. in: query required: false schema: type: boolean - name: model_type_id description: 'Filtering options: Filter models by the specific model_type_id. See ListModelTypes for the list of ModelType.Id''s supported.' in: query required: false schema: type: string - name: trained_only description: If true, we only return models that have the status MODEL_TRAINED, which includes non-trainable model types. in: query required: false schema: type: boolean - name: input_fields description: 'The list of input fields to the model. For example, you can specify ''image'', which will return models that make inferences on images like visual-classifier models.' in: query required: false style: form explode: true schema: type: array items: type: string - name: output_fields description: 'The list of output fields to the model. For example, you can specify ''regions[...].data.concepts'', which will return visual-detector models.' in: query required: false style: form explode: true schema: type: array items: type: string - name: license description: Filter by the license of the model version in: query required: false schema: type: string - name: featured_only description: If true, we only return models that are handpicked by clarifai staff in: query required: false schema: type: boolean - name: starred_only description: If true, we only return models that are starred by the requesting user in: query required: false schema: type: boolean - name: toolkits description: List of toolkit tags to filter by in: query required: false style: form explode: true schema: type: array items: type: string - name: use_cases description: List of use_case tags to filter by in: query required: false style: form explode: true schema: type: array items: type: string - name: languages description: List of language tags to filter by in: query required: false style: form explode: true schema: type: array items: type: string - name: dont_fetch_from_main description: 'Old API behavior resulted in returning clarifai main models when calling ListModels while scoped to an app. While we transition away from that, we can use this flag to not always fetch clarifai main models, unless that is the app we are explicitly listing for. @exclude TODO (EAGLE-4447): Remove this field' in: query required: false schema: type: boolean - name: bookmark description: 'Filter models by bookmark. If set, only return bookmarked models. Otherwise none bookmarked models only. Note: you can not filter `trained_only` and bookmark at the same time. When filter by bookmark, we will return trained and untrained models.' in: query required: false schema: type: boolean - name: model_version_ids description: Filter by the model version ids. If set, only return the model of these versions. in: query required: false style: form explode: true schema: type: array items: type: string - name: license_type description: Filter by LicenseType in: query required: false schema: type: string enum: - UNKNOWN_LICENSE_TYPE - FIRST_PARTY - OPEN_SOURCE - CLOSED_SOURCE default: UNKNOWN_LICENSE_TYPE - name: source description: Filter by Source in: query required: false schema: type: integer format: int64 - name: creator description: Filter by Creator in: query required: false schema: type: string - name: min_replicas description: Filter by model versions runners with replicas >= min_replicas. in: query required: false schema: type: integer format: int64 - name: visibility.gettable description: " - UNKNOWN_VISIBILITY: Default value not allowed.\n - PRIVATE: PRIVATE requires collaborator or team permissions in order to GET this resource.\n - ORG: ORG requires you to be in the same org in order to GET this resource, but don't have to be a\nteammate or collaborator.\n - PUBLIC: PUBLIC opens up GET access to the resource to any user on the platform even if they are not\na teammate or collaborator." in: query required: false schema: type: string enum: - UNKNOWN_VISIBILITY - PRIVATE - ORG - PUBLIC default: UNKNOWN_VISIBILITY - name: search description: "Searching options:\nSpecify a search parameter in order to perform keyword search on the\nfollowing fields of the model:\n - id\n - name\n - description\n - notes\n - user_id (unless user_app_id.user_id is already set)\n\nKeywords are both normalized for search (so searching for \"satisfy\" matches \"satisfied\")\nand used for partial prefix-matching (so searching for \"clari\" matches \"clarifai\").\n\nNOTE: Both the list of fields searched and the exact keyword matching\nrules are subject to change and not guaranteed to be backwards-compatible." in: query required: false schema: type: string - name: query description: 'Query name, description and id fields, that can contain the words in the query string. Does NOT support wildcards - full words only. Supports operators "OR" and "-" as NOT. Deprecated: use search instead.' in: query required: false schema: type: string - name: name description: 'Filter by the description and id of the model. This supports wildcard queries like "gen*" to match "general" as an example. Deprecated: use search instead.' in: query required: false schema: type: string - name: filter_by_user_id description: 'Extends the name filter to include the user_id of the application owner that the model belongs to. Deprecated: use search instead of name.' in: query required: false schema: type: boolean tags: - Users delete: summary: Delete multiple models in one request operationId: V2_DeleteModels responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/statusBaseResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: user_app_id.app_id in: path required: true schema: type: string tags: - Users requestBody: content: application/json: schema: $ref: '#/components/schemas/V2DeleteModelsBody' required: true post: summary: Add a models to an app operationId: V2_PostModels responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/apiSingleModelResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: user_app_id.app_id in: path required: true schema: type: string tags: - Users requestBody: content: application/json: schema: $ref: '#/components/schemas/V2PostModelsBody' required: true patch: summary: Patch one or more models operationId: V2_PatchModels responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/apiMultiModelResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: user_app_id.app_id in: path required: true schema: type: string tags: - Users requestBody: content: application/json: schema: $ref: '#/components/schemas/V2PatchModelsBody' required: true /v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/models/ids: patch: summary: Patch one or more models ids operationId: V2_PatchModelIds responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/apiMultiModelResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: user_app_id.app_id in: path required: true schema: type: string tags: - Users requestBody: content: application/json: schema: $ref: '#/components/schemas/V2PatchModelIdsBody' required: true /v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/models/searches: post: summary: Search over the models to find one or more you're looking for. operationId: V2_PostModelsSearches responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/apiMultiModelResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: user_app_id.app_id in: path required: true schema: type: string tags: - Users requestBody: content: application/json: schema: $ref: '#/components/schemas/V2PostModelsSearchesBody' required: true /v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/models/types: get: summary: List all the model types available in the platform. operationId: V2_ListModelTypes responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/apiMultiModelTypeResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: user_app_id.app_id in: path required: true schema: type: string - name: page description: '(optional URL parameter) The page number. Pagination is used to split the results into chunks. Defaults to 1.' in: query required: false schema: type: integer format: int64 - name: per_page description: '(optional URL parameter) The number of results that will be contained in each page. Defaults to 128.' in: query required: false schema: type: integer format: int64 tags: - Users /v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/models/types/{model_type_id}: get: summary: Get a specific model type operationId: V2_GetModelType responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/apiSingleModelTypeResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: user_app_id.app_id in: path required: true schema: type: string - name: model_type_id description: The specific ModelType.Id you want to retrieve. in: path required: true schema: type: string tags: - Users /v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/models/{model_id}: get: summary: Get a specific model from an app operationId: V2_GetModel responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/apiSingleModelResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: user_app_id.app_id in: path required: true schema: type: string - name: model_id in: path required: true schema: type: string - name: version_id description: 'This is included so that we can re-use this request for multiple rpcs with and without the version_id.' in: query required: false schema: type: string - name: language in: query required: false schema: type: string - name: trained_before in: query required: false schema: type: boolean - name: additional_fields description: '(optional URL parameter) List of additional fields to be included in the response. Currently supported: all, stars, outputs, presets' in: query required: false style: form explode: true schema: type: array items: type: string tags: - Users delete: summary: Delete a single model operationId: V2_DeleteModel responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/statusBaseResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: user_app_id.app_id in: path required: true schema: type: string - name: model_id in: path required: true schema: type: string tags: - Users /v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/models/{model_id}/check_consents: patch: summary: Update model check consents operationId: V2_PatchModelCheckConsents responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/apiMultiModelCheckConsentResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: user_app_id.app_id in: path required: true schema: type: string - name: model_id description: the model id in: path required: true schema: type: string tags: - Users requestBody: content: application/json: schema: $ref: '#/components/schemas/V2PatchModelCheckConsentsBody' required: true /v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/models/{model_id}/concepts: get: summary: List models concepts operationId: V2_ListModelConcepts responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/apiMultiConceptResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: user_app_id.app_id in: path required: true schema: type: string - name: model_id description: Model id in: path required: true schema: type: string - name: version_id description: Model version Id. Optional, if not provided latest model version is used. in: query required: false schema: type: string - name: page description: '(optional URL parameter) The page number. Pagination is used to split the results into chunks. Defaults to 1.' in: query required: false schema: type: integer format: int64 - name: per_page description: '(optional URL parameter) The number of results that will be contained in each page. Defaults to 128.' in: query required: false schema: type: integer format: int64 - name: search description: "Searching options:\nSpecify a search parameter in order to perform keyword search on the\nfollowing fields of the concept:\n - id\n - name\n\nKeywords are used for partial prefix-matching (so searching for \"larif\" matches \"clarifai\").\n\nNOTE: Both the list of fields searched and the exact keyword matching\nrules are subject to change and not guaranteed to be backwards-compatible." in: query required: false schema: type: string tags: - Users /v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/models/{model_id}/inputs: get: summary: 'Deprecated: Unmaintained and ideally replaced with usage of datasets The server…' operationId: V2_ListModelInputs responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/apiMultiInputResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: user_app_id.app_id in: path required: true schema: type: string - name: model_id in: path required: true schema: type: string - name: version_id in: query required: false schema: type: string - name: page description: '(optional URL parameter) The page number. Pagination is used to split the results into chunks. Defaults to 1.' in: query required: false schema: type: integer format: int64 - name: per_page description: '(optional URL parameter) The number of results that will be contained in each page. Defaults to 128.' in: query required: false schema: type: integer format: int64 tags: - Users /v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/models/{model_id}/languages: patch: summary: Update model languages tags operationId: V2_PatchModelLanguages responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/apiMultiModelLanguageResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: user_app_id.app_id in: path required: true schema: type: string - name: model_id in: path required: true schema: type: string tags: - Users requestBody: content: application/json: schema: $ref: '#/components/schemas/V2PatchModelLanguagesBody' required: true /v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/models/{model_id}/migration: delete: summary: Reverts a model migration from Docker format back to Triton format operationId: V2_DeleteModelMigration responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/apiSingleModelResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: user_app_id.app_id in: path required: true schema: type: string - name: model_id in: path required: true schema: type: string tags: - Users post: summary: Kicks off conversion from the old Triton model format to the new Docker model… operationId: V2_PostModelMigration responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/apiSingleModelResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: user_app_id.app_id in: path required: true schema: type: string - name: model_id in: path required: true schema: type: string tags: - Users requestBody: content: application/json: schema: $ref: '#/components/schemas/V2PostModelMigrationBody' required: true /v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/models/{model_id}/output_info: get: summary: Get a the output info for a given model_id or model_id/version_id combo operationId: V2_GetModelOutputInfo responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/apiSingleModelResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: user_app_id.app_id in: path required: true schema: type: string - name: model_id in: path required: true schema: type: string - name: version_id description: 'This is included so that we can re-use this request for multiple rpcs with and without the version_id.' in: query required: false schema: type: string - name: language in: query required: false schema: type: string - name: trained_before in: query required: false schema: type: boolean - name: additional_fields description: '(optional URL parameter) List of additional fields to be included in the response. Currently supported: all, stars, outputs, presets' in: query required: false style: form explode: true schema: type: array items: type: string tags: - Users /v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/models/{model_id}/outputs: post: summary: Get predicted outputs from the model operationId: V2_PostModelOutputs3 responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/apiMultiOutputResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: user_app_id.app_id in: path required: true schema: type: string - name: model_id in: path required: true schema: type: string tags: - Users requestBody: content: application/json: schema: $ref: '#/components/schemas/V2PostModelOutputsBody' required: true /v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/models/{model_id}/outputs/generate: post: summary: 'TODO(zeiler): will need to Single request but streaming responses' operationId: V2_GenerateModelOutputs2 responses: '200': description: A successful response.(streaming responses) content: application/json: schema: type: object properties: result: $ref: '#/components/schemas/apiMultiOutputResponse' error: $ref: '#/components/schemas/googlerpcStatus' title: Stream result of apiMultiOutputResponse default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: user_app_id.app_id in: path required: true schema: type: string - name: model_id in: path required: true schema: type: string tags: - Users requestBody: content: application/json: schema: $ref: '#/components/schemas/V2GenerateModelOutputsBody' required: true /v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/models/{model_id}/publish: post: summary: PostModelVersionsPublish operationId: V2_PostModelVersionsPublish responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/statusBaseResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: user_app_id.app_id in: path required: true schema: type: string - name: model_id in: path required: true schema: type: string tags: - Users requestBody: content: application/json: schema: $ref: '#/components/schemas/V2PostModelVersionsPublishBody' required: true /v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/models/{model_id}/references: get: summary: Lists model references tied to a particular model id operationId: V2_ListModelReferences responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/apiMultiModelReferenceResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: user_app_id.app_id in: path required: true schema: type: string - name: model_id in: path required: true schema: type: string - name: page description: Optional, defaults to 1. in: query required: false schema: type: integer format: int64 - name: per_page description: Optional, defaults to 128 references per page. in: query required: false schema: type: integer format: int64 tags: - Users /v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/models/{model_id}/toolkits: patch: summary: Update model toolkits tags operationId: V2_PatchModelToolkits responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/apiMultiModelToolkitResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: user_app_id.app_id in: path required: true schema: type: string - name: model_id in: path required: true schema: type: string tags: - Users requestBody: content: application/json: schema: $ref: '#/components/schemas/V2PatchModelToolkitsBody' required: true /v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/models/{model_id}/unpublish: post: summary: PostModelVersionsUnPublish operationId: V2_PostModelVersionsUnPublish responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/statusBaseResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: user_app_id.app_id in: path required: true schema: type: string - name: model_id in: path required: true schema: type: string tags: - Users requestBody: content: application/json: schema: $ref: '#/components/schemas/V2PostModelVersionsUnPublishBody' required: true /v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/models/{model_id}/usecases: patch: summary: Update model use_cases tags operationId: V2_PatchModelUseCases responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/apiMultiModelUseCaseResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: user_app_id.app_id in: path required: true schema: type: string - name: model_id in: path required: true schema: type: string tags: - Users requestBody: content: application/json: schema: $ref: '#/components/schemas/V2PatchModelUseCasesBody' required: true /v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/models/{model_id}/versions: get: summary: List all the models operationId: V2_ListModelVersions responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/apiMultiModelVersionResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: user_app_id.app_id in: path required: true schema: type: string - name: model_id in: path required: true schema: type: string - name: page description: '(optional URL parameter) The page number. Pagination is used to split the results into chunks. Defaults to 1.' in: query required: false schema: type: integer format: int64 - name: per_page description: '(optional URL parameter) The number of results that will be contained in each page. Defaults to 128.' in: query required: false schema: type: integer format: int64 - name: concept_ids description: 'Filtering options: To list only the model versions that have these concept ids present in them.' in: query required: false style: form explode: true schema: type: array items: type: string - name: trained_only description: To list only the model versions that have been trained. in: query required: false schema: type: boolean - name: min_replicas description: Filter by model versions runners with replicas >= min_replicas. in: query required: false schema: type: integer format: int64 - name: sort_ascending description: 'Sorting options: Whether to sort in ascending order. If false, will order in descending order.' in: query required: false schema: type: boolean - name: sort_by_status_code description: Whether to order by the status code in: query required: false schema: type: boolean - name: sort_by_num_inputs description: Whether to order by the number of training inputs in: query required: false schema: type: boolean - name: sort_by_description description: Whether to sort by the description in: query required: false schema: type: boolean - name: sort_by_created_at description: 'Whether to order by the created_at time If neither sort option is set to true, will sort by created_at.' in: query required: false schema: type: boolean tags: - Users post: summary: Create a new model version to trigger training of the model operationId: V2_PostModelVersions responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/apiSingleModelResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: user_app_id.app_id in: path required: true schema: type: string - name: model_id in: path required: true schema: type: string tags: - Users requestBody: content: application/json: schema: $ref: '#/components/schemas/V2PostModelVersionsBody' required: true patch: summary: PatchModelVersions operationId: V2_PatchModelVersions responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/apiMultiModelVersionResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: user_app_id.app_id in: path required: true schema: type: string - name: model_id in: path required: true schema: type: string tags: - Users requestBody: content: application/json: schema: $ref: '#/components/schemas/V2PatchModelVersionsBody' required: true /v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/models/{model_id}/versions/time_estimate: post: summary: Get the training time estimate based off train request and estimated input count operationId: V2_PostModelVersionsTrainingTimeEstimate responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/apiMultiTrainingTimeEstimateResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: user_app_id.app_id in: path required: true schema: type: string - name: model_id in: path required: true schema: type: string tags: - Users requestBody: content: application/json: schema: $ref: '#/components/schemas/V2PostModelVersionsTrainingTimeEstimateBody' required: true /v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/models/{model_id}/versions/{model_version_id}/evaluations: get: summary: Deprecated, use GetEvaluation instead List the evaluation metrics for a model… operationId: V2_ListModelVersionEvaluations responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/apiMultiEvalMetricsResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: user_app_id.app_id in: path required: true schema: type: string - name: model_id in: path required: true schema: type: string - name: model_version_id in: path required: true schema: type: string - name: page description: '(optional URL parameter) The page number. Pagination is used to split the results into chunks. Defaults to 1.' in: query required: false schema: type: integer format: int64 - name: per_page description: '(optional URL parameter) The number of results that will be contained in each page. Defaults to 128.' in: query required: false schema: type: integer format: int64 tags: - Users post: summary: Deprecated, use PostEvaluations instead operationId: V2_PostModelVersionEvaluations responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/apiMultiEvalMetricsResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: user_app_id.app_id in: path required: true schema: type: string - name: model_id in: path required: true schema: type: string - name: model_version_id in: path required: true schema: type: string tags: - Users requestBody: content: application/json: schema: $ref: '#/components/schemas/V2PostModelVersionEvaluationsBody' required: true ? /v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/models/{model_id}/versions/{model_version_id}/evaluations/{evaluation_id} : get: summary: Deprecated, use GetEvaluation instead Get an evaluation metrics for a model… operationId: V2_GetModelVersionEvaluation responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/apiSingleEvalMetricsResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: user_app_id.app_id in: path required: true schema: type: string - name: model_id in: path required: true schema: type: string - name: model_version_id in: path required: true schema: type: string - name: evaluation_id in: path required: true schema: type: string - name: fields.confusion_matrix in: query required: false schema: type: boolean - name: fields.cooccurrence_matrix in: query required: false schema: type: boolean - name: fields.label_counts in: query required: false schema: type: boolean - name: fields.binary_metrics in: query required: false schema: type: boolean - name: fields.test_set in: query required: false schema: type: boolean - name: fields.metrics_by_area in: query required: false schema: type: boolean - name: fields.metrics_by_class in: query required: false schema: type: boolean tags: - Users /v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/models/{model_id}/versions/{model_version_id}/input_examples: get: summary: ListModelVersionInputExamples operationId: V2_ListModelVersionInputExamples responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/apiMultiModelVersionInputExampleResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: user_app_id.app_id in: path required: true schema: type: string - name: model_id description: id of model the example belongs to in: path required: true schema: type: string - name: model_version_id description: specific version the example belongs to in: path required: true schema: type: string - name: page description: Optional, defaults to 1. in: query required: false schema: type: integer format: int64 - name: per_page description: Optional, defaults to 128 references per page. in: query required: false schema: type: integer format: int64 tags: - Users ? /v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/models/{model_id}/versions/{model_version_id}/input_examples/{example_id} : get: summary: GetModelVersionInputExample operationId: V2_GetModelVersionInputExample responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/apiSingleModelVersionInputExampleResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: user_app_id.app_id in: path required: true schema: type: string - name: model_id description: id of model the example belongs to in: path required: true schema: type: string - name: model_version_id description: specific version the example belongs to in: path required: true schema: type: string - name: example_id description: Id of example to fetch in: path required: true schema: type: string tags: - Users /v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/models/{model_id}/versions/{model_version_id}/{log_type}/logs: get: operationId: V2_ListLogEntries4 responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/apiMultiLogEntryResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: user_app_id.app_id in: path required: true schema: type: string - name: model_id description: The Model ID, if a model produced the logs. in: path required: true schema: type: string - name: model_version_id description: The Version ID, if a model version produced the logs. in: path required: true schema: type: string - name: log_type description: The type of log entry. Choose from [agent, builder, builder.events, runner, runner.events, pipeline.version.run] in: path required: true schema: type: string - name: page description: '(optional URL parameter) The page number. Pagination is used to split the results into chunks. Defaults to last page.' in: query required: false schema: type: integer format: int64 - name: per_page description: '(optional URL parameter) The number of results that will be contained in each page. Defaults to 32.' in: query required: false schema: type: integer format: int64 - name: workflow_id description: Workflow Id, if a workflow produced the logs. in: query required: false schema: type: string - name: compute_cluster_user_id description: Where the logs came from. in: query required: false schema: type: string - name: compute_cluster_id in: query required: false schema: type: string - name: nodepool_id in: query required: false schema: type: string - name: runner_id in: query required: false schema: type: string - name: pipeline_id description: 'Pipelines that produced the logs for a given pipeline run with log_type: pipeline.version.run Must include user_app_id with user_id and app_id as well.' in: query required: false schema: type: string - name: pipeline_version_id in: query required: false schema: type: string - name: pipeline_version_run_id in: query required: false schema: type: string - name: pipeline_step_id description: During pipeline step build provide these IDs. in: query required: false schema: type: string - name: pipeline_step_version_id in: query required: false schema: type: string tags: - Users summary: V2 list log entries4 x-summary-source: derived /v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/models/{model_id}/versions/{version_id}: get: summary: Get a specific model from an app operationId: V2_GetModelVersion responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/apiSingleModelVersionResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: user_app_id.app_id in: path required: true schema: type: string - name: model_id in: path required: true schema: type: string - name: version_id in: path required: true schema: type: string tags: - Users delete: summary: Delete a single model operationId: V2_DeleteModelVersion responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/statusBaseResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: user_app_id.app_id in: path required: true schema: type: string - name: model_id in: path required: true schema: type: string - name: version_id in: path required: true schema: type: string tags: - Users /v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/models/{model_id}/versions/{version_id}/concepts: get: summary: List models concepts operationId: V2_ListModelConcepts2 responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/apiMultiConceptResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: user_app_id.app_id in: path required: true schema: type: string - name: model_id description: Model id in: path required: true schema: type: string - name: version_id description: Model version Id. Optional, if not provided latest model version is used. in: path required: true schema: type: string - name: page description: '(optional URL parameter) The page number. Pagination is used to split the results into chunks. Defaults to 1.' in: query required: false schema: type: integer format: int64 - name: per_page description: '(optional URL parameter) The number of results that will be contained in each page. Defaults to 128.' in: query required: false schema: type: integer format: int64 - name: search description: "Searching options:\nSpecify a search parameter in order to perform keyword search on the\nfollowing fields of the concept:\n - id\n - name\n\nKeywords are used for partial prefix-matching (so searching for \"larif\" matches \"clarifai\").\n\nNOTE: Both the list of fields searched and the exact keyword matching\nrules are subject to change and not guaranteed to be backwards-compatible." in: query required: false schema: type: string tags: - Users /v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/models/{model_id}/versions/{version_id}/exports: get: summary: GetModelVersionExport operationId: V2_GetModelVersionExport responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/apiSingleModelVersionExportResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: user_app_id.app_id in: path required: true schema: type: string - name: model_id in: path required: true schema: type: string - name: version_id in: path required: true schema: type: string tags: - Users put: summary: Export a model operationId: V2_PutModelVersionExports responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/apiSingleModelVersionExportResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: user_app_id.app_id in: path required: true schema: type: string - name: model_id in: path required: true schema: type: string - name: version_id in: path required: true schema: type: string tags: - Users /v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/models/{model_id}/versions/{version_id}/inputs: get: summary: 'Deprecated: Unmaintained and ideally replaced with usage of datasets The server…' operationId: V2_ListModelInputs3 responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/apiMultiInputResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: user_app_id.app_id in: path required: true schema: type: string - name: model_id in: path required: true schema: type: string - name: version_id in: path required: true schema: type: string - name: page description: '(optional URL parameter) The page number. Pagination is used to split the results into chunks. Defaults to 1.' in: query required: false schema: type: integer format: int64 - name: per_page description: '(optional URL parameter) The number of results that will be contained in each page. Defaults to 128.' in: query required: false schema: type: integer format: int64 tags: - Users /v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/models/{model_id}/versions/{version_id}/metrics: get: summary: Get the evaluation metrics for a model version. operationId: V2_GetModelVersionMetrics responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/apiSingleModelVersionResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: user_app_id.app_id in: path required: true schema: type: string - name: model_id in: path required: true schema: type: string - name: version_id in: path required: true schema: type: string - name: fields.confusion_matrix in: query required: false schema: type: boolean - name: fields.cooccurrence_matrix in: query required: false schema: type: boolean - name: fields.label_counts in: query required: false schema: type: boolean - name: fields.binary_metrics in: query required: false schema: type: boolean - name: fields.test_set in: query required: false schema: type: boolean - name: fields.metrics_by_area in: query required: false schema: type: boolean - name: fields.metrics_by_class in: query required: false schema: type: boolean tags: - Users post: summary: Deprecated, use PostEvaluations instead Run the evaluation metrics for a model… operationId: V2_PostModelVersionMetrics responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/apiSingleModelVersionResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: user_app_id.app_id in: path required: true schema: type: string - name: model_id in: path required: true schema: type: string - name: version_id in: path required: true schema: type: string tags: - Users requestBody: content: application/json: schema: $ref: '#/components/schemas/V2PostModelVersionMetricsBody' required: true /v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/models/{model_id}/versions/{version_id}/migration: post: summary: Kicks off conversion from the old Triton model format to the new Docker model… operationId: V2_PostModelMigration2 responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/apiSingleModelResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: user_app_id.app_id in: path required: true schema: type: string - name: model_id in: path required: true schema: type: string - name: version_id in: path required: true schema: type: string tags: - Users requestBody: content: application/json: schema: $ref: '#/components/schemas/V2PostModelMigrationBody' required: true /v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/models/{model_id}/versions/{version_id}/output_info: get: summary: Get a the output info for a given model_id or model_id/version_id combo operationId: V2_GetModelOutputInfo3 responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/apiSingleModelResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: user_app_id.app_id in: path required: true schema: type: string - name: model_id in: path required: true schema: type: string - name: version_id description: 'This is included so that we can re-use this request for multiple rpcs with and without the version_id.' in: path required: true schema: type: string - name: language in: query required: false schema: type: string - name: trained_before in: query required: false schema: type: boolean - name: additional_fields description: '(optional URL parameter) List of additional fields to be included in the response. Currently supported: all, stars, outputs, presets' in: query required: false style: form explode: true schema: type: array items: type: string tags: - Users /v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/models/{model_id}/versions/{version_id}/outputs: post: summary: Get predicted outputs from the model operationId: V2_PostModelOutputs responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/apiMultiOutputResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: user_app_id.app_id in: path required: true schema: type: string - name: model_id in: path required: true schema: type: string - name: version_id in: path required: true schema: type: string tags: - Users requestBody: content: application/json: schema: $ref: '#/components/schemas/V2PostModelOutputsBody' required: true /v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/models/{model_id}/versions/{version_id}/outputs/generate: post: summary: 'TODO(zeiler): will need to Single request but streaming responses' operationId: V2_GenerateModelOutputs responses: '200': description: A successful response.(streaming responses) content: application/json: schema: type: object properties: result: $ref: '#/components/schemas/apiMultiOutputResponse' error: $ref: '#/components/schemas/googlerpcStatus' title: Stream result of apiMultiOutputResponse default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: user_app_id.app_id in: path required: true schema: type: string - name: model_id in: path required: true schema: type: string - name: version_id in: path required: true schema: type: string tags: - Users requestBody: content: application/json: schema: $ref: '#/components/schemas/V2GenerateModelOutputsBody' required: true /v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/myscopes: get: summary: API Keys in the public API -- request is itself Key authorized, and will tell… operationId: V2_MyScopes responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/apiMultiScopeResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: user_app_id.app_id in: path required: true schema: type: string tags: - Users /v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/partial: patch: summary: Allows to Patch only the below fields in one or more apps. operationId: V2_PatchAppsDetails responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/apiMultiAppResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: user_app_id.app_id in: path required: true schema: type: string tags: - Users requestBody: content: application/json: schema: $ref: '#/components/schemas/V2PatchAppsDetailsBody' required: true /v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/pipeline_steps: get: operationId: V2_ListPipelineSteps responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/apiMultiPipelineStepResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: user_app_id.app_id in: path required: true schema: type: string - name: page description: '(optional URL parameter) The page number. Pagination is used to split the results into chunks. Defaults to 1.' in: query required: false schema: type: integer format: int64 - name: per_page description: '(optional URL parameter) The number of results that will be contained in each page. Defaults to 128.' in: query required: false schema: type: integer format: int64 tags: - Users summary: V2 list pipeline steps x-summary-source: derived delete: operationId: V2_DeletePipelineSteps responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/statusBaseResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: user_app_id.app_id in: path required: true schema: type: string tags: - Users requestBody: content: application/json: schema: $ref: '#/components/schemas/V2DeletePipelineStepsBody' required: true summary: V2 delete pipeline steps x-summary-source: derived post: operationId: V2_PostPipelineSteps responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/apiMultiPipelineStepResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: user_app_id.app_id in: path required: true schema: type: string tags: - Users requestBody: content: application/json: schema: $ref: '#/components/schemas/V2PostPipelineStepsBody' required: true summary: V2 post pipeline steps x-summary-source: derived /v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/pipeline_steps/{pipeline_step_id}: get: operationId: V2_GetPipelineStep responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/apiSinglePipelineStepResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: user_app_id.app_id in: path required: true schema: type: string - name: pipeline_step_id description: The id of the pipeline step that has the requested version. in: path required: true schema: type: string tags: - Users summary: V2 get pipeline step x-summary-source: derived /v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/pipeline_steps/{pipeline_step_id}/versions: get: operationId: V2_ListPipelineStepVersions responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/apiMultiPipelineStepVersionResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: user_app_id.app_id in: path required: true schema: type: string - name: pipeline_step_id description: List versions for the pipeline step identified by this id in: path required: true schema: type: string - name: page description: '(optional URL parameter) The page number. Pagination is used to split the results into chunks. Defaults to 1.' in: query required: false schema: type: integer format: int64 - name: per_page description: '(optional URL parameter) The number of results that will be contained in each page. Defaults to 128.' in: query required: false schema: type: integer format: int64 - name: status_codes description: "Filter based on status\n\n - ZERO: to be revised and greatly expanded\n - SUCCESS: Generic\n - MOVED: Resource moved. Respond with Http status 307 and add new Location header to response\n - ACCEPTED: Request has been accepted. Respond with Http status 202.\n - CONN_ACCOUNT_ISSUES: Clarifai Connection Codes: 11xxx\n\nexpired cc, still in trial, feature not supported in your tier\n - CONN_TOKEN_INVALID: invalid auth token used. Deprecated: we should return CONN_KEY_INVALID instead now in all cases.\n - CONN_CREDENTIALS_INVALID: invalid auth credentials\n - CONN_EXCEED_HOURLY_LIMIT: throttle hourly limit exceeded\n - CONN_EXCEED_MONTHLY_LIMIT: throttle monthly limit exceeded\n - CONN_THROTTLED: throttler and billing stuff\n - CONN_EXCEEDS_LIMITS: throttler and billing stuff\n - CONN_INSUFFICIENT_SCOPES: api key has insufficient permissions\n - CONN_KEY_INVALID: api key is invalid\n - CONN_KEY_NOT_FOUND: api key not found\n - CONN_BAD_REQUEST_FORMAT: multipart form parsing, broken json, etc\n - CONN_DOES_NOT_EXIST: when path is bad\n - CONN_INVALID_REQUEST: something wrong with a header\n - CONN_METHOD_NOT_ALLOWED: when a request method is not allowed\n - CONN_NO_GDPR_CONSENT: lack GDPR consent\n - CONN_INVALID_RANGE: when invalid range of a resource is requested\n - CONN_AUTH_METHOD_DISABLED: authentication method is disabled\n - MODEL_TRAINED: Model/Custom Training related 20xxx\n\nCustom model has been already trained.\n - MODEL_TRAINING: Custom model is currently training.\n - MODEL_UNTRAINED: Custom model has not yet been trained.\n - MODEL_QUEUED_FOR_TRAINING: Custom model is currently in queue for training, waiting on assets to process first.\n - MODEL_TRAINING_FAILED: generic err msg for any type of model training err.\n - MODEL_BUILDING: For new V3 DockerInternalType models which are built images\n - MODEL_BUILDING_FAILED: Failed to build image for model.\n - MODEL_BUILD_UNEXPECTED_ERROR: Failed to build image for model.\n - MODEL_TRAINING_NO_DATA: Custom model training had no data. FIXME(yang): deprecate this. Use the 21106 + errStatusMsg\n - MODEL_TRAINING_NO_POSITIVES: Custom model training had no positive examples. FIXME(yang): deprecate this. Use the 21106 + errStatusMsg\n - MODEL_TRAINING_ONE_VS_N_SINGLE_CLASS: Custom model training was ONE_VS_N but with a single class. FIXME(yang): deprecate this. Use the 21106 + errStatusMsg\n - MODEL_TRAINING_TIMED_OUT: Training took longer than hard coded timeouts. FIXME(yang): deprecate this. Use the 21106 + errStatusMsg\n - MODEL_TRAINING_WAITING_ERROR: Training got error waiting on asset pipeline to finish. FIXME(yang): deprecate this. Use the 21106 + errStatusMsg\n - MODEL_TRAINING_UNKNOWN_ERROR: Training threw an unknown exception.\n - MODEL_TRAINING_MSG_REDELIVER: Training message was redelivered. FIXME(yang): deprecate this. Use the 21106 + errStatusMsg\n - MODEL_TRAINING_INSUFFICIENT_DATA: Training got error due to insufficient labelled data. FIXME(yang): deprecate this. Use the 21106 + errStatusMsg\n - MODEL_TRAINING_INVALID_PARAMS: FIXME(yang): deprecate this. Use the 21106 + errStatusMsg\n - MODEL_TRAINING_INVALID_DATA_TOLERANCE_EXCEEDED: Training is stopped because too much data was dropped. FIXME(yang): deprecate this. Use the 21106 + errStatusMsg\n - MODEL_EVALUATION_TIMED_OUT: Evaluation took longer than hard coded timeouts. FIXME(yang): deprecate this. Use the 21317 + errStatusMsg\n - MODEL_EVALUATION_WAITING_ERROR: Evaluation got error waiting on asset pipeline to finish.FIXME(yang): deprecate this. Use the 21317 + errStatusMsg\n - MODEL_EVALUATION_UNKNOWN_ERROR: EVALUATION THREW AN UNKNOWN EXCEPTION.\n - MODEL_EVALUATION_MSG_REDELIVER: Eval message was redelivered. FIXME(yang): deprecate this. Use the 21317 + errStatusMsg\n - MODEL_EVALUATION_NEED_LABELS: Don't have enough concepts labelled to perform evaluation. FIXME(yang): deprecate this. Use the 21317 + errStatusMsg\n - MODEL_EVALUATION_NEED_INPUTS: Don't have enough inputs per concept to perform evaluation. FIXME(yang): deprecate this. Use the 21317 + errStatusMsg\n - MODEL_EVALUATION_FAILED: Generic err code for eval failure.\n - MODEL_DEPLOYMENT_FAILED: Used when inference coordinator failed to deploy spire and throws an error\n - MODEL_DEPLOYING: Used when calling the inference coordinator to deploy a spire\n - MODEL_QUEUED_FOR_DEPLOYMENT: Used when training is completed\n - MODEL_NOT_DEPLOYED: Used when model spire deployment is manually taken down or due to inactivity\n - MODEL_LOADING: Used when the model pod is running, but not yet ready to serve requests.\n - MODEL_REFERENCE_INVALID_ARGUMENT: Used when a model reference field is not set properly\n - MODEL_EXAMPLE_INPUT_INVALID_ARGUMENT: Used when a model example input field is not set properly\n - MODEL_EXPORTED: Model Export status codes\n - WORKFLOW_NO_MATCHING_INPUT: specified model input not in workflow\n - WORKFLOW_REQUIRE_TRAINED_MODEL: specified model must be trained\n - WORKFLOW_INVALID_ARGUMENT: error in the request somewhere\n - WORKFLOW_INVALID_REQUEST: error in the request somewhere\n - CONCEPT_MODIFY_SUCCESS: Concept related 23xxx\n - ANNOTATION_SUCCESS: Annotation related 24xxx\n - ANNOTATION_AWAITING_REVIEW: Annotation is awaiting review from task REVIEWERS.\n - ANNOTATION_AWAITING_CONSENSUS_REVIEW: Annotation is awaiting consensus review from task LABELERS.\n - ANNOTATION_TRACK_IDLE: Annotation (video) tracks are groups of annotations per frame\nIDLE -> PROCESSING --> PENDING --> APPROVED --> (DELETED)\nPROCESSING --> FAILED --> (DELETED)\nPROCESSING --> (DELETED)\n - METADATA_INVALID_PATCH_ARGUMENTS: Metadata related 249xx\n - TRAINER_JOB_STATE_NONE: Training service related 25xxx\n - DATA_DUMP_SUCCESS: Data Dump related 251xx\n - DATA_DUMP_NO_DATA: DEPRECATED: Not used anymore. Now for an empty data dump, DATA_DUMP_SUCCESS is returned. To detect an empty data dump, check if the inptus count is 0.\n - APP_DUPLICATION_SUCCESS: Duplicate related 252xx - DEPRECATED: App duplication is no longer supported.\n - MODULE_DOES_NOT_EXIST: Module related codes 253xx\n - BULK_OPERATION_SUCCESS: Bulk Operation related codes 254xx\n - RUNNER_DOES_NOT_EXIST: Runner related codes 256xx\n - NODEPOOL_DOES_NOT_EXIST: Nodepool related codes 257xx\n - COMPUTE_CLUSTER_DOES_NOT_EXIST: ComputeCluster related codes 258xx\n - DEPLOYMENT_DOES_NOT_EXIST: Deployment related codes 259xx\n - DEPLOYMENT_DISABLED: The deployment is disabled and cannot serve traffic.\n - INSTANCE_TYPE_DOES_NOT_EXIST: InstanceType related codes 260xx\n - COMPUTE_PLANE_METRICS_INVALID_REQUEST: Compute plane related codes 261xx\n - PIPELINE_STEP_DOES_NOT_EXIST: PipelineStep related codes 262xx\n - PIPELINE_DOES_NOT_EXIST: Pipeline related codes 263xx\n - ARTIFACT_DOES_NOT_EXIST: Artifact related codes 264xx\n - INPUT_SUCCESS: Input:Image related 30xxx\n - INPUT_PENDING: when things are async, this is the default status.\n - INPUT_FAILED: any type of error downloading and processing\n - INPUT_DOWNLOAD_SUCCESS: use INPUT_SUCCESS, INPUT_PENDING, INPUT_FAILED, INPUT_IN_PROGRESS instead\nDOWNLOAD is no longer correct, but keep old statuses for backward compatibility\n - INPUT_VIDEO_DOWNLOAD_SUCCESS: Input:Video related 31xxx -- Deprecated\n - INPUT_WRITES_DISABLED_FOR_MAINTENANCE: deprecate this one. Use REQUEST_DISABLED_FOR_MAINTENANCE\n - PREDICT_INVALID_REQUEST: API formatting issues 4000x\n - DATABASE_DUPLICATE_KEY: Other related 400xx\n - EXTERNAL_CONNECTION_ERROR: could not connect to external services\n - QUEUE_CONN_ERROR: Queue related errors 41xxx\n - SQS_OVERLIMIT: SQS related errors 411xx\n - SEARCH_INTERNAL_FAILURE: Search related errors 43xxxx\n - EVALUATION_QUEUED: Workflow evaluation err code\n - STRIPE_EVENT_ERROR: Stripe 44xxx\n - CACHE_MISS: Redis/Cache 45xxx\n - SIGNUP_EVENT_ERROR: Sift Science 46xxx\n - APP_COUNT_INVALID_MESSAGE: Application counts related errors 470xx\n - MP_DOWNLOAD_ERROR: Media processor related errors 471xx -- DEPRECATED\n - DATATIER_CONN_ERROR: DataTier related error 472xx\n - USER_CONSENT_FACE: User legal consent stauts related 50xxx\n - WORKER_MISSING: Workers 51xxx\n - SSO_IDENTITY_PROVIDER_DOES_NOT_EXIST: SSO 53xxx\n - TASK_IN_PROGRESS: Tasks 54xxx\nThe task was created.\n - TASK_DONE: The task is completed.\n - TASK_WONT_DO: The task is marked as abandoned.\n - TASK_FAILED: An error occurred during add-task-annotations or add-auto-annotations pipeline.\n - TASK_IDLE: Task is waiting for user action.\nExamples:\n- When an Auto Annotation task job has finished processing its last batch and is waiting for more dataset assets.\n- When an Auto Annotation task job for a video livestream input is waiting for user to create a task deployment.\n - TASK_CONFLICT: The task operation is in conflict with the current state of the server.\n - TASK_NOT_IMPLEMENTED: Certain task-related scenarios are not implemented.\n - TASK_MISSING: Task was not found.\n - TASK_PERMISSION_DENIED: Not allowed to perform a task-related action.\n - TASK_ASSIGNMENT_SUCCESS: Task Assignments 542xx\n - TASK_ASSIGNMENT_REVIEW_SUCCESS: Task Assignment Reviews 543xx\n - LABEL_ORDER_PENDING: Label Order Related Status Code 55xxx\n - LICENSE_ACTIVE: License Related Status Code 600xx\nDEPRECATED: License feature is fully deprecated now.\n - LICENSE_DELETED: hidden state not reflected to users\n - PASSWORD_VALIDATION_SUCCESS: Password Related Status Code\n - FEATUREFLAG_CONFIG_NOT_FOUND: Feature flags status code\n - MAINTENANCE_SUCCESS: Maintenance status code\n - DATASET_VERSION_PENDING: Datasets 64xxx\nThe dataset version is pending to be processed.\n - DATASET_VERSION_IN_PROGRESS: The dataset version is currently being processed.\n - DATASET_VERSION_READY: The dataset version is ready to be used.\n - DATASET_VERSION_FAILURE: An error occurred during the dataset version processing.\n - DATASET_VERSION_UNEXPECTED_ERROR: An unexpected error occurred during the dataset version processing.\n - DATASET_VERSION_CONFLICT: An alteration to dataset version would create a conflict\n - DATASET_INPUT_SUCCESS: The dataset input was successfully added.\n - DATASET_INPUT_DUPLICATE: The dataset input is a duplicate.\nDeprecated: Unused.\n - DATASET_VERSION_EXPORT_SUCCESS: The dataset version export is completed.\n - DATASET_VERSION_EXPORT_PENDING: The dataset version is pending to be exported.\n - DATASET_VERSION_EXPORT_FAILED: An error occurred during the dataset version export.\n - DATASET_VERSION_EXPORT_IN_PROGRESS: The dataset version is currently being exported.\n - DATASET_VERSION_EXPORT_UNEXPECTED_ERROR: An unexpected error occurred during the dataset version export.\n - JOB_QUEUED: Generic Job status codes\n - AUTH_MISSING_IDP_ASSOC: auth issues\n\nTODO: Knowledge graph related 80xxx\n - UPLOAD_IN_PROGRESS: Multipart uploading status codes\n - BILLING_INVALID_INFO: Billing related issues: 69xxx\n - LOG_ENTRIES_INVALID_REQUEST: Logs related issues: 70000;\n - TWILIO_MAX_VERIFICATION_BEGIN_EXCEEDED: Twilio related issues: 71xxx\n - TWILIO_PHONE_NUMBER_BLOCKED: The provided phone number was rejected or blocked by Twilio.\n - INTERNAL_SERVER_ISSUE: Internal issues: 98xxx\n - CONN_UNCATEGORIZED: Uncategorized: 99xxx: move off as soon as known\n - BAD_REQUEST: Deprecated: migrate off to one of the internal issues\n - SERVER_ERROR: Deprecated: migrate off to one of the internal issues" in: query required: false style: form explode: true schema: type: array items: type: string enum: - ZERO - SUCCESS - MIXED_STATUS - FAILURE - TRY_AGAIN - NOT_IMPLEMENTED - MOVED - TEAPOT - ACCEPTED - CONN_ACCOUNT_ISSUES - CONN_TOKEN_INVALID - CONN_CREDENTIALS_INVALID - CONN_EXCEED_HOURLY_LIMIT - CONN_EXCEED_MONTHLY_LIMIT - CONN_THROTTLED - CONN_EXCEEDS_LIMITS - CONN_INSUFFICIENT_SCOPES - CONN_KEY_INVALID - CONN_KEY_NOT_FOUND - CONN_BAD_REQUEST_FORMAT - CONN_DOES_NOT_EXIST - CONN_INVALID_REQUEST - CONN_METHOD_NOT_ALLOWED - CONN_NO_GDPR_CONSENT - CONN_INVALID_RANGE - CONN_AUTH_METHOD_DISABLED - MODEL_TRAINED - MODEL_TRAINING - MODEL_UNTRAINED - MODEL_QUEUED_FOR_TRAINING - MODEL_UPLOADING - MODEL_UPLOADING_FAILED - MODEL_TRAINING_FAILED - MODEL_BUILDING - MODEL_BUILDING_FAILED - MODEL_BUILD_UNEXPECTED_ERROR - MODEL_TRAINING_NO_DATA - MODEL_TRAINING_NO_POSITIVES - MODEL_TRAINING_ONE_VS_N_SINGLE_CLASS - MODEL_TRAINING_TIMED_OUT - MODEL_TRAINING_WAITING_ERROR - MODEL_TRAINING_UNKNOWN_ERROR - MODEL_TRAINING_MSG_REDELIVER - MODEL_TRAINING_INSUFFICIENT_DATA - MODEL_TRAINING_INVALID_PARAMS - MODEL_TRAINING_INVALID_DATA_TOLERANCE_EXCEEDED - MODEL_MODIFY_SUCCESS - MODEL_MODIFY_PENDING - MODEL_MODIFY_FAILED - MODEL_DOES_NOT_EXIST - MODEL_PERMISSION_DENIED - MODEL_INVALID_ARGUMENT - MODEL_INVALID_REQUEST - MODEL_EVALUATED - MODEL_EVALUATING - MODEL_NOT_EVALUATED - MODEL_QUEUED_FOR_EVALUATION - MODEL_EVALUATION_TIMED_OUT - MODEL_EVALUATION_WAITING_ERROR - MODEL_EVALUATION_UNKNOWN_ERROR - MODEL_PREDICTION_FAILED - MODEL_EVALUATION_MSG_REDELIVER - MODEL_EVALUATION_NEED_LABELS - MODEL_EVALUATION_NEED_INPUTS - MODEL_EVALUATION_FAILED - MODEL_DEPLOYMENT_FAILED - MODEL_DEPLOYING - MODEL_QUEUED_FOR_DEPLOYMENT - MODEL_NOT_DEPLOYED - MODEL_BUSY_PLEASE_RETRY - MODEL_LOADING - MODEL_REFERENCE_INVALID_ARGUMENT - MODEL_EXAMPLE_INPUT_INVALID_ARGUMENT - MODEL_EXPORTED - MODEL_EXPORTING - MODEL_EXPORTING_FAILED - MODEL_EXPORT_PENDING - WORKFLOW_NO_MATCHING_INPUT - WORKFLOW_REQUIRE_TRAINED_MODEL - WORKFLOW_DUPLICATE - WORKFLOW_UNSUPPORTED_FORMAT - WORKFLOW_DOES_NOT_EXIST - WORKFLOW_PERMISSION_DENIED - WORKFLOW_INVALID_ARGUMENT - WORKFLOW_INVALID_RECIPE - WORKFLOW_INVALID_TEMPLATE - WORKFLOW_INVALID_GRAPH - WORKFLOW_INTERNAL_FAILURE - WORKFLOW_INVALID_REQUEST - WORKFLOW_MODIFY_SUCCESS - WORKFLOW_MODIFY_PENDING - WORKFLOW_MODIFY_FAILED - WORKFLOW_REINDEX_FAILED - CONCEPT_MODIFY_SUCCESS - CONCEPT_MODIFY_PENDING - CONCEPT_MODIFY_FAILED - ANNOTATION_SUCCESS - ANNOTATION_PENDING - ANNOTATION_FAILED - ANNOTATION_UNKNOWN_STATUS - ANNOTATION_INVALID_ARGUMENT - ANNOTATION_PERMISSION_DENIED - ANNOTATION_AWAITING_REVIEW - ANNOTATION_AWAITING_CONSENSUS_REVIEW - ANNOTATION_REVIEW_DENIED - ANNOTATION_MODIFY_SUCCESS - ANNOTATION_MODIFY_PENDING - ANNOTATION_MODIFY_FAILED - ANNOTATION_TRACK_IDLE - ANNOTATION_TRACK_IN_PROGRESS - ANNOTATION_TRACK_PENDING - ANNOTATION_TRACK_APPROVED - ANNOTATION_TRACK_FAILED - METADATA_INVALID_PATCH_ARGUMENTS - METADATA_PARSING_ISSUE - METADATA_MANIPULATION_ISSUE - TRAINER_JOB_STATE_NONE - TRAINER_JOB_STATE_QUEUED - TRAINER_JOB_STATE_RUNNING - TRAINER_JOB_STATE_COMPLETE - TRAINER_JOB_STATE_ERROR - DATA_DUMP_SUCCESS - DATA_DUMP_PENDING - DATA_DUMP_FAILED - DATA_DUMP_IN_PROGRESS - DATA_DUMP_NO_DATA - DATA_DUMP_UNEXPECTED_ERROR - DATA_DUMP_EXPORT_SUCCESS - DATA_DUMP_EXPORT_PENDING - DATA_DUMP_EXPORT_FAILED - DATA_DUMP_EXPORT_IN_PROGRESS - DATA_DUMP_EXPORT_UNEXPECTED_ERROR - APP_DUPLICATION_SUCCESS - APP_DUPLICATION_FAILED - APP_DUPLICATION_PENDING - APP_DUPLICATION_IN_PROGRESS - APP_DUPLICATION_INVALID_REQUEST - MODULE_DOES_NOT_EXIST - MODULE_PERMISSION_DENIED - MODULE_INVALID_ARGUMENT - MODULE_INVALID_REQUEST - BULK_OPERATION_SUCCESS - BULK_OPERATION_FAILED - BULK_OPERATION_PENDING - BULK_OPERATION_IN_PROGRESS - BULK_OPERATION_INVALID_REQUEST - BULK_OPERATION_CANCELLED - BULK_OPERATION_UNEXPECTED_ERROR - RUNNER_DOES_NOT_EXIST - RUNNER_PERMISSION_DENIED - RUNNER_INVALID_ARGUMENT - RUNNER_INVALID_REQUEST - RUNNER_NEEDS_RETRY - RUNNER_STREAM_START - RUNNER_STREAM_END - RUNNER_ITEM_CANCELLED - RUNNER_PROCESSING_FAILED - RUNNER_SPECIAL_HANDLING_NOT_COMPLETE - NODEPOOL_DOES_NOT_EXIST - NODEPOOL_INVALID_ARGUMENT - NODEPOOL_INVALID_REQUEST - COMPUTE_CLUSTER_DOES_NOT_EXIST - COMPUTE_CLUSTER_INVALID_ARGUMENT - COMPUTE_CLUSTER_INVALID_REQUEST - DEPLOYMENT_DOES_NOT_EXIST - DEPLOYMENT_INVALID_ARGUMENT - DEPLOYMENT_INVALID_REQUEST - DEPLOYMENT_DISABLED - INSTANCE_TYPE_DOES_NOT_EXIST - INSTANCE_TYPE_INVALID_ARGUMENT - INSTANCE_TYPE_INVALID_REQUEST - COMPUTE_PLANE_METRICS_INVALID_REQUEST - PIPELINE_STEP_DOES_NOT_EXIST - PIPELINE_STEP_INVALID_ARGUMENT - PIPELINE_STEP_INVALID_REQUEST - PIPELINE_STEP_UPLOADING - PIPELINE_STEP_UPLOADING_FAILED - PIPELINE_STEP_BUILDING - PIPELINE_STEP_BUILDING_FAILED - PIPELINE_STEP_BUILD_UNEXPECTED_ERROR - PIPELINE_STEP_READY - PIPELINE_STEP_NOT_READY - PIPELINE_DOES_NOT_EXIST - PIPELINE_INVALID_ARGUMENT - PIPELINE_INVALID_REQUEST - ARTIFACT_DOES_NOT_EXIST - ARTIFACT_INVALID_ARGUMENT - ARTIFACT_INVALID_REQUEST - ARTIFACT_VERSION_DOES_NOT_EXIST - ARTIFACT_VERSION_INVALID_ARGUMENT - ARTIFACT_VERSION_INVALID_REQUEST - INPUT_SUCCESS - INPUT_PENDING - INPUT_FAILED - INPUT_IN_PROGRESS - INPUT_DOWNLOAD_SUCCESS - INPUT_DOWNLOAD_PENDING - INPUT_DOWNLOAD_FAILED - INPUT_DOWNLOAD_IN_PROGRESS - INPUT_STATUS_UPDATE_FAILED - INPUT_DELETE_FAILED - INPUT_DUPLICATE - INPUT_UNSUPPORTED_FORMAT - INPUT_DOES_NOT_EXIST - INPUT_PERMISSION_DENIED - INPUT_INVALID_ARGUMENT - INPUT_OVER_LIMIT - INPUT_INVALID_URL - INPUT_MODIFY_SUCCESS - INPUT_MODIFY_PENDING - INPUT_MODIFY_FAILED - INPUT_STORAGE_HOST_FAILED - ALL_INPUT_INVALID_BYTES - INPUT_CLUSTER_SUCCESS - INPUT_CLUSTER_PENDING - INPUT_CLUSTER_FAILED - INPUT_CLUSTER_IN_PROGRESS - INPUT_REINDEX_SUCCESS - INPUT_REINDEX_PENDING - INPUT_REINDEX_FAILED - INPUT_REINDEX_IN_PROGRESS - INPUT_VIDEO_DOWNLOAD_SUCCESS - INPUT_VIDEO_DOWNLOAD_PENDING - INPUT_VIDEO_DOWNLOAD_FAILED - INPUT_VIDEO_DUPLICATE - INPUT_VIDEO_UNSUPPORTED_FORMAT - INPUT_VIDEO_DOES_NOT_EXIST - INPUT_VIDEO_PERMISSION_DENIED - INPUT_VIDEO_INVALID_ARGUMENT - INPUT_VIDEO_OVER_LIMIT - INPUT_VIDEO_INVALID_URL - INPUT_VIDEO_MODIFY_SUCCESS - INPUT_VIDEO_MODIFY_PENDING - INPUT_VIDEO_MODIFY_FAILED - INPUT_VIDEO_STORAGE_HOST_FAILED - ALL_INPUT_VIDEOS_INVALID_BYTES - INPUT_VIDEO_PROCESSING_SUCCESS - INPUT_VIDEO_PROCESSING_PENDING - INPUT_VIDEO_PROCESSING_FAILED - INPUT_VIDEO_STORAGE_INCONSISTENCY - INPUT_VIDEO_STORAGE_FAILURE - INPUT_VIDEO_URL_GENERATION_FAILURE - INPUT_CONNECTION_FAILED - REQUEST_DISABLED_FOR_MAINTENANCE - INPUT_WRITES_DISABLED_FOR_MAINTENANCE - INPUT_INVALID_REQUEST - PREDICT_INVALID_REQUEST - SEARCH_INVALID_REQUEST - CONCEPTS_INVALID_REQUEST - STATS_INVALID_REQUEST - DATABASE_DUPLICATE_KEY - DATABASE_STATEMENT_TIMEOUT - DATABASE_INVALID_ROWS_AFFECTED - DATABASE_DEADLOCK_DETECTED - DATABASE_FAIL_TASK - DATABASE_FAIL_TO_GET_CONNECTIONS - DATABASE_TOO_MANY_CLIENTS - DATABASE_CONSTRAINT_VIOLATED - DATABASE_CANCELED - ASYNC_WORKER_MULTI_ERRORS - RPC_REQUEST_QUEUE_FULL - RPC_SERVER_UNAVAILABLE - RPC_REQUEST_TIMEOUT - RPC_MAX_MESSAGE_SIZE_EXCEEDED - RPC_CANCELED - RPC_UNKNOWN_METHOD - REQUEST_CANCELED_BY_USER - CLUSTER_INTERNAL_FAILURE - EXTERNAL_CONNECTION_ERROR - QUERY_INVALID_SYNTAX - QUEUE_CONN_ERROR - QUEUE_CLOSE_REQUEST_TIMEOUT - QUEUE_CONN_CLOSED - QUEUE_PUBLISH_ACK_TIMEOUT - QUEUE_PUBLISH_ERROR - QUEUE_SUBSCRIPTION_TIMEOUT - QUEUE_SUBSCRIPTION_ERROR - QUEUE_MARSHALLING_FAILED - QUEUE_UNMARSHALLING_FAILED - QUEUE_MAX_MSG_REDELIVERY_EXCEEDED - QUEUE_ACK_FAILURE - SQS_OVERLIMIT - SQS_INVALID_RECEIPT_HANDLE - SQS_UNKNOWN - SEARCH_INTERNAL_FAILURE - SEARCH_PROJECTION_FAILURE - SEARCH_PREDICTION_FAILURE - SEARCH_BY_NOT_FULLY_INDEXED_INPUT - SAVED_SEARCH_MODIFY_FAILED - SEARCH_COUNTS_UNAVAILABLE - EVALUATION_QUEUED - EVALUATION_IN_PROGRESS - EVALUATION_SUCCESS - EVALUATION_FAILED_TO_RETRIEVE_DATA - EVALUATION_INVALID_ARGUMENT - EVALUATION_FAILED - EVALUATION_PENDING - EVALUATION_TIMED_OUT - EVALUATION_UNEXPECTED_ERROR - EVALUATION_MIXED - STRIPE_EVENT_ERROR - STRIPE_UNEXPECTED_ERROR - CACHE_MISS - REDIS_SCRIPT_EXITED_WITH_FAILURE - REDIS_STREAM_ERR - REDIS_NO_CONSUMERS - REDIS_STREAM_BACKOFF - REDIS_CHANNEL_ERR - SIGNUP_EVENT_ERROR - SIGNUP_FLAGGED - FILETYPE_UNSUPPORTED - LOGIN_EVENT_ERROR - SIFT_UNCATEGORIZED_ERROR - USER_FLAGGED - APP_COUNT_INVALID_MESSAGE - APP_COUNT_UPDATE_INCREMENT_FAILED - APP_COUNT_REBUILD_FAILED - APP_COUNT_INTERNAL_FAILURE - MP_DOWNLOAD_ERROR - MP_RESOLVE_DNS_ERROR - MP_DOWNLOAD_MAX_SIZE_EXCEEDED_ERROR - MP_IMAGE_DECODE_ERROR - MP_INVALID_ARGUMENT - MP_IMAGE_PROCESSING_ERROR - DATATIER_CONN_ERROR - USER_CONSENT_FACE - WORKER_MISSING - WORKER_ACTIVE - WORKER_INACTIVE - SSO_IDENTITY_PROVIDER_DOES_NOT_EXIST - TASK_IN_PROGRESS - TASK_DONE - TASK_WONT_DO - TASK_FAILED - TASK_IDLE - TASK_CONFLICT - TASK_NOT_IMPLEMENTED - TASK_MISSING - TASK_PERMISSION_DENIED - TASK_ASSIGNMENT_SUCCESS - TASK_ASSIGNMENT_PENDING - TASK_ASSIGNMENT_AWAITING_REVIEW - TASK_ASSIGNMENT_AWAITING_CONSENSUS_REVIEW - TASK_ASSIGNMENT_REJECTED - TASK_ASSIGNMENT_REVIEW_SUCCESS - TASK_ASSIGNMENT_REVIEW_PENDING - TASK_ASSIGNMENT_REVIEW_DISMISSED - LABEL_ORDER_PENDING - LABEL_ORDER_IN_PROGRESS - LABEL_ORDER_SUCCESS - LABEL_ORDER_CANCELED - LICENSE_ACTIVE - LICENSE_DOES_NOT_EXIST - LICENSE_NEED_UPDATE - LICENSE_EXPIRED - LICENSE_REVOKED - LICENSE_DELETED - LICENSE_VOLUME_EXCEEDED - PASSWORD_VALIDATION_SUCCESS - PASSWORD_VALIDATION_FAILED - PASSWORDPOLICY_INVALID_ARGUMENT - FEATUREFLAG_CONFIG_NOT_FOUND - FEATUREFLAG_INVALID_ARGUMENT - FEATUREFLAG_BLOCKED - FEATUREFLAG_NOT_FOUND - MAINTENANCE_SUCCESS - MAINTENANCE_FAILED - DATASET_VERSION_PENDING - DATASET_VERSION_IN_PROGRESS - DATASET_VERSION_READY - DATASET_VERSION_FAILURE - DATASET_VERSION_UNEXPECTED_ERROR - DATASET_VERSION_CONFLICT - DATASET_INPUT_SUCCESS - DATASET_INPUT_DUPLICATE - DATASET_VERSION_EXPORT_SUCCESS - DATASET_VERSION_EXPORT_PENDING - DATASET_VERSION_EXPORT_FAILED - DATASET_VERSION_EXPORT_IN_PROGRESS - DATASET_VERSION_EXPORT_UNEXPECTED_ERROR - JOB_QUEUED - JOB_RUNNING - JOB_COMPLETED - JOB_FAILED - JOB_CANCELLED - JOB_UNEXPECTED_ERROR - JOB_CONFLICT - JOB_PAUSED - AUTH_MISSING_IDP_ASSOC - LIST_OBJECTS_FAILED - ARCHIVE_EXTRACT_FAILED - UPLOAD_IN_PROGRESS - UPLOAD_DONE - UPLOAD_FAILED - UPLOAD_UNEXPECTED_ERROR - UPLOAD_EXPIRED - UPLOAD_CANCELED - UPLOAD_CONFLICT - BILLING_INVALID_INFO - BILLING_MISSING_TOKENS - LOG_ENTRIES_INVALID_REQUEST - TWILIO_MAX_VERIFICATION_BEGIN_EXCEEDED - TWILIO_MAX_VERIFICATION_CHECK_EXCEEDED - TWILIO_PHONE_NUMBER_BLOCKED - INTERNAL_SERVER_ISSUE - INTERNAL_FETCHING_ISSUE - INTERNAL_DATABASE_ISSUE - INTERNAL_CONTEXT_CANCELED - INTERNAL_UNEXPECTED_TIMEOUT - INTERNAL_UNEXPECTED_V1 - INTERNAL_UNEXPECTED_PANIC - INTERNAL_UNEXPECTED_SPIRE - INTERNAL_REDIS_UNAVAILABLE - INTERNAL_RESOURCE_EXHAUSTED - INTERNAL_REDIS_UNCATEGORIZED - INTERNAL_AWS_UNCATEGORIZED - INTERNAL_AZURE_UNCATEGORIZED - INTERNAL_VECTORDB_UNCATEGORIZED - INTERNAL_ORACLE_UNCATEGORIZED - INTERNAL_VULTR_UNCATEGORIZED - INTERNAL_GCP_UNCATEGORIZED - CONN_UNCATEGORIZED - MODEL_UNCATEGORIZED - INPUT_UNCATEGORIZED - ANNOTATION_UNCATEGORIZED - BILLING_UNCATEGORIZED - INTERNAL_UNCATEGORIZED - BAD_REQUEST - SERVER_ERROR tags: - Users summary: V2 list pipeline step versions x-summary-source: derived delete: operationId: V2_DeletePipelineStepVersions responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/statusBaseResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: user_app_id.app_id in: path required: true schema: type: string - name: pipeline_step_id description: The id of the pipeline step for which versions are being deleted in: path required: true schema: type: string tags: - Users requestBody: content: application/json: schema: $ref: '#/components/schemas/V2DeletePipelineStepVersionsBody' required: true summary: V2 delete pipeline step versions x-summary-source: derived ? /v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/pipeline_steps/{pipeline_step_id}/versions/{pipeline_step_version_id} : get: operationId: V2_GetPipelineStepVersion responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/apiSinglePipelineStepVersionResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: user_app_id.app_id in: path required: true schema: type: string - name: pipeline_step_id description: The id of the pipeline step that has the requested version. in: path required: true schema: type: string - name: pipeline_step_version_id description: Get the identified by this id in: path required: true schema: type: string tags: - Users summary: V2 get pipeline step version x-summary-source: derived ? /v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/pipeline_templates/{pipeline_template_name}/pipeline_version_runs : post: summary: Creates a Pipeline, PipelineVersion, and PipelineVersionRun from a… operationId: V2_PostPipelineVersionRunFromTemplate responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/apiPostPipelineVersionRunFromTemplateResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: user_app_id.app_id in: path required: true schema: type: string - name: pipeline_template_name description: Name of the pipeline template to use (from ListPipelineTemplates) in: path required: true schema: type: string tags: - Users requestBody: content: application/json: schema: $ref: '#/components/schemas/V2PostPipelineVersionRunFromTemplateBody' required: true /v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/pipelines: get: operationId: V2_ListPipelines responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/apiMultiPipelineResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: user_app_id.app_id in: path required: true schema: type: string - name: page description: '(optional URL parameter) The page number. Pagination is used to split the results into chunks. Defaults to 1.' in: query required: false schema: type: integer format: int64 - name: per_page description: '(optional URL parameter) The number of results that will be contained in each page. Defaults to 128.' in: query required: false schema: type: integer format: int64 tags: - Users summary: V2 list pipelines x-summary-source: derived delete: operationId: V2_DeletePipelines responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/statusBaseResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: user_app_id.app_id in: path required: true schema: type: string tags: - Users requestBody: content: application/json: schema: $ref: '#/components/schemas/V2DeletePipelinesBody' required: true summary: V2 delete pipelines x-summary-source: derived post: operationId: V2_PostPipelines responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/apiMultiPipelineResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: user_app_id.app_id in: path required: true schema: type: string tags: - Users requestBody: content: application/json: schema: $ref: '#/components/schemas/V2PostPipelinesBody' required: true summary: V2 post pipelines x-summary-source: derived patch: operationId: V2_PatchPipelines responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/apiMultiPipelineResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: user_app_id.app_id in: path required: true schema: type: string tags: - Users requestBody: content: application/json: schema: $ref: '#/components/schemas/V2PatchPipelinesBody' required: true summary: V2 patch pipelines x-summary-source: derived /v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/pipelines/{pipeline_id}: get: operationId: V2_GetPipeline responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/apiSinglePipelineResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: user_app_id.app_id in: path required: true schema: type: string - name: pipeline_id in: path required: true schema: type: string tags: - Users summary: V2 get pipeline x-summary-source: derived /v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/pipelines/{pipeline_id}/versions: get: operationId: V2_ListPipelineVersions responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/apiMultiPipelineVersionResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: user_app_id.app_id in: path required: true schema: type: string - name: pipeline_id description: List versions for the pipeline identified by this id in: path required: true schema: type: string - name: page description: '(optional URL parameter) The page number. Pagination is used to split the results into chunks. Defaults to 1.' in: query required: false schema: type: integer format: int64 - name: per_page description: '(optional URL parameter) The number of results that will be contained in each page. Defaults to 128.' in: query required: false schema: type: integer format: int64 tags: - Users summary: V2 list pipeline versions x-summary-source: derived delete: operationId: V2_DeletePipelineVersions responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/statusBaseResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: user_app_id.app_id in: path required: true schema: type: string - name: pipeline_id description: The id of the Pipeline for which versions are being deleted in: path required: true schema: type: string tags: - Users requestBody: content: application/json: schema: $ref: '#/components/schemas/V2DeletePipelineVersionsBody' required: true summary: V2 delete pipeline versions x-summary-source: derived patch: operationId: V2_PatchPipelineVersions responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/apiMultiPipelineVersionResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: user_app_id.app_id in: path required: true schema: type: string - name: pipeline_id description: The id of the Pipeline that has the requested versions to patch. in: path required: true schema: type: string tags: - Users requestBody: content: application/json: schema: $ref: '#/components/schemas/V2PatchPipelineVersionsBody' required: true summary: V2 patch pipeline versions x-summary-source: derived /v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/pipelines/{pipeline_id}/versions/{pipeline_version_id}: get: operationId: V2_GetPipelineVersion responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/apiSinglePipelineVersionResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: user_app_id.app_id in: path required: true schema: type: string - name: pipeline_id description: The id of the pipeline that has the requested version. in: path required: true schema: type: string - name: pipeline_version_id description: Get the identified by this id in: path required: true schema: type: string tags: - Users summary: V2 get pipeline version x-summary-source: derived /v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/pipelines/{pipeline_id}/versions/{pipeline_version_id}/runs: get: summary: putting above the Get Nodepool endpoint to make it appear above the other one operationId: V2_ListPipelineVersionRuns responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/apiMultiPipelineVersionRunResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: user_app_id.app_id in: path required: true schema: type: string - name: pipeline_id description: The ID of the pipeline in: path required: true schema: type: string - name: pipeline_version_id description: The ID of the pipeline version in: path required: true schema: type: string - name: page description: '(optional URL parameter) The page number. Pagination is used to split the results into chunks. Defaults to 1.' in: query required: false schema: type: integer format: int64 - name: per_page description: '(optional URL parameter) The number of results that will be contained in each page. Defaults to 128.' in: query required: false schema: type: integer format: int64 - name: status_codes description: "Filter based on status\n\n - ZERO: to be revised and greatly expanded\n - SUCCESS: Generic\n - MOVED: Resource moved. Respond with Http status 307 and add new Location header to response\n - ACCEPTED: Request has been accepted. Respond with Http status 202.\n - CONN_ACCOUNT_ISSUES: Clarifai Connection Codes: 11xxx\n\nexpired cc, still in trial, feature not supported in your tier\n - CONN_TOKEN_INVALID: invalid auth token used. Deprecated: we should return CONN_KEY_INVALID instead now in all cases.\n - CONN_CREDENTIALS_INVALID: invalid auth credentials\n - CONN_EXCEED_HOURLY_LIMIT: throttle hourly limit exceeded\n - CONN_EXCEED_MONTHLY_LIMIT: throttle monthly limit exceeded\n - CONN_THROTTLED: throttler and billing stuff\n - CONN_EXCEEDS_LIMITS: throttler and billing stuff\n - CONN_INSUFFICIENT_SCOPES: api key has insufficient permissions\n - CONN_KEY_INVALID: api key is invalid\n - CONN_KEY_NOT_FOUND: api key not found\n - CONN_BAD_REQUEST_FORMAT: multipart form parsing, broken json, etc\n - CONN_DOES_NOT_EXIST: when path is bad\n - CONN_INVALID_REQUEST: something wrong with a header\n - CONN_METHOD_NOT_ALLOWED: when a request method is not allowed\n - CONN_NO_GDPR_CONSENT: lack GDPR consent\n - CONN_INVALID_RANGE: when invalid range of a resource is requested\n - CONN_AUTH_METHOD_DISABLED: authentication method is disabled\n - MODEL_TRAINED: Model/Custom Training related 20xxx\n\nCustom model has been already trained.\n - MODEL_TRAINING: Custom model is currently training.\n - MODEL_UNTRAINED: Custom model has not yet been trained.\n - MODEL_QUEUED_FOR_TRAINING: Custom model is currently in queue for training, waiting on assets to process first.\n - MODEL_TRAINING_FAILED: generic err msg for any type of model training err.\n - MODEL_BUILDING: For new V3 DockerInternalType models which are built images\n - MODEL_BUILDING_FAILED: Failed to build image for model.\n - MODEL_BUILD_UNEXPECTED_ERROR: Failed to build image for model.\n - MODEL_TRAINING_NO_DATA: Custom model training had no data. FIXME(yang): deprecate this. Use the 21106 + errStatusMsg\n - MODEL_TRAINING_NO_POSITIVES: Custom model training had no positive examples. FIXME(yang): deprecate this. Use the 21106 + errStatusMsg\n - MODEL_TRAINING_ONE_VS_N_SINGLE_CLASS: Custom model training was ONE_VS_N but with a single class. FIXME(yang): deprecate this. Use the 21106 + errStatusMsg\n - MODEL_TRAINING_TIMED_OUT: Training took longer than hard coded timeouts. FIXME(yang): deprecate this. Use the 21106 + errStatusMsg\n - MODEL_TRAINING_WAITING_ERROR: Training got error waiting on asset pipeline to finish. FIXME(yang): deprecate this. Use the 21106 + errStatusMsg\n - MODEL_TRAINING_UNKNOWN_ERROR: Training threw an unknown exception.\n - MODEL_TRAINING_MSG_REDELIVER: Training message was redelivered. FIXME(yang): deprecate this. Use the 21106 + errStatusMsg\n - MODEL_TRAINING_INSUFFICIENT_DATA: Training got error due to insufficient labelled data. FIXME(yang): deprecate this. Use the 21106 + errStatusMsg\n - MODEL_TRAINING_INVALID_PARAMS: FIXME(yang): deprecate this. Use the 21106 + errStatusMsg\n - MODEL_TRAINING_INVALID_DATA_TOLERANCE_EXCEEDED: Training is stopped because too much data was dropped. FIXME(yang): deprecate this. Use the 21106 + errStatusMsg\n - MODEL_EVALUATION_TIMED_OUT: Evaluation took longer than hard coded timeouts. FIXME(yang): deprecate this. Use the 21317 + errStatusMsg\n - MODEL_EVALUATION_WAITING_ERROR: Evaluation got error waiting on asset pipeline to finish.FIXME(yang): deprecate this. Use the 21317 + errStatusMsg\n - MODEL_EVALUATION_UNKNOWN_ERROR: EVALUATION THREW AN UNKNOWN EXCEPTION.\n - MODEL_EVALUATION_MSG_REDELIVER: Eval message was redelivered. FIXME(yang): deprecate this. Use the 21317 + errStatusMsg\n - MODEL_EVALUATION_NEED_LABELS: Don't have enough concepts labelled to perform evaluation. FIXME(yang): deprecate this. Use the 21317 + errStatusMsg\n - MODEL_EVALUATION_NEED_INPUTS: Don't have enough inputs per concept to perform evaluation. FIXME(yang): deprecate this. Use the 21317 + errStatusMsg\n - MODEL_EVALUATION_FAILED: Generic err code for eval failure.\n - MODEL_DEPLOYMENT_FAILED: Used when inference coordinator failed to deploy spire and throws an error\n - MODEL_DEPLOYING: Used when calling the inference coordinator to deploy a spire\n - MODEL_QUEUED_FOR_DEPLOYMENT: Used when training is completed\n - MODEL_NOT_DEPLOYED: Used when model spire deployment is manually taken down or due to inactivity\n - MODEL_LOADING: Used when the model pod is running, but not yet ready to serve requests.\n - MODEL_REFERENCE_INVALID_ARGUMENT: Used when a model reference field is not set properly\n - MODEL_EXAMPLE_INPUT_INVALID_ARGUMENT: Used when a model example input field is not set properly\n - MODEL_EXPORTED: Model Export status codes\n - WORKFLOW_NO_MATCHING_INPUT: specified model input not in workflow\n - WORKFLOW_REQUIRE_TRAINED_MODEL: specified model must be trained\n - WORKFLOW_INVALID_ARGUMENT: error in the request somewhere\n - WORKFLOW_INVALID_REQUEST: error in the request somewhere\n - CONCEPT_MODIFY_SUCCESS: Concept related 23xxx\n - ANNOTATION_SUCCESS: Annotation related 24xxx\n - ANNOTATION_AWAITING_REVIEW: Annotation is awaiting review from task REVIEWERS.\n - ANNOTATION_AWAITING_CONSENSUS_REVIEW: Annotation is awaiting consensus review from task LABELERS.\n - ANNOTATION_TRACK_IDLE: Annotation (video) tracks are groups of annotations per frame\nIDLE -> PROCESSING --> PENDING --> APPROVED --> (DELETED)\nPROCESSING --> FAILED --> (DELETED)\nPROCESSING --> (DELETED)\n - METADATA_INVALID_PATCH_ARGUMENTS: Metadata related 249xx\n - TRAINER_JOB_STATE_NONE: Training service related 25xxx\n - DATA_DUMP_SUCCESS: Data Dump related 251xx\n - DATA_DUMP_NO_DATA: DEPRECATED: Not used anymore. Now for an empty data dump, DATA_DUMP_SUCCESS is returned. To detect an empty data dump, check if the inptus count is 0.\n - APP_DUPLICATION_SUCCESS: Duplicate related 252xx - DEPRECATED: App duplication is no longer supported.\n - MODULE_DOES_NOT_EXIST: Module related codes 253xx\n - BULK_OPERATION_SUCCESS: Bulk Operation related codes 254xx\n - RUNNER_DOES_NOT_EXIST: Runner related codes 256xx\n - NODEPOOL_DOES_NOT_EXIST: Nodepool related codes 257xx\n - COMPUTE_CLUSTER_DOES_NOT_EXIST: ComputeCluster related codes 258xx\n - DEPLOYMENT_DOES_NOT_EXIST: Deployment related codes 259xx\n - DEPLOYMENT_DISABLED: The deployment is disabled and cannot serve traffic.\n - INSTANCE_TYPE_DOES_NOT_EXIST: InstanceType related codes 260xx\n - COMPUTE_PLANE_METRICS_INVALID_REQUEST: Compute plane related codes 261xx\n - PIPELINE_STEP_DOES_NOT_EXIST: PipelineStep related codes 262xx\n - PIPELINE_DOES_NOT_EXIST: Pipeline related codes 263xx\n - ARTIFACT_DOES_NOT_EXIST: Artifact related codes 264xx\n - INPUT_SUCCESS: Input:Image related 30xxx\n - INPUT_PENDING: when things are async, this is the default status.\n - INPUT_FAILED: any type of error downloading and processing\n - INPUT_DOWNLOAD_SUCCESS: use INPUT_SUCCESS, INPUT_PENDING, INPUT_FAILED, INPUT_IN_PROGRESS instead\nDOWNLOAD is no longer correct, but keep old statuses for backward compatibility\n - INPUT_VIDEO_DOWNLOAD_SUCCESS: Input:Video related 31xxx -- Deprecated\n - INPUT_WRITES_DISABLED_FOR_MAINTENANCE: deprecate this one. Use REQUEST_DISABLED_FOR_MAINTENANCE\n - PREDICT_INVALID_REQUEST: API formatting issues 4000x\n - DATABASE_DUPLICATE_KEY: Other related 400xx\n - EXTERNAL_CONNECTION_ERROR: could not connect to external services\n - QUEUE_CONN_ERROR: Queue related errors 41xxx\n - SQS_OVERLIMIT: SQS related errors 411xx\n - SEARCH_INTERNAL_FAILURE: Search related errors 43xxxx\n - EVALUATION_QUEUED: Workflow evaluation err code\n - STRIPE_EVENT_ERROR: Stripe 44xxx\n - CACHE_MISS: Redis/Cache 45xxx\n - SIGNUP_EVENT_ERROR: Sift Science 46xxx\n - APP_COUNT_INVALID_MESSAGE: Application counts related errors 470xx\n - MP_DOWNLOAD_ERROR: Media processor related errors 471xx -- DEPRECATED\n - DATATIER_CONN_ERROR: DataTier related error 472xx\n - USER_CONSENT_FACE: User legal consent stauts related 50xxx\n - WORKER_MISSING: Workers 51xxx\n - SSO_IDENTITY_PROVIDER_DOES_NOT_EXIST: SSO 53xxx\n - TASK_IN_PROGRESS: Tasks 54xxx\nThe task was created.\n - TASK_DONE: The task is completed.\n - TASK_WONT_DO: The task is marked as abandoned.\n - TASK_FAILED: An error occurred during add-task-annotations or add-auto-annotations pipeline.\n - TASK_IDLE: Task is waiting for user action.\nExamples:\n- When an Auto Annotation task job has finished processing its last batch and is waiting for more dataset assets.\n- When an Auto Annotation task job for a video livestream input is waiting for user to create a task deployment.\n - TASK_CONFLICT: The task operation is in conflict with the current state of the server.\n - TASK_NOT_IMPLEMENTED: Certain task-related scenarios are not implemented.\n - TASK_MISSING: Task was not found.\n - TASK_PERMISSION_DENIED: Not allowed to perform a task-related action.\n - TASK_ASSIGNMENT_SUCCESS: Task Assignments 542xx\n - TASK_ASSIGNMENT_REVIEW_SUCCESS: Task Assignment Reviews 543xx\n - LABEL_ORDER_PENDING: Label Order Related Status Code 55xxx\n - LICENSE_ACTIVE: License Related Status Code 600xx\nDEPRECATED: License feature is fully deprecated now.\n - LICENSE_DELETED: hidden state not reflected to users\n - PASSWORD_VALIDATION_SUCCESS: Password Related Status Code\n - FEATUREFLAG_CONFIG_NOT_FOUND: Feature flags status code\n - MAINTENANCE_SUCCESS: Maintenance status code\n - DATASET_VERSION_PENDING: Datasets 64xxx\nThe dataset version is pending to be processed.\n - DATASET_VERSION_IN_PROGRESS: The dataset version is currently being processed.\n - DATASET_VERSION_READY: The dataset version is ready to be used.\n - DATASET_VERSION_FAILURE: An error occurred during the dataset version processing.\n - DATASET_VERSION_UNEXPECTED_ERROR: An unexpected error occurred during the dataset version processing.\n - DATASET_VERSION_CONFLICT: An alteration to dataset version would create a conflict\n - DATASET_INPUT_SUCCESS: The dataset input was successfully added.\n - DATASET_INPUT_DUPLICATE: The dataset input is a duplicate.\nDeprecated: Unused.\n - DATASET_VERSION_EXPORT_SUCCESS: The dataset version export is completed.\n - DATASET_VERSION_EXPORT_PENDING: The dataset version is pending to be exported.\n - DATASET_VERSION_EXPORT_FAILED: An error occurred during the dataset version export.\n - DATASET_VERSION_EXPORT_IN_PROGRESS: The dataset version is currently being exported.\n - DATASET_VERSION_EXPORT_UNEXPECTED_ERROR: An unexpected error occurred during the dataset version export.\n - JOB_QUEUED: Generic Job status codes\n - AUTH_MISSING_IDP_ASSOC: auth issues\n\nTODO: Knowledge graph related 80xxx\n - UPLOAD_IN_PROGRESS: Multipart uploading status codes\n - BILLING_INVALID_INFO: Billing related issues: 69xxx\n - LOG_ENTRIES_INVALID_REQUEST: Logs related issues: 70000;\n - TWILIO_MAX_VERIFICATION_BEGIN_EXCEEDED: Twilio related issues: 71xxx\n - TWILIO_PHONE_NUMBER_BLOCKED: The provided phone number was rejected or blocked by Twilio.\n - INTERNAL_SERVER_ISSUE: Internal issues: 98xxx\n - CONN_UNCATEGORIZED: Uncategorized: 99xxx: move off as soon as known\n - BAD_REQUEST: Deprecated: migrate off to one of the internal issues\n - SERVER_ERROR: Deprecated: migrate off to one of the internal issues" in: query required: false style: form explode: true schema: type: array items: type: string enum: - ZERO - SUCCESS - MIXED_STATUS - FAILURE - TRY_AGAIN - NOT_IMPLEMENTED - MOVED - TEAPOT - ACCEPTED - CONN_ACCOUNT_ISSUES - CONN_TOKEN_INVALID - CONN_CREDENTIALS_INVALID - CONN_EXCEED_HOURLY_LIMIT - CONN_EXCEED_MONTHLY_LIMIT - CONN_THROTTLED - CONN_EXCEEDS_LIMITS - CONN_INSUFFICIENT_SCOPES - CONN_KEY_INVALID - CONN_KEY_NOT_FOUND - CONN_BAD_REQUEST_FORMAT - CONN_DOES_NOT_EXIST - CONN_INVALID_REQUEST - CONN_METHOD_NOT_ALLOWED - CONN_NO_GDPR_CONSENT - CONN_INVALID_RANGE - CONN_AUTH_METHOD_DISABLED - MODEL_TRAINED - MODEL_TRAINING - MODEL_UNTRAINED - MODEL_QUEUED_FOR_TRAINING - MODEL_UPLOADING - MODEL_UPLOADING_FAILED - MODEL_TRAINING_FAILED - MODEL_BUILDING - MODEL_BUILDING_FAILED - MODEL_BUILD_UNEXPECTED_ERROR - MODEL_TRAINING_NO_DATA - MODEL_TRAINING_NO_POSITIVES - MODEL_TRAINING_ONE_VS_N_SINGLE_CLASS - MODEL_TRAINING_TIMED_OUT - MODEL_TRAINING_WAITING_ERROR - MODEL_TRAINING_UNKNOWN_ERROR - MODEL_TRAINING_MSG_REDELIVER - MODEL_TRAINING_INSUFFICIENT_DATA - MODEL_TRAINING_INVALID_PARAMS - MODEL_TRAINING_INVALID_DATA_TOLERANCE_EXCEEDED - MODEL_MODIFY_SUCCESS - MODEL_MODIFY_PENDING - MODEL_MODIFY_FAILED - MODEL_DOES_NOT_EXIST - MODEL_PERMISSION_DENIED - MODEL_INVALID_ARGUMENT - MODEL_INVALID_REQUEST - MODEL_EVALUATED - MODEL_EVALUATING - MODEL_NOT_EVALUATED - MODEL_QUEUED_FOR_EVALUATION - MODEL_EVALUATION_TIMED_OUT - MODEL_EVALUATION_WAITING_ERROR - MODEL_EVALUATION_UNKNOWN_ERROR - MODEL_PREDICTION_FAILED - MODEL_EVALUATION_MSG_REDELIVER - MODEL_EVALUATION_NEED_LABELS - MODEL_EVALUATION_NEED_INPUTS - MODEL_EVALUATION_FAILED - MODEL_DEPLOYMENT_FAILED - MODEL_DEPLOYING - MODEL_QUEUED_FOR_DEPLOYMENT - MODEL_NOT_DEPLOYED - MODEL_BUSY_PLEASE_RETRY - MODEL_LOADING - MODEL_REFERENCE_INVALID_ARGUMENT - MODEL_EXAMPLE_INPUT_INVALID_ARGUMENT - MODEL_EXPORTED - MODEL_EXPORTING - MODEL_EXPORTING_FAILED - MODEL_EXPORT_PENDING - WORKFLOW_NO_MATCHING_INPUT - WORKFLOW_REQUIRE_TRAINED_MODEL - WORKFLOW_DUPLICATE - WORKFLOW_UNSUPPORTED_FORMAT - WORKFLOW_DOES_NOT_EXIST - WORKFLOW_PERMISSION_DENIED - WORKFLOW_INVALID_ARGUMENT - WORKFLOW_INVALID_RECIPE - WORKFLOW_INVALID_TEMPLATE - WORKFLOW_INVALID_GRAPH - WORKFLOW_INTERNAL_FAILURE - WORKFLOW_INVALID_REQUEST - WORKFLOW_MODIFY_SUCCESS - WORKFLOW_MODIFY_PENDING - WORKFLOW_MODIFY_FAILED - WORKFLOW_REINDEX_FAILED - CONCEPT_MODIFY_SUCCESS - CONCEPT_MODIFY_PENDING - CONCEPT_MODIFY_FAILED - ANNOTATION_SUCCESS - ANNOTATION_PENDING - ANNOTATION_FAILED - ANNOTATION_UNKNOWN_STATUS - ANNOTATION_INVALID_ARGUMENT - ANNOTATION_PERMISSION_DENIED - ANNOTATION_AWAITING_REVIEW - ANNOTATION_AWAITING_CONSENSUS_REVIEW - ANNOTATION_REVIEW_DENIED - ANNOTATION_MODIFY_SUCCESS - ANNOTATION_MODIFY_PENDING - ANNOTATION_MODIFY_FAILED - ANNOTATION_TRACK_IDLE - ANNOTATION_TRACK_IN_PROGRESS - ANNOTATION_TRACK_PENDING - ANNOTATION_TRACK_APPROVED - ANNOTATION_TRACK_FAILED - METADATA_INVALID_PATCH_ARGUMENTS - METADATA_PARSING_ISSUE - METADATA_MANIPULATION_ISSUE - TRAINER_JOB_STATE_NONE - TRAINER_JOB_STATE_QUEUED - TRAINER_JOB_STATE_RUNNING - TRAINER_JOB_STATE_COMPLETE - TRAINER_JOB_STATE_ERROR - DATA_DUMP_SUCCESS - DATA_DUMP_PENDING - DATA_DUMP_FAILED - DATA_DUMP_IN_PROGRESS - DATA_DUMP_NO_DATA - DATA_DUMP_UNEXPECTED_ERROR - DATA_DUMP_EXPORT_SUCCESS - DATA_DUMP_EXPORT_PENDING - DATA_DUMP_EXPORT_FAILED - DATA_DUMP_EXPORT_IN_PROGRESS - DATA_DUMP_EXPORT_UNEXPECTED_ERROR - APP_DUPLICATION_SUCCESS - APP_DUPLICATION_FAILED - APP_DUPLICATION_PENDING - APP_DUPLICATION_IN_PROGRESS - APP_DUPLICATION_INVALID_REQUEST - MODULE_DOES_NOT_EXIST - MODULE_PERMISSION_DENIED - MODULE_INVALID_ARGUMENT - MODULE_INVALID_REQUEST - BULK_OPERATION_SUCCESS - BULK_OPERATION_FAILED - BULK_OPERATION_PENDING - BULK_OPERATION_IN_PROGRESS - BULK_OPERATION_INVALID_REQUEST - BULK_OPERATION_CANCELLED - BULK_OPERATION_UNEXPECTED_ERROR - RUNNER_DOES_NOT_EXIST - RUNNER_PERMISSION_DENIED - RUNNER_INVALID_ARGUMENT - RUNNER_INVALID_REQUEST - RUNNER_NEEDS_RETRY - RUNNER_STREAM_START - RUNNER_STREAM_END - RUNNER_ITEM_CANCELLED - RUNNER_PROCESSING_FAILED - RUNNER_SPECIAL_HANDLING_NOT_COMPLETE - NODEPOOL_DOES_NOT_EXIST - NODEPOOL_INVALID_ARGUMENT - NODEPOOL_INVALID_REQUEST - COMPUTE_CLUSTER_DOES_NOT_EXIST - COMPUTE_CLUSTER_INVALID_ARGUMENT - COMPUTE_CLUSTER_INVALID_REQUEST - DEPLOYMENT_DOES_NOT_EXIST - DEPLOYMENT_INVALID_ARGUMENT - DEPLOYMENT_INVALID_REQUEST - DEPLOYMENT_DISABLED - INSTANCE_TYPE_DOES_NOT_EXIST - INSTANCE_TYPE_INVALID_ARGUMENT - INSTANCE_TYPE_INVALID_REQUEST - COMPUTE_PLANE_METRICS_INVALID_REQUEST - PIPELINE_STEP_DOES_NOT_EXIST - PIPELINE_STEP_INVALID_ARGUMENT - PIPELINE_STEP_INVALID_REQUEST - PIPELINE_STEP_UPLOADING - PIPELINE_STEP_UPLOADING_FAILED - PIPELINE_STEP_BUILDING - PIPELINE_STEP_BUILDING_FAILED - PIPELINE_STEP_BUILD_UNEXPECTED_ERROR - PIPELINE_STEP_READY - PIPELINE_STEP_NOT_READY - PIPELINE_DOES_NOT_EXIST - PIPELINE_INVALID_ARGUMENT - PIPELINE_INVALID_REQUEST - ARTIFACT_DOES_NOT_EXIST - ARTIFACT_INVALID_ARGUMENT - ARTIFACT_INVALID_REQUEST - ARTIFACT_VERSION_DOES_NOT_EXIST - ARTIFACT_VERSION_INVALID_ARGUMENT - ARTIFACT_VERSION_INVALID_REQUEST - INPUT_SUCCESS - INPUT_PENDING - INPUT_FAILED - INPUT_IN_PROGRESS - INPUT_DOWNLOAD_SUCCESS - INPUT_DOWNLOAD_PENDING - INPUT_DOWNLOAD_FAILED - INPUT_DOWNLOAD_IN_PROGRESS - INPUT_STATUS_UPDATE_FAILED - INPUT_DELETE_FAILED - INPUT_DUPLICATE - INPUT_UNSUPPORTED_FORMAT - INPUT_DOES_NOT_EXIST - INPUT_PERMISSION_DENIED - INPUT_INVALID_ARGUMENT - INPUT_OVER_LIMIT - INPUT_INVALID_URL - INPUT_MODIFY_SUCCESS - INPUT_MODIFY_PENDING - INPUT_MODIFY_FAILED - INPUT_STORAGE_HOST_FAILED - ALL_INPUT_INVALID_BYTES - INPUT_CLUSTER_SUCCESS - INPUT_CLUSTER_PENDING - INPUT_CLUSTER_FAILED - INPUT_CLUSTER_IN_PROGRESS - INPUT_REINDEX_SUCCESS - INPUT_REINDEX_PENDING - INPUT_REINDEX_FAILED - INPUT_REINDEX_IN_PROGRESS - INPUT_VIDEO_DOWNLOAD_SUCCESS - INPUT_VIDEO_DOWNLOAD_PENDING - INPUT_VIDEO_DOWNLOAD_FAILED - INPUT_VIDEO_DUPLICATE - INPUT_VIDEO_UNSUPPORTED_FORMAT - INPUT_VIDEO_DOES_NOT_EXIST - INPUT_VIDEO_PERMISSION_DENIED - INPUT_VIDEO_INVALID_ARGUMENT - INPUT_VIDEO_OVER_LIMIT - INPUT_VIDEO_INVALID_URL - INPUT_VIDEO_MODIFY_SUCCESS - INPUT_VIDEO_MODIFY_PENDING - INPUT_VIDEO_MODIFY_FAILED - INPUT_VIDEO_STORAGE_HOST_FAILED - ALL_INPUT_VIDEOS_INVALID_BYTES - INPUT_VIDEO_PROCESSING_SUCCESS - INPUT_VIDEO_PROCESSING_PENDING - INPUT_VIDEO_PROCESSING_FAILED - INPUT_VIDEO_STORAGE_INCONSISTENCY - INPUT_VIDEO_STORAGE_FAILURE - INPUT_VIDEO_URL_GENERATION_FAILURE - INPUT_CONNECTION_FAILED - REQUEST_DISABLED_FOR_MAINTENANCE - INPUT_WRITES_DISABLED_FOR_MAINTENANCE - INPUT_INVALID_REQUEST - PREDICT_INVALID_REQUEST - SEARCH_INVALID_REQUEST - CONCEPTS_INVALID_REQUEST - STATS_INVALID_REQUEST - DATABASE_DUPLICATE_KEY - DATABASE_STATEMENT_TIMEOUT - DATABASE_INVALID_ROWS_AFFECTED - DATABASE_DEADLOCK_DETECTED - DATABASE_FAIL_TASK - DATABASE_FAIL_TO_GET_CONNECTIONS - DATABASE_TOO_MANY_CLIENTS - DATABASE_CONSTRAINT_VIOLATED - DATABASE_CANCELED - ASYNC_WORKER_MULTI_ERRORS - RPC_REQUEST_QUEUE_FULL - RPC_SERVER_UNAVAILABLE - RPC_REQUEST_TIMEOUT - RPC_MAX_MESSAGE_SIZE_EXCEEDED - RPC_CANCELED - RPC_UNKNOWN_METHOD - REQUEST_CANCELED_BY_USER - CLUSTER_INTERNAL_FAILURE - EXTERNAL_CONNECTION_ERROR - QUERY_INVALID_SYNTAX - QUEUE_CONN_ERROR - QUEUE_CLOSE_REQUEST_TIMEOUT - QUEUE_CONN_CLOSED - QUEUE_PUBLISH_ACK_TIMEOUT - QUEUE_PUBLISH_ERROR - QUEUE_SUBSCRIPTION_TIMEOUT - QUEUE_SUBSCRIPTION_ERROR - QUEUE_MARSHALLING_FAILED - QUEUE_UNMARSHALLING_FAILED - QUEUE_MAX_MSG_REDELIVERY_EXCEEDED - QUEUE_ACK_FAILURE - SQS_OVERLIMIT - SQS_INVALID_RECEIPT_HANDLE - SQS_UNKNOWN - SEARCH_INTERNAL_FAILURE - SEARCH_PROJECTION_FAILURE - SEARCH_PREDICTION_FAILURE - SEARCH_BY_NOT_FULLY_INDEXED_INPUT - SAVED_SEARCH_MODIFY_FAILED - SEARCH_COUNTS_UNAVAILABLE - EVALUATION_QUEUED - EVALUATION_IN_PROGRESS - EVALUATION_SUCCESS - EVALUATION_FAILED_TO_RETRIEVE_DATA - EVALUATION_INVALID_ARGUMENT - EVALUATION_FAILED - EVALUATION_PENDING - EVALUATION_TIMED_OUT - EVALUATION_UNEXPECTED_ERROR - EVALUATION_MIXED - STRIPE_EVENT_ERROR - STRIPE_UNEXPECTED_ERROR - CACHE_MISS - REDIS_SCRIPT_EXITED_WITH_FAILURE - REDIS_STREAM_ERR - REDIS_NO_CONSUMERS - REDIS_STREAM_BACKOFF - REDIS_CHANNEL_ERR - SIGNUP_EVENT_ERROR - SIGNUP_FLAGGED - FILETYPE_UNSUPPORTED - LOGIN_EVENT_ERROR - SIFT_UNCATEGORIZED_ERROR - USER_FLAGGED - APP_COUNT_INVALID_MESSAGE - APP_COUNT_UPDATE_INCREMENT_FAILED - APP_COUNT_REBUILD_FAILED - APP_COUNT_INTERNAL_FAILURE - MP_DOWNLOAD_ERROR - MP_RESOLVE_DNS_ERROR - MP_DOWNLOAD_MAX_SIZE_EXCEEDED_ERROR - MP_IMAGE_DECODE_ERROR - MP_INVALID_ARGUMENT - MP_IMAGE_PROCESSING_ERROR - DATATIER_CONN_ERROR - USER_CONSENT_FACE - WORKER_MISSING - WORKER_ACTIVE - WORKER_INACTIVE - SSO_IDENTITY_PROVIDER_DOES_NOT_EXIST - TASK_IN_PROGRESS - TASK_DONE - TASK_WONT_DO - TASK_FAILED - TASK_IDLE - TASK_CONFLICT - TASK_NOT_IMPLEMENTED - TASK_MISSING - TASK_PERMISSION_DENIED - TASK_ASSIGNMENT_SUCCESS - TASK_ASSIGNMENT_PENDING - TASK_ASSIGNMENT_AWAITING_REVIEW - TASK_ASSIGNMENT_AWAITING_CONSENSUS_REVIEW - TASK_ASSIGNMENT_REJECTED - TASK_ASSIGNMENT_REVIEW_SUCCESS - TASK_ASSIGNMENT_REVIEW_PENDING - TASK_ASSIGNMENT_REVIEW_DISMISSED - LABEL_ORDER_PENDING - LABEL_ORDER_IN_PROGRESS - LABEL_ORDER_SUCCESS - LABEL_ORDER_CANCELED - LICENSE_ACTIVE - LICENSE_DOES_NOT_EXIST - LICENSE_NEED_UPDATE - LICENSE_EXPIRED - LICENSE_REVOKED - LICENSE_DELETED - LICENSE_VOLUME_EXCEEDED - PASSWORD_VALIDATION_SUCCESS - PASSWORD_VALIDATION_FAILED - PASSWORDPOLICY_INVALID_ARGUMENT - FEATUREFLAG_CONFIG_NOT_FOUND - FEATUREFLAG_INVALID_ARGUMENT - FEATUREFLAG_BLOCKED - FEATUREFLAG_NOT_FOUND - MAINTENANCE_SUCCESS - MAINTENANCE_FAILED - DATASET_VERSION_PENDING - DATASET_VERSION_IN_PROGRESS - DATASET_VERSION_READY - DATASET_VERSION_FAILURE - DATASET_VERSION_UNEXPECTED_ERROR - DATASET_VERSION_CONFLICT - DATASET_INPUT_SUCCESS - DATASET_INPUT_DUPLICATE - DATASET_VERSION_EXPORT_SUCCESS - DATASET_VERSION_EXPORT_PENDING - DATASET_VERSION_EXPORT_FAILED - DATASET_VERSION_EXPORT_IN_PROGRESS - DATASET_VERSION_EXPORT_UNEXPECTED_ERROR - JOB_QUEUED - JOB_RUNNING - JOB_COMPLETED - JOB_FAILED - JOB_CANCELLED - JOB_UNEXPECTED_ERROR - JOB_CONFLICT - JOB_PAUSED - AUTH_MISSING_IDP_ASSOC - LIST_OBJECTS_FAILED - ARCHIVE_EXTRACT_FAILED - UPLOAD_IN_PROGRESS - UPLOAD_DONE - UPLOAD_FAILED - UPLOAD_UNEXPECTED_ERROR - UPLOAD_EXPIRED - UPLOAD_CANCELED - UPLOAD_CONFLICT - BILLING_INVALID_INFO - BILLING_MISSING_TOKENS - LOG_ENTRIES_INVALID_REQUEST - TWILIO_MAX_VERIFICATION_BEGIN_EXCEEDED - TWILIO_MAX_VERIFICATION_CHECK_EXCEEDED - TWILIO_PHONE_NUMBER_BLOCKED - INTERNAL_SERVER_ISSUE - INTERNAL_FETCHING_ISSUE - INTERNAL_DATABASE_ISSUE - INTERNAL_CONTEXT_CANCELED - INTERNAL_UNEXPECTED_TIMEOUT - INTERNAL_UNEXPECTED_V1 - INTERNAL_UNEXPECTED_PANIC - INTERNAL_UNEXPECTED_SPIRE - INTERNAL_REDIS_UNAVAILABLE - INTERNAL_RESOURCE_EXHAUSTED - INTERNAL_REDIS_UNCATEGORIZED - INTERNAL_AWS_UNCATEGORIZED - INTERNAL_AZURE_UNCATEGORIZED - INTERNAL_VECTORDB_UNCATEGORIZED - INTERNAL_ORACLE_UNCATEGORIZED - INTERNAL_VULTR_UNCATEGORIZED - INTERNAL_GCP_UNCATEGORIZED - CONN_UNCATEGORIZED - MODEL_UNCATEGORIZED - INPUT_UNCATEGORIZED - ANNOTATION_UNCATEGORIZED - BILLING_UNCATEGORIZED - INTERNAL_UNCATEGORIZED - BAD_REQUEST - SERVER_ERROR - name: compute_cluster_id description: compute cluster id in: query required: false schema: type: string - name: nodepool_id description: nodepool id in: query required: false schema: type: string tags: - Users post: operationId: V2_PostPipelineVersionRuns responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/apiMultiPipelineVersionRunResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: user_app_id.app_id in: path required: true schema: type: string - name: pipeline_id description: The ID of the pipeline in: path required: true schema: type: string - name: pipeline_version_id description: The ID of the pipeline-version in: path required: true schema: type: string tags: - Users requestBody: content: application/json: schema: $ref: '#/components/schemas/V2PostPipelineVersionRunsBody' required: true summary: V2 post pipeline version runs x-summary-source: derived patch: operationId: V2_PatchPipelineVersionRuns responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/apiMultiPipelineVersionRunResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: user_app_id.app_id in: path required: true schema: type: string - name: pipeline_id description: The ID of the pipeline in: path required: true schema: type: string - name: pipeline_version_id description: The ID of the pipeline-version in: path required: true schema: type: string tags: - Users requestBody: content: application/json: schema: $ref: '#/components/schemas/V2PatchPipelineVersionRunsBody' required: true summary: V2 patch pipeline version runs x-summary-source: derived ? /v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/pipelines/{pipeline_id}/versions/{pipeline_version_id}/runs/{pipeline_version_run_id} : get: operationId: V2_GetPipelineVersionRun responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/apiSinglePipelineVersionRunResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: user_app_id.app_id in: path required: true schema: type: string - name: pipeline_id description: the ID of the pipeline in: path required: true schema: type: string - name: pipeline_version_id description: The ID of the pipeline version in: path required: true schema: type: string - name: pipeline_version_run_id description: the ID of the pipeline version run in: path required: true schema: type: string tags: - Users summary: V2 get pipeline version run x-summary-source: derived ? /v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/pipelines/{pipeline_id}/versions/{pipeline_version_id}/runs/{pipeline_version_run_id}/status_logs : get: operationId: V2_ListPipelineVersionRunStatusLogs responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/apiMultiPipelineVersionRunStatusLogResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: user_app_id.app_id in: path required: true schema: type: string - name: pipeline_id description: Pipeline ID in: path required: true schema: type: string - name: pipeline_version_id description: Pipeline Version ID in: path required: true schema: type: string - name: pipeline_version_run_id description: Pipeline Version Run ID in: path required: true schema: type: string - name: status_codes description: "Status codes to filter by (optional)\n\n - ZERO: to be revised and greatly expanded\n - SUCCESS: Generic\n - MOVED: Resource moved. Respond with Http status 307 and add new Location header to response\n - ACCEPTED: Request has been accepted. Respond with Http status 202.\n - CONN_ACCOUNT_ISSUES: Clarifai Connection Codes: 11xxx\n\nexpired cc, still in trial, feature not supported in your tier\n - CONN_TOKEN_INVALID: invalid auth token used. Deprecated: we should return CONN_KEY_INVALID instead now in all cases.\n - CONN_CREDENTIALS_INVALID: invalid auth credentials\n - CONN_EXCEED_HOURLY_LIMIT: throttle hourly limit exceeded\n - CONN_EXCEED_MONTHLY_LIMIT: throttle monthly limit exceeded\n - CONN_THROTTLED: throttler and billing stuff\n - CONN_EXCEEDS_LIMITS: throttler and billing stuff\n - CONN_INSUFFICIENT_SCOPES: api key has insufficient permissions\n - CONN_KEY_INVALID: api key is invalid\n - CONN_KEY_NOT_FOUND: api key not found\n - CONN_BAD_REQUEST_FORMAT: multipart form parsing, broken json, etc\n - CONN_DOES_NOT_EXIST: when path is bad\n - CONN_INVALID_REQUEST: something wrong with a header\n - CONN_METHOD_NOT_ALLOWED: when a request method is not allowed\n - CONN_NO_GDPR_CONSENT: lack GDPR consent\n - CONN_INVALID_RANGE: when invalid range of a resource is requested\n - CONN_AUTH_METHOD_DISABLED: authentication method is disabled\n - MODEL_TRAINED: Model/Custom Training related 20xxx\n\nCustom model has been already trained.\n - MODEL_TRAINING: Custom model is currently training.\n - MODEL_UNTRAINED: Custom model has not yet been trained.\n - MODEL_QUEUED_FOR_TRAINING: Custom model is currently in queue for training, waiting on assets to process first.\n - MODEL_TRAINING_FAILED: generic err msg for any type of model training err.\n - MODEL_BUILDING: For new V3 DockerInternalType models which are built images\n - MODEL_BUILDING_FAILED: Failed to build image for model.\n - MODEL_BUILD_UNEXPECTED_ERROR: Failed to build image for model.\n - MODEL_TRAINING_NO_DATA: Custom model training had no data. FIXME(yang): deprecate this. Use the 21106 + errStatusMsg\n - MODEL_TRAINING_NO_POSITIVES: Custom model training had no positive examples. FIXME(yang): deprecate this. Use the 21106 + errStatusMsg\n - MODEL_TRAINING_ONE_VS_N_SINGLE_CLASS: Custom model training was ONE_VS_N but with a single class. FIXME(yang): deprecate this. Use the 21106 + errStatusMsg\n - MODEL_TRAINING_TIMED_OUT: Training took longer than hard coded timeouts. FIXME(yang): deprecate this. Use the 21106 + errStatusMsg\n - MODEL_TRAINING_WAITING_ERROR: Training got error waiting on asset pipeline to finish. FIXME(yang): deprecate this. Use the 21106 + errStatusMsg\n - MODEL_TRAINING_UNKNOWN_ERROR: Training threw an unknown exception.\n - MODEL_TRAINING_MSG_REDELIVER: Training message was redelivered. FIXME(yang): deprecate this. Use the 21106 + errStatusMsg\n - MODEL_TRAINING_INSUFFICIENT_DATA: Training got error due to insufficient labelled data. FIXME(yang): deprecate this. Use the 21106 + errStatusMsg\n - MODEL_TRAINING_INVALID_PARAMS: FIXME(yang): deprecate this. Use the 21106 + errStatusMsg\n - MODEL_TRAINING_INVALID_DATA_TOLERANCE_EXCEEDED: Training is stopped because too much data was dropped. FIXME(yang): deprecate this. Use the 21106 + errStatusMsg\n - MODEL_EVALUATION_TIMED_OUT: Evaluation took longer than hard coded timeouts. FIXME(yang): deprecate this. Use the 21317 + errStatusMsg\n - MODEL_EVALUATION_WAITING_ERROR: Evaluation got error waiting on asset pipeline to finish.FIXME(yang): deprecate this. Use the 21317 + errStatusMsg\n - MODEL_EVALUATION_UNKNOWN_ERROR: EVALUATION THREW AN UNKNOWN EXCEPTION.\n - MODEL_EVALUATION_MSG_REDELIVER: Eval message was redelivered. FIXME(yang): deprecate this. Use the 21317 + errStatusMsg\n - MODEL_EVALUATION_NEED_LABELS: Don't have enough concepts labelled to perform evaluation. FIXME(yang): deprecate this. Use the 21317 + errStatusMsg\n - MODEL_EVALUATION_NEED_INPUTS: Don't have enough inputs per concept to perform evaluation. FIXME(yang): deprecate this. Use the 21317 + errStatusMsg\n - MODEL_EVALUATION_FAILED: Generic err code for eval failure.\n - MODEL_DEPLOYMENT_FAILED: Used when inference coordinator failed to deploy spire and throws an error\n - MODEL_DEPLOYING: Used when calling the inference coordinator to deploy a spire\n - MODEL_QUEUED_FOR_DEPLOYMENT: Used when training is completed\n - MODEL_NOT_DEPLOYED: Used when model spire deployment is manually taken down or due to inactivity\n - MODEL_LOADING: Used when the model pod is running, but not yet ready to serve requests.\n - MODEL_REFERENCE_INVALID_ARGUMENT: Used when a model reference field is not set properly\n - MODEL_EXAMPLE_INPUT_INVALID_ARGUMENT: Used when a model example input field is not set properly\n - MODEL_EXPORTED: Model Export status codes\n - WORKFLOW_NO_MATCHING_INPUT: specified model input not in workflow\n - WORKFLOW_REQUIRE_TRAINED_MODEL: specified model must be trained\n - WORKFLOW_INVALID_ARGUMENT: error in the request somewhere\n - WORKFLOW_INVALID_REQUEST: error in the request somewhere\n - CONCEPT_MODIFY_SUCCESS: Concept related 23xxx\n - ANNOTATION_SUCCESS: Annotation related 24xxx\n - ANNOTATION_AWAITING_REVIEW: Annotation is awaiting review from task REVIEWERS.\n - ANNOTATION_AWAITING_CONSENSUS_REVIEW: Annotation is awaiting consensus review from task LABELERS.\n - ANNOTATION_TRACK_IDLE: Annotation (video) tracks are groups of annotations per frame\nIDLE -> PROCESSING --> PENDING --> APPROVED --> (DELETED)\nPROCESSING --> FAILED --> (DELETED)\nPROCESSING --> (DELETED)\n - METADATA_INVALID_PATCH_ARGUMENTS: Metadata related 249xx\n - TRAINER_JOB_STATE_NONE: Training service related 25xxx\n - DATA_DUMP_SUCCESS: Data Dump related 251xx\n - DATA_DUMP_NO_DATA: DEPRECATED: Not used anymore. Now for an empty data dump, DATA_DUMP_SUCCESS is returned. To detect an empty data dump, check if the inptus count is 0.\n - APP_DUPLICATION_SUCCESS: Duplicate related 252xx - DEPRECATED: App duplication is no longer supported.\n - MODULE_DOES_NOT_EXIST: Module related codes 253xx\n - BULK_OPERATION_SUCCESS: Bulk Operation related codes 254xx\n - RUNNER_DOES_NOT_EXIST: Runner related codes 256xx\n - NODEPOOL_DOES_NOT_EXIST: Nodepool related codes 257xx\n - COMPUTE_CLUSTER_DOES_NOT_EXIST: ComputeCluster related codes 258xx\n - DEPLOYMENT_DOES_NOT_EXIST: Deployment related codes 259xx\n - DEPLOYMENT_DISABLED: The deployment is disabled and cannot serve traffic.\n - INSTANCE_TYPE_DOES_NOT_EXIST: InstanceType related codes 260xx\n - COMPUTE_PLANE_METRICS_INVALID_REQUEST: Compute plane related codes 261xx\n - PIPELINE_STEP_DOES_NOT_EXIST: PipelineStep related codes 262xx\n - PIPELINE_DOES_NOT_EXIST: Pipeline related codes 263xx\n - ARTIFACT_DOES_NOT_EXIST: Artifact related codes 264xx\n - INPUT_SUCCESS: Input:Image related 30xxx\n - INPUT_PENDING: when things are async, this is the default status.\n - INPUT_FAILED: any type of error downloading and processing\n - INPUT_DOWNLOAD_SUCCESS: use INPUT_SUCCESS, INPUT_PENDING, INPUT_FAILED, INPUT_IN_PROGRESS instead\nDOWNLOAD is no longer correct, but keep old statuses for backward compatibility\n - INPUT_VIDEO_DOWNLOAD_SUCCESS: Input:Video related 31xxx -- Deprecated\n - INPUT_WRITES_DISABLED_FOR_MAINTENANCE: deprecate this one. Use REQUEST_DISABLED_FOR_MAINTENANCE\n - PREDICT_INVALID_REQUEST: API formatting issues 4000x\n - DATABASE_DUPLICATE_KEY: Other related 400xx\n - EXTERNAL_CONNECTION_ERROR: could not connect to external services\n - QUEUE_CONN_ERROR: Queue related errors 41xxx\n - SQS_OVERLIMIT: SQS related errors 411xx\n - SEARCH_INTERNAL_FAILURE: Search related errors 43xxxx\n - EVALUATION_QUEUED: Workflow evaluation err code\n - STRIPE_EVENT_ERROR: Stripe 44xxx\n - CACHE_MISS: Redis/Cache 45xxx\n - SIGNUP_EVENT_ERROR: Sift Science 46xxx\n - APP_COUNT_INVALID_MESSAGE: Application counts related errors 470xx\n - MP_DOWNLOAD_ERROR: Media processor related errors 471xx -- DEPRECATED\n - DATATIER_CONN_ERROR: DataTier related error 472xx\n - USER_CONSENT_FACE: User legal consent stauts related 50xxx\n - WORKER_MISSING: Workers 51xxx\n - SSO_IDENTITY_PROVIDER_DOES_NOT_EXIST: SSO 53xxx\n - TASK_IN_PROGRESS: Tasks 54xxx\nThe task was created.\n - TASK_DONE: The task is completed.\n - TASK_WONT_DO: The task is marked as abandoned.\n - TASK_FAILED: An error occurred during add-task-annotations or add-auto-annotations pipeline.\n - TASK_IDLE: Task is waiting for user action.\nExamples:\n- When an Auto Annotation task job has finished processing its last batch and is waiting for more dataset assets.\n- When an Auto Annotation task job for a video livestream input is waiting for user to create a task deployment.\n - TASK_CONFLICT: The task operation is in conflict with the current state of the server.\n - TASK_NOT_IMPLEMENTED: Certain task-related scenarios are not implemented.\n - TASK_MISSING: Task was not found.\n - TASK_PERMISSION_DENIED: Not allowed to perform a task-related action.\n - TASK_ASSIGNMENT_SUCCESS: Task Assignments 542xx\n - TASK_ASSIGNMENT_REVIEW_SUCCESS: Task Assignment Reviews 543xx\n - LABEL_ORDER_PENDING: Label Order Related Status Code 55xxx\n - LICENSE_ACTIVE: License Related Status Code 600xx\nDEPRECATED: License feature is fully deprecated now.\n - LICENSE_DELETED: hidden state not reflected to users\n - PASSWORD_VALIDATION_SUCCESS: Password Related Status Code\n - FEATUREFLAG_CONFIG_NOT_FOUND: Feature flags status code\n - MAINTENANCE_SUCCESS: Maintenance status code\n - DATASET_VERSION_PENDING: Datasets 64xxx\nThe dataset version is pending to be processed.\n - DATASET_VERSION_IN_PROGRESS: The dataset version is currently being processed.\n - DATASET_VERSION_READY: The dataset version is ready to be used.\n - DATASET_VERSION_FAILURE: An error occurred during the dataset version processing.\n - DATASET_VERSION_UNEXPECTED_ERROR: An unexpected error occurred during the dataset version processing.\n - DATASET_VERSION_CONFLICT: An alteration to dataset version would create a conflict\n - DATASET_INPUT_SUCCESS: The dataset input was successfully added.\n - DATASET_INPUT_DUPLICATE: The dataset input is a duplicate.\nDeprecated: Unused.\n - DATASET_VERSION_EXPORT_SUCCESS: The dataset version export is completed.\n - DATASET_VERSION_EXPORT_PENDING: The dataset version is pending to be exported.\n - DATASET_VERSION_EXPORT_FAILED: An error occurred during the dataset version export.\n - DATASET_VERSION_EXPORT_IN_PROGRESS: The dataset version is currently being exported.\n - DATASET_VERSION_EXPORT_UNEXPECTED_ERROR: An unexpected error occurred during the dataset version export.\n - JOB_QUEUED: Generic Job status codes\n - AUTH_MISSING_IDP_ASSOC: auth issues\n\nTODO: Knowledge graph related 80xxx\n - UPLOAD_IN_PROGRESS: Multipart uploading status codes\n - BILLING_INVALID_INFO: Billing related issues: 69xxx\n - LOG_ENTRIES_INVALID_REQUEST: Logs related issues: 70000;\n - TWILIO_MAX_VERIFICATION_BEGIN_EXCEEDED: Twilio related issues: 71xxx\n - TWILIO_PHONE_NUMBER_BLOCKED: The provided phone number was rejected or blocked by Twilio.\n - INTERNAL_SERVER_ISSUE: Internal issues: 98xxx\n - CONN_UNCATEGORIZED: Uncategorized: 99xxx: move off as soon as known\n - BAD_REQUEST: Deprecated: migrate off to one of the internal issues\n - SERVER_ERROR: Deprecated: migrate off to one of the internal issues" in: query required: false style: form explode: true schema: type: array items: type: string enum: - ZERO - SUCCESS - MIXED_STATUS - FAILURE - TRY_AGAIN - NOT_IMPLEMENTED - MOVED - TEAPOT - ACCEPTED - CONN_ACCOUNT_ISSUES - CONN_TOKEN_INVALID - CONN_CREDENTIALS_INVALID - CONN_EXCEED_HOURLY_LIMIT - CONN_EXCEED_MONTHLY_LIMIT - CONN_THROTTLED - CONN_EXCEEDS_LIMITS - CONN_INSUFFICIENT_SCOPES - CONN_KEY_INVALID - CONN_KEY_NOT_FOUND - CONN_BAD_REQUEST_FORMAT - CONN_DOES_NOT_EXIST - CONN_INVALID_REQUEST - CONN_METHOD_NOT_ALLOWED - CONN_NO_GDPR_CONSENT - CONN_INVALID_RANGE - CONN_AUTH_METHOD_DISABLED - MODEL_TRAINED - MODEL_TRAINING - MODEL_UNTRAINED - MODEL_QUEUED_FOR_TRAINING - MODEL_UPLOADING - MODEL_UPLOADING_FAILED - MODEL_TRAINING_FAILED - MODEL_BUILDING - MODEL_BUILDING_FAILED - MODEL_BUILD_UNEXPECTED_ERROR - MODEL_TRAINING_NO_DATA - MODEL_TRAINING_NO_POSITIVES - MODEL_TRAINING_ONE_VS_N_SINGLE_CLASS - MODEL_TRAINING_TIMED_OUT - MODEL_TRAINING_WAITING_ERROR - MODEL_TRAINING_UNKNOWN_ERROR - MODEL_TRAINING_MSG_REDELIVER - MODEL_TRAINING_INSUFFICIENT_DATA - MODEL_TRAINING_INVALID_PARAMS - MODEL_TRAINING_INVALID_DATA_TOLERANCE_EXCEEDED - MODEL_MODIFY_SUCCESS - MODEL_MODIFY_PENDING - MODEL_MODIFY_FAILED - MODEL_DOES_NOT_EXIST - MODEL_PERMISSION_DENIED - MODEL_INVALID_ARGUMENT - MODEL_INVALID_REQUEST - MODEL_EVALUATED - MODEL_EVALUATING - MODEL_NOT_EVALUATED - MODEL_QUEUED_FOR_EVALUATION - MODEL_EVALUATION_TIMED_OUT - MODEL_EVALUATION_WAITING_ERROR - MODEL_EVALUATION_UNKNOWN_ERROR - MODEL_PREDICTION_FAILED - MODEL_EVALUATION_MSG_REDELIVER - MODEL_EVALUATION_NEED_LABELS - MODEL_EVALUATION_NEED_INPUTS - MODEL_EVALUATION_FAILED - MODEL_DEPLOYMENT_FAILED - MODEL_DEPLOYING - MODEL_QUEUED_FOR_DEPLOYMENT - MODEL_NOT_DEPLOYED - MODEL_BUSY_PLEASE_RETRY - MODEL_LOADING - MODEL_REFERENCE_INVALID_ARGUMENT - MODEL_EXAMPLE_INPUT_INVALID_ARGUMENT - MODEL_EXPORTED - MODEL_EXPORTING - MODEL_EXPORTING_FAILED - MODEL_EXPORT_PENDING - WORKFLOW_NO_MATCHING_INPUT - WORKFLOW_REQUIRE_TRAINED_MODEL - WORKFLOW_DUPLICATE - WORKFLOW_UNSUPPORTED_FORMAT - WORKFLOW_DOES_NOT_EXIST - WORKFLOW_PERMISSION_DENIED - WORKFLOW_INVALID_ARGUMENT - WORKFLOW_INVALID_RECIPE - WORKFLOW_INVALID_TEMPLATE - WORKFLOW_INVALID_GRAPH - WORKFLOW_INTERNAL_FAILURE - WORKFLOW_INVALID_REQUEST - WORKFLOW_MODIFY_SUCCESS - WORKFLOW_MODIFY_PENDING - WORKFLOW_MODIFY_FAILED - WORKFLOW_REINDEX_FAILED - CONCEPT_MODIFY_SUCCESS - CONCEPT_MODIFY_PENDING - CONCEPT_MODIFY_FAILED - ANNOTATION_SUCCESS - ANNOTATION_PENDING - ANNOTATION_FAILED - ANNOTATION_UNKNOWN_STATUS - ANNOTATION_INVALID_ARGUMENT - ANNOTATION_PERMISSION_DENIED - ANNOTATION_AWAITING_REVIEW - ANNOTATION_AWAITING_CONSENSUS_REVIEW - ANNOTATION_REVIEW_DENIED - ANNOTATION_MODIFY_SUCCESS - ANNOTATION_MODIFY_PENDING - ANNOTATION_MODIFY_FAILED - ANNOTATION_TRACK_IDLE - ANNOTATION_TRACK_IN_PROGRESS - ANNOTATION_TRACK_PENDING - ANNOTATION_TRACK_APPROVED - ANNOTATION_TRACK_FAILED - METADATA_INVALID_PATCH_ARGUMENTS - METADATA_PARSING_ISSUE - METADATA_MANIPULATION_ISSUE - TRAINER_JOB_STATE_NONE - TRAINER_JOB_STATE_QUEUED - TRAINER_JOB_STATE_RUNNING - TRAINER_JOB_STATE_COMPLETE - TRAINER_JOB_STATE_ERROR - DATA_DUMP_SUCCESS - DATA_DUMP_PENDING - DATA_DUMP_FAILED - DATA_DUMP_IN_PROGRESS - DATA_DUMP_NO_DATA - DATA_DUMP_UNEXPECTED_ERROR - DATA_DUMP_EXPORT_SUCCESS - DATA_DUMP_EXPORT_PENDING - DATA_DUMP_EXPORT_FAILED - DATA_DUMP_EXPORT_IN_PROGRESS - DATA_DUMP_EXPORT_UNEXPECTED_ERROR - APP_DUPLICATION_SUCCESS - APP_DUPLICATION_FAILED - APP_DUPLICATION_PENDING - APP_DUPLICATION_IN_PROGRESS - APP_DUPLICATION_INVALID_REQUEST - MODULE_DOES_NOT_EXIST - MODULE_PERMISSION_DENIED - MODULE_INVALID_ARGUMENT - MODULE_INVALID_REQUEST - BULK_OPERATION_SUCCESS - BULK_OPERATION_FAILED - BULK_OPERATION_PENDING - BULK_OPERATION_IN_PROGRESS - BULK_OPERATION_INVALID_REQUEST - BULK_OPERATION_CANCELLED - BULK_OPERATION_UNEXPECTED_ERROR - RUNNER_DOES_NOT_EXIST - RUNNER_PERMISSION_DENIED - RUNNER_INVALID_ARGUMENT - RUNNER_INVALID_REQUEST - RUNNER_NEEDS_RETRY - RUNNER_STREAM_START - RUNNER_STREAM_END - RUNNER_ITEM_CANCELLED - RUNNER_PROCESSING_FAILED - RUNNER_SPECIAL_HANDLING_NOT_COMPLETE - NODEPOOL_DOES_NOT_EXIST - NODEPOOL_INVALID_ARGUMENT - NODEPOOL_INVALID_REQUEST - COMPUTE_CLUSTER_DOES_NOT_EXIST - COMPUTE_CLUSTER_INVALID_ARGUMENT - COMPUTE_CLUSTER_INVALID_REQUEST - DEPLOYMENT_DOES_NOT_EXIST - DEPLOYMENT_INVALID_ARGUMENT - DEPLOYMENT_INVALID_REQUEST - DEPLOYMENT_DISABLED - INSTANCE_TYPE_DOES_NOT_EXIST - INSTANCE_TYPE_INVALID_ARGUMENT - INSTANCE_TYPE_INVALID_REQUEST - COMPUTE_PLANE_METRICS_INVALID_REQUEST - PIPELINE_STEP_DOES_NOT_EXIST - PIPELINE_STEP_INVALID_ARGUMENT - PIPELINE_STEP_INVALID_REQUEST - PIPELINE_STEP_UPLOADING - PIPELINE_STEP_UPLOADING_FAILED - PIPELINE_STEP_BUILDING - PIPELINE_STEP_BUILDING_FAILED - PIPELINE_STEP_BUILD_UNEXPECTED_ERROR - PIPELINE_STEP_READY - PIPELINE_STEP_NOT_READY - PIPELINE_DOES_NOT_EXIST - PIPELINE_INVALID_ARGUMENT - PIPELINE_INVALID_REQUEST - ARTIFACT_DOES_NOT_EXIST - ARTIFACT_INVALID_ARGUMENT - ARTIFACT_INVALID_REQUEST - ARTIFACT_VERSION_DOES_NOT_EXIST - ARTIFACT_VERSION_INVALID_ARGUMENT - ARTIFACT_VERSION_INVALID_REQUEST - INPUT_SUCCESS - INPUT_PENDING - INPUT_FAILED - INPUT_IN_PROGRESS - INPUT_DOWNLOAD_SUCCESS - INPUT_DOWNLOAD_PENDING - INPUT_DOWNLOAD_FAILED - INPUT_DOWNLOAD_IN_PROGRESS - INPUT_STATUS_UPDATE_FAILED - INPUT_DELETE_FAILED - INPUT_DUPLICATE - INPUT_UNSUPPORTED_FORMAT - INPUT_DOES_NOT_EXIST - INPUT_PERMISSION_DENIED - INPUT_INVALID_ARGUMENT - INPUT_OVER_LIMIT - INPUT_INVALID_URL - INPUT_MODIFY_SUCCESS - INPUT_MODIFY_PENDING - INPUT_MODIFY_FAILED - INPUT_STORAGE_HOST_FAILED - ALL_INPUT_INVALID_BYTES - INPUT_CLUSTER_SUCCESS - INPUT_CLUSTER_PENDING - INPUT_CLUSTER_FAILED - INPUT_CLUSTER_IN_PROGRESS - INPUT_REINDEX_SUCCESS - INPUT_REINDEX_PENDING - INPUT_REINDEX_FAILED - INPUT_REINDEX_IN_PROGRESS - INPUT_VIDEO_DOWNLOAD_SUCCESS - INPUT_VIDEO_DOWNLOAD_PENDING - INPUT_VIDEO_DOWNLOAD_FAILED - INPUT_VIDEO_DUPLICATE - INPUT_VIDEO_UNSUPPORTED_FORMAT - INPUT_VIDEO_DOES_NOT_EXIST - INPUT_VIDEO_PERMISSION_DENIED - INPUT_VIDEO_INVALID_ARGUMENT - INPUT_VIDEO_OVER_LIMIT - INPUT_VIDEO_INVALID_URL - INPUT_VIDEO_MODIFY_SUCCESS - INPUT_VIDEO_MODIFY_PENDING - INPUT_VIDEO_MODIFY_FAILED - INPUT_VIDEO_STORAGE_HOST_FAILED - ALL_INPUT_VIDEOS_INVALID_BYTES - INPUT_VIDEO_PROCESSING_SUCCESS - INPUT_VIDEO_PROCESSING_PENDING - INPUT_VIDEO_PROCESSING_FAILED - INPUT_VIDEO_STORAGE_INCONSISTENCY - INPUT_VIDEO_STORAGE_FAILURE - INPUT_VIDEO_URL_GENERATION_FAILURE - INPUT_CONNECTION_FAILED - REQUEST_DISABLED_FOR_MAINTENANCE - INPUT_WRITES_DISABLED_FOR_MAINTENANCE - INPUT_INVALID_REQUEST - PREDICT_INVALID_REQUEST - SEARCH_INVALID_REQUEST - CONCEPTS_INVALID_REQUEST - STATS_INVALID_REQUEST - DATABASE_DUPLICATE_KEY - DATABASE_STATEMENT_TIMEOUT - DATABASE_INVALID_ROWS_AFFECTED - DATABASE_DEADLOCK_DETECTED - DATABASE_FAIL_TASK - DATABASE_FAIL_TO_GET_CONNECTIONS - DATABASE_TOO_MANY_CLIENTS - DATABASE_CONSTRAINT_VIOLATED - DATABASE_CANCELED - ASYNC_WORKER_MULTI_ERRORS - RPC_REQUEST_QUEUE_FULL - RPC_SERVER_UNAVAILABLE - RPC_REQUEST_TIMEOUT - RPC_MAX_MESSAGE_SIZE_EXCEEDED - RPC_CANCELED - RPC_UNKNOWN_METHOD - REQUEST_CANCELED_BY_USER - CLUSTER_INTERNAL_FAILURE - EXTERNAL_CONNECTION_ERROR - QUERY_INVALID_SYNTAX - QUEUE_CONN_ERROR - QUEUE_CLOSE_REQUEST_TIMEOUT - QUEUE_CONN_CLOSED - QUEUE_PUBLISH_ACK_TIMEOUT - QUEUE_PUBLISH_ERROR - QUEUE_SUBSCRIPTION_TIMEOUT - QUEUE_SUBSCRIPTION_ERROR - QUEUE_MARSHALLING_FAILED - QUEUE_UNMARSHALLING_FAILED - QUEUE_MAX_MSG_REDELIVERY_EXCEEDED - QUEUE_ACK_FAILURE - SQS_OVERLIMIT - SQS_INVALID_RECEIPT_HANDLE - SQS_UNKNOWN - SEARCH_INTERNAL_FAILURE - SEARCH_PROJECTION_FAILURE - SEARCH_PREDICTION_FAILURE - SEARCH_BY_NOT_FULLY_INDEXED_INPUT - SAVED_SEARCH_MODIFY_FAILED - SEARCH_COUNTS_UNAVAILABLE - EVALUATION_QUEUED - EVALUATION_IN_PROGRESS - EVALUATION_SUCCESS - EVALUATION_FAILED_TO_RETRIEVE_DATA - EVALUATION_INVALID_ARGUMENT - EVALUATION_FAILED - EVALUATION_PENDING - EVALUATION_TIMED_OUT - EVALUATION_UNEXPECTED_ERROR - EVALUATION_MIXED - STRIPE_EVENT_ERROR - STRIPE_UNEXPECTED_ERROR - CACHE_MISS - REDIS_SCRIPT_EXITED_WITH_FAILURE - REDIS_STREAM_ERR - REDIS_NO_CONSUMERS - REDIS_STREAM_BACKOFF - REDIS_CHANNEL_ERR - SIGNUP_EVENT_ERROR - SIGNUP_FLAGGED - FILETYPE_UNSUPPORTED - LOGIN_EVENT_ERROR - SIFT_UNCATEGORIZED_ERROR - USER_FLAGGED - APP_COUNT_INVALID_MESSAGE - APP_COUNT_UPDATE_INCREMENT_FAILED - APP_COUNT_REBUILD_FAILED - APP_COUNT_INTERNAL_FAILURE - MP_DOWNLOAD_ERROR - MP_RESOLVE_DNS_ERROR - MP_DOWNLOAD_MAX_SIZE_EXCEEDED_ERROR - MP_IMAGE_DECODE_ERROR - MP_INVALID_ARGUMENT - MP_IMAGE_PROCESSING_ERROR - DATATIER_CONN_ERROR - USER_CONSENT_FACE - WORKER_MISSING - WORKER_ACTIVE - WORKER_INACTIVE - SSO_IDENTITY_PROVIDER_DOES_NOT_EXIST - TASK_IN_PROGRESS - TASK_DONE - TASK_WONT_DO - TASK_FAILED - TASK_IDLE - TASK_CONFLICT - TASK_NOT_IMPLEMENTED - TASK_MISSING - TASK_PERMISSION_DENIED - TASK_ASSIGNMENT_SUCCESS - TASK_ASSIGNMENT_PENDING - TASK_ASSIGNMENT_AWAITING_REVIEW - TASK_ASSIGNMENT_AWAITING_CONSENSUS_REVIEW - TASK_ASSIGNMENT_REJECTED - TASK_ASSIGNMENT_REVIEW_SUCCESS - TASK_ASSIGNMENT_REVIEW_PENDING - TASK_ASSIGNMENT_REVIEW_DISMISSED - LABEL_ORDER_PENDING - LABEL_ORDER_IN_PROGRESS - LABEL_ORDER_SUCCESS - LABEL_ORDER_CANCELED - LICENSE_ACTIVE - LICENSE_DOES_NOT_EXIST - LICENSE_NEED_UPDATE - LICENSE_EXPIRED - LICENSE_REVOKED - LICENSE_DELETED - LICENSE_VOLUME_EXCEEDED - PASSWORD_VALIDATION_SUCCESS - PASSWORD_VALIDATION_FAILED - PASSWORDPOLICY_INVALID_ARGUMENT - FEATUREFLAG_CONFIG_NOT_FOUND - FEATUREFLAG_INVALID_ARGUMENT - FEATUREFLAG_BLOCKED - FEATUREFLAG_NOT_FOUND - MAINTENANCE_SUCCESS - MAINTENANCE_FAILED - DATASET_VERSION_PENDING - DATASET_VERSION_IN_PROGRESS - DATASET_VERSION_READY - DATASET_VERSION_FAILURE - DATASET_VERSION_UNEXPECTED_ERROR - DATASET_VERSION_CONFLICT - DATASET_INPUT_SUCCESS - DATASET_INPUT_DUPLICATE - DATASET_VERSION_EXPORT_SUCCESS - DATASET_VERSION_EXPORT_PENDING - DATASET_VERSION_EXPORT_FAILED - DATASET_VERSION_EXPORT_IN_PROGRESS - DATASET_VERSION_EXPORT_UNEXPECTED_ERROR - JOB_QUEUED - JOB_RUNNING - JOB_COMPLETED - JOB_FAILED - JOB_CANCELLED - JOB_UNEXPECTED_ERROR - JOB_CONFLICT - JOB_PAUSED - AUTH_MISSING_IDP_ASSOC - LIST_OBJECTS_FAILED - ARCHIVE_EXTRACT_FAILED - UPLOAD_IN_PROGRESS - UPLOAD_DONE - UPLOAD_FAILED - UPLOAD_UNEXPECTED_ERROR - UPLOAD_EXPIRED - UPLOAD_CANCELED - UPLOAD_CONFLICT - BILLING_INVALID_INFO - BILLING_MISSING_TOKENS - LOG_ENTRIES_INVALID_REQUEST - TWILIO_MAX_VERIFICATION_BEGIN_EXCEEDED - TWILIO_MAX_VERIFICATION_CHECK_EXCEEDED - TWILIO_PHONE_NUMBER_BLOCKED - INTERNAL_SERVER_ISSUE - INTERNAL_FETCHING_ISSUE - INTERNAL_DATABASE_ISSUE - INTERNAL_CONTEXT_CANCELED - INTERNAL_UNEXPECTED_TIMEOUT - INTERNAL_UNEXPECTED_V1 - INTERNAL_UNEXPECTED_PANIC - INTERNAL_UNEXPECTED_SPIRE - INTERNAL_REDIS_UNAVAILABLE - INTERNAL_RESOURCE_EXHAUSTED - INTERNAL_REDIS_UNCATEGORIZED - INTERNAL_AWS_UNCATEGORIZED - INTERNAL_AZURE_UNCATEGORIZED - INTERNAL_VECTORDB_UNCATEGORIZED - INTERNAL_ORACLE_UNCATEGORIZED - INTERNAL_VULTR_UNCATEGORIZED - INTERNAL_GCP_UNCATEGORIZED - CONN_UNCATEGORIZED - MODEL_UNCATEGORIZED - INPUT_UNCATEGORIZED - ANNOTATION_UNCATEGORIZED - BILLING_UNCATEGORIZED - INTERNAL_UNCATEGORIZED - BAD_REQUEST - SERVER_ERROR - name: page description: Pagination in: query required: false schema: type: integer format: int64 - name: per_page in: query required: false schema: type: integer format: int64 tags: - Users summary: V2 list pipeline version run status logs x-summary-source: derived ? /v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/pipelines/{pipeline_id}/versions/{pipeline_version_id}/runs/{pipeline_version_run_id}/{log_type}/logs : get: operationId: V2_ListLogEntries5 responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/apiMultiLogEntryResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: user_app_id.app_id in: path required: true schema: type: string - name: pipeline_id description: 'Pipelines that produced the logs for a given pipeline run with log_type: pipeline.version.run Must include user_app_id with user_id and app_id as well.' in: path required: true schema: type: string - name: pipeline_version_id in: path required: true schema: type: string - name: pipeline_version_run_id in: path required: true schema: type: string - name: log_type description: The type of log entry. Choose from [agent, builder, builder.events, runner, runner.events, pipeline.version.run] in: path required: true schema: type: string - name: page description: '(optional URL parameter) The page number. Pagination is used to split the results into chunks. Defaults to last page.' in: query required: false schema: type: integer format: int64 - name: per_page description: '(optional URL parameter) The number of results that will be contained in each page. Defaults to 32.' in: query required: false schema: type: integer format: int64 - name: model_id description: The Model ID, if a model produced the logs. in: query required: false schema: type: string - name: model_version_id description: The Version ID, if a model version produced the logs. in: query required: false schema: type: string - name: workflow_id description: Workflow Id, if a workflow produced the logs. in: query required: false schema: type: string - name: compute_cluster_user_id description: Where the logs came from. in: query required: false schema: type: string - name: compute_cluster_id in: query required: false schema: type: string - name: nodepool_id in: query required: false schema: type: string - name: runner_id in: query required: false schema: type: string - name: pipeline_step_id description: During pipeline step build provide these IDs. in: query required: false schema: type: string - name: pipeline_step_version_id in: query required: false schema: type: string tags: - Users summary: V2 list log entries5 x-summary-source: derived ? /v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/pipelines/{pipeline_id}/versions/{pipeline_version_id}/runs/{pipeline_version_run_id}/{log_type}/stream/logs : get: operationId: V2_StreamLogEntries3 responses: '200': description: A successful response.(streaming responses) content: application/json: schema: type: object properties: result: $ref: '#/components/schemas/apiMultiLogEntryResponse' error: $ref: '#/components/schemas/googlerpcStatus' title: Stream result of apiMultiLogEntryResponse default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: user_app_id.app_id in: path required: true schema: type: string - name: pipeline_id description: 'Pipelines that produced the logs with log_type: pipeline.version.run Must include user_app_id with user_id and app_id as well.' in: path required: true schema: type: string - name: pipeline_version_id in: path required: true schema: type: string - name: pipeline_version_run_id in: path required: true schema: type: string - name: log_type description: 'The type of log entry. Examples: model, agent, build, training.' in: path required: true schema: type: string - name: model_id description: 'For models if you set log_type to "builder" then you get the model build logs. The Model ID, if a model produced the logs.' in: query required: false schema: type: string - name: model_version_id description: The Version ID, if a model version produced the logs. in: query required: false schema: type: string - name: workflow_id description: Workflow Id, if a workflow produced the logs. in: query required: false schema: type: string - name: compute_cluster_user_id description: Where the logs came from. in: query required: false schema: type: string - name: compute_cluster_id in: query required: false schema: type: string - name: nodepool_id in: query required: false schema: type: string - name: runner_id in: query required: false schema: type: string - name: pipeline_step_id description: 'During pipeline step build provide these IDs with log_type: builder Must include user_app_id with user_id and app_id as well.' in: query required: false schema: type: string - name: pipeline_step_version_id in: query required: false schema: type: string tags: - Users summary: V2 stream log entries3 x-summary-source: derived /v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/resource_counts: get: summary: List the resource counts for the app operationId: V2_GetResourceCounts responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/apiGetResourceCountsResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: user_app_id.app_id in: path required: true schema: type: string tags: - Users /v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/runner_replica_task_metrics: post: summary: Post task metrics from runner replicas operationId: V2_PostRunnerReplicaTaskMetrics responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/statusBaseResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: user_app_id.app_id in: path required: true schema: type: string tags: - Users requestBody: content: application/json: schema: $ref: '#/components/schemas/V2PostRunnerReplicaTaskMetricsBody' required: true /v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/searches: get: summary: List all saved legacy searches operationId: V2_ListSearches responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/apiMultiSearchResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: user_app_id.app_id in: path required: true schema: type: string - name: page description: '(optional URL parameter) The page number. Pagination is used to split the results into chunks. Defaults to 1.' in: query required: false schema: type: integer format: int64 - name: per_page description: '(optional URL parameter) The number of results that will be contained in each page. Defaults to 128.' in: query required: false schema: type: integer format: int64 tags: - Users post: summary: Execute a new search and optionally save it description: 'Deprecated: Use PostInputsSearches or PostAnnotationsSearches instead. The server may refuse to accept requests to this endpoint.' operationId: V2_PostSearches responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/apiMultiSearchResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: user_app_id.app_id in: path required: true schema: type: string tags: - Users requestBody: content: application/json: schema: $ref: '#/components/schemas/V2PostSearchesBody' required: true patch: summary: Patch saved legacy searches by ids operationId: V2_PatchSearches responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/apiMultiSearchResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: user_app_id.app_id in: path required: true schema: type: string tags: - Users requestBody: content: application/json: schema: $ref: '#/components/schemas/V2PatchSearchesBody' required: true /v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/searches/{id}: get: summary: Get a saved legacy search operationId: V2_GetSearch responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/apiSingleSearchResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: user_app_id.app_id in: path required: true schema: type: string - name: id in: path required: true schema: type: string tags: - Users delete: summary: Delete a saved search operationId: V2_DeleteSearch responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/statusBaseResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: user_app_id.app_id in: path required: true schema: type: string - name: id in: path required: true schema: type: string tags: - Users post: summary: Execute a previously saved legacy search operationId: V2_PostSearchesByID responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/apiMultiSearchResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: user_app_id.app_id in: path required: true schema: type: string - name: id description: ID for saves search to be executed in: path required: true schema: type: string tags: - Users requestBody: content: application/json: schema: $ref: '#/components/schemas/V2PostSearchesByIDBody' required: true /v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/task/{task_id}/annotations/status: patch: summary: Patch annotations status by worker id and task id. operationId: V2_PatchAnnotationsStatus responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/apiPatchAnnotationsStatusResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: user_app_id.app_id in: path required: true schema: type: string - name: task_id description: Filter by task ID in: path required: true schema: type: string tags: - Users requestBody: content: application/json: schema: $ref: '#/components/schemas/V2PatchAnnotationsStatusBody' required: true /v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/tasks: get: summary: List tasks from an app operationId: V2_ListTasks responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/apiMultiTaskResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: user_app_id.app_id in: path required: true schema: type: string - name: page description: '(optional URL parameter) The page number. Pagination is used to split the results into chunks. Defaults to 1.' in: query required: false schema: type: integer format: int64 - name: per_page description: '(optional URL parameter) The number of results that will be contained in each page. Defaults to 128.' in: query required: false schema: type: integer format: int64 - name: worker_user_ids description: 'Get tasks that have ANY user from this list assigned as worker. Deprecated: Use worker_ids.' in: query required: false style: form explode: true schema: type: array items: type: string - name: review_user_ids description: Get tasks that have ANY user from this list assigned as reviewer. in: query required: false style: form explode: true schema: type: array items: type: string - name: label_order_ids description: Get tasks that are associated to ANY label order from this list. in: query required: false style: form explode: true schema: type: array items: type: string - name: including_label_order_tasks description: 'Get label order tasks as well It is automatically set to true if label_order_ids is set.' in: query required: false schema: type: boolean - name: additional_fields description: '(optional URL parameter) List of additional fields to be included in the response. Currently supported additional fields: - all - worker.users - review.users - metrics.input_source.inputs_count_estimated - metrics.work.inputs_count_estimated - metrics.work.inputs_percent_estimated - metrics.review.inputs_count_estimated - metrics.review.inputs_count_estimated_per_reviewer - metrics.review.inputs_percent_estimated - metrics.review.inputs_percent_estimated_per_reviewer - metrics.review.inputs_reviewable_count_estimated_per_reviewer' in: query required: false style: form explode: true schema: type: array items: type: string - name: ids description: (optional) task IDs to filter on in: query required: false style: form explode: true schema: type: array items: type: string - name: input_source_type description: "(optional) input source type to filter\n\n - ALL_INPUTS: Use all inputs in the app.\n - SAVED_SEARCH: Use the inputs from a saved search.\n - DATASET: Inputs from a dataset.\n - INPUT: Single input (e.g. video livestream input)" in: query required: false schema: type: string enum: - INPUT_SOURCE_TYPE_NOT_SET - ALL_INPUTS - SAVED_SEARCH - DATASET - INPUT default: INPUT_SOURCE_TYPE_NOT_SET - name: input_source_ids description: (optional) ids of input source to be filtered in: query required: false style: form explode: true schema: type: array items: type: string tags: - Users delete: summary: Delete multiple tasks in one request operationId: V2_DeleteTasks responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/statusBaseResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: user_app_id.app_id in: path required: true schema: type: string tags: - Users requestBody: content: application/json: schema: $ref: '#/components/schemas/V2DeleteTasksBody' required: true post: summary: Add tasks to an app operationId: V2_PostTasks responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/apiMultiTaskResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: user_app_id.app_id in: path required: true schema: type: string tags: - Users requestBody: content: application/json: schema: $ref: '#/components/schemas/V2PostTasksBody' required: true patch: summary: Patch one or more tasks operationId: V2_PatchTasks responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/apiMultiTaskResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: user_app_id.app_id in: path required: true schema: type: string tags: - Users requestBody: content: application/json: schema: $ref: '#/components/schemas/V2PatchTasksBody' required: true /v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/tasks/{task_id}: get: summary: Get a specific task from an app operationId: V2_GetTask responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/apiSingleTaskResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: user_app_id.app_id in: path required: true schema: type: string - name: task_id in: path required: true schema: type: string - name: additional_fields description: '(optional URL parameter) List of additional fields to be included in the response. Currently supported additional fields: - all - worker.users - review.users - metrics.input_source.inputs_count_estimated - metrics.work.inputs_count_estimated - metrics.work.inputs_percent_estimated - metrics.review.inputs_count_estimated - metrics.review.inputs_count_estimated_per_reviewer - metrics.review.inputs_percent_estimated - metrics.review.inputs_percent_estimated_per_reviewer - metrics.review.inputs_reviewable_count_estimated_per_reviewer' in: query required: false style: form explode: true schema: type: array items: type: string tags: - Users /v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/tasks/{task_id}/annotations/count: get: summary: Task annotation count operationId: V2_GetTaskAnnotationCount responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/apiSingleTaskCountResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: user_app_id.app_id in: path required: true schema: type: string - name: task_id description: task_id for which count per user per status is needed in: path required: true schema: type: string - name: user_ids description: 'Only return counts for these user IDs, effectively operating as an OR among them to filter down the results. If model_version_ids or workflow_version_ids are also provided, these user_ids are OR''d with them as well because we want the union of all worker (user, model or workflow) counts in the results.' in: query required: false style: form explode: true schema: type: array items: type: string - name: model_version_ids description: 'Only return counts for these model version IDs, effectively operating as an OR among them to filter down the results. If user_ids or workflow_version_ids are also provided, these model_version_ids are OR''d with them as well because we want the union of all worker (user, model or workflow) counts in the results.' in: query required: false style: form explode: true schema: type: array items: type: string - name: workflow_version_ids description: 'Only return counts for these workflow version IDs, effectively operating as an OR among them to filter down the results. If user_ids or model_version_ids are also provided, these workflow_version_ids are OR''d with them as well because we want the union of all worker (user, model or workflow) counts in the results.' in: query required: false style: form explode: true schema: type: array items: type: string tags: - Users /v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/tasks/{task_id}/assignments: get: summary: 'Deprecated: Use PutTaskAssignments with action=LABEL_START.' operationId: V2_ListNextTaskAssignments responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/apiMultiInputResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: user_app_id.app_id in: path required: true schema: type: string - name: task_id in: path required: true schema: type: string tags: - Users put: summary: PutTaskAssignments performs an idempotent action for the task assignments in… operationId: V2_PutTaskAssignments responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/apiMultiTaskAssignmentResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: user_app_id.app_id in: path required: true schema: type: string - name: task_id in: path required: true schema: type: string tags: - Users requestBody: content: application/json: schema: $ref: '#/components/schemas/V2PutTaskAssignmentsBody' required: true /v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/tasks/{task_id}/inputs/count: get: summary: Task Input count operationId: V2_GetTaskInputCount responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/apiSingleTaskCountResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: user_app_id.app_id in: path required: true schema: type: string - name: task_id description: task_id for which count per user per status is needed in: path required: true schema: type: string - name: user_ids description: 'Only return counts for these user IDs, effectively operating as an OR among them to filter down the results. If model_version_ids or workflow_version_ids are also provided, these user_ids are OR''d with them as well because we want the union of all worker (user, model or workflow) counts in the results.' in: query required: false style: form explode: true schema: type: array items: type: string - name: model_version_ids description: 'Only return counts for these model version IDs, effectively operating as an OR among them to filter down the results. If user_ids or workflow_version_ids are also provided, these model_version_ids are OR''d with them as well because we want the union of all worker (user, model or workflow) counts in the results.' in: query required: false style: form explode: true schema: type: array items: type: string - name: workflow_version_ids description: 'Only return counts for these workflow version IDs, effectively operating as an OR among them to filter down the results. If user_ids or model_version_ids are also provided, these workflow_version_ids are OR''d with them as well because we want the union of all worker (user, model or workflow) counts in the results.' in: query required: false style: form explode: true schema: type: array items: type: string tags: - Users /v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/tasks/{task_id}/inputs/samples: get: operationId: V2_GetInputSamples responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/apiMultiInputAnnotationResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: user_app_id.app_id in: path required: true schema: type: string - name: task_id in: path required: true schema: type: string - name: user_ids description: URL param. If zero ids provided, returns for all task labelers in: query required: false style: form explode: true schema: type: array items: type: string tags: - Users summary: V2 get input samples x-summary-source: derived /v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/uploads: get: operationId: V2_ListUploads responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/apiMultiUploadResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: user_app_id.app_id in: path required: true schema: type: string - name: page description: '(optional URL parameter) The page number. Pagination is used to split the results into chunks. Defaults to 1.' in: query required: false schema: type: integer format: int64 - name: per_page description: '(optional URL parameter) The number of results that will be contained in each page. Defaults to 128.' in: query required: false schema: type: integer format: int64 tags: - Users summary: V2 list uploads x-summary-source: derived delete: operationId: V2_DeleteUploads responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/statusBaseResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: user_app_id.app_id in: path required: true schema: type: string tags: - Users requestBody: content: application/json: schema: $ref: '#/components/schemas/V2DeleteUploadsBody' required: true summary: V2 delete uploads x-summary-source: derived post: summary: PostUploads is used to upload files. operationId: V2_PostUploads responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/apiMultiUploadResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: user_app_id.app_id in: path required: true schema: type: string tags: - Users requestBody: content: application/json: schema: $ref: '#/components/schemas/V2PostUploadsBody' required: true /v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/uploads/{upload_id}: get: operationId: V2_GetUpload responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/apiSingleUploadResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: user_app_id.app_id in: path required: true schema: type: string - name: upload_id description: Upload ID in: path required: true schema: type: string tags: - Users summary: V2 get upload x-summary-source: derived /v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/uploads/{upload_id}/content_parts: put: summary: Upload a part of a multipart upload. operationId: V2_PutUploadContentParts responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/apiSingleUploadResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: user_app_id.app_id in: path required: true schema: type: string - name: upload_id in: path required: true schema: type: string tags: - Users requestBody: content: application/json: schema: $ref: '#/components/schemas/V2PutUploadContentPartsBody' required: true /v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/workflows: get: summary: List all the workflows operationId: V2_ListWorkflows responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/apiMultiWorkflowResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: user_app_id.app_id in: path required: true schema: type: string - name: page description: '(optional URL parameter) The page number. Pagination is used to split the results into chunks. Defaults to 1.' in: query required: false schema: type: integer format: int64 - name: per_page description: '(optional URL parameter) The number of results that will be contained in each page. Defaults to 128.' in: query required: false schema: type: integer format: int64 - name: additional_fields description: '(optional URL parameter) List of additional fields to be included in the response. Currently supported: all, stars' in: query required: false style: form explode: true schema: type: array items: type: string - name: sort_ascending description: 'Sorting options: Whether to sort in ascending order. If false, will order in descending order.' in: query required: false schema: type: boolean - name: sort_by_id description: Whether to order by the name in: query required: false schema: type: boolean - name: sort_by_modified_at description: 'Whether to order by the modified_at time. If none of the sort options is set to true, will sort by modified_at.' in: query required: false schema: type: boolean - name: sort_by_created_at description: Whether to order by the created_at time. in: query required: false schema: type: boolean - name: sort_by_star_count description: Whether to order by the number of users stared the workflow in: query required: false schema: type: boolean - name: sort_by_relevance description: Whether to order by search query relevance. Can only be used if search is not empty. in: query required: false schema: type: boolean - name: featured_only description: 'Filtering options: If true, we only return workflows that are handpicked by clarifai staff' in: query required: false schema: type: boolean - name: starred_only description: If true, we only return workflows that are starred by the requesting user in: query required: false schema: type: boolean - name: bookmark description: Filter workflows by bookmark. If set, only return bookmarked workflows. Otherwise none bookmarked workflows only. in: query required: false schema: type: boolean - name: visibility.gettable description: " - UNKNOWN_VISIBILITY: Default value not allowed.\n - PRIVATE: PRIVATE requires collaborator or team permissions in order to GET this resource.\n - ORG: ORG requires you to be in the same org in order to GET this resource, but don't have to be a\nteammate or collaborator.\n - PUBLIC: PUBLIC opens up GET access to the resource to any user on the platform even if they are not\na teammate or collaborator." in: query required: false schema: type: string enum: - UNKNOWN_VISIBILITY - PRIVATE - ORG - PUBLIC default: UNKNOWN_VISIBILITY - name: search description: "Searching options:\nSpecify a search parameter in order to perform keyword search on the\nfollowing fields of the workflow:\n - id\n - description\n - notes\n - user_id (unless user_app_id.user_id is already set)\n\nKeywords are both normalized for search (so searching for \"satisfy\" matches \"satisfied\")\nand used for partial prefix-matching (so searching for \"clari\" matches \"clarifai\").\n\nNOTE: Both the list of fields searched and the exact keyword matching\nrules are subject to change and not guaranteed to be backwards-compatible." in: query required: false schema: type: string - name: query description: 'Query various text fields (id, description and notes) that can contain the words in the query string. Deprecated: use search instead.' in: query required: false schema: type: string - name: id description: 'Filter by the id of the workflow. This supports wilcard queries like "gen*" to match "general" as an example. Deprecated: use search instead.' in: query required: false schema: type: string - name: search_term description: 'Full text and prefix matching on id, owner id, description and notes. Searchable fields may be added Deprecated: use search instead.' in: query required: false schema: type: string tags: - Users delete: summary: Delete multiple workflows in one request operationId: V2_DeleteWorkflows responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/statusBaseResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: user_app_id.app_id in: path required: true schema: type: string tags: - Users requestBody: content: application/json: schema: $ref: '#/components/schemas/V2DeleteWorkflowsBody' required: true post: summary: Add a workflow to an app. operationId: V2_PostWorkflows responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/apiMultiWorkflowResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: user_app_id.app_id in: path required: true schema: type: string tags: - Users requestBody: content: application/json: schema: $ref: '#/components/schemas/V2PostWorkflowsBody' required: true patch: summary: Patch one or more workflows operationId: V2_PatchWorkflows responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/apiMultiWorkflowResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: user_app_id.app_id in: path required: true schema: type: string tags: - Users requestBody: content: application/json: schema: $ref: '#/components/schemas/V2PatchWorkflowsBody' required: true /v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/workflows/ids: patch: summary: Patch one or more workflows ids operationId: V2_PatchWorkflowIds responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/apiMultiWorkflowResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: user_app_id.app_id in: path required: true schema: type: string tags: - Users requestBody: content: application/json: schema: $ref: '#/components/schemas/V2PatchWorkflowIdsBody' required: true /v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/workflows/{workflow_id}: get: summary: Get a specific workflow from an app operationId: V2_GetWorkflow responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/apiSingleWorkflowResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: user_app_id.app_id in: path required: true schema: type: string - name: workflow_id description: 'Workflow ID to retrieve If no ID is specified we return default workflow of the application If an ID is specified by default we first looks into Clarifai workflows for a Workflow ID' in: path required: true schema: type: string - name: additional_fields description: '(optional URL parameter) List of additional fields to be included in the response. Currently supported: all, stars' in: query required: false style: form explode: true schema: type: array items: type: string tags: - Users delete: summary: Delete a single workflow operationId: V2_DeleteWorkflow responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/statusBaseResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: user_app_id.app_id in: path required: true schema: type: string - name: workflow_id in: path required: true schema: type: string tags: - Users /v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/workflows/{workflow_id}/publish: post: operationId: V2_PostWorkflowVersionsPublish responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/statusBaseResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: user_app_id.app_id in: path required: true schema: type: string - name: workflow_id in: path required: true schema: type: string tags: - Users requestBody: content: application/json: schema: $ref: '#/components/schemas/V2PostWorkflowVersionsPublishBody' required: true summary: V2 post workflow versions publish x-summary-source: derived /v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/workflows/{workflow_id}/results: post: summary: Predict using a workflow operationId: V2_PostWorkflowResults2 responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/apiPostWorkflowResultsResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: user_app_id.app_id in: path required: true schema: type: string - name: workflow_id description: 'Workflow ID to retrieve If no ID is specified we return default workflow of the application If an ID is specified by default we first looks into Clarifai workflows for a Workflow ID' in: path required: true schema: type: string tags: - Users requestBody: content: application/json: schema: $ref: '#/components/schemas/V2PostWorkflowResultsBody' required: true /v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/workflows/{workflow_id}/unpublish: post: operationId: V2_PostWorkflowVersionsUnPublish responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/statusBaseResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: user_app_id.app_id in: path required: true schema: type: string - name: workflow_id in: path required: true schema: type: string tags: - Users requestBody: content: application/json: schema: $ref: '#/components/schemas/V2PostWorkflowVersionsUnPublishBody' required: true summary: V2 post workflow versions un publish x-summary-source: derived /v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/workflows/{workflow_id}/versions: get: summary: List workflow versions operationId: V2_ListWorkflowVersions responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/apiMultiWorkflowVersionResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: user_app_id.app_id in: path required: true schema: type: string - name: workflow_id description: List versions for the workflow identified by this id in: path required: true schema: type: string - name: page description: '(optional URL parameter) The page number. Pagination is used to split the results into chunks. Defaults to 1.' in: query required: false schema: type: integer format: int64 - name: per_page description: '(optional URL parameter) The number of results that will be contained in each page. Defaults to 128.' in: query required: false schema: type: integer format: int64 tags: - Users delete: summary: Delete workflow versions operationId: V2_DeleteWorkflowVersions responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/statusBaseResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: user_app_id.app_id in: path required: true schema: type: string - name: workflow_id description: The id of the workflow that has the requested versions to delete. in: path required: true schema: type: string tags: - Users requestBody: content: application/json: schema: $ref: '#/components/schemas/V2DeleteWorkflowVersionsBody' required: true patch: summary: Patch workflow versions operationId: V2_PatchWorkflowVersions responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/apiMultiWorkflowVersionResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: user_app_id.app_id in: path required: true schema: type: string - name: workflow_id description: The id of the workflow that has the requested versions to patch. in: path required: true schema: type: string tags: - Users requestBody: content: application/json: schema: $ref: '#/components/schemas/V2PatchWorkflowVersionsBody' required: true /v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/workflows/{workflow_id}/versions/{version_id}/results: post: summary: Predict using a workflow operationId: V2_PostWorkflowResults responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/apiPostWorkflowResultsResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: user_app_id.app_id in: path required: true schema: type: string - name: workflow_id description: 'Workflow ID to retrieve If no ID is specified we return default workflow of the application If an ID is specified by default we first looks into Clarifai workflows for a Workflow ID' in: path required: true schema: type: string - name: version_id description: 'Workflow version ID to retrieve If no ID is specified, latest workflow version is used' in: path required: true schema: type: string tags: - Users requestBody: content: application/json: schema: $ref: '#/components/schemas/V2PostWorkflowResultsBody' required: true /v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/workflows/{workflow_id}/versions/{workflow_version_id}: get: summary: Get single workflow version operationId: V2_GetWorkflowVersion responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/apiSingleWorkflowVersionResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: user_app_id.app_id in: path required: true schema: type: string - name: workflow_id description: The id of the workflow that has the requested version. in: path required: true schema: type: string - name: workflow_version_id description: Get the identified by this id in: path required: true schema: type: string tags: - Users ? /v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/workflows/{workflow_id}/versions/{workflow_version_id}/evaluations : get: operationId: V2_ListWorkflowVersionEvaluations responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/apiMultiWorkflowVersionEvaluationResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: user_app_id.app_id in: path required: true schema: type: string - name: workflow_id in: path required: true schema: type: string - name: workflow_version_id in: path required: true schema: type: string - name: page description: '(optional URL parameter) The page number. Pagination is used to split the results into chunks. Defaults to 1.' in: query required: false schema: type: integer format: int64 - name: per_page description: '(optional URL parameter) The number of results that will be contained in each page. Defaults to 128.' in: query required: false schema: type: integer format: int64 tags: - Users summary: V2 list workflow version evaluations x-summary-source: derived post: operationId: V2_PostWorkflowVersionEvaluations responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/apiMultiWorkflowVersionEvaluationResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: user_app_id.app_id in: path required: true schema: type: string - name: workflow_id in: path required: true schema: type: string - name: workflow_version_id in: path required: true schema: type: string tags: - Users requestBody: content: application/json: schema: $ref: '#/components/schemas/V2PostWorkflowVersionEvaluationsBody' required: true summary: V2 post workflow version evaluations x-summary-source: derived patch: operationId: V2_PatchWorkflowVersionEvaluations responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/apiMultiWorkflowVersionEvaluationResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: user_app_id.app_id in: path required: true schema: type: string - name: workflow_id in: path required: true schema: type: string - name: workflow_version_id in: path required: true schema: type: string tags: - Users requestBody: content: application/json: schema: $ref: '#/components/schemas/V2PatchWorkflowVersionEvaluationsBody' required: true summary: V2 patch workflow version evaluations x-summary-source: derived ? /v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/workflows/{workflow_id}/versions/{workflow_version_id}/evaluations/{workflow_version_evaluation_id} : get: operationId: V2_GetWorkflowVersionEvaluation responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/apiSingleWorkflowVersionEvaluationResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: user_app_id.app_id in: path required: true schema: type: string - name: workflow_id in: path required: true schema: type: string - name: workflow_version_id in: path required: true schema: type: string - name: workflow_version_evaluation_id in: path required: true schema: type: string tags: - Users summary: V2 get workflow version evaluation x-summary-source: derived ? /v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/workflows/{workflow_id}/versions/{workflow_version_id}/evaluations/{workflow_version_evaluation_id}/data : get: operationId: V2_ListWorkflowVersionEvaluationData responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/apiMultiListWorkflowVersionEvaluationDataResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: user_app_id.app_id in: path required: true schema: type: string - name: workflow_id in: path required: true schema: type: string - name: workflow_version_id in: path required: true schema: type: string - name: workflow_version_evaluation_id in: path required: true schema: type: string - name: page description: '(optional URL parameter) The page number. Pagination is used to split the results into chunks. Defaults to 1.' in: query required: false schema: type: integer format: int64 - name: per_page description: '(optional URL parameter) The number of results that will be contained in each page. Defaults to 128.' in: query required: false schema: type: integer format: int64 tags: - Users summary: V2 list workflow version evaluation data x-summary-source: derived post: operationId: V2_PostWorkflowVersionEvaluationData responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/apiMultiListWorkflowVersionEvaluationDataResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: user_app_id.app_id in: path required: true schema: type: string - name: workflow_id in: path required: true schema: type: string - name: workflow_version_id in: path required: true schema: type: string - name: workflow_version_evaluation_id in: path required: true schema: type: string tags: - Users requestBody: content: application/json: schema: $ref: '#/components/schemas/V2PostWorkflowVersionEvaluationDataBody' required: true summary: V2 post workflow version evaluation data x-summary-source: derived /v2/users/{user_app_id.user_id}/audit_log/searches: post: operationId: V2_PostAuditLogSearches responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/apiMultiAuditLogEntryResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string tags: - Users requestBody: content: application/json: schema: $ref: '#/components/schemas/V2PostAuditLogSearchesBody' required: true summary: V2 post audit log searches x-summary-source: derived /v2/users/{user_app_id.user_id}/collaborations: get: summary: Collaboration includes the app user are invitied to work on operationId: V2_ListCollaborations responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/apiMultiCollaborationsResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: user_app_id.app_id in: query required: false schema: type: string - name: page description: '(optional URL parameter) The page number. Pagination is used to split the results into chunks. Defaults to 1.' in: query required: false schema: type: integer format: int64 - name: per_page description: '(optional URL parameter) The number of results that will be contained in each page. Defaults to 128.' in: query required: false schema: type: integer format: int64 - name: template_only description: 'Filtering options: If true, we only return collaborations on apps that are marked as a template by the app owner.' in: query required: false schema: type: boolean tags: - Users /v2/users/{user_app_id.user_id}/compute_clusters: get: operationId: V2_ListComputeClusters responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/apiMultiComputeClusterResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: user_app_id.app_id in: query required: false schema: type: string - name: page description: '(optional URL parameter) The page number. Pagination is used to split the results into chunks. Defaults to 1.' in: query required: false schema: type: integer format: int64 - name: per_page description: '(optional URL parameter) The number of results that will be contained in each page. Defaults to 128.' in: query required: false schema: type: integer format: int64 tags: - Users summary: V2 list compute clusters x-summary-source: derived delete: summary: Delete multiple compute_clusters in one request operationId: V2_DeleteComputeClusters responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/statusBaseResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string tags: - Users requestBody: content: application/json: schema: $ref: '#/components/schemas/V2DeleteComputeClustersBody' required: true post: operationId: V2_PostComputeClusters responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/apiMultiComputeClusterResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string tags: - Users requestBody: content: application/json: schema: $ref: '#/components/schemas/V2PostComputeClustersBody' required: true summary: V2 post compute clusters x-summary-source: derived patch: operationId: V2_PatchComputeClusters responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/apiMultiComputeClusterResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string tags: - Users requestBody: content: application/json: schema: $ref: '#/components/schemas/V2PatchComputeClustersBody' required: true summary: V2 patch compute clusters x-summary-source: derived /v2/users/{user_app_id.user_id}/compute_clusters/{compute_cluster_id}: get: summary: ComputeCluster CRUD operationId: V2_GetComputeCluster responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/apiSingleComputeClusterResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: compute_cluster_id in: path required: true schema: type: string - name: user_app_id.app_id in: query required: false schema: type: string tags: - Users /v2/users/{user_app_id.user_id}/compute_clusters/{compute_cluster_id}/nodepools: get: operationId: V2_ListNodepools responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/apiMultiNodepoolResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: compute_cluster_id in: path required: true schema: type: string - name: user_app_id.app_id in: query required: false schema: type: string - name: page description: '(optional URL parameter) The page number. Pagination is used to split the results into chunks. Defaults to 1.' in: query required: false schema: type: integer format: int64 - name: per_page description: '(optional URL parameter) The number of results that will be contained in each page. Defaults to 128.' in: query required: false schema: type: integer format: int64 - name: active_usage description: 'Only return nodepools that are actively being used (having runners with replicas >= threshold and pipeline versions scheduled to run)' in: query required: false schema: type: boolean tags: - Users summary: V2 list nodepools x-summary-source: derived delete: summary: Delete multiple nodepools in one request operationId: V2_DeleteNodepools responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/statusBaseResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: compute_cluster_id in: path required: true schema: type: string tags: - Users requestBody: content: application/json: schema: $ref: '#/components/schemas/V2DeleteNodepoolsBody' required: true post: operationId: V2_PostNodepools responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/apiMultiNodepoolResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: compute_cluster_id in: path required: true schema: type: string tags: - Users requestBody: content: application/json: schema: $ref: '#/components/schemas/V2PostNodepoolsBody' required: true summary: V2 post nodepools x-summary-source: derived patch: operationId: V2_PatchNodepools responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/apiMultiNodepoolResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: compute_cluster_id in: path required: true schema: type: string tags: - Users requestBody: content: application/json: schema: $ref: '#/components/schemas/V2PatchNodepoolsBody' required: true summary: V2 patch nodepools x-summary-source: derived /v2/users/{user_app_id.user_id}/compute_clusters/{compute_cluster_id}/nodepools/{nodepool_id}: get: summary: Nodepools CRUD operationId: V2_GetNodepool responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/apiSingleNodepoolResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: compute_cluster_id in: path required: true schema: type: string - name: nodepool_id in: path required: true schema: type: string - name: user_app_id.app_id in: query required: false schema: type: string - name: active_usage description: 'Only return the nodepool if it is actively being used (having min_instances > 0, runners with replicas >= threshold or pipeline versions scheduled to run)' in: query required: false schema: type: boolean tags: - Users /v2/users/{user_app_id.user_id}/compute_clusters/{compute_cluster_id}/nodepools/{nodepool_id}/pipeline_version_runs: get: summary: putting above the Get Nodepool endpoint to make it appear above the other one operationId: V2_ListPipelineVersionRuns2 responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/apiMultiPipelineVersionRunResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: compute_cluster_id description: compute cluster id in: path required: true schema: type: string - name: nodepool_id description: nodepool id in: path required: true schema: type: string - name: user_app_id.app_id in: query required: false schema: type: string - name: pipeline_id description: The ID of the pipeline in: query required: false schema: type: string - name: pipeline_version_id description: The ID of the pipeline version in: query required: false schema: type: string - name: page description: '(optional URL parameter) The page number. Pagination is used to split the results into chunks. Defaults to 1.' in: query required: false schema: type: integer format: int64 - name: per_page description: '(optional URL parameter) The number of results that will be contained in each page. Defaults to 128.' in: query required: false schema: type: integer format: int64 - name: status_codes description: "Filter based on status\n\n - ZERO: to be revised and greatly expanded\n - SUCCESS: Generic\n - MOVED: Resource moved. Respond with Http status 307 and add new Location header to response\n - ACCEPTED: Request has been accepted. Respond with Http status 202.\n - CONN_ACCOUNT_ISSUES: Clarifai Connection Codes: 11xxx\n\nexpired cc, still in trial, feature not supported in your tier\n - CONN_TOKEN_INVALID: invalid auth token used. Deprecated: we should return CONN_KEY_INVALID instead now in all cases.\n - CONN_CREDENTIALS_INVALID: invalid auth credentials\n - CONN_EXCEED_HOURLY_LIMIT: throttle hourly limit exceeded\n - CONN_EXCEED_MONTHLY_LIMIT: throttle monthly limit exceeded\n - CONN_THROTTLED: throttler and billing stuff\n - CONN_EXCEEDS_LIMITS: throttler and billing stuff\n - CONN_INSUFFICIENT_SCOPES: api key has insufficient permissions\n - CONN_KEY_INVALID: api key is invalid\n - CONN_KEY_NOT_FOUND: api key not found\n - CONN_BAD_REQUEST_FORMAT: multipart form parsing, broken json, etc\n - CONN_DOES_NOT_EXIST: when path is bad\n - CONN_INVALID_REQUEST: something wrong with a header\n - CONN_METHOD_NOT_ALLOWED: when a request method is not allowed\n - CONN_NO_GDPR_CONSENT: lack GDPR consent\n - CONN_INVALID_RANGE: when invalid range of a resource is requested\n - CONN_AUTH_METHOD_DISABLED: authentication method is disabled\n - MODEL_TRAINED: Model/Custom Training related 20xxx\n\nCustom model has been already trained.\n - MODEL_TRAINING: Custom model is currently training.\n - MODEL_UNTRAINED: Custom model has not yet been trained.\n - MODEL_QUEUED_FOR_TRAINING: Custom model is currently in queue for training, waiting on assets to process first.\n - MODEL_TRAINING_FAILED: generic err msg for any type of model training err.\n - MODEL_BUILDING: For new V3 DockerInternalType models which are built images\n - MODEL_BUILDING_FAILED: Failed to build image for model.\n - MODEL_BUILD_UNEXPECTED_ERROR: Failed to build image for model.\n - MODEL_TRAINING_NO_DATA: Custom model training had no data. FIXME(yang): deprecate this. Use the 21106 + errStatusMsg\n - MODEL_TRAINING_NO_POSITIVES: Custom model training had no positive examples. FIXME(yang): deprecate this. Use the 21106 + errStatusMsg\n - MODEL_TRAINING_ONE_VS_N_SINGLE_CLASS: Custom model training was ONE_VS_N but with a single class. FIXME(yang): deprecate this. Use the 21106 + errStatusMsg\n - MODEL_TRAINING_TIMED_OUT: Training took longer than hard coded timeouts. FIXME(yang): deprecate this. Use the 21106 + errStatusMsg\n - MODEL_TRAINING_WAITING_ERROR: Training got error waiting on asset pipeline to finish. FIXME(yang): deprecate this. Use the 21106 + errStatusMsg\n - MODEL_TRAINING_UNKNOWN_ERROR: Training threw an unknown exception.\n - MODEL_TRAINING_MSG_REDELIVER: Training message was redelivered. FIXME(yang): deprecate this. Use the 21106 + errStatusMsg\n - MODEL_TRAINING_INSUFFICIENT_DATA: Training got error due to insufficient labelled data. FIXME(yang): deprecate this. Use the 21106 + errStatusMsg\n - MODEL_TRAINING_INVALID_PARAMS: FIXME(yang): deprecate this. Use the 21106 + errStatusMsg\n - MODEL_TRAINING_INVALID_DATA_TOLERANCE_EXCEEDED: Training is stopped because too much data was dropped. FIXME(yang): deprecate this. Use the 21106 + errStatusMsg\n - MODEL_EVALUATION_TIMED_OUT: Evaluation took longer than hard coded timeouts. FIXME(yang): deprecate this. Use the 21317 + errStatusMsg\n - MODEL_EVALUATION_WAITING_ERROR: Evaluation got error waiting on asset pipeline to finish.FIXME(yang): deprecate this. Use the 21317 + errStatusMsg\n - MODEL_EVALUATION_UNKNOWN_ERROR: EVALUATION THREW AN UNKNOWN EXCEPTION.\n - MODEL_EVALUATION_MSG_REDELIVER: Eval message was redelivered. FIXME(yang): deprecate this. Use the 21317 + errStatusMsg\n - MODEL_EVALUATION_NEED_LABELS: Don't have enough concepts labelled to perform evaluation. FIXME(yang): deprecate this. Use the 21317 + errStatusMsg\n - MODEL_EVALUATION_NEED_INPUTS: Don't have enough inputs per concept to perform evaluation. FIXME(yang): deprecate this. Use the 21317 + errStatusMsg\n - MODEL_EVALUATION_FAILED: Generic err code for eval failure.\n - MODEL_DEPLOYMENT_FAILED: Used when inference coordinator failed to deploy spire and throws an error\n - MODEL_DEPLOYING: Used when calling the inference coordinator to deploy a spire\n - MODEL_QUEUED_FOR_DEPLOYMENT: Used when training is completed\n - MODEL_NOT_DEPLOYED: Used when model spire deployment is manually taken down or due to inactivity\n - MODEL_LOADING: Used when the model pod is running, but not yet ready to serve requests.\n - MODEL_REFERENCE_INVALID_ARGUMENT: Used when a model reference field is not set properly\n - MODEL_EXAMPLE_INPUT_INVALID_ARGUMENT: Used when a model example input field is not set properly\n - MODEL_EXPORTED: Model Export status codes\n - WORKFLOW_NO_MATCHING_INPUT: specified model input not in workflow\n - WORKFLOW_REQUIRE_TRAINED_MODEL: specified model must be trained\n - WORKFLOW_INVALID_ARGUMENT: error in the request somewhere\n - WORKFLOW_INVALID_REQUEST: error in the request somewhere\n - CONCEPT_MODIFY_SUCCESS: Concept related 23xxx\n - ANNOTATION_SUCCESS: Annotation related 24xxx\n - ANNOTATION_AWAITING_REVIEW: Annotation is awaiting review from task REVIEWERS.\n - ANNOTATION_AWAITING_CONSENSUS_REVIEW: Annotation is awaiting consensus review from task LABELERS.\n - ANNOTATION_TRACK_IDLE: Annotation (video) tracks are groups of annotations per frame\nIDLE -> PROCESSING --> PENDING --> APPROVED --> (DELETED)\nPROCESSING --> FAILED --> (DELETED)\nPROCESSING --> (DELETED)\n - METADATA_INVALID_PATCH_ARGUMENTS: Metadata related 249xx\n - TRAINER_JOB_STATE_NONE: Training service related 25xxx\n - DATA_DUMP_SUCCESS: Data Dump related 251xx\n - DATA_DUMP_NO_DATA: DEPRECATED: Not used anymore. Now for an empty data dump, DATA_DUMP_SUCCESS is returned. To detect an empty data dump, check if the inptus count is 0.\n - APP_DUPLICATION_SUCCESS: Duplicate related 252xx - DEPRECATED: App duplication is no longer supported.\n - MODULE_DOES_NOT_EXIST: Module related codes 253xx\n - BULK_OPERATION_SUCCESS: Bulk Operation related codes 254xx\n - RUNNER_DOES_NOT_EXIST: Runner related codes 256xx\n - NODEPOOL_DOES_NOT_EXIST: Nodepool related codes 257xx\n - COMPUTE_CLUSTER_DOES_NOT_EXIST: ComputeCluster related codes 258xx\n - DEPLOYMENT_DOES_NOT_EXIST: Deployment related codes 259xx\n - DEPLOYMENT_DISABLED: The deployment is disabled and cannot serve traffic.\n - INSTANCE_TYPE_DOES_NOT_EXIST: InstanceType related codes 260xx\n - COMPUTE_PLANE_METRICS_INVALID_REQUEST: Compute plane related codes 261xx\n - PIPELINE_STEP_DOES_NOT_EXIST: PipelineStep related codes 262xx\n - PIPELINE_DOES_NOT_EXIST: Pipeline related codes 263xx\n - ARTIFACT_DOES_NOT_EXIST: Artifact related codes 264xx\n - INPUT_SUCCESS: Input:Image related 30xxx\n - INPUT_PENDING: when things are async, this is the default status.\n - INPUT_FAILED: any type of error downloading and processing\n - INPUT_DOWNLOAD_SUCCESS: use INPUT_SUCCESS, INPUT_PENDING, INPUT_FAILED, INPUT_IN_PROGRESS instead\nDOWNLOAD is no longer correct, but keep old statuses for backward compatibility\n - INPUT_VIDEO_DOWNLOAD_SUCCESS: Input:Video related 31xxx -- Deprecated\n - INPUT_WRITES_DISABLED_FOR_MAINTENANCE: deprecate this one. Use REQUEST_DISABLED_FOR_MAINTENANCE\n - PREDICT_INVALID_REQUEST: API formatting issues 4000x\n - DATABASE_DUPLICATE_KEY: Other related 400xx\n - EXTERNAL_CONNECTION_ERROR: could not connect to external services\n - QUEUE_CONN_ERROR: Queue related errors 41xxx\n - SQS_OVERLIMIT: SQS related errors 411xx\n - SEARCH_INTERNAL_FAILURE: Search related errors 43xxxx\n - EVALUATION_QUEUED: Workflow evaluation err code\n - STRIPE_EVENT_ERROR: Stripe 44xxx\n - CACHE_MISS: Redis/Cache 45xxx\n - SIGNUP_EVENT_ERROR: Sift Science 46xxx\n - APP_COUNT_INVALID_MESSAGE: Application counts related errors 470xx\n - MP_DOWNLOAD_ERROR: Media processor related errors 471xx -- DEPRECATED\n - DATATIER_CONN_ERROR: DataTier related error 472xx\n - USER_CONSENT_FACE: User legal consent stauts related 50xxx\n - WORKER_MISSING: Workers 51xxx\n - SSO_IDENTITY_PROVIDER_DOES_NOT_EXIST: SSO 53xxx\n - TASK_IN_PROGRESS: Tasks 54xxx\nThe task was created.\n - TASK_DONE: The task is completed.\n - TASK_WONT_DO: The task is marked as abandoned.\n - TASK_FAILED: An error occurred during add-task-annotations or add-auto-annotations pipeline.\n - TASK_IDLE: Task is waiting for user action.\nExamples:\n- When an Auto Annotation task job has finished processing its last batch and is waiting for more dataset assets.\n- When an Auto Annotation task job for a video livestream input is waiting for user to create a task deployment.\n - TASK_CONFLICT: The task operation is in conflict with the current state of the server.\n - TASK_NOT_IMPLEMENTED: Certain task-related scenarios are not implemented.\n - TASK_MISSING: Task was not found.\n - TASK_PERMISSION_DENIED: Not allowed to perform a task-related action.\n - TASK_ASSIGNMENT_SUCCESS: Task Assignments 542xx\n - TASK_ASSIGNMENT_REVIEW_SUCCESS: Task Assignment Reviews 543xx\n - LABEL_ORDER_PENDING: Label Order Related Status Code 55xxx\n - LICENSE_ACTIVE: License Related Status Code 600xx\nDEPRECATED: License feature is fully deprecated now.\n - LICENSE_DELETED: hidden state not reflected to users\n - PASSWORD_VALIDATION_SUCCESS: Password Related Status Code\n - FEATUREFLAG_CONFIG_NOT_FOUND: Feature flags status code\n - MAINTENANCE_SUCCESS: Maintenance status code\n - DATASET_VERSION_PENDING: Datasets 64xxx\nThe dataset version is pending to be processed.\n - DATASET_VERSION_IN_PROGRESS: The dataset version is currently being processed.\n - DATASET_VERSION_READY: The dataset version is ready to be used.\n - DATASET_VERSION_FAILURE: An error occurred during the dataset version processing.\n - DATASET_VERSION_UNEXPECTED_ERROR: An unexpected error occurred during the dataset version processing.\n - DATASET_VERSION_CONFLICT: An alteration to dataset version would create a conflict\n - DATASET_INPUT_SUCCESS: The dataset input was successfully added.\n - DATASET_INPUT_DUPLICATE: The dataset input is a duplicate.\nDeprecated: Unused.\n - DATASET_VERSION_EXPORT_SUCCESS: The dataset version export is completed.\n - DATASET_VERSION_EXPORT_PENDING: The dataset version is pending to be exported.\n - DATASET_VERSION_EXPORT_FAILED: An error occurred during the dataset version export.\n - DATASET_VERSION_EXPORT_IN_PROGRESS: The dataset version is currently being exported.\n - DATASET_VERSION_EXPORT_UNEXPECTED_ERROR: An unexpected error occurred during the dataset version export.\n - JOB_QUEUED: Generic Job status codes\n - AUTH_MISSING_IDP_ASSOC: auth issues\n\nTODO: Knowledge graph related 80xxx\n - UPLOAD_IN_PROGRESS: Multipart uploading status codes\n - BILLING_INVALID_INFO: Billing related issues: 69xxx\n - LOG_ENTRIES_INVALID_REQUEST: Logs related issues: 70000;\n - TWILIO_MAX_VERIFICATION_BEGIN_EXCEEDED: Twilio related issues: 71xxx\n - TWILIO_PHONE_NUMBER_BLOCKED: The provided phone number was rejected or blocked by Twilio.\n - INTERNAL_SERVER_ISSUE: Internal issues: 98xxx\n - CONN_UNCATEGORIZED: Uncategorized: 99xxx: move off as soon as known\n - BAD_REQUEST: Deprecated: migrate off to one of the internal issues\n - SERVER_ERROR: Deprecated: migrate off to one of the internal issues" in: query required: false style: form explode: true schema: type: array items: type: string enum: - ZERO - SUCCESS - MIXED_STATUS - FAILURE - TRY_AGAIN - NOT_IMPLEMENTED - MOVED - TEAPOT - ACCEPTED - CONN_ACCOUNT_ISSUES - CONN_TOKEN_INVALID - CONN_CREDENTIALS_INVALID - CONN_EXCEED_HOURLY_LIMIT - CONN_EXCEED_MONTHLY_LIMIT - CONN_THROTTLED - CONN_EXCEEDS_LIMITS - CONN_INSUFFICIENT_SCOPES - CONN_KEY_INVALID - CONN_KEY_NOT_FOUND - CONN_BAD_REQUEST_FORMAT - CONN_DOES_NOT_EXIST - CONN_INVALID_REQUEST - CONN_METHOD_NOT_ALLOWED - CONN_NO_GDPR_CONSENT - CONN_INVALID_RANGE - CONN_AUTH_METHOD_DISABLED - MODEL_TRAINED - MODEL_TRAINING - MODEL_UNTRAINED - MODEL_QUEUED_FOR_TRAINING - MODEL_UPLOADING - MODEL_UPLOADING_FAILED - MODEL_TRAINING_FAILED - MODEL_BUILDING - MODEL_BUILDING_FAILED - MODEL_BUILD_UNEXPECTED_ERROR - MODEL_TRAINING_NO_DATA - MODEL_TRAINING_NO_POSITIVES - MODEL_TRAINING_ONE_VS_N_SINGLE_CLASS - MODEL_TRAINING_TIMED_OUT - MODEL_TRAINING_WAITING_ERROR - MODEL_TRAINING_UNKNOWN_ERROR - MODEL_TRAINING_MSG_REDELIVER - MODEL_TRAINING_INSUFFICIENT_DATA - MODEL_TRAINING_INVALID_PARAMS - MODEL_TRAINING_INVALID_DATA_TOLERANCE_EXCEEDED - MODEL_MODIFY_SUCCESS - MODEL_MODIFY_PENDING - MODEL_MODIFY_FAILED - MODEL_DOES_NOT_EXIST - MODEL_PERMISSION_DENIED - MODEL_INVALID_ARGUMENT - MODEL_INVALID_REQUEST - MODEL_EVALUATED - MODEL_EVALUATING - MODEL_NOT_EVALUATED - MODEL_QUEUED_FOR_EVALUATION - MODEL_EVALUATION_TIMED_OUT - MODEL_EVALUATION_WAITING_ERROR - MODEL_EVALUATION_UNKNOWN_ERROR - MODEL_PREDICTION_FAILED - MODEL_EVALUATION_MSG_REDELIVER - MODEL_EVALUATION_NEED_LABELS - MODEL_EVALUATION_NEED_INPUTS - MODEL_EVALUATION_FAILED - MODEL_DEPLOYMENT_FAILED - MODEL_DEPLOYING - MODEL_QUEUED_FOR_DEPLOYMENT - MODEL_NOT_DEPLOYED - MODEL_BUSY_PLEASE_RETRY - MODEL_LOADING - MODEL_REFERENCE_INVALID_ARGUMENT - MODEL_EXAMPLE_INPUT_INVALID_ARGUMENT - MODEL_EXPORTED - MODEL_EXPORTING - MODEL_EXPORTING_FAILED - MODEL_EXPORT_PENDING - WORKFLOW_NO_MATCHING_INPUT - WORKFLOW_REQUIRE_TRAINED_MODEL - WORKFLOW_DUPLICATE - WORKFLOW_UNSUPPORTED_FORMAT - WORKFLOW_DOES_NOT_EXIST - WORKFLOW_PERMISSION_DENIED - WORKFLOW_INVALID_ARGUMENT - WORKFLOW_INVALID_RECIPE - WORKFLOW_INVALID_TEMPLATE - WORKFLOW_INVALID_GRAPH - WORKFLOW_INTERNAL_FAILURE - WORKFLOW_INVALID_REQUEST - WORKFLOW_MODIFY_SUCCESS - WORKFLOW_MODIFY_PENDING - WORKFLOW_MODIFY_FAILED - WORKFLOW_REINDEX_FAILED - CONCEPT_MODIFY_SUCCESS - CONCEPT_MODIFY_PENDING - CONCEPT_MODIFY_FAILED - ANNOTATION_SUCCESS - ANNOTATION_PENDING - ANNOTATION_FAILED - ANNOTATION_UNKNOWN_STATUS - ANNOTATION_INVALID_ARGUMENT - ANNOTATION_PERMISSION_DENIED - ANNOTATION_AWAITING_REVIEW - ANNOTATION_AWAITING_CONSENSUS_REVIEW - ANNOTATION_REVIEW_DENIED - ANNOTATION_MODIFY_SUCCESS - ANNOTATION_MODIFY_PENDING - ANNOTATION_MODIFY_FAILED - ANNOTATION_TRACK_IDLE - ANNOTATION_TRACK_IN_PROGRESS - ANNOTATION_TRACK_PENDING - ANNOTATION_TRACK_APPROVED - ANNOTATION_TRACK_FAILED - METADATA_INVALID_PATCH_ARGUMENTS - METADATA_PARSING_ISSUE - METADATA_MANIPULATION_ISSUE - TRAINER_JOB_STATE_NONE - TRAINER_JOB_STATE_QUEUED - TRAINER_JOB_STATE_RUNNING - TRAINER_JOB_STATE_COMPLETE - TRAINER_JOB_STATE_ERROR - DATA_DUMP_SUCCESS - DATA_DUMP_PENDING - DATA_DUMP_FAILED - DATA_DUMP_IN_PROGRESS - DATA_DUMP_NO_DATA - DATA_DUMP_UNEXPECTED_ERROR - DATA_DUMP_EXPORT_SUCCESS - DATA_DUMP_EXPORT_PENDING - DATA_DUMP_EXPORT_FAILED - DATA_DUMP_EXPORT_IN_PROGRESS - DATA_DUMP_EXPORT_UNEXPECTED_ERROR - APP_DUPLICATION_SUCCESS - APP_DUPLICATION_FAILED - APP_DUPLICATION_PENDING - APP_DUPLICATION_IN_PROGRESS - APP_DUPLICATION_INVALID_REQUEST - MODULE_DOES_NOT_EXIST - MODULE_PERMISSION_DENIED - MODULE_INVALID_ARGUMENT - MODULE_INVALID_REQUEST - BULK_OPERATION_SUCCESS - BULK_OPERATION_FAILED - BULK_OPERATION_PENDING - BULK_OPERATION_IN_PROGRESS - BULK_OPERATION_INVALID_REQUEST - BULK_OPERATION_CANCELLED - BULK_OPERATION_UNEXPECTED_ERROR - RUNNER_DOES_NOT_EXIST - RUNNER_PERMISSION_DENIED - RUNNER_INVALID_ARGUMENT - RUNNER_INVALID_REQUEST - RUNNER_NEEDS_RETRY - RUNNER_STREAM_START - RUNNER_STREAM_END - RUNNER_ITEM_CANCELLED - RUNNER_PROCESSING_FAILED - RUNNER_SPECIAL_HANDLING_NOT_COMPLETE - NODEPOOL_DOES_NOT_EXIST - NODEPOOL_INVALID_ARGUMENT - NODEPOOL_INVALID_REQUEST - COMPUTE_CLUSTER_DOES_NOT_EXIST - COMPUTE_CLUSTER_INVALID_ARGUMENT - COMPUTE_CLUSTER_INVALID_REQUEST - DEPLOYMENT_DOES_NOT_EXIST - DEPLOYMENT_INVALID_ARGUMENT - DEPLOYMENT_INVALID_REQUEST - DEPLOYMENT_DISABLED - INSTANCE_TYPE_DOES_NOT_EXIST - INSTANCE_TYPE_INVALID_ARGUMENT - INSTANCE_TYPE_INVALID_REQUEST - COMPUTE_PLANE_METRICS_INVALID_REQUEST - PIPELINE_STEP_DOES_NOT_EXIST - PIPELINE_STEP_INVALID_ARGUMENT - PIPELINE_STEP_INVALID_REQUEST - PIPELINE_STEP_UPLOADING - PIPELINE_STEP_UPLOADING_FAILED - PIPELINE_STEP_BUILDING - PIPELINE_STEP_BUILDING_FAILED - PIPELINE_STEP_BUILD_UNEXPECTED_ERROR - PIPELINE_STEP_READY - PIPELINE_STEP_NOT_READY - PIPELINE_DOES_NOT_EXIST - PIPELINE_INVALID_ARGUMENT - PIPELINE_INVALID_REQUEST - ARTIFACT_DOES_NOT_EXIST - ARTIFACT_INVALID_ARGUMENT - ARTIFACT_INVALID_REQUEST - ARTIFACT_VERSION_DOES_NOT_EXIST - ARTIFACT_VERSION_INVALID_ARGUMENT - ARTIFACT_VERSION_INVALID_REQUEST - INPUT_SUCCESS - INPUT_PENDING - INPUT_FAILED - INPUT_IN_PROGRESS - INPUT_DOWNLOAD_SUCCESS - INPUT_DOWNLOAD_PENDING - INPUT_DOWNLOAD_FAILED - INPUT_DOWNLOAD_IN_PROGRESS - INPUT_STATUS_UPDATE_FAILED - INPUT_DELETE_FAILED - INPUT_DUPLICATE - INPUT_UNSUPPORTED_FORMAT - INPUT_DOES_NOT_EXIST - INPUT_PERMISSION_DENIED - INPUT_INVALID_ARGUMENT - INPUT_OVER_LIMIT - INPUT_INVALID_URL - INPUT_MODIFY_SUCCESS - INPUT_MODIFY_PENDING - INPUT_MODIFY_FAILED - INPUT_STORAGE_HOST_FAILED - ALL_INPUT_INVALID_BYTES - INPUT_CLUSTER_SUCCESS - INPUT_CLUSTER_PENDING - INPUT_CLUSTER_FAILED - INPUT_CLUSTER_IN_PROGRESS - INPUT_REINDEX_SUCCESS - INPUT_REINDEX_PENDING - INPUT_REINDEX_FAILED - INPUT_REINDEX_IN_PROGRESS - INPUT_VIDEO_DOWNLOAD_SUCCESS - INPUT_VIDEO_DOWNLOAD_PENDING - INPUT_VIDEO_DOWNLOAD_FAILED - INPUT_VIDEO_DUPLICATE - INPUT_VIDEO_UNSUPPORTED_FORMAT - INPUT_VIDEO_DOES_NOT_EXIST - INPUT_VIDEO_PERMISSION_DENIED - INPUT_VIDEO_INVALID_ARGUMENT - INPUT_VIDEO_OVER_LIMIT - INPUT_VIDEO_INVALID_URL - INPUT_VIDEO_MODIFY_SUCCESS - INPUT_VIDEO_MODIFY_PENDING - INPUT_VIDEO_MODIFY_FAILED - INPUT_VIDEO_STORAGE_HOST_FAILED - ALL_INPUT_VIDEOS_INVALID_BYTES - INPUT_VIDEO_PROCESSING_SUCCESS - INPUT_VIDEO_PROCESSING_PENDING - INPUT_VIDEO_PROCESSING_FAILED - INPUT_VIDEO_STORAGE_INCONSISTENCY - INPUT_VIDEO_STORAGE_FAILURE - INPUT_VIDEO_URL_GENERATION_FAILURE - INPUT_CONNECTION_FAILED - REQUEST_DISABLED_FOR_MAINTENANCE - INPUT_WRITES_DISABLED_FOR_MAINTENANCE - INPUT_INVALID_REQUEST - PREDICT_INVALID_REQUEST - SEARCH_INVALID_REQUEST - CONCEPTS_INVALID_REQUEST - STATS_INVALID_REQUEST - DATABASE_DUPLICATE_KEY - DATABASE_STATEMENT_TIMEOUT - DATABASE_INVALID_ROWS_AFFECTED - DATABASE_DEADLOCK_DETECTED - DATABASE_FAIL_TASK - DATABASE_FAIL_TO_GET_CONNECTIONS - DATABASE_TOO_MANY_CLIENTS - DATABASE_CONSTRAINT_VIOLATED - DATABASE_CANCELED - ASYNC_WORKER_MULTI_ERRORS - RPC_REQUEST_QUEUE_FULL - RPC_SERVER_UNAVAILABLE - RPC_REQUEST_TIMEOUT - RPC_MAX_MESSAGE_SIZE_EXCEEDED - RPC_CANCELED - RPC_UNKNOWN_METHOD - REQUEST_CANCELED_BY_USER - CLUSTER_INTERNAL_FAILURE - EXTERNAL_CONNECTION_ERROR - QUERY_INVALID_SYNTAX - QUEUE_CONN_ERROR - QUEUE_CLOSE_REQUEST_TIMEOUT - QUEUE_CONN_CLOSED - QUEUE_PUBLISH_ACK_TIMEOUT - QUEUE_PUBLISH_ERROR - QUEUE_SUBSCRIPTION_TIMEOUT - QUEUE_SUBSCRIPTION_ERROR - QUEUE_MARSHALLING_FAILED - QUEUE_UNMARSHALLING_FAILED - QUEUE_MAX_MSG_REDELIVERY_EXCEEDED - QUEUE_ACK_FAILURE - SQS_OVERLIMIT - SQS_INVALID_RECEIPT_HANDLE - SQS_UNKNOWN - SEARCH_INTERNAL_FAILURE - SEARCH_PROJECTION_FAILURE - SEARCH_PREDICTION_FAILURE - SEARCH_BY_NOT_FULLY_INDEXED_INPUT - SAVED_SEARCH_MODIFY_FAILED - SEARCH_COUNTS_UNAVAILABLE - EVALUATION_QUEUED - EVALUATION_IN_PROGRESS - EVALUATION_SUCCESS - EVALUATION_FAILED_TO_RETRIEVE_DATA - EVALUATION_INVALID_ARGUMENT - EVALUATION_FAILED - EVALUATION_PENDING - EVALUATION_TIMED_OUT - EVALUATION_UNEXPECTED_ERROR - EVALUATION_MIXED - STRIPE_EVENT_ERROR - STRIPE_UNEXPECTED_ERROR - CACHE_MISS - REDIS_SCRIPT_EXITED_WITH_FAILURE - REDIS_STREAM_ERR - REDIS_NO_CONSUMERS - REDIS_STREAM_BACKOFF - REDIS_CHANNEL_ERR - SIGNUP_EVENT_ERROR - SIGNUP_FLAGGED - FILETYPE_UNSUPPORTED - LOGIN_EVENT_ERROR - SIFT_UNCATEGORIZED_ERROR - USER_FLAGGED - APP_COUNT_INVALID_MESSAGE - APP_COUNT_UPDATE_INCREMENT_FAILED - APP_COUNT_REBUILD_FAILED - APP_COUNT_INTERNAL_FAILURE - MP_DOWNLOAD_ERROR - MP_RESOLVE_DNS_ERROR - MP_DOWNLOAD_MAX_SIZE_EXCEEDED_ERROR - MP_IMAGE_DECODE_ERROR - MP_INVALID_ARGUMENT - MP_IMAGE_PROCESSING_ERROR - DATATIER_CONN_ERROR - USER_CONSENT_FACE - WORKER_MISSING - WORKER_ACTIVE - WORKER_INACTIVE - SSO_IDENTITY_PROVIDER_DOES_NOT_EXIST - TASK_IN_PROGRESS - TASK_DONE - TASK_WONT_DO - TASK_FAILED - TASK_IDLE - TASK_CONFLICT - TASK_NOT_IMPLEMENTED - TASK_MISSING - TASK_PERMISSION_DENIED - TASK_ASSIGNMENT_SUCCESS - TASK_ASSIGNMENT_PENDING - TASK_ASSIGNMENT_AWAITING_REVIEW - TASK_ASSIGNMENT_AWAITING_CONSENSUS_REVIEW - TASK_ASSIGNMENT_REJECTED - TASK_ASSIGNMENT_REVIEW_SUCCESS - TASK_ASSIGNMENT_REVIEW_PENDING - TASK_ASSIGNMENT_REVIEW_DISMISSED - LABEL_ORDER_PENDING - LABEL_ORDER_IN_PROGRESS - LABEL_ORDER_SUCCESS - LABEL_ORDER_CANCELED - LICENSE_ACTIVE - LICENSE_DOES_NOT_EXIST - LICENSE_NEED_UPDATE - LICENSE_EXPIRED - LICENSE_REVOKED - LICENSE_DELETED - LICENSE_VOLUME_EXCEEDED - PASSWORD_VALIDATION_SUCCESS - PASSWORD_VALIDATION_FAILED - PASSWORDPOLICY_INVALID_ARGUMENT - FEATUREFLAG_CONFIG_NOT_FOUND - FEATUREFLAG_INVALID_ARGUMENT - FEATUREFLAG_BLOCKED - FEATUREFLAG_NOT_FOUND - MAINTENANCE_SUCCESS - MAINTENANCE_FAILED - DATASET_VERSION_PENDING - DATASET_VERSION_IN_PROGRESS - DATASET_VERSION_READY - DATASET_VERSION_FAILURE - DATASET_VERSION_UNEXPECTED_ERROR - DATASET_VERSION_CONFLICT - DATASET_INPUT_SUCCESS - DATASET_INPUT_DUPLICATE - DATASET_VERSION_EXPORT_SUCCESS - DATASET_VERSION_EXPORT_PENDING - DATASET_VERSION_EXPORT_FAILED - DATASET_VERSION_EXPORT_IN_PROGRESS - DATASET_VERSION_EXPORT_UNEXPECTED_ERROR - JOB_QUEUED - JOB_RUNNING - JOB_COMPLETED - JOB_FAILED - JOB_CANCELLED - JOB_UNEXPECTED_ERROR - JOB_CONFLICT - JOB_PAUSED - AUTH_MISSING_IDP_ASSOC - LIST_OBJECTS_FAILED - ARCHIVE_EXTRACT_FAILED - UPLOAD_IN_PROGRESS - UPLOAD_DONE - UPLOAD_FAILED - UPLOAD_UNEXPECTED_ERROR - UPLOAD_EXPIRED - UPLOAD_CANCELED - UPLOAD_CONFLICT - BILLING_INVALID_INFO - BILLING_MISSING_TOKENS - LOG_ENTRIES_INVALID_REQUEST - TWILIO_MAX_VERIFICATION_BEGIN_EXCEEDED - TWILIO_MAX_VERIFICATION_CHECK_EXCEEDED - TWILIO_PHONE_NUMBER_BLOCKED - INTERNAL_SERVER_ISSUE - INTERNAL_FETCHING_ISSUE - INTERNAL_DATABASE_ISSUE - INTERNAL_CONTEXT_CANCELED - INTERNAL_UNEXPECTED_TIMEOUT - INTERNAL_UNEXPECTED_V1 - INTERNAL_UNEXPECTED_PANIC - INTERNAL_UNEXPECTED_SPIRE - INTERNAL_REDIS_UNAVAILABLE - INTERNAL_RESOURCE_EXHAUSTED - INTERNAL_REDIS_UNCATEGORIZED - INTERNAL_AWS_UNCATEGORIZED - INTERNAL_AZURE_UNCATEGORIZED - INTERNAL_VECTORDB_UNCATEGORIZED - INTERNAL_ORACLE_UNCATEGORIZED - INTERNAL_VULTR_UNCATEGORIZED - INTERNAL_GCP_UNCATEGORIZED - CONN_UNCATEGORIZED - MODEL_UNCATEGORIZED - INPUT_UNCATEGORIZED - ANNOTATION_UNCATEGORIZED - BILLING_UNCATEGORIZED - INTERNAL_UNCATEGORIZED - BAD_REQUEST - SERVER_ERROR tags: - Users /v2/users/{user_app_id.user_id}/compute_clusters/{compute_cluster_id}/nodepools/{nodepool_id}/runners: get: summary: List all the runners for the user operationId: V2_ListRunners responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/apiMultiRunnerResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: compute_cluster_id in: path required: true schema: type: string - name: nodepool_id in: path required: true schema: type: string - name: user_app_id.app_id in: query required: false schema: type: string - name: page description: '(optional URL parameter) The page number. Pagination is used to split the results into chunks. Defaults to 1.' in: query required: false schema: type: integer format: int64 - name: per_page description: '(optional URL parameter) The number of results that will be contained in each page. Defaults to 128.' in: query required: false schema: type: integer format: int64 - name: min_replicas description: Only return runners whose replicas are >= min_replicas. in: query required: false schema: type: integer format: int64 - name: model_version_ids description: (optional URL parameter) ModelVersion IDs. To list all runners for the model version in: query required: false style: form explode: true schema: type: array items: type: string tags: - Users delete: summary: Delete multiple runners in one request operationId: V2_DeleteRunners responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/statusBaseResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: compute_cluster_id in: path required: true schema: type: string - name: nodepool_id in: path required: true schema: type: string tags: - Users requestBody: content: application/json: schema: $ref: '#/components/schemas/V2DeleteRunnersBody' required: true post: summary: Add a runners to a user operationId: V2_PostRunners responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/apiMultiRunnerResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: compute_cluster_id in: path required: true schema: type: string - name: nodepool_id in: path required: true schema: type: string tags: - Users requestBody: content: application/json: schema: $ref: '#/components/schemas/V2PostRunnersBody' required: true /v2/users/{user_app_id.user_id}/compute_clusters/{compute_cluster_id}/nodepools/{nodepool_id}/runners/{runner_id}: get: summary: Get a specific runner. operationId: V2_GetRunner responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/apiSingleRunnerResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: compute_cluster_id in: path required: true schema: type: string - name: nodepool_id in: path required: true schema: type: string - name: runner_id in: path required: true schema: type: string - name: user_app_id.app_id in: query required: false schema: type: string tags: - Users /v2/users/{user_app_id.user_id}/compute_clusters/{compute_cluster_id}/nodepools/{nodepool_id}/runners/{runner_id}/items: get: summary: List items for the remote runner to work on. operationId: V2_ListRunnerItems responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/apiMultiRunnerItemResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: compute_cluster_id in: path required: true schema: type: string - name: nodepool_id in: path required: true schema: type: string - name: runner_id in: path required: true schema: type: string - name: user_app_id.app_id in: query required: false schema: type: string tags: - Users ? /v2/users/{user_app_id.user_id}/compute_clusters/{compute_cluster_id}/nodepools/{nodepool_id}/runners/{runner_id}/items/{runner_item_id}/outputs : post: summary: Post back outputs from remote runners since the runner_id is a UUID we can… operationId: V2_PostRunnerItemOutputs responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/apiMultiRunnerItemOutputResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: compute_cluster_id in: path required: true schema: type: string - name: nodepool_id description: The particular nodepool that runner belongs to in: path required: true schema: type: string - name: runner_id description: The particular runner that processed the work. in: path required: true schema: type: string - name: runner_item_id description: The particular item of work processed. in: path required: true schema: type: string tags: - Users requestBody: content: application/json: schema: $ref: '#/components/schemas/V2PostRunnerItemOutputsBody' required: true ? /v2/users/{user_app_id.user_id}/compute_clusters/{compute_cluster_id}/nodepools/{nodepool_id}/runners/{runner_id}/{log_type}/logs : get: operationId: V2_ListLogEntries responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/apiMultiLogEntryResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: compute_cluster_id in: path required: true schema: type: string - name: nodepool_id in: path required: true schema: type: string - name: runner_id in: path required: true schema: type: string - name: log_type description: The type of log entry. Choose from [agent, builder, builder.events, runner, runner.events, pipeline.version.run] in: path required: true schema: type: string - name: page description: '(optional URL parameter) The page number. Pagination is used to split the results into chunks. Defaults to last page.' in: query required: false schema: type: integer format: int64 - name: per_page description: '(optional URL parameter) The number of results that will be contained in each page. Defaults to 32.' in: query required: false schema: type: integer format: int64 - name: user_app_id.app_id in: query required: false schema: type: string - name: model_id description: The Model ID, if a model produced the logs. in: query required: false schema: type: string - name: model_version_id description: The Version ID, if a model version produced the logs. in: query required: false schema: type: string - name: workflow_id description: Workflow Id, if a workflow produced the logs. in: query required: false schema: type: string - name: compute_cluster_user_id description: Where the logs came from. in: query required: false schema: type: string - name: pipeline_id description: 'Pipelines that produced the logs for a given pipeline run with log_type: pipeline.version.run Must include user_app_id with user_id and app_id as well.' in: query required: false schema: type: string - name: pipeline_version_id in: query required: false schema: type: string - name: pipeline_version_run_id in: query required: false schema: type: string - name: pipeline_step_id description: During pipeline step build provide these IDs. in: query required: false schema: type: string - name: pipeline_step_version_id in: query required: false schema: type: string tags: - Users summary: V2 list log entries x-summary-source: derived /v2/users/{user_app_id.user_id}/compute_clusters/{compute_cluster_id}/nodepools/{nodepool_id}/status: post: summary: Update nodepool status. Called by the agent to report nodepool health/errors operationId: V2_PostNodepoolStatus responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/statusBaseResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: compute_cluster_id in: path required: true schema: type: string - name: nodepool_id in: path required: true schema: type: string tags: - Users requestBody: content: application/json: schema: $ref: '#/components/schemas/V2PostNodepoolStatusBody' required: true /v2/users/{user_app_id.user_id}/compute_clusters/{compute_cluster_id}/{log_type}/logs: get: operationId: V2_ListLogEntries3 responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/apiMultiLogEntryResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: compute_cluster_id in: path required: true schema: type: string - name: log_type description: The type of log entry. Choose from [agent, builder, builder.events, runner, runner.events, pipeline.version.run] in: path required: true schema: type: string - name: page description: '(optional URL parameter) The page number. Pagination is used to split the results into chunks. Defaults to last page.' in: query required: false schema: type: integer format: int64 - name: per_page description: '(optional URL parameter) The number of results that will be contained in each page. Defaults to 32.' in: query required: false schema: type: integer format: int64 - name: user_app_id.app_id in: query required: false schema: type: string - name: model_id description: The Model ID, if a model produced the logs. in: query required: false schema: type: string - name: model_version_id description: The Version ID, if a model version produced the logs. in: query required: false schema: type: string - name: workflow_id description: Workflow Id, if a workflow produced the logs. in: query required: false schema: type: string - name: compute_cluster_user_id description: Where the logs came from. in: query required: false schema: type: string - name: nodepool_id in: query required: false schema: type: string - name: runner_id in: query required: false schema: type: string - name: pipeline_id description: 'Pipelines that produced the logs for a given pipeline run with log_type: pipeline.version.run Must include user_app_id with user_id and app_id as well.' in: query required: false schema: type: string - name: pipeline_version_id in: query required: false schema: type: string - name: pipeline_version_run_id in: query required: false schema: type: string - name: pipeline_step_id description: During pipeline step build provide these IDs. in: query required: false schema: type: string - name: pipeline_step_version_id in: query required: false schema: type: string tags: - Users summary: V2 list log entries3 x-summary-source: derived ? /v2/users/{user_app_id.user_id}/compute_clusters/{compute_cluster_user_id}/{compute_cluster_id}/nodepools/{nodepool_id}/versions/{model_version_id}/{log_type}/logs : get: operationId: V2_ListLogEntries2 responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/apiMultiLogEntryResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: compute_cluster_user_id description: Where the logs came from. in: path required: true schema: type: string - name: compute_cluster_id in: path required: true schema: type: string - name: nodepool_id in: path required: true schema: type: string - name: model_version_id description: The Version ID, if a model version produced the logs. in: path required: true schema: type: string - name: log_type description: The type of log entry. Choose from [agent, builder, builder.events, runner, runner.events, pipeline.version.run] in: path required: true schema: type: string - name: page description: '(optional URL parameter) The page number. Pagination is used to split the results into chunks. Defaults to last page.' in: query required: false schema: type: integer format: int64 - name: per_page description: '(optional URL parameter) The number of results that will be contained in each page. Defaults to 32.' in: query required: false schema: type: integer format: int64 - name: user_app_id.app_id in: query required: false schema: type: string - name: model_id description: The Model ID, if a model produced the logs. in: query required: false schema: type: string - name: workflow_id description: Workflow Id, if a workflow produced the logs. in: query required: false schema: type: string - name: runner_id in: query required: false schema: type: string - name: pipeline_id description: 'Pipelines that produced the logs for a given pipeline run with log_type: pipeline.version.run Must include user_app_id with user_id and app_id as well.' in: query required: false schema: type: string - name: pipeline_version_id in: query required: false schema: type: string - name: pipeline_version_run_id in: query required: false schema: type: string - name: pipeline_step_id description: During pipeline step build provide these IDs. in: query required: false schema: type: string - name: pipeline_step_version_id in: query required: false schema: type: string tags: - Users summary: V2 list log entries2 x-summary-source: derived /v2/users/{user_app_id.user_id}/datasets: get: summary: List all the datasets operationId: V2_ListDatasets2 responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/apiMultiDatasetResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: user_app_id.app_id in: query required: false schema: type: string - name: page description: '(optional URL parameter) The page number. Pagination is used to split the results into chunks. Defaults to 1.' in: query required: false schema: type: integer format: int64 - name: per_page description: '(optional URL parameter) The number of results that will be contained in each page. Defaults to 128.' in: query required: false schema: type: integer format: int64 - name: additional_fields in: query required: false style: form explode: true schema: type: array items: type: string - name: sort_ascending description: 'Sorting options: Whether to sort in ascending order. If false, will order in descending order.' in: query required: false schema: type: boolean - name: sort_by_created_at description: Whether to order by the created_at time. in: query required: false schema: type: boolean - name: sort_by_star_count description: Whether to order by the number of users stared the app in: query required: false schema: type: boolean - name: sort_by_modified_at description: If neither sort option is set to true, will sort by modified_at. in: query required: false schema: type: boolean - name: sort_by_id description: Whether to order by the external id in: query required: false schema: type: boolean - name: sort_by_relevance description: Whether to order by search query relevance. Can only be used if search is not empty. in: query required: false schema: type: boolean - name: starred_only description: 'Filtering options:' in: query required: false schema: type: boolean - name: bookmark description: Filter datasets by bookmark. If set, only return bookmarked datasets. Otherwise none bookmarked datasets only. in: query required: false schema: type: boolean - name: search description: "Searching options:\nSpecify a search parameter in order to perform keyword search on the\nfollowing fields of the dataset:\n - id\n - description\n - notes\n - user_id (unless user_app_id.user_id is already set)\n\nKeywords are both normalized for search (so searching for \"satisfy\" matches \"satisfied\")\nand used for partial prefix-matching (so searching for \"clari\" matches \"clarifai\").\n\nNOTE: Both the list of fields searched and the exact keyword matching\nrules are subject to change and not guaranteed to be backwards-compatible." in: query required: false schema: type: string - name: id description: 'Fuzzy filter on dataset ID Deprecated: use search instead.' in: query required: false schema: type: string tags: - Users /v2/users/{user_app_id.user_id}/deployments: get: operationId: V2_ListDeployments responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/apiMultiDeploymentResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: user_app_id.app_id in: query required: false schema: type: string - name: nodepool_id description: (optional URL parameter) Nodepool ID. To list all deployed workers in a Nodepool in: query required: false schema: type: string - name: page description: '(optional URL parameter) The page number. Pagination is used to split the results into chunks. Defaults to 1.' in: query required: false schema: type: integer format: int64 - name: per_page description: '(optional URL parameter) The number of results that will be contained in each page. Defaults to 128.' in: query required: false schema: type: integer format: int64 - name: model_version_ids description: (optional URL parameter) ModelVersion IDs. To list all deployments for the model version in: query required: false style: form explode: true schema: type: array items: type: string - name: workflow_version_ids description: (optional URL parameter) WorkflowVersion IDs. To list all deployments for the workflow version in: query required: false style: form explode: true schema: type: array items: type: string - name: compute_cluster_id description: (optional URL parameter) ComputeCluster ID. To list all deployed workers in a ComputeCluster in: query required: false schema: type: string - name: scheduling_priorities description: '(optional URL parameter) Scheduling priorities. To list all deployments with one of the provided scheduling priorities. Valid values are 0-9.' in: query required: false style: form explode: true schema: type: array items: type: integer format: int64 tags: - Users summary: V2 list deployments x-summary-source: derived delete: summary: Delete multiple deployments in one request operationId: V2_DeleteDeployments responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/statusBaseResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string tags: - Users requestBody: content: application/json: schema: $ref: '#/components/schemas/V2DeleteDeploymentsBody' required: true post: operationId: V2_PostDeployments responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/apiMultiDeploymentResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string tags: - Users requestBody: content: application/json: schema: $ref: '#/components/schemas/V2PostDeploymentsBody' required: true summary: V2 post deployments x-summary-source: derived patch: operationId: V2_PatchDeployments responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/apiMultiDeploymentResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string tags: - Users requestBody: content: application/json: schema: $ref: '#/components/schemas/V2PatchDeploymentsBody' required: true summary: V2 patch deployments x-summary-source: derived /v2/users/{user_app_id.user_id}/deployments/{deployment_id}: get: summary: Deployments CRUD operationId: V2_GetDeployment responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/apiSingleDeploymentResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: deployment_id in: path required: true schema: type: string - name: user_app_id.app_id in: query required: false schema: type: string tags: - Users /v2/users/{user_app_id.user_id}/duplications: get: summary: 'Deprecated: App duplication is no longer supported.' operationId: V2_ListAppDuplications responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/apiMultiAppDuplicationsResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: user_app_id.app_id in: query required: false schema: type: string - name: page description: '(optional URL parameter) The page number. Pagination is used to split the results into chunks. Defaults to 1.' in: query required: false schema: type: integer format: int64 - name: per_page description: '(optional URL parameter) The number of results that will be contained in each page. Defaults to 128.' in: query required: false schema: type: integer format: int64 tags: - Users /v2/users/{user_app_id.user_id}/duplications/{app_duplication_id}: get: summary: 'Deprecated: App duplication is no longer supported.' operationId: V2_GetAppDuplication responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/apiSingleAppDuplicationResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: app_duplication_id in: path required: true schema: type: string - name: user_app_id.app_id in: query required: false schema: type: string tags: - Users /v2/users/{user_app_id.user_id}/evaluations: get: operationId: V2_ListEvaluations2 responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/apiMultiEvalMetricsResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: user_app_id.app_id in: query required: false schema: type: string - name: page description: '(optional URL parameter) The page number. Pagination is used to split the results into chunks. Defaults to 1.' in: query required: false schema: type: integer format: int64 - name: per_page description: '(optional URL parameter) The number of results that will be contained in each page. Defaults to 128.' in: query required: false schema: type: integer format: int64 - name: sort_ascending description: If true, sort in ascending order, otherwise sort in descending order. in: query required: false schema: type: boolean - name: sort_by_app_id description: Whether to order by application id in: query required: false schema: type: boolean - name: sort_by_roc_auc description: Whether to order by eval metric summary.macro_avg_roc_auc in: query required: false schema: type: boolean - name: sort_by_f1 description: Whether to order by eval metric summary.f1 in: query required: false schema: type: boolean - name: sort_by_created_at description: Whether to order by when the metric was created in: query required: false schema: type: boolean - name: sort_by_mean_avg_precision description: Whether to order by eval metric summary.mean_avg_precision_iou_50 in: query required: false schema: type: boolean - name: sort_by_precision description: Whether to order by eval metric summary.macro_avg_precision in: query required: false schema: type: boolean - name: sort_by_recall description: Whether to order by eval metric summary.macro_avg_recall in: query required: false schema: type: boolean - name: sort_by_model_id in: query required: false schema: type: boolean - name: sort_by_eval_dataset_id in: query required: false schema: type: boolean - name: sort_by_train_dataset_id in: query required: false schema: type: boolean - name: model_type_id description: Filter on model type id in: query required: false schema: type: string - name: eval_dataset_ids description: Filter on dataset ID of the dataset version specified in the metric version in: query required: false style: form explode: true schema: type: array items: type: string - name: train_dataset_ids description: Filter on dataset ID of the dataset version specified by the model version in: query required: false style: form explode: true schema: type: array items: type: string - name: concept_ids description: Filter on concept IDs specified in the modele version's output_info in: query required: false style: form explode: true schema: type: array items: type: string - name: show_failed_metrics description: Whether to show failed metrics, defaults to false in: query required: false schema: type: boolean tags: - Users summary: V2 list evaluations2 x-summary-source: derived /v2/users/{user_app_id.user_id}/keys: get: summary: List all the keys operationId: V2_ListKeys responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/apiMultiKeyResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: user_app_id.app_id in: query required: false schema: type: string - name: page description: '(optional URL parameter) The page number. Pagination is used to split the results into chunks. Defaults to 1.' in: query required: false schema: type: integer format: int64 - name: per_page description: '(optional URL parameter) The number of results that will be contained in each page. Defaults to 128.' in: query required: false schema: type: integer format: int64 - name: not_expired description: 'Filtering options: If true, only return keys that have not expired.' in: query required: false schema: type: boolean - name: scopes description: Only return keys that have the listed scopes. in: query required: false style: form explode: true schema: type: array items: type: string - name: endpoints description: Only return keys that have the listed endpoints. in: query required: false style: form explode: true schema: type: array items: type: string - name: type description: Only return keys with the listed type. in: query required: false schema: type: string tags: - Users post: summary: Add a key to an app operationId: V2_PostKeys responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/apiMultiKeyResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string tags: - Users requestBody: content: application/json: schema: $ref: '#/components/schemas/V2PostKeysBody' required: true patch: summary: Patch one or more keys operationId: V2_PatchKeys responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/apiMultiKeyResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string tags: - Users requestBody: content: application/json: schema: $ref: '#/components/schemas/V2PatchKeysBody' required: true /v2/users/{user_app_id.user_id}/keys/{key_id}: get: summary: Get a specific key from an app operationId: V2_GetKey responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/apiSingleKeyResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: key_id in: path required: true schema: type: string - name: user_app_id.app_id in: query required: false schema: type: string tags: - Users delete: summary: Search over the keys to find one or more you're looking for. operationId: V2_DeleteKey responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/statusBaseResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: key_id in: path required: true schema: type: string - name: user_app_id.app_id in: query required: false schema: type: string tags: - Users /v2/users/{user_app_id.user_id}/metrics: post: operationId: V2_PostMetricsQuery responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/apiMetricsQueryResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string tags: - Users requestBody: content: application/json: schema: $ref: '#/components/schemas/V2PostMetricsQueryBody' required: true summary: V2 post metrics query x-summary-source: derived /v2/users/{user_app_id.user_id}/metrics/labels: get: operationId: V2_ListMetricLabels responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/apiMultiMetricLabelsResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: user_app_id.app_id in: query required: false schema: type: string - name: metric_types description: " - MODEL_TTFT: Model metrics: 1-50\n - NODEPOOL_NODE_COUNT: Nodepool metrics: 51-100" in: query required: false style: form explode: true schema: type: array items: type: string enum: - METRIC_TYPE_NOT_SET - MODEL_TTFT - MODEL_THROUGHPUT - MODEL_PROMPT_TOKEN_THROUGHPUT - MODEL_COMPLETION_TOKEN_THROUGHPUT - MODEL_REQUEST_COUNT - MODEL_E2E_LATENCY - NODEPOOL_NODE_COUNT - NODEPOOL_GPU_UTILIZATION - NODEPOOL_GPU_TENSOR_UTILIZATION - NODEPOOL_GPU_MEMORY_UTILIZATION - NODEPOOL_CPU_UTILIZATION - NODEPOOL_MEMORY_UTILIZATION tags: - Users summary: V2 list metric labels x-summary-source: derived /v2/users/{user_app_id.user_id}/models: get: summary: List all the models operationId: V2_ListModels2 responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/apiMultiModelResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: user_app_id.app_id in: query required: false schema: type: string - name: page description: '(optional URL parameter) The page number. Pagination is used to split the results into chunks. Defaults to 1.' in: query required: false schema: type: integer format: int64 - name: per_page description: '(optional URL parameter) The number of results that will be contained in each page. Defaults to 128.' in: query required: false schema: type: integer format: int64 - name: additional_fields description: '(optional URL parameter) List of additional fields to be included in the response. Currently supported: all, stars, outputs, presets, counts' in: query required: false style: form explode: true schema: type: array items: type: string - name: show_replicas description: If true, show replica counts for models. in: query required: false schema: type: boolean - name: sort_ascending description: 'Sorting options: Whether to sort in ascending order. If false, will order in descending order.' in: query required: false schema: type: boolean - name: sort_by_name description: Whether to order by the name in: query required: false schema: type: boolean - name: sort_by_num_inputs description: Whether to order by the number of training inputs in: query required: false schema: type: boolean - name: sort_by_modified_at description: 'Whether to order by the modified_at time of the latest model version. If none of the sort options is set to true, will sort by modified_at.' in: query required: false schema: type: boolean - name: sort_by_created_at description: Whether to order by the created_at in: query required: false schema: type: boolean - name: sort_by_star_count description: Whether to order by count of stars in: query required: false schema: type: boolean - name: sort_by_relevance description: Whether to order by search query relevance. Can only be used if search is not empty. in: query required: false schema: type: boolean - name: model_type_id description: 'Filtering options: Filter models by the specific model_type_id. See ListModelTypes for the list of ModelType.Id''s supported.' in: query required: false schema: type: string - name: trained_only description: If true, we only return models that have the status MODEL_TRAINED, which includes non-trainable model types. in: query required: false schema: type: boolean - name: input_fields description: 'The list of input fields to the model. For example, you can specify ''image'', which will return models that make inferences on images like visual-classifier models.' in: query required: false style: form explode: true schema: type: array items: type: string - name: output_fields description: 'The list of output fields to the model. For example, you can specify ''regions[...].data.concepts'', which will return visual-detector models.' in: query required: false style: form explode: true schema: type: array items: type: string - name: license description: Filter by the license of the model version in: query required: false schema: type: string - name: featured_only description: If true, we only return models that are handpicked by clarifai staff in: query required: false schema: type: boolean - name: starred_only description: If true, we only return models that are starred by the requesting user in: query required: false schema: type: boolean - name: toolkits description: List of toolkit tags to filter by in: query required: false style: form explode: true schema: type: array items: type: string - name: use_cases description: List of use_case tags to filter by in: query required: false style: form explode: true schema: type: array items: type: string - name: languages description: List of language tags to filter by in: query required: false style: form explode: true schema: type: array items: type: string - name: dont_fetch_from_main description: 'Old API behavior resulted in returning clarifai main models when calling ListModels while scoped to an app. While we transition away from that, we can use this flag to not always fetch clarifai main models, unless that is the app we are explicitly listing for. @exclude TODO (EAGLE-4447): Remove this field' in: query required: false schema: type: boolean - name: bookmark description: 'Filter models by bookmark. If set, only return bookmarked models. Otherwise none bookmarked models only. Note: you can not filter `trained_only` and bookmark at the same time. When filter by bookmark, we will return trained and untrained models.' in: query required: false schema: type: boolean - name: model_version_ids description: Filter by the model version ids. If set, only return the model of these versions. in: query required: false style: form explode: true schema: type: array items: type: string - name: license_type description: Filter by LicenseType in: query required: false schema: type: string enum: - UNKNOWN_LICENSE_TYPE - FIRST_PARTY - OPEN_SOURCE - CLOSED_SOURCE default: UNKNOWN_LICENSE_TYPE - name: source description: Filter by Source in: query required: false schema: type: integer format: int64 - name: creator description: Filter by Creator in: query required: false schema: type: string - name: min_replicas description: Filter by model versions runners with replicas >= min_replicas. in: query required: false schema: type: integer format: int64 - name: visibility.gettable description: " - UNKNOWN_VISIBILITY: Default value not allowed.\n - PRIVATE: PRIVATE requires collaborator or team permissions in order to GET this resource.\n - ORG: ORG requires you to be in the same org in order to GET this resource, but don't have to be a\nteammate or collaborator.\n - PUBLIC: PUBLIC opens up GET access to the resource to any user on the platform even if they are not\na teammate or collaborator." in: query required: false schema: type: string enum: - UNKNOWN_VISIBILITY - PRIVATE - ORG - PUBLIC default: UNKNOWN_VISIBILITY - name: search description: "Searching options:\nSpecify a search parameter in order to perform keyword search on the\nfollowing fields of the model:\n - id\n - name\n - description\n - notes\n - user_id (unless user_app_id.user_id is already set)\n\nKeywords are both normalized for search (so searching for \"satisfy\" matches \"satisfied\")\nand used for partial prefix-matching (so searching for \"clari\" matches \"clarifai\").\n\nNOTE: Both the list of fields searched and the exact keyword matching\nrules are subject to change and not guaranteed to be backwards-compatible." in: query required: false schema: type: string - name: query description: 'Query name, description and id fields, that can contain the words in the query string. Does NOT support wildcards - full words only. Supports operators "OR" and "-" as NOT. Deprecated: use search instead.' in: query required: false schema: type: string - name: name description: 'Filter by the description and id of the model. This supports wildcard queries like "gen*" to match "general" as an example. Deprecated: use search instead.' in: query required: false schema: type: string - name: filter_by_user_id description: 'Extends the name filter to include the user_id of the application owner that the model belongs to. Deprecated: use search instead of name.' in: query required: false schema: type: boolean tags: - Users /v2/users/{user_app_id.user_id}/myscopes: get: operationId: V2_MyScopesUser responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/apiMultiScopeUserResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: user_app_id.app_id in: query required: false schema: type: string tags: - Users summary: V2 my scopes user x-summary-source: derived /v2/users/{user_app_id.user_id}/nodepools: get: operationId: V2_ListNodepools2 responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/apiMultiNodepoolResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: user_app_id.app_id in: query required: false schema: type: string - name: compute_cluster_id in: query required: false schema: type: string - name: page description: '(optional URL parameter) The page number. Pagination is used to split the results into chunks. Defaults to 1.' in: query required: false schema: type: integer format: int64 - name: per_page description: '(optional URL parameter) The number of results that will be contained in each page. Defaults to 128.' in: query required: false schema: type: integer format: int64 - name: active_usage description: 'Only return nodepools that are actively being used (having runners with replicas >= threshold and pipeline versions scheduled to run)' in: query required: false schema: type: boolean tags: - Users summary: V2 list nodepools2 x-summary-source: derived /v2/users/{user_app_id.user_id}/runners: get: summary: List all the runners for the user operationId: V2_ListRunners2 responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/apiMultiRunnerResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: user_app_id.app_id in: query required: false schema: type: string - name: nodepool_id in: query required: false schema: type: string - name: page description: '(optional URL parameter) The page number. Pagination is used to split the results into chunks. Defaults to 1.' in: query required: false schema: type: integer format: int64 - name: per_page description: '(optional URL parameter) The number of results that will be contained in each page. Defaults to 128.' in: query required: false schema: type: integer format: int64 - name: compute_cluster_id in: query required: false schema: type: string - name: min_replicas description: Only return runners whose replicas are >= min_replicas. in: query required: false schema: type: integer format: int64 - name: model_version_ids description: (optional URL parameter) ModelVersion IDs. To list all runners for the model version in: query required: false style: form explode: true schema: type: array items: type: string tags: - Users /v2/users/{user_app_id.user_id}/runners/{runner_id}: get: summary: Get a specific runner. operationId: V2_GetRunner2 responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/apiSingleRunnerResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: runner_id in: path required: true schema: type: string - name: user_app_id.app_id in: query required: false schema: type: string - name: nodepool_id in: query required: false schema: type: string - name: compute_cluster_id in: query required: false schema: type: string tags: - Users /v2/users/{user_app_id.user_id}/scopes: get: summary: List all auth scopes available to me as a user operationId: V2_ListScopes responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/apiMultiScopeDepsResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: key_type description: 'If "personal_access_token" include scopes and endpoints available to personal access tokens. If "app_specific_key" include scopes and endpoints available to app-specific keys. (default)' in: query required: false schema: type: string - name: user_app_id.app_id in: query required: false schema: type: string tags: - Users /v2/users/{user_app_id.user_id}/secrets: get: operationId: V2_ListSecrets responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/apiMultiSecretResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: user_app_id.app_id in: query required: false schema: type: string - name: page description: '(optional URL parameter) The page number. Pagination is used to split the results into chunks. Defaults to 1.' in: query required: false schema: type: integer format: int64 - name: per_page description: '(optional URL parameter) The number of results that will be contained in each page. Defaults to 128.' in: query required: false schema: type: integer format: int64 tags: - Users summary: V2 list secrets x-summary-source: derived delete: operationId: V2_DeleteSecrets responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/apiMultiSecretResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string tags: - Users requestBody: content: application/json: schema: $ref: '#/components/schemas/V2DeleteSecretsBody' required: true summary: V2 delete secrets x-summary-source: derived post: operationId: V2_PostSecrets responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/apiMultiSecretResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string tags: - Users requestBody: content: application/json: schema: $ref: '#/components/schemas/V2PostSecretsBody' required: true summary: V2 post secrets x-summary-source: derived patch: operationId: V2_PatchSecrets responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/apiMultiSecretResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string tags: - Users requestBody: content: application/json: schema: $ref: '#/components/schemas/V2PatchSecretsBody' required: true summary: V2 patch secrets x-summary-source: derived /v2/users/{user_app_id.user_id}/secrets/{id}: get: operationId: V2_GetSecret responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/apiSingleSecretResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: id description: The id of the secret to get in: path required: true schema: type: string - name: user_app_id.app_id in: query required: false schema: type: string tags: - Users summary: V2 get secret x-summary-source: derived /v2/users/{user_app_id.user_id}/validate_password: post: summary: Validate new password in real-time for a user operationId: V2_PostValidatePassword responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/apiSinglePasswordValidationResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string tags: - Users requestBody: content: application/json: schema: $ref: '#/components/schemas/V2PostValidatePasswordBody' required: true /v2/users/{user_app_id.user_id}/workflows: get: summary: List all the workflows operationId: V2_ListWorkflows2 responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/apiMultiWorkflowResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: user_app_id.user_id description: Note user_id 'me' is reserved - it is the alias for the id of authorized user in: path required: true schema: type: string - name: user_app_id.app_id in: query required: false schema: type: string - name: page description: '(optional URL parameter) The page number. Pagination is used to split the results into chunks. Defaults to 1.' in: query required: false schema: type: integer format: int64 - name: per_page description: '(optional URL parameter) The number of results that will be contained in each page. Defaults to 128.' in: query required: false schema: type: integer format: int64 - name: additional_fields description: '(optional URL parameter) List of additional fields to be included in the response. Currently supported: all, stars' in: query required: false style: form explode: true schema: type: array items: type: string - name: sort_ascending description: 'Sorting options: Whether to sort in ascending order. If false, will order in descending order.' in: query required: false schema: type: boolean - name: sort_by_id description: Whether to order by the name in: query required: false schema: type: boolean - name: sort_by_modified_at description: 'Whether to order by the modified_at time. If none of the sort options is set to true, will sort by modified_at.' in: query required: false schema: type: boolean - name: sort_by_created_at description: Whether to order by the created_at time. in: query required: false schema: type: boolean - name: sort_by_star_count description: Whether to order by the number of users stared the workflow in: query required: false schema: type: boolean - name: sort_by_relevance description: Whether to order by search query relevance. Can only be used if search is not empty. in: query required: false schema: type: boolean - name: featured_only description: 'Filtering options: If true, we only return workflows that are handpicked by clarifai staff' in: query required: false schema: type: boolean - name: starred_only description: If true, we only return workflows that are starred by the requesting user in: query required: false schema: type: boolean - name: bookmark description: Filter workflows by bookmark. If set, only return bookmarked workflows. Otherwise none bookmarked workflows only. in: query required: false schema: type: boolean - name: visibility.gettable description: " - UNKNOWN_VISIBILITY: Default value not allowed.\n - PRIVATE: PRIVATE requires collaborator or team permissions in order to GET this resource.\n - ORG: ORG requires you to be in the same org in order to GET this resource, but don't have to be a\nteammate or collaborator.\n - PUBLIC: PUBLIC opens up GET access to the resource to any user on the platform even if they are not\na teammate or collaborator." in: query required: false schema: type: string enum: - UNKNOWN_VISIBILITY - PRIVATE - ORG - PUBLIC default: UNKNOWN_VISIBILITY - name: search description: "Searching options:\nSpecify a search parameter in order to perform keyword search on the\nfollowing fields of the workflow:\n - id\n - description\n - notes\n - user_id (unless user_app_id.user_id is already set)\n\nKeywords are both normalized for search (so searching for \"satisfy\" matches \"satisfied\")\nand used for partial prefix-matching (so searching for \"clari\" matches \"clarifai\").\n\nNOTE: Both the list of fields searched and the exact keyword matching\nrules are subject to change and not guaranteed to be backwards-compatible." in: query required: false schema: type: string - name: query description: 'Query various text fields (id, description and notes) that can contain the words in the query string. Deprecated: use search instead.' in: query required: false schema: type: string - name: id description: 'Filter by the id of the workflow. This supports wilcard queries like "gen*" to match "general" as an example. Deprecated: use search instead.' in: query required: false schema: type: string - name: search_term description: 'Full text and prefix matching on id, owner id, description and notes. Searchable fields may be added Deprecated: use search instead.' in: query required: false schema: type: string tags: - Users components: schemas: apiMultiConceptLanguageResponse: type: object properties: status: $ref: '#/components/schemas/apistatusStatus' concept_languages: type: array items: type: object $ref: '#/components/schemas/apiConceptLanguage' title: MultiConceptLanguageResponse apiAnnotationDataType: type: string enum: - ANNOTATION_DATA_TYPE_NOT_SET - TAG - BOUNDING_BOX - POLYGON - POINT - SPAN - MASK default: ANNOTATION_DATA_TYPE_NOT_SET apiUploadContentPart: type: object properties: range_start: type: string format: uint64 part_number: type: string format: int64 data: type: string format: byte V2PostPipelinesBody: type: object properties: user_app_id: type: object description: Common message to identify the app in a url endpoint. pipelines: type: array items: type: object $ref: '#/components/schemas/apiPipeline' apiTaskReview: type: object properties: strategy: $ref: '#/components/schemas/TaskReviewTaskReviewStrategy' description: Task review strategy. user_ids: type: array items: type: string description: 'Who will review this task. DEPRECATED: Use users.id instead.' users: type: array items: type: object $ref: '#/components/schemas/apiUser' description: 'Users who will review this task. When the ''review.users'' field is additionally requested, then all user info is filled for the reviewers. Otherwise, only the user ''id'' is filled.' manual_strategy_info: $ref: '#/components/schemas/apiTaskReviewManualStrategyInfo' consensus_strategy_info: $ref: '#/components/schemas/apiTaskReviewConsensusStrategyInfo' title: TaskReview apiSingleConceptLanguageResponse: type: object properties: status: $ref: '#/components/schemas/apistatusStatus' concept_language: $ref: '#/components/schemas/apiConceptLanguage' title: SingleConceptLanguageResponse apiMultiCollaborationsResponse: type: object properties: status: $ref: '#/components/schemas/apistatusStatus' collaborations: type: array items: type: object $ref: '#/components/schemas/apiCollaboration' title: MultiCollaborationsResponse MatrixDataTimeSeries: type: object properties: labels: type: array items: type: object $ref: '#/components/schemas/apiMetricDataLabel' value: type: array items: type: object $ref: '#/components/schemas/MetricDataMetricSample' V2PostSearchesBody: type: object properties: user_app_id: type: object description: The user_id and app_id to query from. title: The user_id and app_id to query from. query: $ref: '#/components/schemas/apiQuery' title: 'The query; this specifies how the data to be searched this will be replaced by "Searches"' searches: type: array items: type: object $ref: '#/components/schemas/apiSearch' title: 'The searched to be executed or saved Eventually the request level fields will be deprecated in favor of this object' pagination: $ref: '#/components/schemas/apiPagination' description: Pagination information to paginate through search result Hits. title: PostSearchesRequest V2PostAppsSearchesBody: type: object properties: user_app_id: type: object properties: app_id: type: string description: Common message to identify the app in a url endpoint. app_query: $ref: '#/components/schemas/apiAppQuery' description: The body of the request. pagination: $ref: '#/components/schemas/apiPagination' description: 'Pagination parameters here since there are no url args in this POST request.' description: Search over the available applications. apiTrainInfo: type: object properties: params: type: object description: 'To control the training process when PostModelVersions is used we allow a list of parameters defined for each ModelType as a Struct (JSON object) here. During training, the settings contained within are sent to the training processor to alter the training process.' dataset: $ref: '#/components/schemas/apiDataset' title: The dataset and dataset version this model version was or will be trained on resume_from_model: $ref: '#/components/schemas/apiModel' description: The model to resume training from. V2PatchModelLanguagesBody: type: object properties: user_app_id: $ref: '#/components/schemas/apiUserAppIDSet' languages: type: array items: type: string action: type: string title: Only overwrite supported apiMultiListWorkflowVersionEvaluationDataResponse: type: object properties: status: $ref: '#/components/schemas/apistatusStatus' workflow_version_evaluation_data: type: array items: type: object $ref: '#/components/schemas/apiWorkflowVersionEvaluationData' apiDatasetVersionMetrics: type: object properties: inputs_count: type: string format: uint64 title: Number of inputs unlabeled_inputs_count: type: string format: uint64 description: 'Number of unlabeled inputs An input is considered unlabeled if it there are no annotations with positive labels for that input.' inputs_with_metadata_count: type: string format: uint64 title: Number of inputs that have metadata inputs_with_geo_count: type: string format: uint64 title: Number of inputs that have geo information regions_count: type: string format: uint64 title: Number of regions region_location_matrix: $ref: '#/components/schemas/MatrixUint64' title: 'The matrix shows where the regions are located. Example: If the matrix has 2x2 dimensions, then * region_location_matrix[0][0] = the number of regions that appear in the top left corner, i.e. [0,0]..(0.5,0.5) * region_location_matrix[0][1] = the number of regions that appear in the top right corner, i.e. [0,0.5]..[0.5,1] * region_location_matrix[1][0] = the number of regions that appear in the bottom left corner, i.e. [0.5,0]..[1,0.5) * region_location_matrix[1][1] = the number of regions that appear in the bottom right corner, i.e. [0.5,0.5]..[1,1]' bounding_boxes_count: type: string format: uint64 title: Number of bounding boxes polygons_count: type: string format: uint64 title: Number of polygons points_count: type: string format: uint64 title: Number of points masks_count: type: string format: uint64 title: Number of masks region_inputs_count: type: string format: uint64 description: 'Number of inputs that have regions attached Note that this is not a recursive count: if an input contains frames that contains regions, then the region_frames_count is increased, but region_inputs_count is not increased.' region_frames_count: type: string format: uint64 title: Number of frames that have regions attached frames_count: type: string format: uint64 title: Number of frames frame_inputs_count: type: string format: uint64 title: Number of inputs that have frames attached embeddings_count: type: string format: uint64 title: Number of embeddings positive_input_tags_count: type: string format: uint64 title: Number of positive tags added at input-level positive_region_tags_count: type: string format: uint64 title: Number of positive tags added at region-level positive_frame_tags_count: type: string format: uint64 title: Number of positive tags added at frame-level apiConceptLanguage: type: object properties: id: type: string description: This is the language code for the language such as "en". name: type: string description: The type of the outside source. definition: type: string description: The ID that is referenced in the source. description: 'This represents a link to an outside source for the given concept. The values from here are sticked into Concept message into the name and definition fields when returning from the API in your default language. The "id" field here becomes the "language" field of the Concept message which is a little weird.' apiSingleUserResponse: type: object properties: status: $ref: '#/components/schemas/apistatusStatus' user: $ref: '#/components/schemas/apiUser' title: SingleUserResponse V2DeleteNodepoolsBody: type: object properties: user_app_id: type: object properties: app_id: type: string description: Only the user_id is used from this. title: Only the user_id is used from this. ids: type: array items: type: string title: List of nodepool ids to be deleted apiBookmarkOrigin: type: object properties: id: type: string title: original resource id app_id: type: string title: original resource app id user_id: type: string title: original resource user id resource_type: $ref: '#/components/schemas/BookmarkOriginBookmarkType' description: resource type. V2PatchRunnersBody: type: object properties: user_app_id: type: object properties: app_id: type: string description: Common message to identify the app in a url endpoint. runners: type: array items: type: object $ref: '#/components/schemas/apiRunner' description: This allows you to create one or more runner by posting it to the API. action: type: string title: 'The action to perform on the patched objects For now actions ''merge'', ''overwrite'', and ''remove'' are supported' title: PatchRunnersRequest apiWorkflowEvaluationResult: type: object properties: summary: $ref: '#/components/schemas/apiWorkflowEvaluationResultSummary' description: The summary of the evaluation result. apiKnowledgeGraph: type: object properties: id: type: string title: ID of the knowledge graph name: type: string title: Name of the knowledge graph description: type: string title: Human readable description of the knowledge graph examples_app_id: type: string title: The app that contains the images that correspond to the concepts in the knowledge graph sampled_examples_app_id: type: string title: The app that contains the sample images that we want to show the customer for the concepts in the knowledge graph title: A Knowledge Graph is a logical subsets of edges in the overall Concept Graph apiSingleBulkOperationsResponse: type: object properties: status: $ref: '#/components/schemas/apistatusStatus' bulk_operation: $ref: '#/components/schemas/apiBulkOperation' title: SingleBulkOperationsResponse apiKeypointInfo: type: object properties: keypoint_names: type: array items: type: string title: Names of the keypoints skeleton: type: array items: type: object $ref: '#/components/schemas/apiKeypointEdge' description: Defines the connections between keypoint_names. Each value represents the index in keypoint_names. apiSingleModelTypeResponse: type: object properties: status: $ref: '#/components/schemas/apistatusStatus' description: Status of the response. model_type: $ref: '#/components/schemas/apiModelType' description: The retrieved ModelType object. . title: SingleModelTypeResponse apiAnd: type: object properties: input: $ref: '#/components/schemas/apiInput' title: "FILTER by input.data... information.\nThis can include human provided concepts, geo location info, metadata, etc.\nThis is effectively searching over only the trusted annotation attached to an input in your\napp. To search by more specific annotation fields use the Annotation object here.\n########## Supported fields ##########\n - data.concepts[].id\n - data.concepts[].name\n - data.concepts[].value\n - data.geo.geo_box[].geo_point.latitude\n - data.geo.geo_box[].geo_point.longitude\n - data.geo.geo_limit.type\n - data.geo.geo_limit.value\n - data.geo.geo_point.latitude\n - data.geo.geo_point.longitude\n - data.image.url\n - data.metadata.fields - filter by metadata. metadata key&value fields are OR-ed.\n - dataset_ids[] - filter by dataset IDs\n - id - filter by input ID\n - status.code - filter by input status" output: $ref: '#/components/schemas/apiOutput' description: "RANK based predicted outputs from models such as custom trained models, pre-trained models,\netc. This is also where you enter the image url for a visual search because what we're asking\nthe system to do is find output embedding most visually similar to the provided input (that\ninput being in And.output.input.data.image.url for example). This will return the Hits\nsorted by visual similarity (1.0 being very similar or exact match and 0.0 being very\ndissimlar). For a search by Output concept, this means we're asking the system to rank\nthe Hits by confidence of our model's predicted Outputs. So for example if the model\npredicts an image is 0.95 likely there is a \"dog\" present, that should related directly\nto the score returned if you search for Output concept \"dog\" in your query. This provides\na natural ranking to search results based on confidence of predictions from the models and\nis used when ANDing multiple of these types of RANK by Output queries together as well.\n\n########## Supported fields ##########\n - data.clusters[].id\n - data.concepts[].id\n - data.concepts[].name\n - data.concepts[].value\n - input.data.image.base64[]\n - input.data.image.url\n - input.id" negate: type: boolean title: 'If True then this will flip the meaning of this part of the query. This allow for queries such as dog AND ! metadata=={"blah":"value"}' annotation: $ref: '#/components/schemas/clarifaiapiAnnotation' description: "FILTER by annotation information. This is more flexible than just filtering by\nInput information because in the general case each input can have several annotations.\nSome example use cases for filtering by annotations:\n1) find all the inputs annotated \"dog\" by worker_id = \"XYZ\"\n2) find all the annotations associated with embed_model_version_id = \"123\"\n3) find all the annotations that are trusted, etc.\n\nSince all the annotations under the hood are joined to the embedding model's annotation\nusing worker_id's of other models like cluster models or concept models should be\ncombinable with queries like visual search (a query with Output filled in).\n\n########## Supported fields ##########\n - annotation_info.fields - filter by annotation info\n - data.concepts[].id\n - data.concepts[].name\n - data.concepts[].value\n - data.geo.geo_box[].geo_point.latitude\n - data.geo.geo_box[].geo_point.longitude\n - data.geo.geo_limit.type\n - data.geo.geo_limit.value\n - data.geo.geo_point.latitude\n - data.geo.geo_point.longitude\n - data.image.url\n - data.metadata.fields - filter by metadata. metadata key&value fields are OR-ed.\n - input_id\n - input_level\n - model_version_id\n - status.code\n - task_id\n - trusted\n - user_id" description: 'This is the common building block of a query which is a sequence of And messages ANDed together. Note that some fields are used too RANK results (affect the scores) and some are used to FILTER results (unordered subset of your app''s contents). In general, FILTER operations are more efficient queries at scale and when combined with RANK operations can speed up search performance as you effectively operate on a smaller sub-set of your entire app.' apiSecret: type: object properties: id: type: string title: The name of the secret, corresponds to id in model_version.output_info.params.secrets user_id: type: string description: The user the secret belongs to. value: type: string description: The value of the secret. version: type: integer format: int64 description: The version of the secret. description: type: string description: The description of the secret. created_at: type: string format: date-time description: When the secret was created. modified_at: type: string format: date-time description: When the secret was last modified. expires_at: type: string format: date-time description: When the secret will expire. apiSingleModelResponse: type: object properties: status: $ref: '#/components/schemas/apistatusStatus' model: $ref: '#/components/schemas/apiModel' workflow_count: type: integer format: int32 title: SingleModelResponse V2PostModelsSearchesBody: type: object properties: user_app_id: type: object description: Ids present in the url of the request. title: Ids present in the url of the request. model_query: $ref: '#/components/schemas/apiModelQuery' description: The body of the request. pagination: $ref: '#/components/schemas/apiPagination' description: 'Pagination parameters here since there are no url args in this POST request.' description: Search over the available models. V2PostComputeClustersBody: type: object properties: user_app_id: type: object properties: app_id: type: string description: Only the user_id is used from this. title: Only the user_id is used from this. compute_clusters: type: array items: type: object $ref: '#/components/schemas/apiComputeCluster' description: This allows you to create one or more compute_clusters by posting it to the API. AppEmbeddingsStorage: type: string enum: - EMBEDDING_STORAGE_NOT_SET - POSTGRES - QDRANT default: EMBEDDING_STORAGE_NOT_SET V2PatchDatasetVersionsBody: type: object properties: user_app_id: $ref: '#/components/schemas/apiUserAppIDSet' dataset_versions: type: array items: type: object $ref: '#/components/schemas/apiDatasetVersion' description: List of dataset versions that are requested to be updated. action: type: string title: 'The action to perform on the patched objects For now, only ''overwrite'' action is supported' description: Request to patch several dataset versions. apiSpan: type: object properties: char_start: type: integer format: int64 char_end: type: integer format: int64 raw_text: type: string apiPipelineStepVersion: type: object properties: id: type: string description: The ID of the pipeline step version. user_id: type: string title: The user the pipeline step version belongs to app_id: type: string title: The app the pipeline step version belongs to description: type: string title: Description of the pipeline step version pipeline_step: $ref: '#/components/schemas/apiPipelineStep' title: Pipeline Step orchestration_step_spec: $ref: '#/components/schemas/apiOrchestrationStepSpec' title: Orchestration Step Specification using oneof pipeline_step_input_params: type: array items: type: object $ref: '#/components/schemas/apiPipelineStepInputParam' title: The pipeline step version input parameters status: $ref: '#/components/schemas/apistatusStatus' title: Pipeline step Status - Created, Building Artifacts, Completed, Failed pipeline_step_compute_info: $ref: '#/components/schemas/apiComputeInfo' title: The minimum required compute resource to run the pipeline step as part of a Pipeline build_info: $ref: '#/components/schemas/apiBuildInfo' title: Build information for the pipeline step visibility: $ref: '#/components/schemas/clarifaiapiVisibility' description: 'The visibility field represents whether this is privately/publicly visible. To be visible to the public the App that contains it AND the User that contains the App must also be publicly visible.' created_at: type: string format: date-time title: When the pipeline step was created modified_at: type: string format: date-time title: When the pipeline step was last modified apiWorkflowVersionPublishRequest: type: object properties: version_id: type: string apiSingleInputsAddJobResponse: type: object properties: status: $ref: '#/components/schemas/apistatusStatus' inputs_add_job: $ref: '#/components/schemas/apiInputsAddJob' title: SingleInputsAddJobResponse V2PostSecretsBody: type: object properties: user_app_id: type: object properties: app_id: type: string description: Common message to identify the app in a url endpoint. secrets: type: array items: type: object $ref: '#/components/schemas/apiSecret' title: The secrets to create apiIdUpdateSource: type: object properties: id: type: string title: old id new_id: type: string title: new id apiMetricSearchQuery: type: object properties: metric_type: $ref: '#/components/schemas/apiMetricType' start_time: type: string format: date-time title: start time of the search window end_time: type: string format: date-time title: end time of the search window resolution: type: string title: duration string https://pkg.go.dev/time#ParseDuration filters: type: array items: type: object $ref: '#/components/schemas/apiMetricFilter' title: ANDed aggregate: $ref: '#/components/schemas/apiMetricAggregate' apiRank: type: object properties: negate: type: boolean title: 'If True then this will flip the meaning of this part of the query. This allow for queries such as !dog' annotation: $ref: '#/components/schemas/clarifaiapiAnnotation' title: "RANK by annotation information.\n########## Supported fields ##########\n - data.concepts[].id\n - data.concepts[].name\n - data.concepts[].value\n - data.embeddings[].num_dimensions\n - data.embeddings[].vector[]\n - data.image.base64[]\n - data.image.url\n - data.text.raw\n - input_id\n - model_version_id" title: Rank V2PostModelVersionMetricsBody: type: object properties: user_app_id: $ref: '#/components/schemas/apiUserAppIDSet' test_search: $ref: '#/components/schemas/apiSearch' title: Use this to filter inputs that are used in evaluation eval_info: $ref: '#/components/schemas/apiEvalInfo' description: evaluation info. Such as dataset used for evaluation. description: Evaluate this model version. apiMultiScopeUserResponse: type: object properties: status: $ref: '#/components/schemas/apistatusStatus' description: The status of the request. scopes: type: array items: type: string description: This is a list of the scopes that your key has. endpoints: type: array items: type: string description: This is a list of endpoint permissions that your key has. user_feature_flags: type: string title: MultiScopeUserResponse apiMultiConceptResponse: type: object properties: status: $ref: '#/components/schemas/apistatusStatus' description: The response status. concepts: type: array items: type: object $ref: '#/components/schemas/apiConcept' description: The returned concepts. title: MultiConceptResponse V2DeleteArtifactBody: type: object properties: user_app_id: type: object description: Common message to identify the app in a url endpoint. artifact_id: type: string title: The id of the artifact to be deleted apiFilter: type: object properties: negate: type: boolean title: 'If True then this will flip the meaning of this part of the query. This allow for queries such as dog AND ! metadata=={"blah":"value"}' annotation: $ref: '#/components/schemas/clarifaiapiAnnotation' description: "# Filter by worker fields such as model, workflow and user IDs\n - worker.model.model_version.id\n - worker.user.id\n - worker.workflow.version.id\n\n # Filter by other top-level fields\n - annotation_info.fields - filter by annotation info\n - input_level - filter only input-level annotations\n - status.code - filter by annotation status code\n - trusted - filter only trusted annotations\n\n # Filter by space-time info fields, i.e. region, frames and time-segments\n - data - filter only annotations without space-time info, e.g. classifications\n - in order to enable this, you need to set the field to an empty object, i.e. `{\"data\": {}}`\n - data.frames[].frame_info - filter only frame annotations\n - in order to enable this, you need to set the field to an empty object, i.e. `{\"data\": {\"frames\": [{\"frame_info\": {}}]}}`\n - data.regions[].region_info.bounding_box - filter only bounding box annotations\n - in order to enable this, you need to set the field to an empty object, i.e. `{\"data\": {\"regions\": [{\"region_info\": {\"bounding_box\":{}}}]}}`\n - data.regions[].region_info.mask - filter only mask annotations\n - in order to enable this, you need to set the field to an empty object, i.e. `{\"data\": {\"regions\": [{\"region_info\": {\"mask\":{}}}]}}`\n - data.regions[].region_info.point - filter only point annotations\n - in order to enable this, you need to set the field to an empty object, i.e. `{\"data\": {\"regions\": [{\"region_info\": {\"point\":{}}}]}}`\n - data.regions[].region_info.polygon - filter only polygon annotations\n - in order to enable this, you need to set the field to an empty object, i.e. `{\"data\": {\"regions\": [{\"region_info\": {\"polygon\":{}}}]}}`\n - data.regions[].region_info.span - filter only span annotations\n - in order to enable this, you need to set the field to an empty object, i.e. `{\"data\": {\"regions\": [{\"region_info\": {\"span\":{}}}]}}`\n - data.regions[].track_id - filter annotations by track_id\n - in order to enable this, you need to provide \"track_id_value\" i.e. `{\"data\": {\"regions\": [{\"track_id\" : \"track_id_value\"}]}}`\n - data.time_segments[].time_info - filter only time-segment annotations\n - in order to enable this, you need to set the field to an empty object, i.e. `{\"data\": {\"time_segments\": [{\"time_info\": {}}]}}`\n\n # Filter by other data fields\n - data.clusters[].id\n - data.concepts[].id\n - data.concepts[].name\n - data.concepts[].value\n - data.geo.geo_box[].geo_point.latitude\n - data.geo.geo_box[].geo_point.longitude\n - data.geo.geo_limit.type\n - data.geo.geo_limit.value\n - data.geo.geo_point.latitude\n - data.geo.geo_point.longitude\n - data.metadata.fields - filter by metadata\n - Important to note: metadata key&value fields are OR-ed.\n - example with 1 metadata key: searching by\n `{\n ` \"data\": {\n ` \"metadata\": {\n ` \"fields\": {\n ` \"foo\": {\n ` \"string_value\": \"bar\"\n ` },\n ` }\n ` }\n ` }\n `}\n will result in a search condition like `metadata includes {\"foo\": \"bar}`;\n - example with 2 metadata keys: searching by\n `{\n ` \"data\": {\n ` \"metadata\": {\n ` \"fields\": {\n ` \"foo1\": {\n ` \"string_value\": \"bar2\"\n ` },\n ` \"foo2\": {\n ` \"string_value\": \"bar2\"\n ` }\n ` }\n ` }\n ` }\n `}\n will result in a search condition like `(metadata includes {\"foo1\": \"bar1\"}) OR (metadata includes {\"foo2\": \"bar2\"})`.\n - data.text - filter only text annotations\n - in order to enable this, you need to set the field to an empty object, i.e. `{\"data\": {\"text\": {}}}`" title: "FILTER by annotation information.\n########## Supported fields ##########\n # Filter by ID fields\n - id - example: `{\"id\": \"xyz\"}`\n - input_id\n - model_version_id\n - task_id\n - user_id" input: $ref: '#/components/schemas/apiInput' title: "FILTER by input information.\n########## Supported fields ##########\n - data.audio - filter only audio inputs\n - in order to enable this, you need to set the field to an empty object, i.e. `{\"audio\": {}}`\n - data.image - filter only image inputs\n - enable using `{\"image\": {}}`\n - data.text - filter only text inputs\n - enable using `{\"text\": {}}`\n - data.video - filter only video inputs\n - enable using `{\"video\": {}}`\n - dataset_ids[] - filter by dataset IDs\n - example: `{\"dataset_ids\": [\"d1\", \"d2\"]}` will filter for inputs in d1 OR d2\n - status.code - filter by input status\n - example: `{\"status\": {\"code\": 30000}}` to filter only for SUCCESS inputs" last_updated_time_range: $ref: '#/components/schemas/apiTimeRange' description: Filter by annotation last updated time range. title: Filter apiInputEvaluationMetricValue: type: object properties: evaluation_metric_id: type: string title: The metric values metric_value: $ref: '#/components/schemas/apiMetricValue' title: Aggregated metric value explanation: type: string title: explanation for the value per_region_values: type: object additionalProperties: $ref: '#/components/schemas/apiMetricValue' title: Metric values for each region V2DeleteDatasetInputsBody: type: object properties: user_app_id: $ref: '#/components/schemas/apiUserAppIDSet' input_ids: type: array items: type: string description: Specify which inputs to delete from dataset. description: Request to delete several dataset inputs by list of ids. apiRegionInfo: type: object properties: bounding_box: $ref: '#/components/schemas/apiBoundingBox' description: Details of the region's rectangular bounding box. mask: $ref: '#/components/schemas/apiMask' description: Details of the region's segmentation mask. polygon: $ref: '#/components/schemas/apiPolygon' description: A polygon of points. point: $ref: '#/components/schemas/apiPoint' description: A landmark point location. span: $ref: '#/components/schemas/apiSpan' description: Span char sequence for NLP. token: $ref: '#/components/schemas/apiToken' description: Token char sequence for NLP. keypoint_locations: type: array items: type: object $ref: '#/components/schemas/apiPoint' description: 'The locations of detected keypoints, which are to be used in conjunction with the detected concept''s skeleton to connect the keypoint locations. These will be in the same order as the respective keypoint_names inside the concept.' description: The information of the location of the Region. V2PatchAnnotationFiltersBody: type: object properties: user_app_id: type: object description: Common message to identify the app in a url endpoint. annotation_filters: type: array items: type: object $ref: '#/components/schemas/apiAnnotationFilter' description: List of annotation filters that are requested to be updated. action: type: string title: 'The action to perform on the patched objects For now, only ''overwrite'' action is supported' description: Request to patch several annotation filters. V2PostWorkflowVersionEvaluationDataBody: type: object properties: user_app_id: $ref: '#/components/schemas/apiUserAppIDSet' workflow_id: type: string workflow_version_id: type: string workflow_version_evaluation_data: type: array items: type: object $ref: '#/components/schemas/apiWorkflowVersionEvaluationData' title: '########## Supported fields ########## - id - workflow_evaluation_sample_result' apiCloudProvider: type: object properties: id: type: string description: Unique identifier of the cloud provider. name: type: string description: Name of the cloud provider. special_handling: type: array items: type: object $ref: '#/components/schemas/apiSpecialHandling' description: List of special handling instructions for this cloud provider. description: 'CloudProvider represents the entity that provides the infrastructure where the Nodepools are deployed. This could be a public cloud provider like AWS, GCP, Azure, etc., or a self-hosted infrastructure.' apiInputIDs: type: object properties: input_ids: type: array items: type: string apiTrackerMetrics: type: object properties: mot_mota: type: number format: float title: Multiple object tracking accuracy mot_num_switches: type: integer format: int32 title: Number of switches between tracks morse_frag: type: number format: float title: MORSE fragmentation rate (a.k.a unique switch rate, only calculated in public sector) avg_precision: type: number format: float title: Average precision calculated from all processed frames aiid: type: string title: The concept that we are evaluating the tracker unique_switch_rate: type: number format: float title: Same as morse_frag but calculated using MOT mapping/metrics title: TrackerMetrics apiInputsAddJobProgress: type: object properties: pending_count: type: string format: uint64 in_progress_count: type: string format: uint64 success_count: type: string format: uint64 failed_count: type: string format: uint64 V2PostWorkflowResultsBody: type: object properties: user_app_id: $ref: '#/components/schemas/apiUserAppIDSet' version_id: type: string title: 'Workflow version ID to retrieve If no ID is specified, latest workflow version is used' inputs: type: array items: type: object $ref: '#/components/schemas/apiInput' output_config: $ref: '#/components/schemas/apiOutputConfig' description: 'FIXME(zeiler): the request for post workflows is using an outputconfig object that is supposed to be within models. This is not consistent with setting this on the request for post model outputs where it is inside a model object. To make this consistent we would send in the workflow object so that each model can have it''s own output config. If nobody is setting this OutputConfig it would probably be easier to just remove it for now to keep things simpler and then it''s more consistent we just don''t support the OutputConfig on workflows.' favor_clarifai_workflows: type: boolean description: '@exclude TODO (EAGLE-4447): Remove unused fields' title: Use this flag to look into clarifai published workflows first for a Workflow ID workflow_state: $ref: '#/components/schemas/apiWorkflowState' description: 'A workflow state to be maintained across PostWorkflowResults requests/responses. If it is not sent in the initial request with workflow_state.id = "init" then no state will be saved or returned in PostWorkflowResultsResponse.' node_runner_selectors: type: object additionalProperties: $ref: '#/components/schemas/apiRunnerSelector' description: 'Specify which compute to use for processing each node of the workflow: The key is the node.id from the loaded workflow. The value is a RunnerSelector in which you can specify the deployment or specific nodepool that you''d like that node to run on. This allows for use cases like some light models could run on a CPU-only nodepool while other models in the workflow require large GPUs. If node.id is not in the provided map, it will fall back to searching for an adequate deployment the model owner owns or fall back to the shared nodepools provided by Clarifai. We recommend you specify these RunnerSelectors so that you have better understanding of where processing occurs.' title: PostWorkflowResultsRequest apiSingleWorkflowResponse: type: object properties: status: $ref: '#/components/schemas/apistatusStatus' workflow: $ref: '#/components/schemas/apiWorkflow' title: SingleWorkflowResponse apiMultiArtifactVersionResponse: type: object properties: status: $ref: '#/components/schemas/apistatusStatus' title: The status of the request artifact_versions: type: array items: type: object $ref: '#/components/schemas/apiArtifactVersion' title: The artifact versions that were requested apiNodepoolDeploymentMetrics: type: object properties: compute_cluster_id: type: string description: The user-facing compute cluster ID. nodepool_id: type: string description: The user-facing nodepool ID. metrics: $ref: '#/components/schemas/apiDeploymentMetricsSummary' description: Metrics for this nodepool. description: NodepoolDeploymentMetrics captures metrics for a single nodepool within a Deployment. apiSingleModelVersionInputExampleResponse: type: object properties: status: $ref: '#/components/schemas/apistatusStatus' title: status of response model_version_input_example: $ref: '#/components/schemas/apiModelVersionInputExample' title: model input example message title: SingleModelVersionInputExampleResponse apiMultiRunnerItemOutputResponse: type: object properties: status: $ref: '#/components/schemas/apistatusStatus' runner_item_outputs: type: array items: type: object $ref: '#/components/schemas/apiRunnerItemOutput' V2DeleteDatasetsBody: type: object properties: user_app_id: type: object description: Common message to identify the app in a url endpoint. dataset_ids: type: array items: type: string description: Request to delete several datasets by list of ids. apiMask: type: object properties: image: $ref: '#/components/schemas/apiImage' description: The image of the mask in a non-raster format. description: Segmentation mask. apiModelVersionInputExample: type: object properties: id: type: string title: user unique id model_id: type: string title: external id of model model_version_id: type: string title: external id of model version data: $ref: '#/components/schemas/apiData' title: data to store as example input for model name: type: string title: name of link for display description: type: string title: description of link contents title: ModelVersionInputExample apiPasswordViolations: type: object properties: minimum_length: type: boolean title: when new password length is shorter than minimum length set maximum_length: type: boolean title: when new password length is longer than maximum length set upper_case_needed: type: boolean title: there is no upper case letter in the new password when there should be at least one lower_case_needed: type: boolean title: there is no lower case letter in the new password when there should be at least one numeric_needed: type: boolean title: there is no numerics in the new password when there should be at least one non_alphanumeric_needed: type: boolean title: there is no special character in the new password when there should be at least one password_reuse: type: boolean title: when one of the N most recent old password is reused, N is specified by password_reuse_epoch in db.password_policies exclude_names: type: boolean title: when either user's first, middle or last name is used in the new password exclude_email: type: boolean title: when first part of user's email (exact string or after removing special characters) is used in the new password no_confusing_letters: type: boolean title: when there are confusing letters in the new password, such as o (first character of 'omega') vs 0 (zero) no_simple_passwords: type: boolean title: when there are simple password patterns used, such as 12345678 or aaaaaaa1 no_common_vocabs: type: boolean title: when there are common vocabs from the common vocab list used no_overlap_with_old: type: boolean title: when the current password is contained in the new password or vice versa password_lifespan: type: boolean title: when password has to be changed becauase it's too old title: PasswordViolations apiAppResourceCounts: type: object properties: datasets: type: string format: int64 models: type: string format: int64 workflows: type: string format: int64 inputs: type: string format: int64 pipelines: type: string format: int64 apiHitCount: type: object properties: estimated_total: type: string format: uint64 description: The estimated total number of hits for the search query, not just the current page. apiInputCount: type: object properties: processed: type: integer format: int64 to_process: type: integer format: int64 errors: type: integer format: int64 processing: type: integer format: int64 reindexed: type: integer format: int64 to_reindex: type: integer format: int64 reindex_errors: type: integer format: int64 reindexing: type: integer format: int64 description: 'NOTE: inconsistency: this is weird mix of plural and singular words.' apiArgoArgsOverride: type: object properties: parameters: type: array items: type: object $ref: '#/components/schemas/apiArgoParameterOverride' apiMetricsSummary: type: object properties: top1_accuracy: type: number format: float top5_accuracy: type: number format: float macro_avg_roc_auc: type: number format: float macro_std_roc_auc: type: number format: float macro_avg_f1_score: type: number format: float macro_std_f1_score: type: number format: float macro_avg_precision: type: number format: float macro_avg_recall: type: number format: float mean_avg_precision_iou_50: type: number format: float mean_avg_precision_iou_range: type: number format: float title: MetricsSummary apiConceptExtraInfo: type: object properties: is_rankable: type: boolean description: Whether this concept is rankable based on ConceptExtraInfoRequest configuration. description: 'ConceptExtraInfo represents extra information related to a concept that is context-dependent. It is only set when requested in ConceptExtraInfoRequest.' apiEvalInfo: type: object properties: params: type: object description: 'To control the evaluation process. Allow a list of parameters.' apiInputsExtractionJobProgress: type: object properties: audio_inputs_count: type: string format: uint64 image_inputs_count: type: string format: uint64 video_inputs_count: type: string format: uint64 text_inputs_count: type: string format: uint64 pending_archives_count: type: string format: uint64 in_progress_archives_count: type: string format: uint64 completed_archives_count: type: string format: uint64 failed_archives_count: type: string format: uint64 apiDatasetVersionMetricsGroup: type: object properties: parent_path: type: string type: $ref: '#/components/schemas/apiDatasetVersionMetricsGroupType' value: {} metrics: $ref: '#/components/schemas/apiDatasetVersionMetrics' NodeCapacityTypeCapacityType: type: string enum: - UKNOWN_CAPACITY_TYPE - ON_DEMAND_TYPE - SPOT_TYPE default: UKNOWN_CAPACITY_TYPE apiAppQuery: type: object properties: name: type: string description: Query by application name. This supports wildcard queries like "gen*" to match "general" as an example. title: App query apiDatasetVersionExportInfo: type: object properties: clarifai_data_protobuf: $ref: '#/components/schemas/apiDatasetVersionExport' description: clarifai_data_protobuf is a CLARIFAI_DATA_PROTOBUF export of the dataset version. clarifai_data_json: $ref: '#/components/schemas/apiDatasetVersionExport' description: clarifai_data_json is a CLARIFAI_DATA_JSON export of the dataset version. coco: $ref: '#/components/schemas/apiDatasetVersionExport' description: coco is a COCO export of the dataset version. description: 'DatasetVersionExportInfo contains information about all exports of a dataset version. If the dataset version has not been exported in a format, then the DatasetVersionExport field for that format is empty instead of having a "not exported" status.' V2PostKnowledgeGraphsBody: type: object properties: user_app_id: type: object description: The user_id and app_id information. title: The user_id and app_id information. knowledge_graphs: type: array items: type: object $ref: '#/components/schemas/apiKnowledgeGraph' title: POST new knowledge graphs MatrixUint64: type: object properties: n_cols: type: string format: uint64 title: Number of columns data: type: array items: type: string format: uint64 description: 'Matrix data stored as an array. In order to access matrix element at row i & column j, use data[i*n_cols+j].' description: 'Store matrix of uint64s values. It is recommended to store the matrix as a 1D array because it produces less bytes during serialization than a 2D array. The matrix does store the number of columns, but it does not store the number of rows. The number of rows can automatically be calculated as length(data)/n_cols.' V2PostPipelineVersionRunFromTemplateBody: type: object properties: user_app_id: type: object description: Common message to identify the app in a url endpoint. pipeline_id: type: string title: 'Optional: ID of existing pipeline to create version under' pipeline_description: type: string title: 'Optional: Description for the pipeline (used if creating new pipeline)' pipeline_version_description: type: string title: 'Optional: Description for the pipeline version' nodepools: type: array items: type: object $ref: '#/components/schemas/apiNodepool' title: 'Optional: Nodepools to use for the pipeline version run' input_args_override: $ref: '#/components/schemas/apiOrchestrationArgsOverride' title: 'Optional: Overrides to input arguments for the orchestration system' title: Request to create a Pipeline, PipelineVersion, and PipelineVersionRun from a PipelineTemplate apiAppCopyProgress: type: object properties: field: type: string value: type: integer format: int32 apiAnnotationFilterConfig: type: object properties: annotation_filter: $ref: '#/components/schemas/apiAnnotationFilter' description: The annotation filter that is used. ignore_empty_inputs: type: boolean description: 'If true, empty inputs are not included in the dataset version. If false, empty inputs are included in the dataset version. We define an empty input as an input without any annotations after annotation filter is applied.' apiOperation: type: object properties: add_concepts: $ref: '#/components/schemas/apiAddConcepts' delete_concepts: $ref: '#/components/schemas/apiDeleteConcepts' add_metadata: $ref: '#/components/schemas/apiAddMetadata' delete_metadata: $ref: '#/components/schemas/apiDeleteMetadata' overwrite_geo: $ref: '#/components/schemas/apiOverwriteGeo' delete_geo: $ref: '#/components/schemas/apiDeleteGeo' delete_from_dataset: $ref: '#/components/schemas/apiDeleteFromDataset' add_to_dataset: $ref: '#/components/schemas/apiAddToDataset' split_into_datasets: $ref: '#/components/schemas/apiSplitIntoDatasets' delete_annotations: $ref: '#/components/schemas/clarifaiapiDeleteAnnotations' V2DeleteAnnotationTracksBody: type: object properties: user_app_id: $ref: '#/components/schemas/apiUserAppIDSet' ids: type: array items: type: string title: DeleteAnnotationTracksRequest apiSingleArtifactResponse: type: object properties: status: $ref: '#/components/schemas/apistatusStatus' artifact: $ref: '#/components/schemas/apiArtifact' apiTaskAssignment: type: object properties: id: type: string created_at: type: string format: date-time description: 'Creation time. The format is https://www.ietf.org/rfc/rfc3339.txt. Example: "2006-01-02T15:04:05.999999Z".' modified_at: type: string format: date-time description: 'Most recent modification time. The format is https://www.ietf.org/rfc/rfc3339.txt. Example: "2006-01-02T15:04:05.999999Z".' worker: $ref: '#/components/schemas/apiWorker' description: Assigned worker. input: $ref: '#/components/schemas/apiInput' description: Assigned input. status: $ref: '#/components/schemas/apistatusStatus' description: 'Assignment status. Read as: This is the status of the work assigned to worker W, on input I in task T.' apiDeployRestriction: type: string enum: - USAGE_RESTRICTION_NOT_SET - NO_LIMITS - SHARED_COMPUTE_ONLY - DEDICATED_COMPUTE_ONLY - MODEL_OWNER_DEDICATED_COMPUTE_ONLY default: USAGE_RESTRICTION_NOT_SET description: " - USAGE_RESTRICTION_NOT_SET: Default uninitialized state.\n - NO_LIMITS: No restrictions on usage.\n - SHARED_COMPUTE_ONLY: Model can only be used on shared compute resources.\n - DEDICATED_COMPUTE_ONLY: Model can only be used on dedicated compute resources.\n - MODEL_OWNER_DEDICATED_COMPUTE_ONLY: Model can only be used on dedicated compute resources owned by the model owner." V2PostTasksBody: type: object properties: user_app_id: type: object description: Common message to identify the app in a url endpoint. tasks: type: array items: type: object $ref: '#/components/schemas/apiTask' description: Request to create Tasks. apiSingleWorkflowVersionResponse: type: object properties: status: $ref: '#/components/schemas/apistatusStatus' workflow_version: $ref: '#/components/schemas/apiWorkflowVersion' title: SingleWorkflowVersionResponse WorkflowVersionEvaluationMetricVisualisationType: type: string enum: - VISUALIZATION_TYPE_NOT_SET - CONFUSION_MATRIX - PRECISION_RECALL_CURVE - ROC_AUC_CURVE default: VISUALIZATION_TYPE_NOT_SET title: Enum for visualization types V2PostUploadsBody: type: object properties: user_app_id: type: object description: Common message to identify the app in a url endpoint. uploads: type: array items: type: object $ref: '#/components/schemas/apiUpload' title: Start a multipart upload TaskTaskPriority: type: string enum: - TASK_PRIORITY_NOT_SET - LOW - MEDIUM - HIGH default: TASK_PRIORITY_NOT_SET apiTrack: type: object properties: id: type: string title: track id data: $ref: '#/components/schemas/apiData' description: 'This is a recursive definition which can contain all the concepts, embeddings, etc. that are computed within this track.' time_info: $ref: '#/components/schemas/apiTimeInfo' quality: type: number format: float title: Track proto encodes information of a track over a number of frames apiAddToDataset: type: object properties: dataset_id: type: string apiMultiBulkOperationsResponse: type: object properties: status: $ref: '#/components/schemas/apistatusStatus' bulk_operation: type: array items: type: object $ref: '#/components/schemas/apiBulkOperation' title: MultiBulkOperationsResponse VisibilityGettable: type: string enum: - UNKNOWN_VISIBILITY - PRIVATE - ORG - PUBLIC default: UNKNOWN_VISIBILITY description: "Gettable defined the level of access for GET operations for this resource.\n\n - UNKNOWN_VISIBILITY: Default value not allowed.\n - PRIVATE: PRIVATE requires collaborator or team permissions in order to GET this resource.\n - ORG: ORG requires you to be in the same org in order to GET this resource, but don't have to be a\nteammate or collaborator.\n - PUBLIC: PUBLIC opens up GET access to the resource to any user on the platform even if they are not\na teammate or collaborator." apiArgoOrchestrationStepSpec: type: object properties: api_version: type: string title: 'The API version of the orchestration W. Example: "argoproj.io/v1alpha1", "argoproj.io/v1beta1"' spec_json: type: string title: The JSON representation of the Argo Workflow Template apiCommitmentValue: type: object properties: value: type: integer format: int32 title: The commitment value, in cents type: $ref: '#/components/schemas/CommitmentValueCommitmentType' title: The commitment type, can be either 'monthly' or 'annual' title: Commitment Value - used to track users' commitment amount and type MetricFilterMultiValues: type: object properties: in: type: array items: type: string apiMultiWorkflowVersionResponse: type: object properties: status: $ref: '#/components/schemas/apistatusStatus' workflow_versions: type: array items: type: object $ref: '#/components/schemas/apiWorkflowVersion' title: MultiWorkflowVersionResponse V2PutUploadContentPartsBody: type: object properties: user_app_id: type: object description: Common message to identify the app in a url endpoint. content_parts: type: array items: type: object $ref: '#/components/schemas/apiUploadContentPart' description: 'Upload a part of a multipart upload. Behaviour on completion depends on the endpoint that was used to initiate the upload.' V2PostNodepoolStatusBody: type: object properties: user_app_id: type: object properties: app_id: type: string description: Common message to identify the app in a url endpoint. status: $ref: '#/components/schemas/NodepoolNodepoolStatus' description: New status of the nodepool. status_description: type: string description: Human-readable status description. Contains error details when status is NODEPOOL_STATUS_ERROR. SplitIntoDatasetsDatasetSplitMethod: type: string enum: - NOT_SET - RANDOM_PERCENTAGE_SPLIT default: NOT_SET title: '- RANDOM_PERCENTAGE_SPLIT: We will randomly split inputs into the datasets' apiVideoInfo: type: object properties: width: type: integer format: int32 title: width height: type: integer format: int32 title: height fps: type: number format: float description: Frames per second of the video. video_format: type: string title: video format bit_rate: type: integer format: int32 title: video track bit rate frame_count: type: integer format: int32 title: video frame count duration_seconds: type: number format: float title: video duration in seconds apiSingleComputeClusterResponse: type: object properties: status: $ref: '#/components/schemas/apistatusStatus' compute_cluster: $ref: '#/components/schemas/apiComputeCluster' apiMultiModelToolkitResponse: type: object properties: status: $ref: '#/components/schemas/apistatusStatus' toolkits: type: array items: type: string apiAuditLogQuery: type: object properties: timestamp_from: type: string format: date-time description: Query operations within this time range. timestamp_to: type: string format: date-time user_ids: type: array items: type: string description: Query operations by these users. operations: type: array items: $ref: '#/components/schemas/apiEventType' description: Query these types of operations. targets: type: array items: type: object $ref: '#/components/schemas/apiAuditLogTarget' description: Query operations with these targets. success: type: boolean description: Query operations by success. source_ips: type: array items: type: string description: Query operations by source IP address. description: AuditLogQuery is a query for audit log entries. apiTaskConceptAutoAnnotationConfig: type: object properties: annotation_data_types: type: integer format: int64 description: 'Filter annotations by their annotation data type. This is a bit-mask field that holds multiple AnnotationDataType values that are combined in an OR fashion. Example: if annotation_data_types = 34, then we filter annotations that appear as a mask or a bounding box, because MASK = 32 and BOUNDING_BOX = 2.' threshold_range: $ref: '#/components/schemas/apiThresholdRange' description: 'Filter annotations by concept value. Only concepts that fit in the threshold will be used to generate annotations.' status_code: $ref: '#/components/schemas/statusStatusCode' description: The output annotations will be created using this status code. time_of_day_range: $ref: '#/components/schemas/utilsTimeOfDayRange' description: 'Task auto annotation for this concept only applies to this time of day range. When out of range, the task will not generate annotations for the concept.' polygon: $ref: '#/components/schemas/apiPolygon' description: 'Filter out annotations that are out of this polygon. When it''s set, only detection annotations that intersect the polygon will pass the filter.' apiRunnerItemOutput: type: object properties: multi_output_response: $ref: '#/components/schemas/apiMultiOutputResponse' description: "The output of a model prediction request.\n\nWorkflow response. // FUTURE\n training response ???" title: 'This contains the response of the user''s request once processing is done. The runner should fill in the matching output to the RunnerItem.request oneof field. This is sent to the API within PostRunnerItemOutputsRequest' V2DeleteWorkflowsBody: type: object properties: user_app_id: type: object description: Common message to identify the app in a url endpoint. ids: type: array items: type: string delete_all: type: boolean description: Request to delete several things by the list of ids. V2DeleteAnnotationFiltersBody: type: object properties: user_app_id: type: object description: Common message to identify the app in a url endpoint. annotation_filter_ids: type: array items: type: string description: Specify which filters to delete. description: Request to delete several annotation filters by list of ids. V2PostAnnotationsSearchesBody: type: object properties: user_app_id: type: object description: The user_id and app_id to query from. title: The user_id and app_id to query from. searches: type: array items: type: object $ref: '#/components/schemas/apiSearch' title: The searched to be executed or saved pagination: $ref: '#/components/schemas/apiPagination' description: Pagination information to paginate through search result Hits. title: 'Execute a new annotation search and optionally save it annotation search over annotations using rank and filter proto' V2PostAnnotationsBody: type: object properties: user_app_id: type: object description: Common message to identify the app in a url endpoint. annotations: type: array items: type: object $ref: '#/components/schemas/clarifaiapiAnnotation' title: PostAnnotationsRequest apiTaskConcept: type: object properties: concept: $ref: '#/components/schemas/apiConcept' description: For auto annotation, id/name and value, user + app id must be specified. For other tasks, only the id field is required. auto_annotation_config: $ref: '#/components/schemas/apiTaskConceptAutoAnnotationConfig' apiOrchestrationArgsOverride: type: object properties: argo_args_override: $ref: '#/components/schemas/apiArgoArgsOverride' description: 'Future: KubeFlowArgsOverride, AirflowArgsOverride, etc.' apiKey: type: object properties: id: type: string description: The id of this key, it is used for authorization. type: type: string title: The type of key, it can be app_specific_key (default) or personal_access_token description: type: string title: The description scopes: type: array items: type: string title: The low-level scopes this key has endpoints: type: array items: type: string title: The endpoint-level scopes this key has apps: type: array items: type: object $ref: '#/components/schemas/apiApp' description: 'The apps that this key give you access to, it is empty if this key is personal_access_token API key can only give you access to a single app.' created_at: type: string format: date-time title: 'When the key was created. We follow the XXXX timestamp format. We use https://www.ietf.org/rfc/rfc3339.txt format: "2006-01-02T15:04:05.999999Z" so you can expect results like the following from the API: "2017-04-11T21:50:50.223962Z"' expires_at: type: string format: date-time title: When does the key expires, the key won't expire if this is empty authorized_idp_ids: type: array items: type: string title: list of idp ids at which key is currently authorized organization_id: type: string description: The organization associated with the key, if any. This is applicable only for PAT keys. title: Key apiMultiRunnerResponse: type: object properties: status: $ref: '#/components/schemas/apistatusStatus' runners: type: array items: type: object $ref: '#/components/schemas/apiRunner' title: MultiRunnerResponse apiDatasetInput: type: object properties: created_at: type: string format: date-time description: 'When the input was added to the dataset. The format is https://www.ietf.org/rfc/rfc3339.txt. Example: "2006-01-02T15:04:05.999999Z".' input: $ref: '#/components/schemas/apiInput' description: The input data. title: DatasetInput apiWorkflowVersionEvaluationMetricDataType: type: string enum: - DATA_TYPE_NOT_SET - FLOAT default: DATA_TYPE_NOT_SET title: Enum for data types apiMultiPipelineStepResponse: type: object properties: status: $ref: '#/components/schemas/apistatusStatus' pipeline_steps: type: array items: type: object $ref: '#/components/schemas/apiPipelineStep' apiWorkflowVersionEvaluationData: type: object properties: id: type: string title: the data example id input: $ref: '#/components/schemas/apiInput' ground_truths: type: array items: type: object $ref: '#/components/schemas/apiData' predictions: type: array items: type: object $ref: '#/components/schemas/apiData' workflow_evaluation_sample_result: $ref: '#/components/schemas/apiWorkflowEvaluationInputResult' apiReviewRequestChangesConfig: type: object properties: task_assignments: type: array items: type: object $ref: '#/components/schemas/apiTaskAssignment' workers: type: array items: type: object $ref: '#/components/schemas/apiWorker' apiMultiInputsExtractionJobResponse: type: object properties: status: $ref: '#/components/schemas/apistatusStatus' inputs_extraction_jobs: type: array items: type: object $ref: '#/components/schemas/apiInputsExtractionJob' V2PostConceptLanguagesBody: type: object properties: user_app_id: $ref: '#/components/schemas/apiUserAppIDSet' concept_languages: type: array items: type: object $ref: '#/components/schemas/apiConceptLanguage' description: POST multiple concept languages for the given concept. apiMultiAnnotationResponse: type: object properties: status: $ref: '#/components/schemas/apistatusStatus' annotations: type: array items: type: object $ref: '#/components/schemas/clarifaiapiAnnotation' title: MultiAnnotationResponse V2StreamAnnotationsBody: type: object properties: user_app_id: $ref: '#/components/schemas/apiUserAppIDSet' track_ids: type: array items: type: string description: 'Filter annotations by track_ids (optional - omit to stream all tracks for the input). This is useful for historical playback where you want to stream all annotations in a time range.' frame_number_start: type: integer format: int64 title: Filter annotations starting from this frame number (inclusive) frame_time_start: type: string format: uint64 title: Filter annotations starting from this time in milliseconds (inclusive) annotation_type: $ref: '#/components/schemas/apiAnnotationDataType' title: Filter by annotation type (e.g., "bounding_box", "point", "mask") max_frames: type: integer format: int64 title: 'Maximum number of frames to return. Returns annotations from frames in range [frame_number_start, frame_number_start + max_frames - 1] (inclusive on both ends). For example: frame_number_start=5, max_frames=3 returns frames 5, 6, and 7. Default and max: 216000 frames (60 minutes at 60 FPS)' max_duration: type: string format: uint64 title: 'Maximum duration in milliseconds to return. Returns annotations from time range [frame_time_start, frame_time_start + max_duration - 1] (inclusive on both ends). Default and max: 3600000 ms (60 minutes)' worker: $ref: '#/components/schemas/apiWorker' description: 'Filtering by model version ID within a worker (optional). Point annotations don''t need filtering by worker. For non-point types, a model version ID must be provided.' min_prediction_score: type: number format: float description: 'Optional minimum prediction confidence threshold (0.0 to 1.0). When set (> 0), only annotations with at least one concept (tag) having metadata.prediction_score >= this value are returned. When unset (0), all annotations are returned (backwards compatible).' title: StreamAnnotationsRequest apiOverwriteGeo: type: object properties: geo: $ref: '#/components/schemas/apiGeo' title: Geo info V2PatchDatasetsBody: type: object properties: user_app_id: type: object description: Common message to identify the app in a url endpoint. datasets: type: array items: type: object $ref: '#/components/schemas/apiDataset' description: List of datasets that are requested to be updated. action: type: string description: 'The action to perform on the patched objects Supported values: ''overwrite'', ''merge'', and ''remove''. Note that ''remove'' can only be used to remove the dataset image by setting ''image.url'' in the request to the current value returned for that dataset.' description: Request to patch several datasets. apiRunnerMethodType: type: string enum: - UNKNOWN - UNARY_UNARY - UNARY_STREAMING - STREAMING_UNARY - STREAMING_STREAMING default: UNKNOWN title: "- UNARY_UNARY: single request, single response. predict() in code\n - UNARY_STREAMING: single request, streamed response. generate() in code\n - STREAMING_UNARY: stream of requests, single response.\n - STREAMING_STREAMING: stream of requests, stream of responses. stream() in code" apiEmbedding: type: object properties: vector: type: array items: type: number format: float num_dimensions: type: integer format: int64 title: Embedding apiSingleAnnotationResponse: type: object properties: status: $ref: '#/components/schemas/apistatusStatus' annotation: $ref: '#/components/schemas/clarifaiapiAnnotation' title: SingleAnnotationResponse apiSingleInputCountResponse: type: object properties: status: $ref: '#/components/schemas/apistatusStatus' counts: $ref: '#/components/schemas/apiInputCount' title: SingleInputCountResponse apiDeploymentMetrics: type: object properties: desired_replicas: type: integer format: int64 description: 'Deprecated: use aggregate instead.' live_replicas: type: integer format: int64 description: 'Deprecated: use aggregate instead.' rollout_in_progress: type: boolean description: 'Deprecated: use aggregate instead.' nodepool_metrics: type: array items: type: object $ref: '#/components/schemas/apiNodepoolDeploymentMetrics' description: Per-nodepool breakdown of metrics. aggregate: $ref: '#/components/schemas/apiDeploymentMetricsSummary' description: Aggregate metrics across all nodepools. description: 'DeploymentMetrics captures metrics and status for a Deployment''s underlying runners. This allows tracking of the desired replica count and the actual live replica count.' V2PostDatasetVersionsBody: type: object properties: user_app_id: $ref: '#/components/schemas/apiUserAppIDSet' dataset_versions: type: array items: type: object $ref: '#/components/schemas/apiDatasetVersion' description: List of dataset versions that are requested to be added. description: Request to add one or more dataset versions. apiScopeDeps: type: object properties: scope: type: string title: The scope depending_scopes: type: array items: type: string description: Other scopes that are required. title: ScopeDeps apiOutputConfig: type: object properties: concepts_mutually_exclusive: type: boolean description: 'For custom concept model training: whether the concept predictions must sum to 1.' existing_model_id: type: string description: 'DEPRECATED: For custom models, this is the base model to use for image embeddings. Default is general model.' language: type: string description: 'For concept model predictions: Overrides the default_language for the app in a predict call.' hyper_parameters: type: string description: 'DEPRECATED: Hyper-parameters for custom training. Use new hyper_params field instead.' max_concepts: type: integer format: int64 description: 'For concept model predictions: Maximum number of concepts in result. Defaults to 0 which under the hood will return default of 20. We do a server side default in order to control this feature in the future.' min_value: type: number format: float description: 'For concept model predictions: Minimum value of concept''s probability score in result. Defaults to 0.0 which means we won''t do any thresholding as all probabilities will likely be > 0.0.' select_concepts: type: array items: type: object $ref: '#/components/schemas/apiConcept' title: 'For concept model predictions: Select concepts in result by name or by id' training_timeout: type: integer format: int64 title: 'For custom concept model training: Training timeout of the model (in seconds)' sample_ms: type: integer format: int64 title: 'For model predictions on video: Sample delay for video predicting (1 frame per N milliseconds)' hyper_params: type: object title: 'For custom model training: Hyperparameters for custom training' embed_model_version_id: type: string description: 'For custom model training: this is the base model version to use for image embeddings. This has to be one of the embed models in the app workflow. Use input_info.base_embed_model instead.' fail_on_missing_positive_examples: type: boolean title: 'For custom model training: Use this flag to fail on missing positive examples By default we fill in the missing with random examples' model_metadata: type: object description: 'For custom model training: This is any additional metadata as a JSON object that we want want to persist in the model''s output config. This is a useful quick way to set fields for introducing fields for new model types so we don''t have to add a new proto field and DB field each time. Please refer to the documentation or model implementation internally for more details on what fields are supported for which models. TODO(zeiler): remove this field after Portal is updated.' description: 'OutputConfig is a collection of parameters controlling either inference or training settings for the given Model. This message will be deprecated over time in favor or output_info.params and train_params in OutputInfo which are cleaner and more extensible for many ModelTypes.' V2PostPipelineStepsBody: type: object properties: user_app_id: type: object description: Common message to identify the app in a url endpoint. pipeline_steps: type: array items: type: object $ref: '#/components/schemas/apiPipelineStep' V2DeleteDatasetVersionsBody: type: object properties: user_app_id: $ref: '#/components/schemas/apiUserAppIDSet' dataset_version_ids: type: array items: type: string description: Request to delete several dataset versions by list of ids. clarifaiapiDataType: type: string enum: - UNDEFINED - STRING - UINT8 - INT32 - INT64 - FP32 default: UNDEFINED title: '- UNDEFINED: Default value, should not be used' apiPostModelOutputsRequest: type: object properties: user_app_id: $ref: '#/components/schemas/apiUserAppIDSet' model_id: type: string version_id: type: string inputs: type: array items: type: object $ref: '#/components/schemas/apiInput' model: $ref: '#/components/schemas/apiModel' description: 'This allows you to specify config options for the model such as the language which appear''s in the model''s output_info.' runner_selector: $ref: '#/components/schemas/apiRunnerSelector' title: Allow filtering of prediction requests down to specific Nodepools, Deployments or Runners use_predict_cache: type: boolean title: Configure the prediction cache to avoid expensive compute for predict requests enable_log_summary_on_error: type: boolean title: Configuration to provide logs summarization when request errors out description: '////////////////////////////////////////////////// Model prediction related stuff needs inputs and produces outputs. ////////////////////////////////////////////////// Model prediction.' apiModelLayerInfo: type: object properties: data_field_name: type: string title: The api.Data field this layer will be parsed into shapes: type: array items: type: object $ref: '#/components/schemas/apiLayerShape' description: Description of the expected shape. Can support multiple support layer shapes. description: type: string title: Brief description about the layer if needed requires_label_filename: type: boolean title: Whether this layer should have a label_filename specified and provided apiMetricType: type: string enum: - METRIC_TYPE_NOT_SET - MODEL_TTFT - MODEL_THROUGHPUT - MODEL_PROMPT_TOKEN_THROUGHPUT - MODEL_COMPLETION_TOKEN_THROUGHPUT - MODEL_REQUEST_COUNT - MODEL_E2E_LATENCY - NODEPOOL_NODE_COUNT - NODEPOOL_GPU_UTILIZATION - NODEPOOL_GPU_TENSOR_UTILIZATION - NODEPOOL_GPU_MEMORY_UTILIZATION - NODEPOOL_CPU_UTILIZATION - NODEPOOL_MEMORY_UTILIZATION default: METRIC_TYPE_NOT_SET title: "- MODEL_TTFT: Model metrics: 1-50\n - NODEPOOL_NODE_COUNT: Nodepool metrics: 51-100" apiModelPredictConfig: type: object properties: model: $ref: '#/components/schemas/apiModel' description: Assumed to be owned by the calling users app unless user_id and app_id are filled out. V2DeleteSecretsBody: type: object properties: user_app_id: type: object properties: app_id: type: string description: Common message to identify the app in a url endpoint. ids: type: array items: type: string title: List of secret ids to be deleted apiGeoBoxedPoint: type: object properties: geo_point: $ref: '#/components/schemas/apiGeoPoint' title: GeoBoxedPoint apiMultiMetricLabelsResponse: type: object properties: status: $ref: '#/components/schemas/apistatusStatus' metric_type_labels: type: array items: type: object $ref: '#/components/schemas/apiMetricTypeLabels' clarifaiapiDeleteAnnotations: type: object description: This operation takes no data (payload). apiSpecialHandling: type: object properties: id: type: string reason: $ref: '#/components/schemas/SpecialHandlingReason' done: type: boolean description: Whether special handling is done. description: Tracks special handling reason and whether it's been done. apiAppExtraInfo: type: object properties: search_revision_marker: type: string title: 'Revision marker for this application. The value of the revision changes when * inputs are added, updated or deleted * annotations are added, updated or deleted * inputs are added to or removed from datasets For example, this value can be used to detect if client side caches related to searching should be invalidated. Field not filled in for list endpoints, use GetApp' counts: $ref: '#/components/schemas/apiAppResourceCounts' apiFrameInfo: type: object properties: index: type: integer format: int64 title: 'Deprecated. Use Time instead. The index of the frame, informational and optional. Depends on the sampling rate used during processing May be 0 for interpolated frames that are generated for brief time (training) or if new frame is manually added' time: type: string format: uint64 description: 'time in the video in milliseconds. This is independent of the sampling rates used during processing. Changed from uint32 to uint64 to support video livestreams longer than 49.7 days.' number: type: integer format: int64 title: 'The absolute number of the frame in the (original) video Different from index. Index is just the order in which frames were processed for search (and can be 0 for manual annotations)' description: The information of the location of the Frame. apiModelType: type: object properties: id: type: string description: A unique identifier for this model type. title: type: string description: A display title for this model. description: type: string description: Description of this model type. input_fields: type: array items: type: string description: 'The list of input fields that this model expects as inputs. Used to validate that request input data has the expected fields.' output_fields: type: array items: type: string description: The list of output fields that this model accepts. trainable: type: boolean description: Is this model trainable in our platform. creatable: type: boolean description: 'Is this model creatable. We have some pre-trained model types that users cannot create yet in model mode.' internal_only: type: boolean description: Is this model type only for internal users at this time. model_type_fields: type: array items: type: object $ref: '#/components/schemas/apiModelTypeField' description: The remaining fields are definitions of the configurable fields that exist. requires_sequential_frames: type: boolean description: 'For sequence models we need to know when processing that they require temporal time frames in sequential order. This will be true for model types like trackers as an example.' expected_input_layers: type: array items: type: object $ref: '#/components/schemas/apiModelLayerInfo' description: Expected input layers of an uploaded model. expected_output_layers: type: array items: type: object $ref: '#/components/schemas/apiModelLayerInfo' title: Expected output layers of an uploaded model evaluation_type: $ref: '#/components/schemas/apiEvaluationType' description: What type of evaluation is supported for this model type. method_signatures: type: array items: type: object $ref: '#/components/schemas/apiMethodSignature' description: 'method signature for this model type This will be used in the future to replace input_fields, output_fields, and model_type_fields as it can define any python function call.' description: 'ModelType is a definition of a set of models that generally have the same input and output fields. This is used to understand more about the possible models in our platform.' V2PatchAppsDetailsBody: type: object properties: user_app_id: type: object description: Common message to identify the app in a url endpoint. apps: type: array items: type: object $ref: '#/components/schemas/apiApp' action: type: string description: 'The action to perform on the patched App objects Supported values: ''overwrite'' and ''remove''. Note that ''remove'' can only be used to remove the app image by setting ''image.url'' in the request to the current value returned for that app.' V2PostBulkOperationsBody: type: object properties: user_app_id: type: object description: Common message to identify the app in a url endpoint. bulk_operations: type: array items: type: object $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. apiReviewApproveConfig: type: object properties: task_assignments: type: array items: type: object $ref: '#/components/schemas/apiTaskAssignment' workers: type: array items: type: object $ref: '#/components/schemas/apiWorker' apiDatasetVersionProcessingInfo: type: object properties: frame_interpolation_info: $ref: '#/components/schemas/apiFrameInterpolationInfo' description: 'If frame_interpolation_info is set, then these settings are used to interpolate new frame annotation from other video annotations. If frame_interpolation_info is set in the dataset default_processing_info, then it can be disabled for a single dataset version by setting processing_info but not setting processing_info.frame_interpolation_info.' description: 'DatasetVersionProcessingInfo contains information about processing applied to a dataset version.' apiMultiTrainingTimeEstimateResponse: type: object properties: status: $ref: '#/components/schemas/apistatusStatus' training_time_estimates: type: array items: type: string title: Estimated training time in seconds apiMultiCollaboratorsResponse: type: object properties: status: $ref: '#/components/schemas/apistatusStatus' collaborators: type: array items: type: object $ref: '#/components/schemas/apiCollaborator' app_owner: $ref: '#/components/schemas/apiUser' description: 'The owner of the application. When listing users that have access to the application, i.e. collaborators, it is often relevant to also include the application owner, so return their information here for convenience. Note: app_owner is only returned by ListCollaborators and only if the owner is a regular user, not an organization.' title: MultiCollaboratorsResponse apiSingleRunnerResponse: type: object properties: status: $ref: '#/components/schemas/apistatusStatus' runner: $ref: '#/components/schemas/apiRunner' title: SingleRunnerResponse apiDatasetVersionExportFormat: type: string enum: - DATASET_VERSION_EXPORT_FORMAT_NOT_SET - CLARIFAI_DATA_PROTOBUF - CLARIFAI_DATA_JSON - COCO default: DATASET_VERSION_EXPORT_FORMAT_NOT_SET description: " - CLARIFAI_DATA_PROTOBUF: CLARIFAI_DATA_PROTOBUF is the proprietary Clarifai API Data format. It\nis a ZIP-archive containing batches of serialized InputBatch protobuf messages.\n\nNote that only the \"id\" and \"data\" fields of exported inputs are set.\n - CLARIFAI_DATA_JSON: CLARIFAI_DATA_JSON is the proprietary Clarifai API Data format in JSON. It\nis a ZIP-archive containing batches of serialized InputBatch JSON messages.\n\nNote that only the \"id\" and \"data\" fields of exported inputs are set.\n - COCO: COCO is the data format used by Common Objects in Context. It is a\nZIP-archive containing JSON files with the dataset version annotations.\nSee https://cocodataset.org/#format-data." apiWorkflowVersionEvaluationTemplate: type: object properties: id: type: string description: type: string task_types: type: array items: $ref: '#/components/schemas/apiWorkflowVersionEvaluationTemplateTaskType' title: Applicable for the task types like TextClassification, TextGeneration, etc workflow_version_evaluation_metrics: type: array items: type: object $ref: '#/components/schemas/apiWorkflowVersionEvaluationMetric' title: The Workflow Evaluation template metrics apiMultiAnnotationFilterResponse: type: object properties: status: $ref: '#/components/schemas/apistatusStatus' annotation_filters: type: array items: type: object $ref: '#/components/schemas/apiAnnotationFilter' title: MultiAnnotationFilterResponse apiDeploymentMetricsSummary: type: object properties: desired_replicas: type: integer format: int64 description: The number of replicas desired by the orchestrator. live_replicas: type: integer format: int64 description: The actual number of live replicas connected and ready to process requests. rollout_in_progress: type: boolean description: If true, a new version is currently being rolled out. description: 'DeploymentMetricsSummary holds the core deployment metrics fields, reusable as both an aggregate across all nodepools and per-individual-nodepool metrics.' V2DeleteLabelOrdersBody: type: object properties: user_app_id: type: object description: Common message to identify the app in a url endpoint. ids: type: array items: type: string description: Request to delete a list of label orders. apiDeploymentStatus: type: string enum: - ENABLED - DISABLED default: ENABLED description: "Status of the deployment.\n\n - ENABLED: Default: deployment is enabled and can serve traffic.\n - DISABLED: Deployment is disabled: scaled to zero, traffic rejected." apiPrecisionRecallCurve: type: object properties: recall: type: array items: type: number format: float precision: type: array items: type: number format: float thresholds: type: array items: type: number format: float title: PrecisionRecallCurve apiMultiDatasetInputResponse: type: object properties: status: $ref: '#/components/schemas/apistatusStatus' dataset_inputs: type: array items: type: object $ref: '#/components/schemas/apiDatasetInput' bulk_operation: $ref: '#/components/schemas/apiBulkOperation' title: MultiDatasetInputResponse apiPipelineStepInputParam: type: object properties: name: type: string description: The name of the input parameter. default_value: type: string description: The default value of the input parameter. description: type: string description: The description of the input parameter. accepted_values: type: array items: type: string description: The accepted values for the input parameter. apiTaskWorkMetrics: type: object properties: inputs_count_estimated: type: string format: uint64 description: Estimated number of inputs that workers have worked on. inputs_percent_estimated: type: integer format: int64 description: 'Estimated percent of inputs that workers have worked on. This is a value between 0 and 100, where 0 = 0% and 100 = 100%.' V2CancelBulkOperationsBody: type: object properties: user_app_id: type: object description: Common message to identify the app in a url endpoint. ids: type: array items: type: string title: List of bulk operation ids to be cancelled title: Cancel a list of bulk operation ids apiText: type: object properties: raw: type: string description: This is a raw text string. url: type: string title: Url to a text file allow_duplicate_url: type: boolean hosted: $ref: '#/components/schemas/apiHostedURL' description: 'The hosted field lists original text hosted in Clarifai storage. This field is currently used only in response.' text_info: $ref: '#/components/schemas/apiTextInfo' title: text info title: Text apiWorkflowEvaluationInputResult: type: object properties: input_evaluation_metric_values: type: array items: type: object $ref: '#/components/schemas/apiInputEvaluationMetricValue' title: The evaluation result at the input/sample level apiQuery: type: object properties: ands: type: array items: type: object $ref: '#/components/schemas/apiAnd' description: 'The query syntax is simply a list of And operatiosn that will be ANDed together to fetch results which are returned to the user as Hit messages. Deprecated: Only used by the deprecated PostSearches endpoint. Use filters and ranks instead with PostInputsSearches or PostAnnotationsSearches.' language: type: string description: 'This allows the query to override any default language the app was setup in when doing Concept based searches. This currently only affects public Models Output searches when those public Models have translations for their Concepts.' filters: type: array items: type: object $ref: '#/components/schemas/apiFilter' title: 'filters in this query e.q. only fetch annotations that have certain metadata' ranks: type: array items: type: object $ref: '#/components/schemas/apiRank' title: 'rankings in this query e.g. visual search by a url' description: This is the search query used in /searches, model training requests, bulk data exports, etc. V2PatchAnnotationsBody: type: object properties: user_app_id: type: object description: Common message to identify the app in a url endpoint. annotations: type: array items: type: object $ref: '#/components/schemas/clarifaiapiAnnotation' action: type: string title: 'The action to perform on the patched objects For now actions ''merge'', ''overwrite'', and ''remove'' are supported' delete_if_empty_data: type: boolean description: 'If the request is a "remove" action and the annotation is left with empty data, then setting delete_if_empty_data to true will delete the annotation, if possible (for example, will not delete an input-level annotation).' title: PatchAnnotationsRequest apiEvalTestSetEntry: type: object properties: input: $ref: '#/components/schemas/apiInput' title: the input information predicted_concepts: type: array items: type: object $ref: '#/components/schemas/apiConcept' ground_truth_concepts: type: array items: type: object $ref: '#/components/schemas/apiConcept' title: All the ground truth concepts will be show on the top level annotation: $ref: '#/components/schemas/clarifaiapiAnnotation' title: 'Only region-based/frame-based app contains this annotation Each annotation only contains one region And the concepts is in ground_truth_concepts instead of this annotation' predicted_annotation: $ref: '#/components/schemas/clarifaiapiAnnotation' description: For region based models, region and associated concepts are stored together. ground_truth_annotation: $ref: '#/components/schemas/clarifaiapiAnnotation' title: EvalTestSetEntry V2PutDatasetVersionExportsBody: type: object properties: user_app_id: $ref: '#/components/schemas/apiUserAppIDSet' exports: type: array items: type: object $ref: '#/components/schemas/apiDatasetVersionExport' description: 'exports is the list of requested dataset version exports. Only setting the ''format'' field of the export is supported.' description: Request to create exports of a dataset version. V2PatchConceptLanguagesBody: type: object properties: user_app_id: $ref: '#/components/schemas/apiUserAppIDSet' concept_languages: type: array items: type: object $ref: '#/components/schemas/apiConceptLanguage' action: type: string description: The action to perform with the objects in the PATCH. description: PATCH multiple concept languages for the given concept. apiAutoAnnotationRequest: type: object properties: post_model_outputs_request: $ref: '#/components/schemas/apiPostModelOutputsRequest' description: Perform prediction request and call PostAnnotations endpoint using prediction results. task: $ref: '#/components/schemas/apiTask' description: Task used to create annotations . authorization_value: type: string description: Authorization value to be used when calling PostAnnotations endpoint. V2CancelInputsExtractionJobsBody: type: object properties: user_app_id: type: object description: Common message to identify the app in a url endpoint. ids: type: array items: type: string title: List of extraction job ids to be cancelled title: Cancel a list of extraction job ids utilsTimeOfDayRange: type: object properties: start: $ref: '#/components/schemas/utilsTimeOfDay' description: Start time of day represented as a duration. end: $ref: '#/components/schemas/utilsTimeOfDay' description: 'End time of day represented as a duration. May be less than start duration if the time of day range goes over midnight.' is_start_inclusive: type: boolean is_end_inclusive: type: boolean title: 'TimeOfDayRange represents a period of time withing a day. e.g. [9am, 5pm) -> start = 9:00:00, end = 17:00:00, is_start_inclusive = true, is_end_inclusive = false' apiSingleModelVersionResponse: type: object properties: status: $ref: '#/components/schemas/apistatusStatus' model_version: $ref: '#/components/schemas/apiModelVersion' title: SingleModelVersionResponse apiModelTypeField: type: object properties: path: type: string description: 'The path where the value of the field will be stored in the model version object. Example: "output_info.data" would be the Data message in the OutputInfo message. "output_info.output_config.language" is in the OutputConfig message within OutputInfo "input_info.params" is in the params struct within InputInfo. "output_info.params" is in the params struct within OutputInfo. "train_info.params" is in the params struct within TrainInfo. and so on.' field_type: $ref: '#/components/schemas/ModelTypeFieldModelTypeFieldType' description: 'The field for this field. This is often used for displaying the field in the UI whereas the DataType enum below defines the specific type of datain the Python function.' default_value: description: 'A default value. We use the Value field because we want to have structured data (just like google.protobuf.Struct but this is just a single value).' description: type: string description: Description for this field. placeholder: type: string description: Placeholder text for the UI element. model_type_enum_options: type: array items: type: object $ref: '#/components/schemas/apiModelTypeEnumOption' description: List of options of the ENUM type and potentially additional fields they bring with them. internal_only: type: boolean description: If this field should appear for internal users only. required: type: boolean description: 'If this field is a required field. If True then during validation you won''t be able to create a model of this type with providing a value for this field. When False, the ModelType''s default_value will be used for this field.' model_type_range_info: $ref: '#/components/schemas/apiModelTypeRangeInfo' description: If the field_type is RANGE, this must be filled in. name: type: string title: name of method signature argument type: $ref: '#/components/schemas/apiModelTypeFieldDataType' description: The type of the argument. type_args: type: array items: type: object $ref: '#/components/schemas/apiModelTypeField' title: 'type enum, and recursively set type_args with the inner type argumets in complex objects (e.g. List[Tuple[int, str]])' iterator: type: boolean description: this will be use to define whether the method argument supports streaming as an iterator. default: type: string description: 'This specify the default value of the method argument If this argument is not passed, the input is required. If it is explicitly set to None, the input is optional We define this as a string because the default value can be a string, int, float, bool, or a complex object like a JSON The default_value field above should not also be used.' is_param: type: boolean title: wheather it's a inference param or a modeltype field description: ModelTypeField stores a field value of a configurable type. V2PatchConceptsBody: type: object properties: user_app_id: type: object description: Common message to identify the app in a url endpoint. concepts: type: array items: type: object $ref: '#/components/schemas/apiConcept' description: The concepts to patch. action: type: string title: 'The action to perform on the patched objects For now ony action ''overwrite'' is supported' title: PatchConceptsRequest apiModel: type: object properties: id: type: string description: The model's ID. Must be unique within a particular app and URL-friendly. name: type: string description: 'DEPRECATED: Please use the model id to name the model.' created_at: type: string format: date-time title: "When the model was created. We follow the XXXX timestamp\nformat. We use https://www.ietf.org/rfc/rfc3339.txt format:\n\"2006-01-02T15:04:05.999999Z\" so you can expect results like\n the following from the API:\n \"2017-04-11T21:50:50.223962Z\"" modified_at: type: string format: date-time title: When was the most recent model version created at app_id: type: string description: The app the model belongs to. output_info: $ref: '#/components/schemas/apiOutputInfo' title: 'Info about the model''s output and configuration. DEPRECATED: Will be moved to model version' model_version: $ref: '#/components/schemas/apiModelVersion' description: 'A particular version of the model, e.g., to specify the version when creating a workflow or when listing Models to include the latest ModelVersion of the model in the response.' display_name: type: string description: 'DEPRECATED: Please use the model id to name the model.' user_id: type: string description: The user id that the model belongs to. default_eval_info: $ref: '#/components/schemas/apiEvalInfo' description: The default evaluation info. Can be overwritten by eval request. model_type_id: type: string description: 'The ModelType.Id that is used for this model. This is used for all versions and you cannot change model_type_id between versions of the same model.' task: type: string title: The task the model was trained to do visibility: $ref: '#/components/schemas/clarifaiapiVisibility' description: 'The visibility field represents whether this message is privately/publicly visible. To be visible to the public the App that contains it AND the User that contains the App must also be publicly visible.' description: type: string title: Short description about this model metadata: type: object title: 'To handle arbitrary json metadata you can use a struct field: https://github.com/google/protobuf/blob/master/src/google/protobuf/struct.proto' presets: type: object notes: type: string description: 'Notes for the model This field should be used for in-depth notes and supports up to 64Kbs.' toolkits: type: array items: type: string title: Tags from toolkits category use_cases: type: array items: type: string title: Tags from use_cases category languages: type: array items: type: string description: Tags from languages category. languages_full: type: array items: type: object $ref: '#/components/schemas/apiFullTag' description: Tags from languages category with names, only used in responses. check_consents: type: array items: type: string is_starred: type: boolean title: 'Is starred by the requesting user (only showed on get/list requests) Please use PostModelStars/DeleteModelStars endpoints to star/unstar a model' star_count: type: integer format: int32 title: 'How many users have starred the model (only showed on get/list requests) Computed value, not editable' workflow_recommended: type: boolean title: Whether it's recommended that this model is used within a workflow bookmark_origin: $ref: '#/components/schemas/apiBookmarkOrigin' description: 'bookmark info. When set, this model is a bookmarked model of this app. Info in this field will allow you to find/access original model.' image: $ref: '#/components/schemas/apiImage' title: Representative image for this model license_type: $ref: '#/components/schemas/apiLicenseType' title: License Type source: $ref: '#/components/schemas/ModelSource' creator: type: string title: Creator of Model version_count: type: integer format: int32 billing_type: $ref: '#/components/schemas/ModelBillingType' featured_order: type: integer format: int32 description: 'Whether the model should be featured, and if so, the order in which it should be featured. The order is relative to other models that are also featured. Models with a higher order will be featured first.' deploy_restriction: $ref: '#/components/schemas/apiDeployRestriction' description: Deploy restriction for the model. replica_count: type: integer format: int64 description: 'replica_count indicates the number of deployed model replicas. This field is populated when `show_replicas` is true in ListModelsRequest.' open_router_info: $ref: '#/components/schemas/apiOpenRouterInfo' title: OpenRouter Info for the model description: "This is the Model object which represents a created model in the platform.\nEach model has a particular type denoted by the model_type_id.\nWhen creating a Model with PostModels the following happens:\n - if the ModelType is trainable, then a new ModelVersion is created that is\n - UNTRAINED status by default\n - TRAINED status if a ModelVersion was included with PretrainedModelConfig in PostModels\n - if the ModelType is not trainable, then a new ModelVersion is created with TRAINED status.\nTo modify config settings like OutputInfo for the Model you an use PatchModels. This will\nalso create a new ModelVersion, potentially UNTRAINED following the same rules as above.\nThe fields that are patchable include Model.name, Model.display_name and Model.output_info\n(except the Model.output_info.type and Model.output_info.type_ext)." apiDataSourceCredentials: type: object properties: s3_creds: $ref: '#/components/schemas/apiAWSCreds' description: AWS S3 credentials for authentication. gcp_creds: type: string format: byte description: GCP Cloud Storage uses service account key data(creds.json) as Byte array for authentication. azure_blob_creds: $ref: '#/components/schemas/apiAzureBlobCreds' description: Azure Blob credentials for authentication. apiDetailConceptCount: type: object properties: processed: $ref: '#/components/schemas/apiConceptTypeCount' title: The concept count for processed assets to_process: $ref: '#/components/schemas/apiConceptTypeCount' title: The concept count for to process assets errors: $ref: '#/components/schemas/apiConceptTypeCount' title: The concept count for assets with status error processing: $ref: '#/components/schemas/apiConceptTypeCount' title: The concept count for processing assets title: DetailConceptCount apiMetricTypeLabels: type: object properties: metric_type: $ref: '#/components/schemas/apiMetricType' labels: type: array items: type: object $ref: '#/components/schemas/MetricTypeLabelsLabelWithValues' apiMultiSearchResponse: type: object properties: status: $ref: '#/components/schemas/apistatusStatus' description: Status of whether the search was successful. id: type: string title: A unique id which uniquely identifies a search hits: type: array items: type: object $ref: '#/components/schemas/apiHit' description: The list of search result Hits. query: $ref: '#/components/schemas/apiQuery' description: The original query provided in the request. searches: type: array items: type: object $ref: '#/components/schemas/apiSearch' description: The original Searches provided in the request. hit_counts: type: array items: type: object $ref: '#/components/schemas/apiHitCount' description: 'The counts of hits for each search, in the same order as searches. Only returned if the request set only_count.' title: MultiSearchResponse apiWorkflowVersionUnPublishRequest: type: object properties: version_id: type: string V2PatchLabelOrdersBody: type: object properties: user_app_id: type: object description: Common message to identify the app in a url endpoint. label_orders: type: array items: type: object $ref: '#/components/schemas/apiLabelOrder' action: type: string title: 'The action to perform on the patched objects For now, only ''overwrite'' option is supported' description: Request to patch a list of label orders. apiArgoOrchestrationStatus: type: object properties: status: type: string title: Refer https://pkg.go.dev/github.com/argoproj/argo-workflows/v3/pkg/apis/workflow/v1alpha1#WorkflowStatus title: Argo Workflow Status message apiSinglePasswordValidationResponse: type: object properties: status: $ref: '#/components/schemas/apistatusStatus' title: Standard clarifai status code password_violations: $ref: '#/components/schemas/apiPasswordViolations' title: SinglePasswordValidationResponse V2PatchKeysBody: type: object properties: user_app_id: type: object properties: app_id: type: string description: Common message to identify the app in a url endpoint. keys: type: array items: type: object $ref: '#/components/schemas/apiKey' action: type: string title: 'The action to perform on the patched objects For now only action ''overwrite'' is supported' title: PatchKeysRequest V2PatchWorkflowsBody: type: object properties: user_app_id: type: object description: Common message to identify the app in a url endpoint. workflows: type: array items: type: object $ref: '#/components/schemas/apiWorkflow' action: type: string description: 'Note that ''remove'' can be used to remove the workflow image by setting ''image.url'' in the request to the current value returned for that workflow. This cannot be used in a request that is patching other fields as well.' title: 'The action to perform on the patched objects For now actions ''merge'', ''overwrite'', and ''remove'' are supported' title: PatchWorkflowsRequest V2PatchDeploymentsBody: type: object properties: user_app_id: type: object properties: app_id: type: string description: Only the user_id is used from this. title: Only the user_id is used from this. deployments: type: array items: type: object $ref: '#/components/schemas/apiDeployment' action: type: string title: 'The action to perform on the patched objects For now actions ''merge'', ''overwrite'', and ''remove'' are supported' apiExtendedMetrics: type: object properties: user_metrics: type: object V2PatchAnnotationsSearchesBody: type: object properties: user_app_id: type: object description: The user_id and app_id to query from. title: The user_id and app_id to query from. searches: type: array items: type: object $ref: '#/components/schemas/apiSearch' title: The searches to be patched action: type: string title: 'The action to perform on the patched Search objects For now only action ''overwrite'' is supported' apiDataSourceURL: type: object properties: url: type: string description: Supported providers are AWS S3, Azure blob, GCP cloud storage. credentials: $ref: '#/components/schemas/apiDataSourceCredentials' title: Credentials that would allow access to the provided url apiDeleteGeo: type: object V2DeleteConceptRelationsBody: type: object properties: user_app_id: type: object description: The user_id and app_id information. title: The user_id and app_id information. ids: type: array items: type: string description: The concept relationship ids to delete. title: DELETE concept relations apiAudio: type: object properties: url: type: string description: 'This is a URL to a publicly accessible image file. The platform will download this file server side and then process.' base64: type: string format: byte description: 'The base64 field is using image file bytes directly in the request. NOTE: if you''re sending a json request, then this MUST be base64 encoded before sending (hence the name here). When using our grpc clients, you DO NOT need to base64 encode it yourself since the clients know how to do this for you automatically and will avoid the base64 encoding if they send a binary request.' allow_duplicate_url: type: boolean description: If True then you will be allowed to have multiple urls. hosted: $ref: '#/components/schemas/apiHostedURL' description: 'The hosted field lists original audio hosted in Clarifai storage. This field is currently used only in response.' audio_info: $ref: '#/components/schemas/apiAudioInfo' title: audio info title: Audio asset struct apiComputeSourceMetadata: type: object properties: user_app_id: $ref: '#/components/schemas/apiUserAppIDSet' description: The user app id, if any. model_id: type: string description: The Model ID, if any. model_version_id: type: string description: The Version ID, if any. workflow_id: type: string description: Workflow Id, if any. compute_cluster_user_id: type: string description: Compute Cluster, Nodepool, Runner. compute_cluster_id: type: string nodepool_id: type: string runner_id: type: string pipeline_id: type: string title: Pipeline related data, if any pipeline_version_id: type: string pipeline_version_run_id: type: string pipeline_step_id: type: string description: Pipeline step related data for pipeline step builds. pipeline_step_version_id: type: string description: ComputeSourceMetadata describes the source of something computed. The who and where. apiArtifact: type: object properties: id: type: string title: ID of artifact user_id: type: string title: User ID that this Artifact belongs to app_id: type: string title: Application ID that this Artifact belongs to artifact_version: $ref: '#/components/schemas/apiArtifactVersion' title: Reference to the artifact version resource that represents a specific version of the artifact created_at: type: string format: date-time description: When the artifact was created. modified_at: type: string format: date-time description: Most recent time when the artifact was updated. deleted_at: type: string format: date-time description: When the artifact was deleted. description: 'Artifact is a resource that represents a file stored in Clarifai''s storage system. It should have a reference to upload resource which contains the actual file location and metadata.' apiPolygon: type: object properties: points: type: array items: type: object $ref: '#/components/schemas/apiPoint' description: A list of points connected together to form the polygon. title: Polygon V2PatchModelUseCasesBody: type: object properties: user_app_id: $ref: '#/components/schemas/apiUserAppIDSet' usecases: type: array items: type: string action: type: string title: overwrite supported apiMultiSecretResponse: type: object properties: status: $ref: '#/components/schemas/apistatusStatus' secrets: type: array items: type: object $ref: '#/components/schemas/apiSecret' apiTaskStatusCountPerUser: type: object properties: user_id: type: string description: 'Deprecated: Use worker instead.' pending: type: integer format: int64 awaiting_review: type: integer format: int64 success: type: integer format: int64 review_denied: type: integer format: int64 awaiting_consensus_review: type: integer format: int64 worker: $ref: '#/components/schemas/apiWorker' title: 'TaskStatusCountPerUser can represent one of the following: * count of task annotations created by a worker for each valid status, * count of task inputs assigned to a worker (i.e. task assignments) for each valid status' DeploymentSchedulingChoice: type: string enum: - UNKNOWN_SCHEDULING_CHOICE - FAIL - RANDOM - PRICE - PERFORMANCE - NETWORK - UTILIZATION - PREFER_SPOT - PREFER_ONDEMAND default: UNKNOWN_SCHEDULING_CHOICE description: "In some scenarios it may not be obvous how we should schedule a resource to underlying nodes\nwithin the nodepool(s) above. The SchedulerChoice allows us to specify how to decide which\nnodepool to use when there are multiple nodepools and how to decide which type of node\nwithin a nodepool if there are multiple types.\nIf here are multiple nondepools then a decision on which to use comes into play\nif it is not specified in the prediction request.\nEven with a single nodepool a choice may come up such as when a resource that needs scheduling\nhas not specified the accelerator types it supports and the nodepool has multiple types.\n\n - FAIL: fail if there is any ambiguity.\n - RANDOM: randomly pick amongst the nodepools/nodes to assign.\n - PRICE: choose the compute that is cheaper\n - PERFORMANCE: schedule to the fastest known iption.\n - NETWORK: optimize based on network latency.\n - UTILIZATION: send to the least used nodepool based on it's capacity.\n - PREFER_SPOT: choose spot instances over on-demand\n - PREFER_ONDEMAND: choose on-demand instances over spot." apiSplitIntoDatasets: type: object properties: dataset_splits: type: array items: type: object $ref: '#/components/schemas/apiDatasetSplit' method: $ref: '#/components/schemas/SplitIntoDatasetsDatasetSplitMethod' apiAutoscaleConfig: type: object properties: min_replicas: type: integer format: int64 description: 'The minimum number of replicas for the runner to have. Defaults to 0 which means autoscaling can scale down to zero. If you want a replica always up then set to >= 1.' max_replicas: type: integer format: int64 description: The maximium number of replicas to scale up the runner to. traffic_history_seconds: type: integer format: int64 description: The number of seconds of traffic history to consider when autoscaling. scale_down_delay_seconds: type: integer format: int64 description: The time to wait before scaling down after the last request. scale_up_delay_seconds: type: integer format: int64 description: The time to wait between scaling up replicas without burst traffic. disable_packing: type: boolean description: 'Depending on your plan you may be able to enable packing of resources into a single node for more compute and cost efficiency.' scale_to_zero_delay_seconds: type: integer format: int64 title: The idle time before scaling down to zero soft_min_replicas: type: integer format: int64 description: 'Additional minimum replicas added on top of min_replicas. "Soft" refers to scheduling priority (preemptable), not to whether the floor is enforced. The orchestrator always maintains min_replicas + soft_min_replicas (capped to max_replicas). A value of 0 means not set / disabled.' description: 'It might be better to do this as runner autoscaling so that resources of a model are very simply what that model needs at minimum. Note that resources for things like modes inside runners are not related to how many replicas of those runners are needed to handle traffic.' apiMultiDatasetVersionResponse: type: object properties: status: $ref: '#/components/schemas/apistatusStatus' dataset_versions: type: array items: type: object $ref: '#/components/schemas/apiDatasetVersion' apiMetricAggregate: type: object properties: operator: $ref: '#/components/schemas/MetricAggregateOperator' labels: type: array items: $ref: '#/components/schemas/apiMetricLabel' apiEmailAddress: type: object properties: email: type: string primary: type: boolean verified: type: boolean title: EmailAddress apiMultiTaskAssignmentResponse: type: object properties: status: $ref: '#/components/schemas/apistatusStatus' task_assignments: type: array items: type: object $ref: '#/components/schemas/apiTaskAssignment' V2PatchWorkflowVersionsBody: type: object properties: user_app_id: $ref: '#/components/schemas/apiUserAppIDSet' workflow_versions: type: array items: type: object $ref: '#/components/schemas/apiWorkflowVersion' description: Patch these versions. action: type: string title: 'The action to perform on the patched objects For now actions ''merge'', ''overwrite'', and ''remove'' are supported' title: PatchWorkflowVersionsRequest V2PostWorkflowVersionsUnPublishBody: type: object properties: user_app_id: $ref: '#/components/schemas/apiUserAppIDSet' publications: type: array items: type: object $ref: '#/components/schemas/apiWorkflowVersionUnPublishRequest' V2PostAppDuplicationsBody: type: object properties: user_app_id: type: object description: The user and application ID of the source application to duplicate. title: The user and application ID of the source application to duplicate. app_duplications: type: array items: type: object $ref: '#/components/schemas/apiAppDuplication' description: 'Deprecated: App duplication is no longer supported. Request to start app duplication jobs.' apiConfusionMatrixEntry: type: object properties: predicted: type: string actual: type: string value: type: number format: float predicted_concept: $ref: '#/components/schemas/apiConcept' actual_concept: $ref: '#/components/schemas/apiConcept' title: ConfusionMatrixEntry apiPipelineVersionRunStatusLog: type: object properties: id: type: string title: Unique ID for this status record pipeline_version_run_id: type: string title: The PipelineVersionRun this log entry belongs to status: $ref: '#/components/schemas/apistatusStatus' title: Clarifai status object representing the current status message: type: string title: Optional human-readable reason or message (e.g. "Paused due to resource limit") triggered_by_user_id: type: string title: Who triggered this status change created_at: type: string format: date-time title: When this status was recorded apiNodeCapacityType: type: object properties: capacity_types: type: array items: $ref: '#/components/schemas/NodeCapacityTypeCapacityType' description: 'Type of nodes that are ok for instances in this pool. If both spot and on-demand are provided then the runner will be able to run on either with a preference for spot until they are not available.' V2DeletePipelineStepVersionsBody: type: object properties: user_app_id: type: object description: Common message to identify the app in a url endpoint. pipeline_step_version_ids: type: array items: type: string title: The ids of the pipeline step versions to delete V2DeletePipelinesBody: type: object properties: user_app_id: type: object description: Common message to identify the app in a url endpoint. ids: type: array items: type: string apiTask: type: object properties: id: type: string description: Unique ID for the task. created_at: type: string format: date-time description: 'When the task was created. The format is https://www.ietf.org/rfc/rfc3339.txt. Example: "2006-01-02T15:04:05.999999Z".' modified_at: type: string format: date-time description: 'Most recent time when the task was updated. The format is https://www.ietf.org/rfc/rfc3339.txt. Example: "2006-01-02T15:04:05.999999Z".' type: $ref: '#/components/schemas/apiTaskTaskType' description: Task type. description: type: string description: Description of the task. worker: $ref: '#/components/schemas/apiTaskWorker' description: Worker details. concept_ids: type: array items: type: string description: 'List of concept ids used in the work of this task. DEPRECATED: Use task.concepts instead.' input_source: $ref: '#/components/schemas/apiTaskInputSource' description: List of inputs used in this task will be taken from this source. sample_ms: type: integer format: int64 title: 'For model predictions on video: Sample delay for video predicting (1 frame per N milliseconds)' ai_assistant: $ref: '#/components/schemas/apiTaskAIAssistant' description: AI assistant details. review: $ref: '#/components/schemas/apiTaskReview' description: Review details. status: $ref: '#/components/schemas/apistatusStatus' description: Status of this task. name: type: string description: Add a title for this task to quickly recognise it in a list of tasks. ai_assist_params: $ref: '#/components/schemas/apiAiAssistParameters' visibility: $ref: '#/components/schemas/clarifaiapiVisibility' description: 'The visibility field represents whether this message is privately/publicly visible. To be visible to the public the App that contains it AND the User that contains the App must also be publicly visible.' app_id: type: string description: The app the task belongs to. user_id: type: string description: The user the task belongs to. label_order_id: type: string description: The label order the task belongs to. concepts: type: array items: type: object $ref: '#/components/schemas/apiTaskConcept' description: Ignore Task.concept_ids field if Task.TaskConcept are supplied. delete_previous_annotations: type: boolean title: 'Specify whether existing Annotations within the same app that are generated by other auto annotation tasks with the specified Concept from the selected Model or Workflow should deleted before executing the Task' metrics: $ref: '#/components/schemas/apiTaskMetrics' description: Tasks metrics are filled in upon user-request. priority: $ref: '#/components/schemas/TaskTaskPriority' title: Priority of the task metadata: type: object title: 'To handle arbitrary json metadata you can use a struct field: https://github.com/google/protobuf/blob/master/src/google/protobuf/struct.proto' description: Task is the work that needs to be done for labeling the inputs in an app. apiInputsDataSource: type: object properties: inputs_add_job_id: type: string description: 'Collect statistics about created inputs in job with given ID. On Post call: * If job ID is empty, then job is automatically created with random ID. * If job ID is non-empty, then a new job will be created with given ID.' url: $ref: '#/components/schemas/apiDataSourceURL' input_id_conflict_resolution: $ref: '#/components/schemas/apiInputIDConflictResolution' description: How to handle input ID conflicts. input_template: $ref: '#/components/schemas/apiInput' title: Fields set in the template will also be added to all generated inputs apiWorkflowVersionEvaluationTemplateTaskType: type: string enum: - TASK_TYPE_NOT_SET - TEXT_CLASSIFICATION default: TASK_TYPE_NOT_SET apiGeo: type: object properties: geo_point: $ref: '#/components/schemas/apiGeoPoint' geo_limit: $ref: '#/components/schemas/apiGeoLimit' geo_box: type: array items: type: object $ref: '#/components/schemas/apiGeoBoxedPoint' title: 'NOTE: inconsistency: should have been geo_boxed_points' title: Geo V2PostAuditLogSearchesBody: type: object properties: user_app_id: type: object properties: app_id: type: string description: Only the user_id is used from this. title: Only the user_id is used from this. query: $ref: '#/components/schemas/apiAuditLogQuery' sort_ascending: type: boolean description: 'Sorting options: Whether to sort by timestamp in ascending order. If false, will order in descending order.' pagination: $ref: '#/components/schemas/apiPagination' apiAddMetadata: type: object properties: metadata: type: object title: 'To handle arbitrary json metadata you can use a struct field: https://github.com/google/protobuf/blob/master/src/google/protobuf/struct.proto' V2PostTrackAnnotationsSearchesBody: type: object properties: user_app_id: $ref: '#/components/schemas/apiUserAppIDSet' track_id: type: string title: Filter annotations by track_id frame_number_start: type: integer format: int64 title: Filter annotations starting from this frame number (inclusive) frame_time_start: type: string format: uint64 title: Filter annotations starting from this time in milliseconds (inclusive) annotation_type: $ref: '#/components/schemas/apiAnnotationDataType' title: Filter by annotation type (e.g., "bounding_box", "point", "mask") max_frames: type: integer format: int64 title: 'Maximum number of frames to return (default and max: 60)' max_duration: type: string format: uint64 title: 'Maximum duration in milliseconds to return (default and max: 3000)' worker: $ref: '#/components/schemas/apiWorker' description: 'Filtering by model version ID within a worker (optional). Point annotations don''t need filtering by worker. For non-point types, a model version ID must be provided.' title: ListVideoTrackAnnotationsRequest V2PostModelVersionsPublishBody: type: object properties: user_app_id: $ref: '#/components/schemas/apiUserAppIDSet' publications: type: array items: type: object $ref: '#/components/schemas/apiModelVersionPublishRequest' title: PostModelVersionsPublishRequest apiTaskReviewConsensusStrategyInfo: type: object properties: approval_threshold: type: integer format: int64 description: 'Deprecated: Use approval_threshold_labelers.' approval_threshold_labelers: type: integer format: int64 description: 'The number of labelers that need to agree in order to automatically approve an annotation. When 0, labelers consensus is disabled. When 1, the labels are automatically approved once a single labeler labels the input. When greater than 1, the labels are automatically approved when the specified number of labelers agree. If the number of labelers that agree is less than the specified number, then the input will reviewed by reviewers.' approval_threshold_reviewers: type: integer format: int32 title: 'The number of reviewers that need to agree in order to approve an input. Currently, the only allowed values are: 0 - when not set, it defaults to 1 1 - only a single reviewer needs to approve each labeled input -1 - an input will be approved when all reviewers approve it' title: TaskReviewConsensusStrategyInfo apiSingleDatasetVersionResponse: type: object properties: status: $ref: '#/components/schemas/apistatusStatus' dataset_version: $ref: '#/components/schemas/apiDatasetVersion' apiArgoParameterOverride: type: object properties: name: type: string value: type: string title: Argo parameters are always strings V2PatchTasksBody: type: object properties: user_app_id: type: object description: Common message to identify the app in a url endpoint. tasks: type: array items: type: object $ref: '#/components/schemas/apiTask' action: type: string description: 'The action to perform on the patched tasks Supported operations: * ''overwrite'' - overwrite the task with the fields provided in the request * ''merge'' - update only the fields provided in the request, leave other fields unchanged For now, the ''merge'' operation only supports updating task status.' description: Request to patch a list of tasks. apiMultiPipelineResponse: type: object properties: status: $ref: '#/components/schemas/apistatusStatus' pipelines: type: array items: type: object $ref: '#/components/schemas/apiPipeline' apiConceptExtraInfoRequest: type: object properties: rankable_model: $ref: '#/components/schemas/apiModel' title: 'Determine if the concept is searchable by rank using this model. Currently, only embedder models are supported. ########## Supported fields ########## - app_id - id - model_version.id - user_id' apiInputIDConflictResolution: type: string enum: - INPUT_ID_CONFLICT_RESOLUTION_NOT_SET - SKIP - SUFFIX default: INPUT_ID_CONFLICT_RESOLUTION_NOT_SET description: " - INPUT_ID_CONFLICT_RESOLUTION_NOT_SET: Defaults to SKIP\n - SKIP: Mark duplicate inputs as error and skip processing them.\n - SUFFIX: Add a suffix to inputs with conflicting IDs. Attempts numeric suffixes \"-1\" to \"-9\" and then a randomized suffix. Identical ID's in the same request are still treated as errors." apiOutput: type: object properties: id: type: string title: One of these outputs per Input status: $ref: '#/components/schemas/apistatusStatus' created_at: type: string format: date-time title: 'When the object was created. We follow the XXXX timestamp format. We use https://www.ietf.org/rfc/rfc3339.txt format: "2006-01-02T15:04:05.999999Z" so you can expect results like the following from the API: "2017-04-11T21:50:50.223962Z"' model: $ref: '#/components/schemas/apiModel' description: The model that created this Output. input: $ref: '#/components/schemas/apiInput' description: 'The input that was passed to the model to create this Output. For example if we have an image model then it will take as input here an Input object with Image filled in.' data: $ref: '#/components/schemas/apiData' description: 'The output data for this Output. For example if we have a concept model then the predicted concepts will appear here.' prompt_tokens: type: integer format: int64 description: Number of prompt tokens as reported by the model or third-party API. completion_tokens: type: integer format: int64 description: Number of completion tokens as reported by the model or third-party API. cached_tokens: type: integer format: int64 description: 'Number of cached prompt tokens as reported by the model (subset of prompt_tokens). Cached tokens are prompt tokens served from the model''s KV cache rather than recomputed.' title: Output apiRunnerReplicaTaskMetrics: type: object properties: task_id: type: string start_time: type: string format: date-time description: Time window these metrics cover. end_time: type: string format: date-time start_frame_time: type: string format: uint64 description: Frame time range in milliseconds (nullable — absent when no frames have been processed yet). end_frame_time: type: string format: uint64 frames_processed: type: integer format: int64 description: Frame counts. frames_dropped: type: integer format: int64 frames_skipped: type: integer format: int64 annotations_uploaded: type: integer format: int64 description: Annotation counts. annotations_failed: type: integer format: int64 batches_uploaded: type: integer format: int64 batches_dropped: type: integer format: int64 avg_upload_latency: type: string description: Upload latency metrics (nullable — absent means not yet measured). max_upload_latency: type: string last_upload_latency: type: string avg_stream_delay: type: string description: Stream delay metrics (nullable — absent means not yet measured). max_stream_delay: type: string last_stream_delay: type: string predict_queue_size: type: integer format: int64 description: Queue metrics. upload_queue_size: type: integer format: int64 current_frame_drop_chance: type: number format: float description: Current probability of dropping a frame (0.0 – 1.0). description: 'RunnerReplicaTaskMetrics captures auto-annotation task metrics reported by an individual runner replica. Each entry corresponds to a specific task running on a specific replica.' apiRunnerMetrics: type: object properties: pods_total: type: integer format: int64 pods_running: type: integer format: int64 total_pods_running_time_s: type: integer format: int64 description: 'Cumulative total time (in seconds) that pods have been running for this runner. This accumulates across scale-up/down cycles and is reported by the agent.' pods_preempted_total: type: integer format: int64 description: 'Cumulative count of pods that have been preempted by the k8s scheduler. This accumulates across reconcile cycles and is reported by the agent.' description: 'RunnerMetrics captures metrics and status for a Runner''s underlying k8s deployment. This allows tracking of deployment health, replica counts, and other relevant metrics.' apiAnnotationFilter: type: object properties: id: type: string title: The ID for the annotation filter created_at: type: string format: date-time description: 'When the annotation filter was created. The format is https://www.ietf.org/rfc/rfc3339.txt. Example: "2006-01-02T15:04:05.999999Z".' modified_at: type: string format: date-time description: 'When the annotation filter was modified. The format is https://www.ietf.org/rfc/rfc3339.txt. Example: "2006-01-02T15:04:05.999999Z".' user_id: type: string description: The user the annotation filter belongs to. app_id: type: string description: The app the annotation filter belongs to. search: $ref: '#/components/schemas/apiSearch' description: The search that this filter uses. description: 'AnnotationFilter is used to create a new dataset version. For now, the filter is simply a wrapper over a Search. In the future, we may add extra fields to customize the filtering.' apiW3C: type: object properties: hex: type: string name: type: string apiModelTypeFieldDataType: type: string enum: - NOT_SET - STR - BYTES - INT - FLOAT - BOOL - NDARRAY - JSON_DATA - TEXT - IMAGE - CONCEPT - REGION - FRAME - AUDIO - VIDEO - NAMED_FIELDS - TUPLE - LIST default: NOT_SET description: "DataType is used in MethodSignature to define all the possible types that a python function\nmay have that we want to support. These include built-ins like int, float, str, bool, and\nmore complex types like JSON, numpy arrays, List, Tuple, Dict (as Named Fields), as well as Clarifai provided\nunstructured types like Image, Video, Text, etc.\n\n - STR: A string value.\n - BYTES: A byte string. This is used for binary data.\n - INT: An integer value.\n - FLOAT: A float value.\n - BOOL: A boolean value.\n - NDARRAY: A proto representation for numpy arrays.\n - JSON_DATA: For arbitrary json object: \"{...}\"\n - TEXT: For text data\n - IMAGE: A image is a image proto for url or bytes.\n - CONCEPT: A concept is a concept proto that represents a concept in the app.\n - REGION: A region is a bounding box in an image or video frame.\n - FRAME: A frame is a single image in a video stream\n - AUDIO: A audio is a audio proto for url or bytes.\n - VIDEO: A video is a video proto for url or bytes.\n - NAMED_FIELDS: this can be used to store named fields with values similar to Dict\n - TUPLE: An arg that is a tuple.\n - LIST: An arg that is a list." apiInputInfo: type: object properties: fields_map: type: object description: 'Map from the api.Data field names to the underlying model graph''s inputs. When using a PretrainedModelConfig the values in this map need to match the Triton config.pbtxt input names.' params: type: object description: 'To control the inputs to the given model we allow a list of parameters defined for each ModelType as a Struct (JSON object) here. During training or inference, the settings contained within are sent to the training processor to alter the training process.' base_embed_model: $ref: '#/components/schemas/apiModel' description: For base model to get embeddings from for transfer learned models. title: InputInfo apiUser: type: object properties: id: type: string primary_email: type: string first_name: type: string last_name: type: string company_name: type: string job_title: type: string job_role: type: string intention: type: string title: This specifies user intent when registering on clarifai referral_source: type: string title: This specifies how one got to know about clarifai bill_type: type: string created_at: type: string format: date-time title: 'When the user was created. We follow the XXXX timestamp format. We use https://www.ietf.org/rfc/rfc3339.txt format: "2006-01-02T15:04:05.999999Z" so you can expect results like the following from the API: "2017-04-11T21:50:50.223962Z"' date_gdpr_consent: type: string format: date-time date_tos_consent: type: string format: date-time date_marketing_consent: type: string format: date-time date_pii_consent: type: string format: date-time metadata: type: object title: 'To handle arbitrary json metadata you can use a struct field: https://github.com/google/protobuf/blob/master/src/google/protobuf/struct.proto' email_addresses: type: array items: type: object $ref: '#/components/schemas/apiEmailAddress' two_factor_auth_enabled: type: boolean teams_count: type: integer format: int64 is_starred: type: boolean title: 'Is starred by the requesting user (only showed on get/list requests) Please use PostUserStars/DeleteUserStars endpoints to star/unstar an user' star_count: type: integer format: int32 title: 'How many users have starred the user (only showed on get/list requests) Computed value, not editable' visibility: $ref: '#/components/schemas/clarifaiapiVisibility' description: 'The visibility field represents whether this message is privately/publicly visible. To be visible to the public the App that contains it AND the User that contains the App must also be publicly visible.' user_detail: $ref: '#/components/schemas/apiUserDetail' description: 'This is all the personal information of a user. GetUser/ListUsers will not return this information unless the caller has the UserAccounts_Get scope on their key or is the user themselves.' image: $ref: '#/components/schemas/apiImage' title: Representative image for this User (a.k.a. Profile or cover photo) title: User V2PostInputsDataSourcesBody: type: object properties: user_app_id: type: object description: Common message to identify the app in a url endpoint. data_sources: type: array items: type: object $ref: '#/components/schemas/apiInputsDataSource' call_back_url: type: string description: If call back url is set, we will send a Post request to this endpoint with job status. app_pat: type: string title: 'Personal Access Token to the application to which inputs are added Deprecated: No need to send app_pat, it will be generated internally if not present' description: 'Initiates retrieval of inputs from cloud storage from a user provided data source. Will create and return an inputs-add-job for tracking progress. Archives will be extracted and their contents will be processed as inputs. The cloud URL will be treated as a filter prefix. For example s3:/bucket/images_folder/abc will process files in the images_folder beginning with abc or in a subfolder beginning with abc. For example: bucket/images_folder/abcImage.png bucket/images_folder/abc-1/Data.zip If given URL is for a private bucket or file, then credentials should be provided to access the bucket. Credentials should include rights to list the objects in the bucket, except when pointed directly at a file archive, in which case it only requires rights to access that particular file.' apiProgress: type: object properties: processed: type: integer format: int64 last_processed_id: type: string apiSingleSecretResponse: type: object properties: status: $ref: '#/components/schemas/apistatusStatus' secret: $ref: '#/components/schemas/apiSecret' apiDeployment: type: object properties: id: type: string description: An id for this configured deployment. user_id: type: string description: The user who owns the deployment. These live in the user/org account. autoscale_config: $ref: '#/components/schemas/apiAutoscaleConfig' description: "How to autoscale the object.\n\nYou can configure different autoscaling per nodepool(s).\n These nodepools have to be also owned by the same user_id/org as this deployment.\n If there is more than one nodepool we use the model's ComputeInfo to match\n with what the nodepool provides to decide which one can handle it combined with the\n NodepoolRank below. Note: even within a single nodepool if it is heterogeneous then\n we need a way to rank scheduling choices when we don't know how to decide (like a model\n supports" nodepools: type: array items: type: object $ref: '#/components/schemas/apiNodepool' title: Use DeploymentNodepools field instead scheduling_choice: $ref: '#/components/schemas/DeploymentSchedulingChoice' visibility: $ref: '#/components/schemas/clarifaiapiVisibility' description: 'The visibility field represents whether this message is privately/publicly visible. To be visible to the public the App that contains it AND the User that contains the App must also be publicly visible.' metadata: type: object title: 'To handle arbitrary json metadata: https://github.com/google/protobuf/blob/master/src/google/protobuf/struct.proto' description: type: string description: Short description of deployment. worker: $ref: '#/components/schemas/apiWorker' title: 'The thing that the autoscaling config applies to for this nodepool. For a given user_id, nodepool_id, and object ID we can only have one deployment as it defines' desired_worker: $ref: '#/components/schemas/apiWorker' created_at: type: string format: date-time description: When the deployment was created. modified_at: type: string format: date-time description: When the deployment was last modified. deploy_latest_version: type: boolean title: Whether to always deploy latest model version special_handling: type: array items: type: object $ref: '#/components/schemas/apiSpecialHandling' description: List of special handling instructions for this deployment. email_reminder_after: type: string description: 'Duration after which to send a reminder email if pods are still running. If set, users will receive a one-time email notification when any runner under this deployment has been running longer than this duration.' graceful_deploy: type: boolean title: Whether to gracefully deploy a new worker deployment_nodepools: type: array items: type: object $ref: '#/components/schemas/apiDeploymentNodepool' description: 'Per-nodepool settings including priority. If set, ''nodepools'' must not also be set. When any priority value is non-zero, the response will populate this field instead of ''nodepools''.' deployment_metrics: $ref: '#/components/schemas/apiDeploymentMetrics' description: Real-time metrics for this deployment, including the desired and live replica counts. status: $ref: '#/components/schemas/apiDeploymentStatus' description: 'The current status of the deployment. When disabled, all infrastructure is scaled to zero and prediction requests are rejected. The autoscale_config is preserved for when the deployment is enabled.' description: 'A deployment allows you to configure how runners for a particular type of resource will scale up and down. These are unique per user_id, nodepool and model so for differnet nodepools you can scale differently.' apiBoundingBox: type: object properties: top_row: type: number format: float title: The top left of the bounding box normalized to the data dimension to be within [0-1.0] left_col: type: number format: float title: The left column of the bounding box normalized to the data dimension to be within [0-1.0] bottom_row: type: number format: float title: The bottom row of the bounding box normalized to the data dimension to be within [0-1.0] right_col: type: number format: float title: The right col of the bounding box normalized to the data dimension to be within [0-1.0] description: Rectangular bounding box for a region. apiSingleDeploymentResponse: type: object properties: status: $ref: '#/components/schemas/apistatusStatus' deployment: $ref: '#/components/schemas/apiDeployment' TaskReviewTaskReviewStrategy: type: string enum: - TASK_REVIEW_STRATEGY_NOT_SET - NONE - MANUAL - CONSENSUS default: TASK_REVIEW_STRATEGY_NOT_SET description: " - NONE: No review is needed.\nWhen a labeler labels an input, the annotations are immediately approved.\n - MANUAL: Human reviewers will review the work done by labelers.\n - CONSENSUS: Automatically approve inputs when labelers reach consensus.\nIf consensus is not reached, then it will fallback to human reviewers." V2PatchInputsSearchesBody: type: object properties: user_app_id: type: object description: The user_id and app_id to query from. title: The user_id and app_id to query from. searches: type: array items: type: object $ref: '#/components/schemas/apiSearch' title: The searches to be patched action: type: string title: 'The action to perform on the patched Search objects For now only action ''overwrite'' is supported' apiLabelSubmitConfig: type: object properties: task_assignments: type: array items: type: object $ref: '#/components/schemas/apiTaskAssignment' apiUserDetail: type: object properties: primary_email: type: string bill_type: type: string date_gdpr_consent: type: string format: date-time date_tos_consent: type: string format: date-time date_marketing_consent: type: string format: date-time date_pii_consent: type: string format: date-time metadata: type: object title: 'To handle arbitrary json metadata you can use a struct field: https://github.com/google/protobuf/blob/master/src/google/protobuf/struct.proto' email_addresses: type: array items: type: object $ref: '#/components/schemas/apiEmailAddress' two_factor_auth_enabled: type: boolean teams_count: type: integer format: int64 country: type: string state: type: string commitment_value: $ref: '#/components/schemas/apiCommitmentValue' phone_verified: type: boolean title: For phone number verification, true if the phone number has been verified description: 'This message holds the confidential information from the User object that we don''t want to expose to other users. It will be accessible only from /users/{user_id}/account and with the User scopes.' apiMetricData: type: object properties: matrix_data: $ref: '#/components/schemas/MetricDataMatrixData' apiTextInfo: type: object properties: char_count: type: integer format: int32 title: count of characters in text encoding: type: string title: text encoding SpecialHandlingReason: type: string enum: - REASON_NOT_SET - CONTACT_SALES - INTERNAL_ONLY default: REASON_NOT_SET apiMultiRunnerItemResponse: type: object properties: status: $ref: '#/components/schemas/apistatusStatus' runner_items: type: array items: type: object $ref: '#/components/schemas/apiRunnerItem' title: MultiRunnerItemResponse V2DeleteTasksBody: type: object properties: user_app_id: type: object description: Common message to identify the app in a url endpoint. ids: type: array items: type: string description: Request to delete a list of tasks. apiSinglePipelineResponse: type: object properties: status: $ref: '#/components/schemas/apistatusStatus' pipeline: $ref: '#/components/schemas/apiPipeline' apiMultiPipelineVersionRunResponse: type: object properties: status: $ref: '#/components/schemas/apistatusStatus' pipeline_version_runs: type: array items: type: object $ref: '#/components/schemas/apiPipelineVersionRun' apiMultiInputAnnotationResponse: type: object properties: status: $ref: '#/components/schemas/apistatusStatus' hits: type: array items: type: object $ref: '#/components/schemas/apiHit' title: MultiInputAnnotationResponse apiAzureBlobCreds: type: object properties: account_name: type: string account_key: type: string description: Azure Blob storage credentials. apiHostedURL: type: object properties: prefix: type: string description: Prefix of the URL of every hosted image. suffix: type: string description: Suffix of an image stored in different sizes. sizes: type: array items: type: string description: 'The sizes field lists which images of the different sizes are hosted in our storage. The URL of each hosted image can be obtained by joining the prefix, one of the sizes and suffix.' crossorigin: type: string title: 'The crossorigin property of html media tag For Secure Data Hosting this needs to be set to ''use-credentials''' title: HostedURL apiThresholdRange: type: object properties: is_lower_inclusive: type: boolean title: 'The range used to filter over concept values. e.g. GREATER_THAN_OR_EQUAL_TO 0.7 -> is_lower_inclusive = true, lower = 0.7, is_upper_inclusive = true, upper = 1.0 e.g. (0.3, 0.75] -> is_lower_inclusive = false, lower = 0.3, is_upper_inclusive = true, upper = 0.75' is_upper_inclusive: type: boolean lower: type: number format: float upper: type: number format: float V2DeleteModelsBody: type: object properties: user_app_id: type: object description: Common message to identify the app in a url endpoint. ids: type: array items: type: string delete_all: type: boolean description: Request to delete several things by the list of ids. V2PostPipelineVersionRunsBody: type: object properties: user_app_id: type: object description: Common message to identify the app in a url endpoint. pipeline_version_runs: type: array items: type: object $ref: '#/components/schemas/apiPipelineVersionRun' runner_selector: $ref: '#/components/schemas/apiRunnerSelector' title: Allows using specific Nodepools for pipeline version runs TaskWorkerPartitionedStrategyInfoTaskWorkerPartitionedStrategy: type: string enum: - PARTITIONED_WORKER_STRATEGY_NOT_SET - EVENLY - WEIGHTED default: PARTITIONED_WORKER_STRATEGY_NOT_SET description: " - EVENLY: Each worker will label (approximately) the same number of inputs.\n - WEIGHTED: Each worker will have an assigned weight.\nSee weights field for more details." V2PatchModelVersionsBody: type: object properties: user_app_id: type: object description: Common message to identify the app in a url endpoint. model_versions: type: array items: type: object $ref: '#/components/schemas/apiModelVersion' action: type: string title: 'The action to perform on the patched objects For now actions ''merge'', ''overwrite'', and ''remove'' are supported' title: PatchModelVersionsRequest V2StreamLivestreamAnnotationsBody: type: object properties: user_app_id: $ref: '#/components/schemas/apiUserAppIDSet' min_prediction_score: type: number format: float description: 'Optional minimum prediction confidence threshold (0.0 to 1.0). When set (> 0), only annotations with at least one concept (tag) having metadata.prediction_score >= this value are streamed. When unset (0), all annotations are streamed (backwards compatible).' title: 'StreamLivestreamAnnotationsRequest Streams live annotations from Redis as they are being created by the runner' V2PatchModelIdsBody: type: object properties: user_app_id: type: object description: Common message to identify the app in a url endpoint. ids: type: array items: type: object $ref: '#/components/schemas/apiIdUpdateSource' title: Array containing 1 entry action: type: string title: 'The action to perform on the patched objects Only ''overwrite'' is supported' title: PatchModelIdsRequest V2PatchPipelineVersionsBody: type: object properties: user_app_id: type: object description: Common message to identify the app in a url endpoint. pipeline_versions: type: array items: type: object $ref: '#/components/schemas/apiPipelineVersion' title: Patch these versions action: type: string title: 'The action to perform on the patched objects For now actions ''merge'', ''overwrite'', and ''remove'' are supported' clarifaiapiVisibility: type: object properties: gettable: $ref: '#/components/schemas/VisibilityGettable' description: 'Visibility represents how visible the given resource is to other users. When authenticating a request we can tell if a user is a collaborator or a teammate for the the app that contains the resource and set their allowed visibility. We use that to restrict what they are allowed to see: If AllowedVisibility is PRIVATE then we allow PRIVATE (10), ORG (30), PUBLIC (50) If AllowedVisibility is ORG then we allow ORG (30), PUBLIC (50) If AllowedVisibility is PUBLIC then we allow PUBLIC (50) only.' apiLabelDistribution: type: object properties: positive_label_counts: type: array items: type: object $ref: '#/components/schemas/apiLabelCount' title: LabelDistribution apiArgoOrchestrationSpec: type: object properties: api_version: type: string title: 'The API version of the orchestration specification. Example: "argoproj.io/v1alpha1", "argoproj.io/v1beta1"' spec_json: type: string description: The JSON representation of the Argo orchestration specification. apiWorkflowVersion: type: object properties: id: type: string description: Id of this version. workflow_id: type: string description: Workflow id for this version. created_at: type: string format: date-time description: 'When the version was created. The format is https://www.ietf.org/rfc/rfc3339.txt. Example: "2006-01-02T15:04:05.999999Z".' modified_at: type: string format: date-time description: 'Most recent time when the version was updated. The format is https://www.ietf.org/rfc/rfc3339.txt. Example: "2006-01-02T15:04:05.999999Z".' visibility: $ref: '#/components/schemas/clarifaiapiVisibility' description: 'The visibility field represents whether this message is privately/publicly visible. To be visible to the public the App that contains it AND the User that contains the App must also be publicly visible.' nodes: type: array items: type: object $ref: '#/components/schemas/apiWorkflowNode' description: 'The list of nodes that make up the workflow version. Each node can specify an input node that it connects to in order to define the graph.' metadata: type: object title: 'To handle arbitrary json metadata you can use a struct field: https://github.com/google/protobuf/blob/master/src/google/protobuf/struct.proto' app_id: type: string description: The app the workflow version belongs to. user_id: type: string description: The user the workflow version belongs to. description: type: string title: Short description about this workflow version license: type: string title: License associated to this workflow version is_deprecated: type: boolean description: 'If a model version associated with the workflow version is deleted, the workflow version will be marked as deprecated.' title: WorkflowVersion apiModelQuery: type: object properties: name: type: string description: The name ofthe field. This supports wilcard queries like "gen*" to match "general" as an example. model_type_id: type: string description: 'Filter models by the specific model_type_id. See ListModelTypes for the list of ModelType.Id''s supported.' title: ModelQuery apiSingleAppResponse: type: object properties: status: $ref: '#/components/schemas/apistatusStatus' app: $ref: '#/components/schemas/apiApp' title: SingleAppResponse apiMultiDeploymentResponse: type: object properties: status: $ref: '#/components/schemas/apistatusStatus' deployments: type: array items: type: object $ref: '#/components/schemas/apiDeployment' apiEvaluationType: type: string enum: - Undefined - Classification - Detection - Segmentation - Clustering - Tracker - Generation default: Undefined title: '- Classification: default' V2PatchAppsIdsBody: type: object properties: user_app_id: type: object properties: app_id: type: string description: Common message to identify the app in a url endpoint. ids: type: array items: type: object $ref: '#/components/schemas/apiIdUpdateSource' title: Array containing 1 entry action: type: string title: 'The action to perform on the patched objects Only ''overwrite'' is supported' title: PatchAppsIdsRequest apiMultiOutputResponse: type: object properties: status: $ref: '#/components/schemas/apistatusStatus' outputs: type: array items: type: object $ref: '#/components/schemas/apiOutput' description: For each input processed during model prediction we create one output. runner_selector: $ref: '#/components/schemas/apiRunnerSelector' title: Information on where the computation is executed down to specific Deployment, Nodepool and ComputeCluster title: MultiOutputResponse apiTaskAIAssistant: type: object properties: workflow_id: type: string description: 'The worker is helped by an AI assistant. This field is the workflow id which is used to assist the worker with predictions. If empty, then AI assistant is disabled.' workflow: $ref: '#/components/schemas/apiWorkflow' title: TaskAIAssistant apiDatasetVersionMetricsGroupType: type: string enum: - DATASET_VERSION_METRICS_GROUP_TYPE_NOT_SET - INPUT_TYPE - CONCEPT_ID - CONCEPTS_COUNT - BOUNDING_BOXES_COUNT - POLYGONS_COUNT - POINTS_COUNT - MASKS_COUNT - PIXELS_COUNT - ASPECT_RATIO default: DATASET_VERSION_METRICS_GROUP_TYPE_NOT_SET description: " - INPUT_TYPE: Group data examples by input type.\nExamples: images, videos, text, audio.\n - CONCEPT_ID: Group data examples by concept ID.\nExamples: inputs with cat concept, inputs with dog concept.\n - CONCEPTS_COUNT: Group data examples by concepts count.\nExamples: inputs with 20 concepts, inputs with 21 concepts.\n - BOUNDING_BOXES_COUNT: Group data examples by bounding boxes count.\nExamples: inputs with 20 bounding boxes, inputs with 21 bounding boxes.\n - POLYGONS_COUNT: Group data examples by polygons count.\nExamples: inputs with 20 polygons, inputs with 21 polygons.\n - POINTS_COUNT: Group data examples by points count.\nExamples: inputs with 20 points, inputs with 21 points.\n - MASKS_COUNT: Group data examples by masks count.\nExamples: inputs with 20 masks, inputs with 21 masks.\n - PIXELS_COUNT: Group data examples by pixels count.\nIn order to reduce the number of groups, we use bins.\nExamples for bin size = 400: inputs with [200000, 200400) pixels, inputs with [200400, 200800) pixels.\n - ASPECT_RATIO: Group data examples by aspect ratio.\nIn order to reduce the number of groups, we use bins.\nExamples for bin size = 0.1: inputs with [0.5, 0.6) aspect ratio, inputs with [0.6, 0.7) aspect ratio." apiDatasetVersionExport: type: object properties: format: $ref: '#/components/schemas/apiDatasetVersionExportFormat' description: format is the format of the dataset version export. status: $ref: '#/components/schemas/apistatusStatus' description: status is the current status of the dataset version export. url: type: string description: url is the URL from where the dataset version export can be downloaded. size: type: string format: uint64 description: size is the size of the dataset version export in number of bytes. include_embeddings: type: boolean description: whether to include embeddings in the export or not. description: DatasetVersionExport contains metadata for a single dataset version export. apiAudioInfo: type: object properties: audio_format: type: string title: audio format sample_rate: type: integer format: int32 title: sample rate duration_seconds: type: number format: float title: audio track duration in seconds bit_rate: type: integer format: int32 title: audio track bit rate apiNDArray: type: object properties: buffer: type: string format: byte title: The bytes of data from the array from array.tobytes() shape: type: array items: type: integer format: int64 description: Simply the shape of the numpy array. array.shape. dtype: type: string description: 'Dtype for numpy. You can get it back from this string format using: np.dtype(''float32'') for example.' description: 'To convert this proto ''ndarray_proto'' to a numpy array: array = np.frombuffer(ndarray_proto.buffer, dtype=ndarray_proto.dtype) array = array.reshape(tuple(ndarray_proto.shape))' title: 'A representation of a numpy array as a proto. To convert a numpy array ''ndarray'' to this proto do: NDArray(buffer=ndarray.tobytes(), shape=ndarray.shape, dtype=str(ndarray.dtype))' apiWorkflowVersionEvaluationMetric: type: object properties: id: type: string summary: type: string description: type: string data_type: $ref: '#/components/schemas/apiWorkflowVersionEvaluationMetricDataType' title: Metric data type - string, float, int visualisation_type: $ref: '#/components/schemas/WorkflowVersionEvaluationMetricVisualisationType' statusBaseResponse: type: object properties: status: $ref: '#/components/schemas/apistatusStatus' description: 'Base message to return when there is a internal server error that is not caught elsewhere.' apiWorkflowResult: type: object properties: id: type: string status: $ref: '#/components/schemas/apistatusStatus' created_at: type: string format: date-time title: 'When the object was created. We follow the XXXX timestamp format. We use https://www.ietf.org/rfc/rfc3339.txt format: "2006-01-02T15:04:05.999999Z" so you can expect results like the following from the API: "2017-04-11T21:50:50.223962Z"' input: $ref: '#/components/schemas/apiInput' description: The input that ran through the workflow to generate the outputs in this WorkflowResult. outputs: type: array items: type: object $ref: '#/components/schemas/apiOutput' description: For each model in the workflow we return an Output. suppress_output: type: boolean description: Indicate if the output of this model is suppressed. description: 'WorkflowResult One result per input in the workflow.' apiApp: type: object properties: id: type: string name: type: string default_language: type: string default_workflow_id: type: string description: 'Deprecated, use default_workflow instead. @exclude TODO (EAGLE-4506): Remove this field and associated code' default_workflow: $ref: '#/components/schemas/apiWorkflow' user_id: type: string title: 'why is user_id present here when this message type is used in PostApps but completely ignored there? PostApp already specifies the userid in path but doesn''t even actually use neither of userids, it instead used the id from auth context. This creates a lot of ambiguity, should always have different message types for Post/Get endpoints so that the minimum interface for each op can be described' created_at: type: string format: date-time title: 'When the app was created. We follow the XXXX timestamp format. We use https://www.ietf.org/rfc/rfc3339.txt format: "2006-01-02T15:04:05.999999Z" so you can expect results like the following from the API: "2017-04-11T21:50:50.223962Z"' modified_at: type: string format: date-time title: When the app was last modified legal_consent_status: type: integer format: int64 title: if user accept legal consent for face recognition metadata: type: object title: 'To handle arbitrary json metadata you can use a struct field: https://github.com/google/protobuf/blob/master/src/google/protobuf/struct.proto' description: type: string description: short description about the app. sample_ms: type: integer format: int64 title: 'Default value for model predictions on video: Sample delay for video predicting (1 frame per N milliseconds)' visibility: $ref: '#/components/schemas/clarifaiapiVisibility' description: 'The visibility field represents whether this message is privately/publicly visible. To be visible to the public the App that contains it AND the User that contains the App must also be publicly visible.' data_tier_id: type: string description: data tier id this app is using. is_starred: type: boolean title: 'Is starred by the requesting user (only showed on get/list requests) Please use PostAppStars/DeleteAppStars endpoints to star/unstar an app' star_count: type: integer format: int32 title: 'How many users have starred the app (only showed on get/list requests) Computed value, not editable' notes: type: string description: 'Notes for the application This field should be used for in-depth notes and supports up to 64Kbs.' image: $ref: '#/components/schemas/apiImage' title: Representative image for this app is_template: type: boolean description: 'An app marked as a template can be duplicated by any user that can see it, including all visible resources within it.' extra_info: $ref: '#/components/schemas/apiAppExtraInfo' embeddings_storage: $ref: '#/components/schemas/AppEmbeddingsStorage' title: 'Where app embeddings are stored postgres (default), qdrant' title: Application with tasks and datasets apiTaskTaskType: type: string enum: - TYPE_NOT_SET - CONCEPTS_CLASSIFICATION - BOUNDING_BOX_DETECTION - POLYGON_DETECTION default: TYPE_NOT_SET description: " - CONCEPTS_CLASSIFICATION: Concepts classification tasks annotate concepts for the overall image, frame of video or section of text.\n - BOUNDING_BOX_DETECTION: Bounding box detection tasks annotate rectangular bounding box regions around each concept in an image, frame of video or section of text.\n - POLYGON_DETECTION: Polygon detection tasks annotate free-form regions around concepts in an image, frame of video or section of text." V2PostDeploymentsBody: type: object properties: user_app_id: type: object properties: app_id: type: string description: Only the user_id is used from this. title: Only the user_id is used from this. deployments: type: array items: type: object $ref: '#/components/schemas/apiDeployment' description: This allows you to create one or more deployments by posting it to the API. apiModelTypeEnumOption: type: object properties: id: type: string description: The unique value of the enum option. aliases: type: array items: type: object $ref: '#/components/schemas/apiModelTypeEnumOptionAlias' title: 'List of other ID values that are equivalent with this ID. This allows the user to choose this option by multiple IDs. Example: if enum is "Phone Number Prefix", you could add an option that is selectable by two values: 1. ID: "Estonia" 2. Alias: 37' description: type: string description: Optional description for this enum option. model_type_fields: type: array items: type: object $ref: '#/components/schemas/apiModelTypeField' description: 'These are additional fields that are specific to this enum choice. This allows us to use enums to control configuration settings as well.' internal_only: type: boolean description: If this enum option should be internal only. recommended: type: boolean description: 'Whether this is the recommended enum option. Set to `true` when there are multiple options, and one is shown to be better than the others.' title: ModelTypeEnumOption TaskWorkerWorkerType: type: string enum: - WORKER_TYPE_NOT_SET - WORKER_HUMAN - WORKER_AUTO default: WORKER_TYPE_NOT_SET title: "- WORKER_TYPE_NOT_SET: for backward compatibility when task is not setting any type and only sets workers\n - WORKER_HUMAN: only human workers\n - WORKER_AUTO: auto-annotation tasks. Task must set worker as model or workflow" apiMultiModelReferenceResponse: type: object properties: status: $ref: '#/components/schemas/apistatusStatus' model_references: type: array items: type: object $ref: '#/components/schemas/apiModelReference' title: MultiModelReferenceResponse apiGetVideoManifestResponse: type: object properties: status: $ref: '#/components/schemas/apistatusStatus' manifest_url: type: string title: 'MPEG-dash manifest as data-URI, base64-encoded Can be empty if status is FAILED Can be fallback manifest if status is MIXED_STATUS' apiPostWorkflowResultsResponse: type: object properties: status: $ref: '#/components/schemas/apistatusStatus' description: The status of the request. workflow: $ref: '#/components/schemas/apiWorkflow' title: The workflow that was used in predictions with PostWorkflowResults results: type: array items: type: object $ref: '#/components/schemas/apiWorkflowResult' description: The resulting predictions of all models in the workflow. workflow_state: $ref: '#/components/schemas/apiWorkflowState' description: 'A workflow state to be maintained across PostWorkflowResults requests/responses. This WorkflowState should be passed in to subsequent PostWorkflowResults calls if you want to keep track of state across requests. If no WorkflowState was initialized in a request then no WorkflowState will be returned in this response.' title: PostWorkflowResultsResponse apiEndpointDeps: type: object properties: endpoint: type: string title: The fully qualified endpoint to depending_scopes: type: array items: type: string description: Other scopes that are required. title: EndpointDeps V2PostAnnotationFiltersBody: type: object properties: user_app_id: type: object description: Common message to identify the app in a url endpoint. annotation_filters: type: array items: type: object $ref: '#/components/schemas/apiAnnotationFilter' description: List of annotation filters that are requested to be added. description: Request to add one or more annotation filters. V2DeleteBulkOperationsBody: type: object properties: user_app_id: type: object description: Common message to identify the app in a url endpoint. ids: type: array items: type: string title: List of bulk operation ids to be deleted description: 'Request to delete the terminated bulk operations by ID Only operations in terminated state can be deleted.' apiLayerShape: type: object properties: dims: type: array items: type: integer format: int32 title: 'Supported dimensions Example: [-1,4] is a 2-dimensional array with the first dimension of variablesize, but second dimension with a static size: [[1,2,3,4],[4,5,6,7],...]' max_dims: type: array items: type: integer format: int32 description: Max dimension size, applicable to layers that can have flexible sizes. data_type: $ref: '#/components/schemas/clarifaiapiDataType' title: The triton data type description: type: string title: Description about the dimensions V2DeleteInputsBody: type: object properties: user_app_id: type: object description: Common message to identify the app in a url endpoint. ids: type: array items: type: string description: Request to delete several things by the list of ids. V2DeleteArtifactVersionBody: type: object properties: user_app_id: type: object description: Common message to identify the app in a url endpoint. artifact_version_id: type: string title: The id of the artifact versions to be deleted apiSinglePipelineVersionResponse: type: object properties: status: $ref: '#/components/schemas/apistatusStatus' pipeline_version: $ref: '#/components/schemas/apiPipelineVersion' apiDeleteConcepts: type: object properties: concepts: type: array items: type: object $ref: '#/components/schemas/apiConcept' user_ids: type: array items: type: string apiInputsUpload: type: object properties: inputs_add_job_id: type: string description: 'Collect statistics about created inputs in job with given ID. * If job ID is empty, then job is automatically created with random ID. * If job ID is non-empty, then a new job will be created with given ID.' app_pat: type: string title: 'Personal Access Token to the application to which inputs are added Deprecated: No need to send app_pat, it will be generated internally if not present' upload: $ref: '#/components/schemas/apiUpload' input_id_conflict_resolution: $ref: '#/components/schemas/apiInputIDConflictResolution' description: How to handle input ID conflicts. input_template: $ref: '#/components/schemas/apiInput' title: Fields set in the template will also be added to all generated inputs apiMultiLabelOrderResponse: type: object properties: status: $ref: '#/components/schemas/apistatusStatus' label_orders: type: array items: type: object $ref: '#/components/schemas/apiLabelOrder' description: Response with multiple label order. V2PostArtifactsBody: type: object properties: user_app_id: type: object description: Common message to identify the app in a url endpoint. artifacts: type: array items: type: object $ref: '#/components/schemas/apiArtifact' apiModelTypeRangeInfo: type: object properties: min: type: number format: float description: The start of the range as a float. max: type: number format: float description: The end of the range as a float. step: type: number format: float description: 'An optional step size for the range. If provided then only values at that step size will be rounded to. For example if step is 0.02 then 0.0245 will round to 0.02.' title: ModelTypeRangeInfo V2PostRunnerItemOutputsBody: type: object properties: user_app_id: type: object properties: app_id: type: string description: Common message to identify the app in a url endpoint. runner_item_outputs: type: array items: type: object $ref: '#/components/schemas/apiRunnerItemOutput' description: This allows you to create one or more runner by posting it to the API. status: $ref: '#/components/schemas/apistatusStatus' description: 'This request has a status so that it can communicate to the API from runners and communicate status, errors, etc. This is on the request since runners operate in a reverse protocol. This status is also used to initiate the ProcessRunnerItems request with RUNNER_STREAM_START code.' runner_replica_id: type: string description: 'A unique ID to represent the runner. This may be tied to an underlying compute instance information or just an UUID.' cloud_provider_id: type: string description: Used by agent runners to specify their cloud provider. region: type: string description: Used by agent runners to specify their region. description: 'PostRunnerItemOutputsRequest This is the message that runners send to the API to communicate. At the end of the request it will have the RunnerItemOutput filled in with results of the workload the runner is processing. Other messages from the runner use this same proto to communicate over to the API and do handshakes.' apiModelVersionUnpublishRequest: type: object properties: version_id: type: string title: ModelVersionUnpublishRequest apiTaskWorkerPartitionedStrategyInfo: type: object properties: type: $ref: '#/components/schemas/TaskWorkerPartitionedStrategyInfoTaskWorkerPartitionedStrategy' description: Define how the partitioning should work. workers_per_input: type: integer format: int32 description: How many workers will label each input. weights: type: object description: 'In case of weighted partitioning, map user ids to weights. Each labeler will be assigned work proportional to its own weight as compared to the sum of total weight. EXAMPLE: If we have 3 workers, and weights = {1: 30, 2: 30, 3: 40}, then first worker will have assigned 30% of the work, second worker will have assigned 30% of the work, and third worker will have assigned 40% of the work. You may use weights which add up to 100, but it''s not necessary. For example, weights {1: 30, 2: 30, 3: 40} are equivalent with {1: 3, 2: 3, 3: 4} because they represent the same percentages: {1: 30%, 2: 30%, 3: 40%}. NOTE: Note that no worker should be assigned a weight percentage greater than 1/workers_per_input. It is mathematically impossible to partition the work in such a case. Why? Say, we have 3 workers. And workers_per_input = 2, i.e. each input must be labeled by 2 workers. Let''s assign weights {1: 51%, 2: 25%, 3: 24%}. Note that first worker has a weight percentage higher than 1/workers_per_input = 1/2 = 50%. If we have 100 inputs, then a total of 100 * workers_per_input = 200 cumulative inputs will be labeled by these 3 workers. Worker 1 should label 102 cumulative inputs, while worker 2 and worker 3 will label 98 cumulative inputs together. No matter how we assign the 98 cumulative inputs, the 2 workers will be able to label up to 98 actual inputs. This means the remaining 2 inputs will be labeled only by worker 1. This contradicts the worker_per_input = 2 requirement.' title: TaskWorkerPartitionedStrategyInfo V2PostRunnersBody: type: object properties: user_app_id: type: object properties: app_id: type: string description: Common message to identify the app in a url endpoint. runners: type: array items: type: object $ref: '#/components/schemas/apiRunner' description: This allows you to create one or more runner by posting it to the API. title: PostRunnersRequest V2PostModelOutputsBody: type: object properties: user_app_id: $ref: '#/components/schemas/apiUserAppIDSet' model_id: type: string version_id: type: string inputs: type: array items: type: object $ref: '#/components/schemas/apiInput' model: $ref: '#/components/schemas/apiModel' description: 'This allows you to specify config options for the model such as the language which appear''s in the model''s output_info.' runner_selector: type: object properties: nodepool: $ref: '#/components/schemas/apiNodepool' description: 'A particular nodepool for the resource to be run within. This request the id and user_id of the nodepool to be specified. Runners will be scaled according to a deployment for the given resource to be run. There should not be more than one deployment in this nodepool for the particular resource to run. If no deployments then default autoscaling will be used.' runner: $ref: '#/components/schemas/apiRunner' description: Optionally a particular runner within the nodepool. deployment: type: object properties: autoscale_config: $ref: '#/components/schemas/apiAutoscaleConfig' description: "How to autoscale the object.\n\nYou can configure different autoscaling per nodepool(s).\n These nodepools have to be also owned by the same user_id/org as this deployment.\n If there is more than one nodepool we use the model's ComputeInfo to match\n with what the nodepool provides to decide which one can handle it combined with the\n NodepoolRank below. Note: even within a single nodepool if it is heterogeneous then\n we need a way to rank scheduling choices when we don't know how to decide (like a model\n supports" nodepools: type: array items: type: object $ref: '#/components/schemas/apiNodepool' title: Use DeploymentNodepools field instead scheduling_choice: $ref: '#/components/schemas/DeploymentSchedulingChoice' visibility: $ref: '#/components/schemas/clarifaiapiVisibility' description: 'The visibility field represents whether this message is privately/publicly visible. To be visible to the public the App that contains it AND the User that contains the App must also be publicly visible.' metadata: type: object title: 'To handle arbitrary json metadata: https://github.com/google/protobuf/blob/master/src/google/protobuf/struct.proto' description: type: string description: Short description of deployment. worker: $ref: '#/components/schemas/apiWorker' title: 'The thing that the autoscaling config applies to for this nodepool. For a given user_id, nodepool_id, and object ID we can only have one deployment as it defines' desired_worker: $ref: '#/components/schemas/apiWorker' created_at: type: string format: date-time description: When the deployment was created. modified_at: type: string format: date-time description: When the deployment was last modified. deploy_latest_version: type: boolean title: Whether to always deploy latest model version special_handling: type: array items: type: object $ref: '#/components/schemas/apiSpecialHandling' description: List of special handling instructions for this deployment. email_reminder_after: type: string description: 'Duration after which to send a reminder email if pods are still running. If set, users will receive a one-time email notification when any runner under this deployment has been running longer than this duration.' graceful_deploy: type: boolean title: Whether to gracefully deploy a new worker deployment_nodepools: type: array items: type: object $ref: '#/components/schemas/apiDeploymentNodepool' description: 'Per-nodepool settings including priority. If set, ''nodepools'' must not also be set. When any priority value is non-zero, the response will populate this field instead of ''nodepools''.' deployment_metrics: $ref: '#/components/schemas/apiDeploymentMetrics' description: Real-time metrics for this deployment, including the desired and live replica counts. status: $ref: '#/components/schemas/apiDeploymentStatus' description: 'The current status of the deployment. When disabled, all infrastructure is scaled to zero and prediction requests are rejected. The autoscale_config is preserved for when the deployment is enabled.' description: "In future as we support matching runners based on just labels:\n RunnerLabels runner_labels = 3; // FUTURE" title: Optionally a particular deployment within the nodepool. title: Allow filtering of prediction requests down to specific Nodepools, Deployments or Runners use_predict_cache: type: boolean title: Configure the prediction cache to avoid expensive compute for predict requests enable_log_summary_on_error: type: boolean title: Configuration to provide logs summarization when request errors out description: '////////////////////////////////////////////////// Model prediction related stuff needs inputs and produces outputs. ////////////////////////////////////////////////// Model prediction.' apiMultiPipelineStepVersionResponse: type: object properties: status: $ref: '#/components/schemas/apistatusStatus' title: The status of the request pipeline_step_versions: type: array items: type: object $ref: '#/components/schemas/apiPipelineStepVersion' title: The pipeline step versions that were requested apiConcept: type: object properties: id: type: string description: The concept's unique id. name: type: string description: The name of the concept in the given language. value: type: number format: float description: 'Used to indicate presence (1.0) or not (0.0) of this concept when making a request. This is also the prediction probability when returning predictions from our API. For convenience we use the default of 1.0 when making requests so the concept you provide is is treated as a positive (1.0) and not a negative (which would be value == 0.0).' created_at: type: string format: date-time description: 'When the concept was created. The format is https://www.ietf.org/rfc/rfc3339.txt . Example: "2006-01-02T15:04:05.999999Z". This field is used only in a response.' language: type: string description: 'The language in which the concept name is in. This is *ONLY* used in the response and setting it in a request is ignored since the default language of your app is used when creating or patching a Concept. To set other languages for your concept use the ConceptLanguage object and its corresponding endpoints.' app_id: type: string description: The application id that this concept is within. This can be ignored by most users. definition: type: string description: The definition for the concept. Similar to name. This can be ignored by most users. vocab_id: type: string description: 'The vocabulary that this concept belongs to. This is useful if you have different unique sets of concepts that you can separate out based on this field. For example "age_appearance" vs "gender_appearance" in a list of concept returned from the demographics model.' visibility: $ref: '#/components/schemas/clarifaiapiVisibility' description: 'The visibility field represents whether this message is privately/publicly visible. To be visible to the public the App that contains it AND the User that contains the App must also be publicly visible.' user_id: type: string description: The user the concept belongs to. keypoint_info: $ref: '#/components/schemas/apiKeypointInfo' title: Information about keypoints for this concept extra_info: $ref: '#/components/schemas/apiConceptExtraInfo' description: Optional extra info. metadata: type: object title: 'To handle arbitrary json metadata: https://github.com/google/protobuf/blob/master/src/google/protobuf/struct.proto' image: $ref: '#/components/schemas/apiImage' title: Representative image for the concept title: Concept or tag apiSingleWorkflowVersionEvaluationResponse: type: object properties: status: $ref: '#/components/schemas/apistatusStatus' workflow_version_evaluation: $ref: '#/components/schemas/apiWorkflowVersionEvaluation' apiModelVersionExport: type: object properties: status: $ref: '#/components/schemas/apistatusStatus' description: status is the current status of the dataset version export. url: type: string description: url is the URL from where the model version export can be downloaded. size: type: string format: int64 title: size of model file description: ModelVersionExport contains metadata for a single Model version export. apiSingleTaskResponse: type: object properties: status: $ref: '#/components/schemas/apistatusStatus' task: $ref: '#/components/schemas/apiTask' description: Response with a single Task. MetricDataMatrixData: type: object properties: series: type: array items: type: object $ref: '#/components/schemas/MatrixDataTimeSeries' apiTaskMetrics: type: object properties: work: $ref: '#/components/schemas/apiTaskWorkMetrics' review: $ref: '#/components/schemas/apiTaskReviewMetrics' input_source: $ref: '#/components/schemas/apiTaskInputSourceMetrics' apiSingleInputResponse: type: object properties: status: $ref: '#/components/schemas/apistatusStatus' input: $ref: '#/components/schemas/apiInput' title: SingleInputResponse apiMultiPipelineVersionRunStatusLogResponse: type: object properties: status: $ref: '#/components/schemas/apistatusStatus' pipeline_version_run_status_logs: type: array items: type: object $ref: '#/components/schemas/apiPipelineVersionRunStatusLog' V2PatchModelCheckConsentsBody: type: object properties: user_app_id: $ref: '#/components/schemas/apiUserAppIDSet' check_consents: type: array items: type: string title: the consents action: type: string title: overwrite supported title: PatchModelCheckConsentsRequest apiTimeInfo: type: object properties: num_frames: type: integer format: int64 title: Number of frames begin_time: type: number format: float description: Timestamp where track begins. end_time: type: number format: float description: Timestamp where track ends. title: TimeInfo V2PatchAppBody: type: object properties: user_app_id: type: object description: Common message to identify the app in a url endpoint. app: $ref: '#/components/schemas/apiApp' action: type: string description: 'The action to perform on the patched App object except App.Metadata Supported values: ''overwrite'' and ''remove''. Note that ''remove'' can only be used to remove the app image by setting ''image.url'' in the request to the current value returned for the app.' metadata_action: $ref: '#/components/schemas/apiPatchAction' title: The action to perform on the patched App.Metadata reindex: type: boolean description: If set, the app will be automatically reindexed upon change of its base workflow. title: PatchAppRequest apiPart: type: object properties: data: $ref: '#/components/schemas/apiData' description: The data for this part. id: type: string description: A unique id for the part. description: A part of data used for multi-modal processing. apiModelVersionPublishRequest: type: object properties: version_id: type: string title: ModelVersionPublishRequest apiMultiAppDuplicationsResponse: type: object properties: status: $ref: '#/components/schemas/apistatusStatus' app_duplications: type: array items: type: object $ref: '#/components/schemas/apiAppDuplication' title: 'Deprecated: App duplication is no longer supported. MultiAppDuplicationsResponse' apiMultiLogEntryResponse: type: object properties: status: $ref: '#/components/schemas/apistatusStatus' log_entries: type: array items: type: object $ref: '#/components/schemas/apiLogEntry' description: Log entries. page: type: integer format: int64 description: The page the log entries are from. If the request's page was omitted or greater than the total pages, then this is set to the last page. per_page: type: integer format: int64 description: The number of results contained in each page. apiInputSettings: type: object properties: worker: $ref: '#/components/schemas/apiWorker' title: 'Default model used for annotation generation (SAM2, etc.) Make sure to set correct model version id, app id and user id etc. Workflow is not supported here yet' sample_rate_ms: type: integer format: int64 title: Sampling settings used sample_rate_frame: type: integer format: int64 pinned_concepts: type: array items: type: object $ref: '#/components/schemas/apiConcept' title: Pinned concept ids V2DeleteWorkflowVersionsBody: type: object properties: user_app_id: $ref: '#/components/schemas/apiUserAppIDSet' workflow_version_ids: type: array items: type: string title: Delete the versions identified by these ids title: DeleteWorkflowVersionsRequest apiMetricLabel: type: string enum: - METRIC_LABEL_NOT_SET - APP_ID - MODEL_ID - MODEL_VERSION_ID - HTTP_STATUS - COMPUTE_CLUSTER_ID - NODEPOOL_ID default: METRIC_LABEL_NOT_SET apiImage: type: object properties: url: type: string description: 'This is a URL to a publicly accessible image file. The platform will download this file server side and then process.' base64: type: string format: byte description: 'The base64 field is using image file bytes directly in the request. NOTE: if you''re sending a json request, then this MUST be base64 encoded before sending (hence the name here). When using our grpc clients, you DO NOT need to base64 encode it yourself since the clients know how to do this for you automatically and will avoid the base64 encoding if they send a binary request.' allow_duplicate_url: type: boolean hosted: $ref: '#/components/schemas/apiHostedURL' description: The hosted field lists images in different sizes hosted in Clarifai storage. image_info: $ref: '#/components/schemas/apiImageInfo' title: image info for original size. for image info for other sizes, use hosted_image_info hosted_image_info: type: object additionalProperties: $ref: '#/components/schemas/apiImageInfo' title: 'The map of hosted image info of different sizes (see hosted.sizes), excluding the original image. Note: keys(hosted_image_info) = hosted.sizes - "orig"' decoded_bytes: type: string format: byte description: For internal processing of already decoded bytes. title: Image V2PostAnnotationTracksBody: type: object properties: user_app_id: $ref: '#/components/schemas/apiUserAppIDSet' annotation_tracks: type: array items: type: object $ref: '#/components/schemas/apiAnnotationTrack' title: PostAnnotationTracksRequest apiPipelineStep: type: object properties: id: type: string description: The ID of the pipeline step. user_id: type: string title: The user the pipeline step belongs to description: type: string title: Description of the pipeline step pipeline_step_version: $ref: '#/components/schemas/apiPipelineStepVersion' title: Latest Pipeline Step Version visibility: $ref: '#/components/schemas/clarifaiapiVisibility' description: 'The visibility field represents whether this is privately/publicly visible. To be visible to the public the App that contains it AND the User that contains the App must also be publicly visible.' created_at: type: string format: date-time title: When the pipeline step was created modified_at: type: string format: date-time title: When the pipeline step was last modified apiMultiDatasetVersionMetricsGroupResponse: type: object properties: status: $ref: '#/components/schemas/apistatusStatus' dataset_version_metrics_groups: type: array items: type: object $ref: '#/components/schemas/apiDatasetVersionMetricsGroup' apiTaskReviewMetrics: type: object properties: inputs_count_estimated: type: string format: uint64 description: 'Estimated number of fully reviewed inputs. An input is considered fully reviewed if it has been reviewed by all necessary reviewers. Example: if task has no review, then an input is considered fully reviewed right after it''s labeled (as review is skipped). Example: if task has manual review with single-reviewer per input, then an input is considered fully reviewed when 1 reviewer has approved/rejected it. Example: if task has consensus review with 3 reviewers per input, then an input is considered fully reviewed when 3 reviewers have approved it or 1 reviewer has rejected it.' inputs_percent_estimated: type: integer format: int64 description: 'Estimated percent of review work that was finished. This is a value between 0 and 100, where 0 = 0% and 100 = 100%. Calculated as inputs_count_estimated/task.metrics.input_source.inputs_count_estimated. As the counts are estimated, the percentage is also estimated. However, additional checks are made to ensure that 100% percentage is only returned when all inputs are reviewed - giving a guarantee that the 100% percentage is always accurate.' inputs_count_estimated_per_reviewer: type: array items: type: string format: uint64 description: 'Estimated number of reviewed inputs per reviewer index. The reviewer indexes are based on task.review.users. An input is considered reviewed by a reviewer if: * the reviewer approved the input * the reviewer rejected the input Note that when a reviewer requests changes for an input, the input is sent to back to work again, so the whole work & review process is restarted. The reviewer will have to review the input again after work has been completed. As such, the review that requests changes for an input is immediately dis-regarded and not counted in this metric.' inputs_reviewable_count_estimated_per_reviewer: type: array items: type: string format: uint64 description: 'The number of inputs actually available for review for each reviewer. Most times, this equals task.metrics.input_source.inputs_count_estimated. Several situations may result in different values: * When task has no review, then this is 0 for each reviewer. * When task has auto-annotation, then this number equals the inputs that have been auto-annotated with AWAITING_REVIEW status. All other inputs are considered completed by the auto-annotation process. * When task has consensus review with approval_threshold_labelers > 0, then it''s possible that labelers will approve inputs through consensus, which skips review. In this case, the number of inputs available for review is less than task.metrics.input_source.inputs_count_estimated. * When task has consensus review with approval_threshold_reviewers = 1, then all inputs are assigned only to one reviewer, so each reviewer will get only a part of the inputs to review. It''s expected that the sum(inputs_reviewable_count_estimated) = task.metrics.input_source.inputs_count_estimated. * When task has consensus review with approval_threshold_reviewers = -1, then all inputs are assigned to all reviewers. However, if an input is rejected, then rejection is final and all other reviewers will not review it. In this case, the number of inputs available for review for other reviewers will be less than task.metrics.input_source.inputs_count_estimated.' inputs_percent_estimated_per_reviewer: type: array items: type: integer format: int64 description: 'Estimated percent of review work that was finished per reviewer. This is a value between 0 and 100, where 0 = 0% and 100 = 100%. Calculated as inputs_count_estimated_per_reviewer/inputs_reviewable_count_estimated_per_reviewer. As the counts are estimated, the percentage is also estimated. However, additional checks are made to ensure that 100% percentage is only returned when all inputs are reviewed - giving a guarantee that the 100% percentage is always accurate.' V2PatchComputeClustersBody: type: object properties: user_app_id: type: object properties: app_id: type: string description: Only the user_id is used from this. title: Only the user_id is used from this. compute_clusters: type: array items: type: object $ref: '#/components/schemas/apiComputeCluster' title: This allows you to patch one or more compute_clusters action: type: string title: 'The action to perform on the patched objects For now ''overwrite'' is supported' V2PostEvaluationsBody: type: object properties: user_app_id: type: object description: Common message to identify the app in a url endpoint. eval_metrics: type: array items: type: object $ref: '#/components/schemas/apiEvalMetrics' description: 'eval_info, id, model, and ground_truth_dataset will be used when creating the evaluation If no dataset is provided, all app data that is annotated with concepts from the model will be used.' title: Evaluate this model vesion apiSingleAnnotationFilterResponse: type: object properties: status: $ref: '#/components/schemas/apistatusStatus' annotation_filter: $ref: '#/components/schemas/apiAnnotationFilter' title: SingleAnnotationFilterResponse apiConceptCount: type: object properties: id: type: string description: The concept's unique id. name: type: string description: The name of the concept. concept_type_count: $ref: '#/components/schemas/apiConceptTypeCount' title: The total count for concepts labeled for all asset statues (processing, to_process, processed, error) detail_concept_count: $ref: '#/components/schemas/apiDetailConceptCount' title: The detail count for different assets status title: ConceptCount apiComputeInfo: type: object properties: cpu_limit: type: string description: 'Amount of CPUs to use as a limit. This follows kubernetes notation like: "1", "100m", "4.5", etc. See https://kubernetes.io/docs/reference/kubernetes-api/common-definitions/quantity/ For instances, this is the instance''s CPU count. For runners, this is the maximum amount of CPU that the runner pod can use.' cpu_memory: type: string description: 'Amount of CPU memory to use as a limit. This follows kubernetes notation like: 1Ki, 1500Mi, 3Gi, 4Ti, etc. See https://kubernetes.io/docs/reference/kubernetes-api/common-definitions/quantity/ For instances, this is the instance''s CPU memory. For runners, this is the maximum amount of CPU memory that the runner pod can use.' cpu_requests: type: string description: 'Amount of CPUs to use as a minimum. This follows kubernetes notation like: "1", "100m", "4.5", etc. See https://kubernetes.io/docs/reference/kubernetes-api/common-definitions/quantity/ For runners, this is the minimum amount of CPU requested for the runner pod. Optional. If unspecified, a small default is used.' cpu_memory_requests: type: string description: 'Amount of CPU memory to use as a minimum. This follows kubernetes notation like: 1Ki, 1500Mi, 3Gi, 4Ti, etc. For runners, this is the minimum amount of CPU memory requested for the runner pod. Optional. If unspecified, a small default is used.' num_accelerators: type: integer format: int64 description: Amount of GPU/TPUs to use. accelerator_memory: type: string description: "The supported accelerators that the resource can run on. If the resource requires a specific\n accelerator type then it will only be scheduled on nodes that have that type of accelerator.\n If there is no hard requirements beyond the number of accelerators and their memory then this\n field can be left empty.\n This setting will cause an error if num_accelerators == 0" title: 'Amount of accelerator/GPU memory to use as a minimum. This is defined per accelerator. This follows the format used by kubernetes like 1Ki, 2Mi, 3Gi, 4Ti. See https://kubernetes.io/docs/reference/kubernetes-api/common-definitions/quantity/' accelerator_type: type: array items: type: string description: 'Or should it be removed completely and use the nodepool accelerator type itself. These are the supported accelerators that the model can run on.' accelerator_topology: type: array items: type: string description: 'For multi-host accelerators (i.e., TPU Slices), this defines the slice topology. Corresponds to the tpu.googleapis.com/topology annotation. Example: "2x2x1" for a 16-chip slice using v4 TPUs. Leave empty for single-host accelerators like GPUs or non-slice TPUs.' description: 'These are the resource needs of a given API object such as a model. This is what they require as a minimum to run and will be used upon scheduling as the request and limit for the k8s pod. If we want to separate limits and requests in the future we can allow setting a limits ComputeInfo and a requests ComputeInfo.' apiAddConcepts: type: object properties: concepts: type: array items: type: object $ref: '#/components/schemas/apiConcept' NodepoolNodepoolStatus: type: string enum: - NODEPOOL_STATUS_UNKNOWN - NODEPOOL_STATUS_PENDING - NODEPOOL_STATUS_READY - NODEPOOL_STATUS_ERROR - NODEPOOL_STATUS_DELETED default: NODEPOOL_STATUS_UNKNOWN apiTaskWorker: type: object properties: strategy: $ref: '#/components/schemas/TaskWorkerTaskWorkerStrategy' description: Worker strategy. user_ids: type: array items: type: string description: 'Who will work on this task. DEPRECATED: Use workers.user.id instead.' users: type: array items: type: object $ref: '#/components/schemas/apiUser' description: 'Users who will work on this task. When the ''worker.users'' field is additionally requested, then all user info is filled for the workers. Otherwise, only the user ''id'' is filled. DEPRECATED: Use workers.user instead.' partitioned_strategy_info: $ref: '#/components/schemas/apiTaskWorkerPartitionedStrategyInfo' workers: type: array items: type: object $ref: '#/components/schemas/apiWorker' description: "Workers that will work on this task.\n\nFor Auto Annotation Tasks:\n the worker can be either a model or a workflow;\n currently only supports 1 worker.\nFor manual labeling Tasks:\n the workers can only be users;\n no limitation on number of workers." type: $ref: '#/components/schemas/TaskWorkerWorkerType' title: 'Who is doing annotations - human Worker or auto-annotation via Model/Workflow. If set, worker must have be set accordingly to either human worker or model/workflow worker' runner_selectors: type: array items: type: object $ref: '#/components/schemas/apiRunnerSelector' description: 'Runner selectors is used to select specific runners for the workers of this task. The index of runner_selectors corresponds to the index of workers. In other words: runner_selectors[i] is the runner selector for workers[i].' description: TaskWorker includes information about the workers that will work on this task. apiSinglePipelineStepVersionResponse: type: object properties: status: $ref: '#/components/schemas/apistatusStatus' title: The status of the request pipeline_step_version: $ref: '#/components/schemas/apiPipelineStepVersion' title: The pipeline step version that was requested V2PostWorkflowVersionEvaluationsBody: type: object properties: user_app_id: type: object description: Common message to identify the app in a url endpoint. workflow_version_evaluations: type: array items: type: object $ref: '#/components/schemas/apiWorkflowVersionEvaluation' title: '########## Supported fields ########## - ground_truth_dataset_version.app_id - ground_truth_dataset_version.dataset_id - ground_truth_dataset_version.id - id - target_node_id - workflow_version_evaluation_template.id' runner_selectors: type: array items: type: object $ref: '#/components/schemas/apiRunnerSelector' apiPipelineVersionConfig: type: object properties: step_version_secrets: type: object additionalProperties: type: object title: 'StepVersionSecrets maps step names to their secret configurations Using google.protobuf.Struct to create the desired flat JSON structure This produces: {stepName: {secretName: "users/user-name/secrets/key"}} example: {"step-0": {"API_KEY": "users/user-name/secrets/key"}}' apiSingleUploadResponse: type: object properties: status: $ref: '#/components/schemas/apistatusStatus' upload: $ref: '#/components/schemas/apiUpload' apiPipeline: type: object properties: id: type: string user_id: type: string title: The user the pipeline belongs to app_id: type: string title: The app the pipeline belongs to pipeline_version: $ref: '#/components/schemas/apiPipelineVersion' title: Latest Pipeline Version description: type: string title: Short description about this pipeline visibility: $ref: '#/components/schemas/clarifaiapiVisibility' description: 'The visibility field represents whether this message is privately/publicly visible. To be visible to the public the App that contains it AND the User that contains the App must also be publicly visible.' notes: type: string description: Notes for the Pipeline. This field should be used for in-depth notes and supports up to 64Kbs. metadata: type: object title: 'To handle arbitrary json metadata, use a struct field https://github.com/google/protobuf/blob/master/src/google/protobuf/struct.proto' created_at: type: string format: date-time title: When the pipeline was created modified_at: type: string format: date-time title: When the pipeline was last modified apiRunnerSelector: type: object properties: nodepool: $ref: '#/components/schemas/apiNodepool' description: 'A particular nodepool for the resource to be run within. This request the id and user_id of the nodepool to be specified. Runners will be scaled according to a deployment for the given resource to be run. There should not be more than one deployment in this nodepool for the particular resource to run. If no deployments then default autoscaling will be used.' runner: $ref: '#/components/schemas/apiRunner' description: Optionally a particular runner within the nodepool. deployment: $ref: '#/components/schemas/apiDeployment' description: "Optionally a particular deployment within the nodepool.\n\nIn future as we support matching runners based on just labels:\n RunnerLabels runner_labels = 3; // FUTURE" description: '//////////////////////////////////////// Don''t need RunnerSelector if we''re opening up endpoints for deployments. //////////////////////////////////////// The RunnerSelector is an optional field we can provide during runtime of model/workflow predictions to specify which particular runner we want to process the work. This can optionally be used to select a particular nodepool and then within that nodepool a particular runner.' V2PatchSecretsBody: type: object properties: user_app_id: type: object properties: app_id: type: string description: Common message to identify the app in a url endpoint. secret: type: array items: type: object $ref: '#/components/schemas/apiSecret' action: type: string V2PostSearchesByIDBody: type: object properties: user_app_id: $ref: '#/components/schemas/apiUserAppIDSet' pagination: $ref: '#/components/schemas/apiPagination' description: Pagination information to paginate through search result Hits. title: PostSearchesByIDRequest performs returns results of a saved search given its ID apiPatchAnnotationsStatusResponse: type: object properties: status: $ref: '#/components/schemas/apistatusStatus' user_ids: type: array items: type: string updated_count: type: integer format: int64 title: PatchAnnotationsStatusResponse apiMultiWorkflowVersionEvaluationResponse: type: object properties: status: $ref: '#/components/schemas/apistatusStatus' workflow_version_evaluations: type: array items: type: object $ref: '#/components/schemas/apiWorkflowVersionEvaluation' V2PostAppsBody: type: object properties: user_app_id: type: object properties: app_id: type: string description: Common message to identify the app in a url endpoint. apps: type: array items: type: object $ref: '#/components/schemas/apiApp' title: PostAppsRequest apiSingleTaskCountResponse: type: object properties: status: $ref: '#/components/schemas/apistatusStatus' app_id: type: string task_id: type: string counts: type: array items: type: object $ref: '#/components/schemas/apiTaskStatusCountPerUser' title: SingleTaskCountResponse represents counts of task annotations or inputs (i.e. task assignments) for labelers in given task apiMultiModelResponse: type: object properties: status: $ref: '#/components/schemas/apistatusStatus' models: type: array items: type: object $ref: '#/components/schemas/apiModel' title: MultiModelResponse V2DeletePipelineStepsBody: type: object properties: user_app_id: type: object description: Common message to identify the app in a url endpoint. ids: type: array items: type: string title: The ids of the pipeline steps to delete apiLicenseType: type: string enum: - UNKNOWN_LICENSE_TYPE - FIRST_PARTY - OPEN_SOURCE - CLOSED_SOURCE default: UNKNOWN_LICENSE_TYPE apiSingleModelVersionExportResponse: type: object properties: status: $ref: '#/components/schemas/apistatusStatus' export: $ref: '#/components/schemas/apiModelVersionExport' title: SingleModelVersionExportResponse V2PostMetricsQueryBody: type: object properties: user_app_id: type: object properties: app_id: type: string description: Common message to identify the app in a url endpoint. query: $ref: '#/components/schemas/apiMetricSearchQuery' apiMultiConceptRelationResponse: type: object properties: status: $ref: '#/components/schemas/apistatusStatus' description: The response status. concept_relations: type: array items: type: object $ref: '#/components/schemas/apiConceptRelation' description: The returned concept relations. title: MultiConceptRelationResponse apiWorkflowVersionEvaluation: type: object properties: id: type: string description: Customer-Facing / External ID of the workflow version evaluation. workflow_version: $ref: '#/components/schemas/apiWorkflowVersion' description: Workflow version that is being evaluated. target_node_id: type: string description: The target node id that is being evaluated. ground_truth_dataset_version: $ref: '#/components/schemas/apiDatasetVersion' description: The dataset version that contains the ground-truth and is used for evaluation. predictions_dataset_version: $ref: '#/components/schemas/apiDatasetVersion' description: The dataset version that contains the predictions and is used for evaluation. workflow_version_evaluation_template: $ref: '#/components/schemas/apiWorkflowVersionEvaluationTemplate' description: Evaluation template that is used for evaluation. user_id: type: string description: The user the workflow version evaluation belongs to. app_id: type: string description: The app the workflow version evaluation belongs to. workflow_evaluation_result: $ref: '#/components/schemas/apiWorkflowEvaluationResult' description: Results of the evaluation. status: $ref: '#/components/schemas/apistatusStatus' title: Status of the evaluation created_at: type: string format: date-time description: When the workflow version evaluation was created. modified_at: type: string format: date-time description: When the workflow version evaluation was modified. apiToken: type: object properties: char_start: type: integer format: int64 char_end: type: integer format: int64 raw_text: type: string V2PatchAnnotationsStatusBody: type: object properties: user_app_id: type: object description: Common message to identify the app in a url endpoint. user_ids: type: array items: type: string title: Filter by user IDs status_codes: type: array items: $ref: '#/components/schemas/statusStatusCode' title: Filter by Status codes action: type: string title: '''overwrite'' is supported' status_code: $ref: '#/components/schemas/statusStatusCode' title: Update filtered annotations to this status title: PatchAnnotationsStatusRequest apiMetricFilter: type: object properties: label: $ref: '#/components/schemas/apiMetricLabel' equals: type: string in: $ref: '#/components/schemas/MetricFilterMultiValues' V2PostDatasetsBody: type: object properties: user_app_id: type: object description: Common message to identify the app in a url endpoint. datasets: type: array items: type: object $ref: '#/components/schemas/apiDataset' description: List of datasets that are requested to be added. description: Request to add one or more datasets. apiInput: type: object properties: id: type: string title: The ID for the input data: $ref: '#/components/schemas/apiData' description: The data passed along in this input. created_at: type: string format: date-time title: 'When the input was created. We follow the XXXX timestamp format. We use https://www.ietf.org/rfc/rfc3339.txt format: "2006-01-02T15:04:05.999999Z" so you can expect results like the following from the API: "2017-04-11T21:50:50.223962Z"' modified_at: type: string format: date-time description: When the input was modified. status: $ref: '#/components/schemas/apistatusStatus' description: 'This is the status at a per Input level which allows for partial failures.' dataset_ids: type: array items: type: string description: 'List of dataset IDs that this input is part of Currently, this field is ONLY used to * search inputs part of dataset(s), e.g. in `PostSearches`, `PostInputsSearches` and `PostAnnotationsSearches` endpoints, and * to add inputs to dataset(s) in `PostInputs` endpoint. Note that this field is ignored for other endpoints, e.g. `GetInput`, `ListInputs` and `PatchInputs`.' settings: $ref: '#/components/schemas/apiInputSettings' description: Global settings for annotation tracks. title: Input apiMultiScopeResponse: type: object properties: status: $ref: '#/components/schemas/apistatusStatus' description: The status of the request. scopes: type: array items: type: string description: This is a list of the scopes that your key has. app: $ref: '#/components/schemas/apiApp' description: The app that the key has access to. endpoints: type: array items: type: string description: This is a list of endpoint permissions that your key has. user_feature_flags: type: string title: MultiScopeResponse apiCollaboration: type: object properties: app: $ref: '#/components/schemas/apiApp' title: the application app_owner: $ref: '#/components/schemas/apiUser' title: the app owner's info(including user_unique_id, first_name, last_name, primary_email) scopes: type: array items: type: string title: the low-level scope users are shared with for this collaboration endpoints: type: array items: type: string title: the endpoint-level scopes users are shared with for this collaboration created_at: type: string format: date-time title: when is the collaboration created description: collaboration includes an app you're invited to work on. V2PutTaskAssignmentsBody: type: object properties: user_app_id: type: object description: Common message to identify the app in a url endpoint. input_id: type: string title: 'Deprecated: use action and action_config instead. Supported for backwards compatibility: setting this field is equivalent with * action = LABEL_SUBMIT * label_submit_config = [{"task_assignments": {{"id": ""}}]' action: $ref: '#/components/schemas/apiPutTaskAssignmentsRequestAction' description: Action to perform on selected task. label_submit_config: $ref: '#/components/schemas/apiLabelSubmitConfig' title: LabelStartConfig label_start_config = 5; // no config for label start action review_start_config: $ref: '#/components/schemas/apiReviewStartConfig' review_approve_config: $ref: '#/components/schemas/apiReviewApproveConfig' review_request_changes_config: $ref: '#/components/schemas/apiReviewRequestChangesConfig' review_reject_config: $ref: '#/components/schemas/apiReviewRejectConfig' title: PutTaskAssignmentsRequest apiModelReference: type: object properties: id: type: string title: Id of the reference model_id: type: string description: The id of the model this Model reference is tied to. url: type: string title: address of resource name: type: string title: name of link metadata: type: object title: 'To handle arbitrary json metadata: https://github.com/google/protobuf/blob/master/src/google/protobuf/struct.proto' description: A link to a html/markdown/text file that stores reference material tied to a model. V2PatchWorkflowVersionEvaluationsBody: type: object properties: user_app_id: type: object description: Common message to identify the app in a url endpoint. workflow_version_evaluations: type: array items: type: object $ref: '#/components/schemas/apiWorkflowVersionEvaluation' title: '########## Supported fields ########## - id - predictions_dataset_version.dataset_id - predictions_dataset_version.id - status.code - status.details - workflow_evaluation_result.summary.evaluation_metric_values[].evaluation_metric_id - workflow_evaluation_result.summary.evaluation_metric_values[].explanation - workflow_evaluation_result.summary.evaluation_metric_values[].metric_value.float_value - workflow_evaluation_result.summary.evaluation_metric_values[].metric_value.int_value - workflow_evaluation_result.summary.evaluation_metric_values[].metric_value.string_value - workflow_evaluation_result.summary.evaluation_metric_values[].per_concept_values' action: type: string title: only overwrite supported apiSingleDatasetResponse: type: object properties: status: $ref: '#/components/schemas/apistatusStatus' dataset: $ref: '#/components/schemas/apiDataset' title: SingleDatasetResponse apiMultiDatasetVersionExportResponse: type: object properties: status: $ref: '#/components/schemas/apistatusStatus' exports: type: array items: type: object $ref: '#/components/schemas/apiDatasetVersionExport' apiOrchestrationSpec: type: object properties: argo_orchestration_spec: $ref: '#/components/schemas/apiArgoOrchestrationSpec' title: Argo orchestration specification V2CancelInputsAddJobBody: type: object properties: user_app_id: $ref: '#/components/schemas/apiUserAppIDSet' apiAppDuplication: type: object properties: id: type: string description: The unique identifier of an app duplication job. destination_app: $ref: '#/components/schemas/apiApp' description: The destination application where resources are written. existing_app_id: type: string description: 'Deprecated: Use destination_app.id with an existing ID instead.' new_app_id: type: string description: 'Deprecated: Use destination_app.id with a new ID instead.' new_app_name: type: string description: 'Deprecated: Application names are deprecated, use application IDs instead.' status: $ref: '#/components/schemas/apistatusStatus' description: The status of the app duplication job. created_at: type: string format: date-time description: The time when the app duplication job was created. last_modified_at: type: string format: date-time description: The last time when the app duplication job status was updated. filter: $ref: '#/components/schemas/apiAppDuplicationFilters' description: The filter specifies which resources are copied by the app duplication job. progress: type: array items: type: object $ref: '#/components/schemas/apiAppCopyProgress' description: Copy progress for each resource type requested by the filter. title: 'Deprecated: App duplication is no longer supported. AppDuplication' apiConfusionMatrix: type: object properties: matrix: type: array items: type: object $ref: '#/components/schemas/apiConfusionMatrixEntry' concept_ids: type: array items: type: string description: These concept_ids are ordered by the strength of the diagonal in the ConfusionMatrix. title: ConfusionMatrix V2PostNodepoolsBody: type: object properties: user_app_id: type: object properties: app_id: type: string description: Only the user_id is used from this. title: Only the user_id is used from this. nodepools: type: array items: type: object $ref: '#/components/schemas/apiNodepool' description: This allows you to create one or more nodepools by posting it to the API. V2PostModelVersionsUnPublishBody: type: object properties: user_app_id: $ref: '#/components/schemas/apiUserAppIDSet' publications: type: array items: type: object $ref: '#/components/schemas/apiModelVersionUnpublishRequest' title: PostModelVersionsUnPublishRequest apiPassword: type: object properties: plaintext: type: string title: unencrypted password string title: Password apiRegion: type: object properties: id: type: string description: A unique id for the region. region_info: $ref: '#/components/schemas/apiRegionInfo' description: The details about the location of the region. data: $ref: '#/components/schemas/apiData' description: 'A recursive definition of the data within the Region. For example, this will contain data.concepts if the region also has annotations or predictions of concepts within it.' value: type: number format: float description: This is the confidence score of the overall Region. track_id: type: string description: For tracking algorithsm and annotations we tie regions together with this track id. description: A region within the data. apiEvaluationMetricValue: type: object properties: evaluation_metric_id: type: string title: The metric values metric_value: $ref: '#/components/schemas/apiMetricValue' title: Aggregated metric value explanation: type: string title: explanation for the value per_concept_values: type: object additionalProperties: $ref: '#/components/schemas/apiMetricValue' title: Metric values for each concept apiPointVisibility: type: string enum: - NOT_SET - VISIBLE - NOT_VISIBLE - NOT_PRESENT default: NOT_SET description: "- NOT_SET: Visibility of the point is not set\n - VISIBLE: Point is visible\n - NOT_VISIBLE: Point is occluded\n - NOT_PRESENT: Point is not in the image" title: Whether this point is visible or occluded MetricTypeLabelsLabelWithValues: type: object properties: label: $ref: '#/components/schemas/apiMetricLabel' values: type: array items: type: string title: sample values for this label apiDeleteFromDataset: type: object properties: dataset_id: type: string apiImageInfo: type: object properties: width: type: integer format: int32 title: width height: type: integer format: int32 title: height format: type: string title: image format color_mode: type: string title: image color mode mode: type: string title: mode (when used for decoded_bytes) (RGB, RGBA, P, L, etc.) ModelBillingType: type: string enum: - Unknown - Tokens - Ops default: Unknown apiInputsExtractionJob: type: object properties: status: $ref: '#/components/schemas/apistatusStatus' id: type: string title: ID of extraction job url: type: string title: Url of archive or bucket progress: $ref: '#/components/schemas/apiInputsExtractionJobProgress' title: Progress counts of the job created_at: type: string format: date-time description: 'When the extraction job was started. The format is https://www.ietf.org/rfc/rfc3339.txt. Example: "2006-01-02T15:04:05.999999Z".' modified_at: type: string format: date-time description: 'Most recent time when the extraction job was updated. The format is https://www.ietf.org/rfc/rfc3339.txt. Example: "2006-01-02T15:04:05.999999Z".' input_id_conflict_resolution: $ref: '#/components/schemas/apiInputIDConflictResolution' description: How to handle input ID conflicts. input_template: $ref: '#/components/schemas/apiInput' title: Fields set in the template are added to all generated inputs apiMultiKeyResponse: type: object properties: status: $ref: '#/components/schemas/apistatusStatus' keys: type: array items: type: object $ref: '#/components/schemas/apiKey' title: MultiKeyResponse apiLogEntry: type: object properties: message: type: string description: Text of the log entry. log_type: type: string description: 'The type of log entry. Examples: model, agent, build, training.' url: type: string description: URL to log file or stream. meta: $ref: '#/components/schemas/apiComputeSourceMetadata' description: Who and where the metrics are from. description: LogEntry is a single technical log entry (e.g. service log, stack traces, etc). apiMultiAppResponse: type: object properties: status: $ref: '#/components/schemas/apistatusStatus' apps: type: array items: type: object $ref: '#/components/schemas/apiApp' title: MultiAppResponse clarifaiapiAnnotation: type: object properties: id: type: string title: The ID for the annotation input_id: type: string title: ID of the input this annotation is tied to data: $ref: '#/components/schemas/apiData' description: The data passed along in this annotation. annotation_info: type: object title: task_id is deprecated in annotation_info. Use task_id user_id: type: string description: 'DEPRECATED: Use worker.user.id instead.' model_version_id: type: string title: 'DEPRECATED: Use worker.model.model_version.id instead' embed_model_version_id: type: string description: DEPRECATED. status: $ref: '#/components/schemas/apistatusStatus' title: Annotation Status created_at: type: string format: date-time title: 'When the annotation was created. We follow the XXXX timestamp format. We use https://www.ietf.org/rfc/rfc3339.txt format: "2006-01-02T15:04:05.999999Z" so you can expect results like the following from the API: "2017-04-11T21:50:50.223962Z"' modified_at: type: string format: date-time description: When the annotation was modified. trusted: type: boolean title: 'Whether or not this annotation is trusted Will be deprecated' input_level: type: boolean description: Is this the input level annotation. consensus_info: type: object title: 'Consensus review related information, e.g. * annotation group * id of annotation parent, in case the annotation was split from another annotation' task_id: type: string title: The id of the task annotation belongs to worker: $ref: '#/components/schemas/apiWorker' description: Worker is the worker that created the annotation. title: Annotation of an asset with metadata V2PostWorkflowsBody: type: object properties: user_app_id: type: object description: Common message to identify the app in a url endpoint. workflows: type: array items: type: object $ref: '#/components/schemas/apiWorkflow' title: PostWorkflowsRequest apiFrameInterpolationInfo: type: object properties: sample_ms: type: integer format: int64 description: 'sample_ms is the sampling rate at which frame annotations are interpolated. If sample_ms is zero, then the dataset default_processing_info value is used. If the dataset default is zero or not set, then the input frame prediction sampling rate is used.' description: 'FrameInterpolationInfo contains information about frame annotations interpolated from other video annotations, such as image object-detection regions generated from video object-tracking regions.' apiAWSCreds: type: object properties: region: type: string id: type: string secret: type: string token: type: string description: AWS S3 storage credentials. V2PostWorkflowVersionsPublishBody: type: object properties: user_app_id: $ref: '#/components/schemas/apiUserAppIDSet' publications: type: array items: type: object $ref: '#/components/schemas/apiWorkflowVersionPublishRequest' apiGeoLimit: type: object properties: type: type: string value: type: number format: float title: GeoLimit CommitmentValueCommitmentType: type: string enum: - TYPE_NOT_SET - MONTHLY - ANNUAL default: TYPE_NOT_SET apiMultiModelUseCaseResponse: type: object properties: status: $ref: '#/components/schemas/apistatusStatus' usecases: type: array items: type: string apiMultiNodepoolResponse: type: object properties: status: $ref: '#/components/schemas/apistatusStatus' nodepools: type: array items: type: object $ref: '#/components/schemas/apiNodepool' V2PostInputsBody: type: object properties: user_app_id: type: object description: Common message to identify the app in a url endpoint. inputs: type: array items: type: object $ref: '#/components/schemas/apiInput' title: 'List of inputs to post. For each input, the following fields are used: * id * data * dataset_ids' inputs_add_job_id: type: string description: 'Collect statistics about created inputs in job with given ID. * If job ID is empty, then job is not created. * If job ID is non-empty and doesn''t already exist, then a new job will be created with given ID. * If job ID does already exist, then new inputs statistics are merged with previous inputs statistics.' input_id_conflict_resolution: $ref: '#/components/schemas/apiInputIDConflictResolution' description: How to handle input ID conflicts. title: PostInputsRequest apiMultiScopeDepsResponse: type: object properties: status: $ref: '#/components/schemas/apistatusStatus' description: The status of the request. scope_deps: type: array items: type: object $ref: '#/components/schemas/apiScopeDeps' description: scopes is a list of low-level scopes and their dependencies. endpoint_deps: type: array items: type: object $ref: '#/components/schemas/apiEndpointDeps' title: 'endpoint_scopes is a listof all the publicly available endponts which can be used as scopes as well. A call to each of those endpoint depends on a subset of the above "scopes"' title: MultiScopeDepsResponse apiTeam: type: object properties: id: type: string description: Identify the team (unique). created_at: type: string format: date-time description: 'When the team was created. The format is https://www.ietf.org/rfc/rfc3339.txt. Example: "2006-01-02T15:04:05.999999Z".' modified_at: type: string format: date-time description: 'Most recent time when the team was updated. The format is https://www.ietf.org/rfc/rfc3339.txt. Example: "2006-01-02T15:04:05.999999Z".' name: type: string description: Name the team. default_role_id: type: string title: When a new application is assigned to the team without an explicit role, then the default role will be used description: Represents a group of users. apiMultiModelVersionInputExampleResponse: type: object properties: status: $ref: '#/components/schemas/apistatusStatus' title: status of response model_version_input_examples: type: array items: type: object $ref: '#/components/schemas/apiModelVersionInputExample' title: model input example messages title: MultiModelVersionInputExampleResponse V2PostDatasetInputsBody: type: object properties: user_app_id: $ref: '#/components/schemas/apiUserAppIDSet' dataset_inputs: type: array items: type: object $ref: '#/components/schemas/apiDatasetInput' description: 'List of inputs that are requested to be added to this dataset. Identify each input by id field. All other inputs fields are ignored.' search: $ref: '#/components/schemas/apiSearch' description: Query to search inputs to be added to this dataset. description: Request to add one or more datasets. apiBulkOperation: type: object properties: id: type: string title: id of the Bulk Operation task input_ids: $ref: '#/components/schemas/apiInputIDs' search: $ref: '#/components/schemas/apiSearch' dataset: $ref: '#/components/schemas/apiDataset' annotation_search: $ref: '#/components/schemas/apiSearch' operation: $ref: '#/components/schemas/apiOperation' title: Operation to perform app_id: type: string title: Application ID that this Operation was created from status: $ref: '#/components/schemas/apistatusStatus' title: Status (pending, in-progress, completed, failed) of the operation progress: $ref: '#/components/schemas/apiProgress' title: Progress of an on-going Bulk Operation task created_by: type: string title: User id that created this operation created_at: type: string format: date-time title: 'When the operation was created. We follow the XXXX timestamp format. We use https://www.ietf.org/rfc/rfc3339.txt format: "2006-01-02T15:04:05.999999Z" so you can expect results like the following from the API: "2017-04-11T21:50:50.223962Z"' last_modified_at: type: string format: date-time title: Last time the status got updated V2PatchSearchesBody: type: object properties: user_app_id: type: object description: The user_id and app_id to query from. title: The user_id and app_id to query from. searches: type: array items: type: object $ref: '#/components/schemas/apiSearch' title: The searches to be patched action: type: string title: 'The action to perform on the patched Search objects For now only action ''overwrite'' is supported' title: PatchSearchesRequest googlerpcStatus: type: object properties: code: type: integer format: int32 message: type: string details: type: array items: type: object $ref: '#/components/schemas/protobufAny' apiNodeInput: type: object properties: node_id: type: string description: The id to a connected WorkflowNode which will be used as an input for current WorkflowNode. description: NodeInput represents inputs to a node of the graph. apiPostPipelineVersionRunFromTemplateResponse: type: object properties: status: $ref: '#/components/schemas/apistatusStatus' pipeline: $ref: '#/components/schemas/apiPipeline' title: The created or updated pipeline (contains the latest pipeline version) pipeline_version_run: $ref: '#/components/schemas/apiPipelineVersionRun' title: The created pipeline version run title: Response containing the created Pipeline, PipelineVersion, and PipelineVersionRun V2PostRunnerReplicaTaskMetricsBody: type: object properties: user_app_id: type: object description: Common message to identify the app in a url endpoint. runner_replica_task_metrics: type: array items: type: object $ref: '#/components/schemas/apiRunnerReplicaTaskMetrics' description: List of task metrics reported by runner replicas. apiMultiComputeClusterResponse: type: object properties: status: $ref: '#/components/schemas/apistatusStatus' compute_clusters: type: array items: type: object $ref: '#/components/schemas/apiComputeCluster' V2PostConceptRelationsBody: type: object properties: user_app_id: type: object description: The user_id and app_id information. title: The user_id and app_id information. concept_relations: type: array items: type: object $ref: '#/components/schemas/apiConceptRelation' description: The relationships you're going to add. title: POST new concept relations V2PostConceptsBody: type: object properties: user_app_id: type: object description: Common message to identify the app in a url endpoint. concepts: type: array items: type: object $ref: '#/components/schemas/apiConcept' description: The concepts to add. title: PostConceptsRequest apiWorkflow: type: object properties: id: type: string description: The workflows's unique id. app_id: type: string title: The app the workflow belongs to created_at: type: string format: date-time title: 'When the workflow was created. We follow the XXXX timestamp format. We use https://www.ietf.org/rfc/rfc3339.txt format: "2006-01-02T15:04:05.999999Z" so you can expect results like the following from the API: "2017-04-11T21:50:50.223962Z"' nodes: type: array items: type: object $ref: '#/components/schemas/apiWorkflowNode' description: 'The list of nodes retrieved from latest workflow version. Each node can specify an input node that it connects to in order to define the graph.' metadata: type: object title: 'To handle arbitrary json metadata you can use a struct field: https://github.com/google/protobuf/blob/master/src/google/protobuf/struct.proto' visibility: $ref: '#/components/schemas/clarifaiapiVisibility' description: 'The visibility field represents whether this message is privately/publicly visible. To be visible to the public the App that contains it AND the User that contains the App must also be publicly visible.' user_id: type: string title: The user the workflow belongs to modified_at: type: string format: date-time title: When the workflow was last modified version: $ref: '#/components/schemas/apiWorkflowVersion' description: Info about the workflow version used to return the latest version when listing Workflows. is_starred: type: boolean title: 'Is starred by the requesting user (only showed on get/list requests) Please use PostWorkflowStars/DeleteWorkflowStars endpoints to star/unstar a workflow' star_count: type: integer format: int32 title: 'How many users have starred the workflow (only showed on get/list requests) Computed value, not editable' description: type: string title: Short description about this workflow notes: type: string description: 'Notes for the workflow This field should be used for in-depth notes and supports up to 64Kbs.' use_cases: type: array items: type: string title: Tags from use_cases category check_consents: type: array items: type: string title: Tags for check consents bookmark_origin: $ref: '#/components/schemas/apiBookmarkOrigin' description: 'bookmark info. When set, this workflow is a bookmarked workflow of this app. Info in this field will allow you to find/access original workflow.' image: $ref: '#/components/schemas/apiImage' title: Representative image for this workflow title: Workflow TaskWorkerTaskWorkerStrategy: type: string enum: - WORKER_STRATEGY_NOT_SET - PARTITIONED - FULL - DYNAMIC default: WORKER_STRATEGY_NOT_SET description: " - PARTITIONED: The inputs will be partitioned in several partitions.\nEach worker will label one or more input partitions.\nAll inputs are assigned at task creation.\n - FULL: Each worker will label all inputs from input source.\nAll inputs are assigned at task creation.\n - DYNAMIC: Each worker will dynamically get 10 inputs assigned at a time.\nNo inputs are assigned at task creation." apiSingleNodepoolResponse: type: object properties: status: $ref: '#/components/schemas/apistatusStatus' nodepool: $ref: '#/components/schemas/apiNodepool' V2PostModelVersionEvaluationsBody: type: object properties: user_app_id: $ref: '#/components/schemas/apiUserAppIDSet' eval_metrics: type: array items: type: object $ref: '#/components/schemas/apiEvalMetrics' title: EvalInfo and ID will be used when creating the evaluation title: Evaluate this model vesion V2PatchAppsBody: type: object properties: user_app_id: type: object properties: app_id: type: string description: Common message to identify the app in a url endpoint. apps: type: array items: type: object $ref: '#/components/schemas/apiApp' action: type: string description: 'The action to perform on the patched App objects except App.Metadata Supported values: ''overwrite'' and ''remove''. Note that ''remove'' can only be used to remove the app image by setting ''image.url'' in the request to the current value returned for that app.' metadata_action: $ref: '#/components/schemas/apiPatchAction' title: The action to perform on the patched App.Metadata reindex: type: boolean description: If set, the app will be automatically reindexed upon change of its base workflow. title: PatchAppsRequest apiMultiTaskResponse: type: object properties: status: $ref: '#/components/schemas/apistatusStatus' tasks: type: array items: type: object $ref: '#/components/schemas/apiTask' description: Response with multiple Tasks. apiMethodSignature: type: object properties: name: type: string description: The name of the method on the server. method_type: $ref: '#/components/schemas/apiRunnerMethodType' title: whether the method is for predict(unary-unary), generate(unary-stream), stream(stream-stream) description: type: string description: description from the docstring of the method on the server. input_fields: type: array items: type: object $ref: '#/components/schemas/apiModelTypeField' title: input fields and signature of every method arguments output_fields: type: array items: type: object $ref: '#/components/schemas/apiModelTypeField' title: output signature of method description: 'MethodSignature is a definition of a method that a model can have. This is used to communicate between a python method definition of any arbitrary function to the client or UI on how to call that function from the client side.' V2PatchWorkflowIdsBody: type: object properties: user_app_id: type: object description: Common message to identify the app in a url endpoint. ids: type: array items: type: object $ref: '#/components/schemas/apiIdUpdateSource' title: Array containing 1 entry action: type: string title: 'The action to perform on the patched objects Only ''overwrite'' is supported' title: PatchWorkflowIdsRequest protobufAny: type: object properties: '@type': type: string additionalProperties: {} V2PatchModelToolkitsBody: type: object properties: user_app_id: $ref: '#/components/schemas/apiUserAppIDSet' toolkits: type: array items: type: string action: type: string title: overwrite supported apiBinaryMetrics: type: object properties: num_pos: type: integer format: int64 num_neg: type: integer format: int64 num_tot: type: integer format: int64 roc_auc: type: number format: float f1: type: number format: float concept: $ref: '#/components/schemas/apiConcept' roc_curve: $ref: '#/components/schemas/apiROC' precision_recall_curve: $ref: '#/components/schemas/apiPrecisionRecallCurve' avg_precision: type: number format: float area_name: type: string area_min: type: number format: double area_max: type: number format: double iou: type: number format: float title: BinaryMetrics statusRedirectInfo: type: object properties: url: type: string description: New location for the resource. Used to set response Location header. resource_type: type: string title: Resource type old_resource_id: type: string title: Old resource id new_resource_id: type: string title: New resource id apiCooccurrenceMatrix: type: object properties: matrix: type: array items: type: object $ref: '#/components/schemas/apiCooccurrenceMatrixEntry' concept_ids: type: array items: type: string description: These concept_ids are ordered by the strength of the diagonal in the ConfusionMatrix. title: CooccurrenceMatrix apiAnnotationTrack: type: object properties: id: type: string title: The ID for the annotation track input_id: type: string title: ID of the asset this annotation track is tied to concept: $ref: '#/components/schemas/apiConcept' title: Concept this annotation track status: $ref: '#/components/schemas/apistatusStatus' title: AnnotationTrack Status start_frame_nr: type: integer format: int64 description: Start frame number (in original video) of the annotation track, inclusive. end_frame_nr: type: integer format: int64 description: End frame number (in original video) of the annotation track, inclusive. start_frame_ms: type: integer format: int64 description: Start time (in milliseconds of original video) of the annotation track, inclusive. end_frame_ms: type: integer format: int64 description: End time (in milliseconds of original video) of the annotation track, inclusive. created_at: type: string format: date-time description: When the annotation track was created. modified_at: type: string format: date-time description: When the annotation track was modified. sample_rate_ms: type: integer format: int64 description: Sampling rate of the annotation track in milliseconds. sample_rate_frame: type: integer format: int64 title: 'Sampling frame rate of the video track in frame number increments increment of 1 means it matches the original video FPS increment of 2 means every second frame is sampled, etc. So if you have 30fps original video and frame_rate=3, your annotations in a track are stored at 30fps/3frame_rate=10 frames per second Useful if client relies on simple frame access. Useful if video has variable frame rate (VFR), then annotations are also sampled with VFR in mind' title: AnnotationTrack of an asset with metadata apiMultiEvalMetricsResponse: type: object properties: status: $ref: '#/components/schemas/apistatusStatus' eval_metrics: type: array items: type: object $ref: '#/components/schemas/apiEvalMetrics' V2PostCollaboratorsBody: type: object properties: user_app_id: type: object description: Common message to identify the app in a url endpoint. collaborators: type: array items: type: object $ref: '#/components/schemas/apiCollaborator' title: PostCollaboratorsRequest apiMultiPipelineVersionResponse: type: object properties: status: $ref: '#/components/schemas/apistatusStatus' pipeline_versions: type: array items: type: object $ref: '#/components/schemas/apiPipelineVersion' apiGetResourceCountsResponse: type: object properties: status: $ref: '#/components/schemas/apistatusStatus' datasets: type: string format: int64 models: type: string format: int64 workflows: type: string format: int64 inputs: type: string format: int64 pipelines: type: string format: int64 title: ResourceCountResponse V2PostConceptsSearchesBody: type: object properties: user_app_id: type: object description: Ids present in the url of the request. title: Ids present in the url of the request. concept_query: $ref: '#/components/schemas/apiConceptQuery' description: The body of the request. extra_info: $ref: '#/components/schemas/apiConceptExtraInfoRequest' description: Request additional info to be retrieved for each concept in the response. pagination: $ref: '#/components/schemas/apiPagination' description: 'Pagination parameters here since there are no url args in this POST request.' title: PostConceptsSearchesRequest V2PostModelVersionsBody: type: object properties: user_app_id: $ref: '#/components/schemas/apiUserAppIDSet' model_versions: type: array items: type: object $ref: '#/components/schemas/apiModelVersion' description: type: string title: Description about this training run eval_info: $ref: '#/components/schemas/apiEvalInfo' description: 'When evaluate_after_training set to true, we will do evaluation immediately after training finishes. We will merge this with default_eval_info.' do_migration: type: boolean description: When set to true, we will convert the model into a containerized model after training. description: Create (train) a new model version. apiCooccurrenceMatrixEntry: type: object properties: row: type: string title: concept_id for the row col: type: string title: concept_id for the col count: type: integer format: int64 title: 'NOTE: this is inefficient, should just have the order of the rows/cols' apiPagination: type: object properties: page: type: integer format: int64 description: (optional URL parameter) The page number. Pagination is used to split the results into chunks. Defaults to 1. per_page: type: integer format: int64 description: (optional URL parameter) The number of results that will be contained in each page. Defaults to 128. description: Split the results into pages. apiRole: type: object properties: id: type: string created_at: type: string format: date-time description: 'When the role was created. The format is https://www.ietf.org/rfc/rfc3339.txt. Example: "2006-01-02T15:04:05.999999Z".' modified_at: type: string format: date-time description: 'Most recent time when the role was updated. The format is https://www.ietf.org/rfc/rfc3339.txt. Example: "2006-01-02T15:04:05.999999Z".' name: type: string description: type: string scopes: type: array items: type: string title: The low-level scopes this role has endpoints: type: array items: type: string title: The endpoint-level scopes this role has type: $ref: '#/components/schemas/apiRoleType' title: Type of the role 'team' or 'org' title: Role represents a list of permissions apiMultiDatasetResponse: type: object properties: status: $ref: '#/components/schemas/apistatusStatus' datasets: type: array items: type: object $ref: '#/components/schemas/apiDataset' title: MultiDatasetResponse apiSingleDatasetInputResponse: type: object properties: status: $ref: '#/components/schemas/apistatusStatus' dataset_input: $ref: '#/components/schemas/apiDatasetInput' title: SingleDatasetInputResponse apiMultiKnowledgeGraphResponse: type: object properties: status: $ref: '#/components/schemas/apistatusStatus' description: The response status. knowledge_graphs: type: array items: type: object $ref: '#/components/schemas/apiKnowledgeGraph' description: The returned knowledge graphs. title: MultiKnowledgeGraphResponse apiSingleArtifactVersionResponse: type: object properties: status: $ref: '#/components/schemas/apistatusStatus' title: The status of the request artifact_version: $ref: '#/components/schemas/apiArtifactVersion' title: The artifact version that was requested apiRunner: type: object properties: id: type: string description: 'A unique ID for this runner. This is a UUID since runners can be automatically orchestrated.' description: type: string description: short description about the runner. created_at: type: string format: date-time description: When the runner was created. modified_at: type: string format: date-time description: When the runner was last modified. metadata: type: object description: 'To handle arbitrary json metadata you can use a struct field: https://github.com/google/protobuf/blob/master/src/google/protobuf/struct.proto This is an optional arg.' labels: type: array items: type: string description: Labels to match in order to find work. worker: $ref: '#/components/schemas/apiWorker' description: 'Instead of just matching on labels we might want to have more explicit matching of what work this runner is looking for. The thing that the autoscaling config applies to for this nodepool.' nodepool: $ref: '#/components/schemas/apiNodepool' description: 'Runners are defined within nodepools so this field needs the id and user_id of the nodepool to be provided when creating a Runner. This nodepool must be accessible to you or an org you are part of.' compute_info: $ref: '#/components/schemas/apiComputeInfo' description: '////////////////////////// Need resources on the runner so we can schedule this Runner into the Nodepool. If this runner is being orchestrated for a model then the orchestrator will set this to the model resource requirements. If a workflow then it''ll compute those requirements and set populate this resource field. Having this on the underlying object like Model and Workflow allows us to represent the minimum requirements on those object, which may be less than what the Runner allocates (as a safety margin for the runner to for sure run the resource).' num_replicas: type: integer format: int64 description: 'Number of replicas that this runner should have up. We keep it separate from ComputeInfo which defines how many resources each replica needs.' special_handling: type: array items: type: object $ref: '#/components/schemas/apiSpecialHandling' description: List of special handling instructions for this runner. runner_metrics: $ref: '#/components/schemas/apiRunnerMetrics' description: 'Metrics and status for the underlying k8s deployment. Each Runner is 1:1 with a k8s deployment, so this field tracks deployment health and metrics.' min_replicas: type: integer format: int64 description: 'Hard minimum replicas from the deployment''s autoscale config. The agent uses this to determine how many replicas are non-preemptable.' priority: type: integer format: int64 description: 'The scheduling priority for this runner''s k8s deployment. Valid values are 0-9, where higher values indicate higher priority. This value comes from the deployment nodepool''s priority setting.' title: 'A worker for compute within a nodepool of instances. This asks the API for work' V2DeletePipelineVersionsBody: type: object properties: user_app_id: type: object description: Common message to identify the app in a url endpoint. pipeline_version_ids: type: array items: type: string V2PostModelVersionsTrainingTimeEstimateBody: type: object properties: user_app_id: $ref: '#/components/schemas/apiUserAppIDSet' model_versions: type: array items: type: object $ref: '#/components/schemas/apiModelVersion' estimated_input_count: type: string format: uint64 title: Get the estimated training time for a model version apiTimeRange: type: object properties: start_time: type: string format: date-time description: Begin of the time range, optional, inclusive. end_time: type: string format: date-time description: End of the time range, optional, inclusive. title: TimeRange apiRunnerItem: type: object properties: id: type: string description: A UUID hash for this work item. description: type: string description: A description of the work to be done in case needed for UIs. processing_info: $ref: '#/components/schemas/apiProcessingInfo' description: Information on how to process the given RunnerItem. post_model_outputs_request: $ref: '#/components/schemas/apiPostModelOutputsRequest' description: Model prediction request from a user. sync_state_request: $ref: '#/components/schemas/apiSyncStateRequest' description: Agent sync request from control plane. auto_annotation_request: $ref: '#/components/schemas/apiAutoAnnotationRequest' description: "Auto annotation request from a user.\n\nWorkflow request from a user. // FUTURE\n training request next, etc." metadata: $ref: '#/components/schemas/apiRunnerItemMetadata' description: Metadata used for routing and other purposes. description: 'This is a unit of work for a runner to process. This comes from the API in the MultiRunnerItemResponse and contains the user''s requests to process.' apiSingleKeyResponse: type: object properties: status: $ref: '#/components/schemas/apistatusStatus' key: $ref: '#/components/schemas/apiKey' title: SingleKeyResponse V2DeleteRunnersBody: type: object properties: user_app_id: type: object properties: app_id: type: string description: Common message to identify the app in a url endpoint. ids: type: array items: type: string description: Request to delete several things by the list of ids. apiModelVersion: type: object properties: id: type: string created_at: type: string format: date-time description: When the version was created. status: $ref: '#/components/schemas/apistatusStatus' description: The status of the version (whether it's untrained, training, trained, etc.). active_concept_count: type: integer format: int64 metrics: $ref: '#/components/schemas/apiEvalMetrics' total_input_count: type: integer format: int64 title: number of inputs in the model version pretrained_model_config: $ref: '#/components/schemas/apiPretrainedModelConfig' title: 'When a model has already been trained externally, you can upload it directly to the platform as a model version directly by setting the PretrainedModelConfig' completed_at: type: string format: date-time description: When training of this version was completed. description: type: string title: Description about this version visibility: $ref: '#/components/schemas/clarifaiapiVisibility' description: 'The visibility field represents whether this message is privately/publicly visible. To be visible to the public the App that contains it AND the User that contains the App must also be publicly visible.' app_id: type: string description: The app the model version belongs to. user_id: type: string description: The user the model version belongs to. modified_at: type: string format: date-time title: When this model version was last modified metadata: type: object title: 'To handle arbitrary json metadata you can use a struct field: https://github.com/google/protobuf/blob/master/src/google/protobuf/struct.proto' license: type: string output_info: $ref: '#/components/schemas/apiOutputInfo' description: 'Info about the model''s output. Besides `output_info.data`, these fields should be reserved for parameters that affect the models outputs when inferencing. `output_info.data` is used to specify the training concepts for this model version.' input_info: $ref: '#/components/schemas/apiInputInfo' description: 'Info about preprocessing the models inputs, before they are sent to this model for training or inferencing. E.g.: `input_info.base_embed_model` lets us know inputs should be ran through a base model before being sent to an embedding-classifier.' train_info: $ref: '#/components/schemas/apiTrainInfo' description: Configuration for the training process of this model version. import_info: $ref: '#/components/schemas/apiImportInfo' title: 'Configuration used to import model from third-party toolkits DEPRECATED: no longer support importing models from third party toolkits' train_log: type: string title: Contains the training logs if available inference_compute_info: $ref: '#/components/schemas/apiComputeInfo' description: The minimum required compute resource for this model for inference. build_info: $ref: '#/components/schemas/apiBuildInfo' title: Build information for the model version method_signatures: type: array items: type: object $ref: '#/components/schemas/apiMethodSignature' title: Model signature information for the model version special_handling: type: array items: type: object $ref: '#/components/schemas/apiSpecialHandling' description: List of special handling instructions for this model version. num_threads: type: integer format: int32 description: The number of threads to use for this model version. title: ModelVersion apiSingleSearchResponse: type: object properties: status: $ref: '#/components/schemas/apistatusStatus' description: Status of whether the search was successful. search: $ref: '#/components/schemas/apiSearch' title: SingleSearchResponse returns saved search in response to GetSearchRequest apiCluster: type: object properties: id: type: string count: type: integer format: int64 title: Number of annotations tied to the cluster in the app score: type: number format: float description: 'The score assigned to this cluster. For List Clusters endpoint, this represents percentage of inputs in the app assigned to this cluster.' hits: type: array items: type: object $ref: '#/components/schemas/apiHit' title: Representative hits for cluster (for now we only return 1) projection: type: array items: type: number format: float title: Cluster data V2PatchInputsBody: type: object properties: user_app_id: type: object description: Common message to identify the app in a url endpoint. inputs: type: array items: type: object $ref: '#/components/schemas/apiInput' title: 'List of inputs to patch. Inputs are identified by id field. For each input, the following fields are patchable: * data' action: type: string title: 'The action to perform on the patched objects For now actions ''merge'', ''overwrite'', and ''remove'' are supported' title: PatchInputsRequest apiMultiWorkflowResponse: type: object properties: status: $ref: '#/components/schemas/apistatusStatus' workflows: type: array items: type: object $ref: '#/components/schemas/apiWorkflow' title: MultiWorkflowResponse apiWorkflowEvaluationResultSummary: type: object properties: evaluation_metric_values: type: array items: type: object $ref: '#/components/schemas/apiEvaluationMetricValue' description: The evaluation metrics. apiMultiArtifactResponse: type: object properties: status: $ref: '#/components/schemas/apistatusStatus' artifacts: type: array items: type: object $ref: '#/components/schemas/apiArtifact' apiSingleLabelOrderResponse: type: object properties: status: $ref: '#/components/schemas/apistatusStatus' label_order: $ref: '#/components/schemas/apiLabelOrder' description: Response with a label order. apiSingleStreamAnnotationResponse: type: object properties: status: $ref: '#/components/schemas/apistatusStatus' annotation: $ref: '#/components/schemas/clarifaiapiAnnotation' frame_fully_processed: type: boolean title: 'Indicates if this frame has been fully processed Needed in case client needs to decide whether to stop and wait for more data or continue playback' title: SingleStreamAnnotationResponse similar to SingleAnnotationResponse but with an extra field apiLabelCount: type: object properties: concept_name: type: string count: type: integer format: int64 concept: $ref: '#/components/schemas/apiConcept' title: LabelCount apiUserAppIDSet: type: object properties: user_id: type: string title: Note user_id 'me' is reserved - it is the alias for the id of authorized user app_id: type: string description: Common message to identify the app in a url endpoint. SearchMetric: type: string enum: - METRIC_NOT_SET - EUCLIDEAN_DISTANCE - COSINE_DISTANCE default: METRIC_NOT_SET description: 'Metric used for search. Can be EUCLIDEAN_DISTANCE (default) or COSINE_DISTANCE. Currently only brute force search supports non-eudlicean metrics.' V2DeleteComputeClustersBody: type: object properties: user_app_id: type: object properties: app_id: type: string description: Only the user_id is used from this. title: Only the user_id is used from this. ids: type: array items: type: string title: List of compute cluster ids to be deleted apiWorker: type: object properties: user: $ref: '#/components/schemas/apiUser' description: 'User is the human that created the annotation. By default no real names of users are returned in responses. These can be requested with the ''names'' additional field.' model: $ref: '#/components/schemas/apiModel' description: Model is the model that created the annotation. workflow: $ref: '#/components/schemas/apiWorkflow' description: Workflow is the workflow that created the annotation. description: Worker is the author of an annotation. apiProcessingInfo: type: object properties: runner_method_type: $ref: '#/components/schemas/apiRunnerMethodType' description: The type of method witin the runner to call. status: $ref: '#/components/schemas/apistatusStatus' description: 'A status of the processing. We use this for signalling end of a request stream, a runner item''s processing should be cancelled, etc.' processing_id: type: string description: Internal field to track processing. Runners will not have access to this. title: Processing info tells the runner how to process a RunnerItem apiAuditLogEntry: type: object properties: timestamp: type: string format: date-time description: Time of the operation. user: $ref: '#/components/schemas/apiUser' description: User that performed the operation. operation: $ref: '#/components/schemas/apiEventType' description: Type of operation that was performed. description: type: string description: A human-readable description of the operation. targets: type: array items: type: object $ref: '#/components/schemas/apiAuditLogTarget' description: 'Targets of the operation. For example, - when creating a new model, the targets would be the application and the model, - when adding a team member, the targets would be the team and the member.' details: type: array items: type: string description: 'Additional human-readable details of the operation. For example, when patching a resource, these would list what was changed.' success: type: boolean title: Was the operation successful? req_id: type: string description: Request that triggered the operation. source_ip: type: string description: IP address where the request originated from. description: AuditLogEntry is a single operation recorded in an audit log. V2PostLabelOrdersBody: type: object properties: user_app_id: type: object description: Common message to identify the app in a url endpoint. label_orders: type: array items: type: object $ref: '#/components/schemas/apiLabelOrder' description: Request to create label orders. apiTaskInputSource: type: object properties: type: $ref: '#/components/schemas/TaskInputSourceTaskInputSourceType' description: Type of input source. id: type: string description: If type is SAVED_SEARCH, then this is the saved search id. title: TaskInputSource apiSinglePipelineStepResponse: type: object properties: status: $ref: '#/components/schemas/apistatusStatus' title: The status of the request pipeline_step: $ref: '#/components/schemas/apiPipelineStep' title: The pipeline step that was requested apiTaskReviewManualStrategyInfo: type: object properties: sample_percentage: type: number format: float description: 'This field represents the percentage of inputs that will be reviewed by reviewers. It is a value between 0 and 1. Deprecated: Not used.' approval_threshold: type: integer format: int32 description: 'Deprecated: Use consensus_strategy_info.approval_threshold_reviewers.' title: TaskReviewManualStrategyInfo apiMetricDataLabel: type: object properties: name: $ref: '#/components/schemas/apiMetricLabel' value: type: string apiData: type: object properties: image: $ref: '#/components/schemas/apiImage' description: Input and output images. video: $ref: '#/components/schemas/apiVideo' description: Input and output videos. concepts: type: array items: type: object $ref: '#/components/schemas/apiConcept' description: A list of concepts. metadata: type: object title: 'To handle arbitrary json metadata you can use a struct field: https://github.com/google/protobuf/blob/master/src/google/protobuf/struct.proto' geo: $ref: '#/components/schemas/apiGeo' description: Geography information. colors: type: array items: type: object $ref: '#/components/schemas/apiColor' description: The dominant colors within an image. clusters: type: array items: type: object $ref: '#/components/schemas/apiCluster' description: Clustering centroids for inputs. embeddings: type: array items: type: object $ref: '#/components/schemas/apiEmbedding' description: Embedding vectors representing each input. regions: type: array items: type: object $ref: '#/components/schemas/apiRegion' description: For recursing into localized regions of an input. frames: type: array items: type: object $ref: '#/components/schemas/apiFrame' description: For temporal content like video. text: $ref: '#/components/schemas/apiText' description: Input, output or annotation text. audio: $ref: '#/components/schemas/apiAudio' description: Input and output audio. tracks: type: array items: type: object $ref: '#/components/schemas/apiTrack' description: Track information. time_segments: type: array items: type: object $ref: '#/components/schemas/apiTimeSegment' description: Time segments information. hits: type: array items: type: object $ref: '#/components/schemas/apiHit' title: Holds score, rank, and user, app, input IDs and search hit data heatmaps: type: array items: type: object $ref: '#/components/schemas/apiImage' title: Heatmap as 2d image parts: type: array items: type: object $ref: '#/components/schemas/apiPart' description: 'For data messages that have multiple parts such as multi-modal requests, we allow you to specify those as a list of Data objects.' ndarray: $ref: '#/components/schemas/apiNDArray' description: 'A proto representation for numpy arrays, useful to pass information from python SDK to a python based model implementation.' int_value: type: string format: int64 title: Input and output integer number float_value: type: number format: double title: Input and output floating number bytes_value: type: string format: byte title: Input and output bytes data bool_value: type: boolean title: Input and output bool data string_value: type: string title: Input and output string data struct_value: type: object title: To handle Input and output json title: Data apiDatasetVersionRequestOrigin: type: string enum: - DATASET_VERSION_REQUEST_ORIGIN_NOT_SET - MANUAL - TRAINING - EVAL_GROUND_TRUTH - EVAL_PREDICTIONS default: DATASET_VERSION_REQUEST_ORIGIN_NOT_SET apiFrame: type: object properties: frame_info: $ref: '#/components/schemas/apiFrameInfo' description: Information aboue frame such as number and time. data: $ref: '#/components/schemas/apiData' description: 'A recursive definition of the data within the Frame. For example, this will contain data.concepts if the Frame also has annotations or predictions of concepts within it. This can also have data.regions for annotation or predictions of detection regions, which can then recursively have their data field filled in as well.' id: type: string description: An ID for the frame. description: A Frame of time-series Data such as a Video. apiTaskInputSourceMetrics: type: object properties: inputs_count_estimated: type: string format: uint64 title: Estimated number of inputs that are in the source of data apiROC: type: object properties: fpr: type: array items: type: number format: float tpr: type: array items: type: number format: float thresholds: type: array items: type: number format: float fpr_per_image: type: array items: type: number format: float fpr_per_object: type: array items: type: number format: float title: ROC V2DeleteDeploymentsBody: type: object properties: user_app_id: type: object properties: app_id: type: string description: Only the user_id is used from this. title: Only the user_id is used from this. ids: type: array items: type: string title: List of deployment ids to be deleted MetricAggregateOperator: type: string enum: - OPERATOR_NOT_SET - AVG - SUM - MAX - MIN - P95 - P99 - P50 - COUNT default: OPERATOR_NOT_SET apiMultiAnnotationTrackResponse: type: object properties: status: $ref: '#/components/schemas/apistatusStatus' annotation_tracks: type: array items: type: object $ref: '#/components/schemas/apiAnnotationTrack' title: MultiAnnotationTrackResponse V2DeleteUploadsBody: type: object properties: user_app_id: type: object description: Common message to identify the app in a url endpoint. ids: type: array items: type: string title: Stops or deletes multipart upload V2PatchCollaboratorsBody: type: object properties: user_app_id: type: object description: Common message to identify the app in a url endpoint. collaborators: type: array items: type: object $ref: '#/components/schemas/apiCollaborator' action: type: string title: 'The action to perform on the patched objects For now only action ''overwrite'' is supported' title: PatchCollaboratorsRequest apiSinglePipelineVersionRunResponse: type: object properties: status: $ref: '#/components/schemas/apistatusStatus' pipeline_version_run: $ref: '#/components/schemas/apiPipelineVersionRun' apiDeploymentNodepool: type: object properties: id: type: string description: Nodepool ID correlates with nodepools in deployment. compute_cluster: $ref: '#/components/schemas/apiComputeCluster' description: The compute cluster that owns this nodepool. priority: type: integer format: int64 description: 'The scheduling priority for this deployment on the given nodepool. Valid values are 0-9, where higher values indicate higher priority. Default is 0 (lowest priority).' nodepool: $ref: '#/components/schemas/apiNodepool' title: '------------------------------------------------------------------- OUTPUT FIELDS (Server populates these so the client gets the data) -------------------------------------------------------------------' description: DeploymentNodepool associates a nodepool with a deployment and holds per-nodepool settings. apiImportInfo: type: object properties: params: type: object title: 'Used to configure model imports from third-party toolkits. DEPRECATED: no longer support importing models from third party toolkits' title: 'DEPRECATED: no longer support importing models from third-party toolkits' apiSearch: type: object properties: query: $ref: '#/components/schemas/apiQuery' description: Search query. id: type: string description: 'Customer facing, external ID for search to be saved. Provided by the user, e.g. "saved-search-1. It is unique per application.' application_id: type: string description: Application that owns this saved search. name: type: string description: Human readable display name of the saved search. as_of: type: string format: date-time description: '"As of" timestamp, indicating a time in the past as of which we want to retrieve the annotations satisfying the query.' git_hash: type: string description: Git hash of the code that ran the filter. created_at: type: string format: date-time description: When the saved search was created. modified_at: type: string format: date-time description: When the saved search was updated. algorithm: type: string title: 'The search algorithm to be used. Options are are ''nearest_neighbor'', ''brute_force'', and ''avg_concept_brute_force'' The last two perform a brute force search visual search instead of a more scalable distributed nearest neighbor search and should be used by advanced users only. If not specified we default to nearest neighbor' save: type: boolean title: 'If true, save this search, and exit without executing the search. If false execute the query' min_value: type: number format: float description: 'Minimum value of confidence threshold score in result. Defaults to 0.0 which means we won''t do any thresholding as all probabilities will likely be > 0.0.' visibility: $ref: '#/components/schemas/clarifaiapiVisibility' description: 'The visibility field represents whether this message is privately/publicly visible. To be visible to the public the App that contains it AND the User that contains the App must also be publicly visible.' metric: $ref: '#/components/schemas/SearchMetric' description: This is the new Search object used in saved searches. ModelTypeFieldModelTypeFieldType: type: string enum: - INVALID_MODEL_TYPE_FIELD_TYPE - BOOLEAN - STRING - NUMBER - ARRAY_OF_CONCEPTS - ARRAY_OF_CONCEPTS_WITH_THRESHOLD - RANGE - ENUM - COLLABORATORS - JSON - ARRAY_OF_NUMBERS - WORKFLOW_EMBED_MODELS - ARRAY_OF_STRINGS - RECURSIVE_ENUM - PYTHON_CODE - DATASET_ID - DATASET_VERSION_ID - ARRAY_OF_MODEL_CONCEPTS - DATASET - DATASET_VERSION - ENCRYPTED_STRING - CHECKPOINT_MODEL - ARRAY_OF_SECRETS default: INVALID_MODEL_TYPE_FIELD_TYPE description: "These are various types of fields that we have UIs for.\n\n - ARRAY_OF_CONCEPTS: For auto-completing to concepts in the app. This goes into an data.concepts field.\n - ARRAY_OF_CONCEPTS_WITH_THRESHOLD: For auto-completing to concepts in the app. This goes into an data.concepts field.\n - RANGE: A range for a float value.\n - ENUM: If ENUM is used then the \"enum_options\" field should also be filled in with the respective ID and description\nfor the different ENUM options.\n - COLLABORATORS: For listing collaborators of the app. The field is a string of the collaborator's user_id.\n - JSON: For arbitrary json object: \"{...}\"\n - ARRAY_OF_NUMBERS: Such as [1.0, 2.0, 3.5]\n - WORKFLOW_EMBED_MODELS: For selecting the embed_model_version_id for context based models.\n - ARRAY_OF_STRINGS: Such as ['a', 'b', 'cantaloupe']\n - RECURSIVE_ENUM: If RECURSIVE_ENUM is used then the \"enum_options\" field should also be filled in with the respective ID and\ndescription for the different RECURSIVE_ENUM options, as well as model_type_fields for each enum choice.\n - PYTHON_CODE: For blocks of code that need to be specified by the user for setup or execution during workflow runs.\n - DATASET_ID: For selecting a dataset id in model parameters. String in API request.\n - DATASET_VERSION_ID: For selecting a dataset version id. String.\n - ARRAY_OF_MODEL_CONCEPTS: For auto-completing to concepts in the model.\n - DATASET: For selecting a dataset\n - DATASET_VERSION: For selecting a dataset version\n - ENCRYPTED_STRING: To pass a string downstream, that is encrypted in the DB and API.\n - CHECKPOINT_MODEL: For selecting a model version of the same model type to resume training from.\n - ARRAY_OF_SECRETS: For model secrets" apiOrchestrationStatus: type: object properties: argo_status: $ref: '#/components/schemas/apiArgoOrchestrationStatus' title: Status for Argo Workflow status: $ref: '#/components/schemas/apistatusStatus' title: This will help us with filtering the PipelineVersionRuns based on status apiAiAssistParameters: type: object properties: min_threshold: type: number format: float title: Min and max threshold values for approving annotations by default based on prediction score max_threshold: type: number format: float concept_relation_ids: type: array items: type: string title: ids of concept relations. Used in AI assist workflow title: AiAssistParameters apiMultiAuditLogEntryResponse: type: object properties: status: $ref: '#/components/schemas/apistatusStatus' entries: type: array items: type: object $ref: '#/components/schemas/apiAuditLogEntry' apiNodepool: type: object properties: id: type: string description: The user defined ID of the nodepool. description: type: string description: Short description about the nodepool. created_at: type: string format: date-time description: When the nodepool was created. modified_at: type: string format: date-time description: When the nodepool was last modified. compute_cluster: $ref: '#/components/schemas/apiComputeCluster' description: Which cluster this nodepool is within. node_capacity_type: $ref: '#/components/schemas/apiNodeCapacityType' instance_types: type: array items: type: object $ref: '#/components/schemas/apiInstanceType' min_instances: type: integer format: int64 description: 'Minimum number of instances in this nodepool. This allows the nodepool to scale down to this amount. This is the user desired minimum.' max_instances: type: integer format: int64 description: 'An upper limit on the number of instances in this nodepool. This allows the nodepool to scale up to this amount. This is the user desired maximum.' enforced_min_instances: type: integer format: int64 description: The actual minimum number of instances. Enforced by the user's plan limits. enforced_max_instances: type: integer format: int64 description: The actual maximum number of instances. Enforced by the user's plan limits. warm_instances: type: integer format: int64 description: 'Number of warm idle instances to keep in this nodepool. These allow the nodepool to have extra capacity ready for quickly scheduling additional runners. This is the user desired amount. See node_count for actual current number of nodes.' visibility: $ref: '#/components/schemas/clarifaiapiVisibility' description: 'The visibility field represents whether this message is privately/publicly visible. To be visible to the public the App that contains it AND the User that contains the App must also be publicly visible.' metadata: type: object title: 'To handle arbitrary json metadata: https://github.com/google/protobuf/blob/master/src/google/protobuf/struct.proto' special_handling: type: array items: type: object $ref: '#/components/schemas/apiSpecialHandling' description: List of special handling instructions for this nodepool. node_count: type: integer format: int64 description: 'The current number of nodes in this nodepool. This value is queried from Prometheus metrics and represents the most recent node count reported by the compute plane.' status: $ref: '#/components/schemas/NodepoolNodepoolStatus' description: Current status of the nodepool. status_description: type: string description: Human-readable status description. Contains error details when status is NODEPOOL_STATUS_ERROR. description: 'A nodepool is a set of nodes dedicated for a given user''s compute needs. This compute will typically be consumed by runners and in the future other objects like UI modules may be assigned to node pools.' apiLabelOrder: type: object properties: id: type: string title: id of the order name: type: string title: name of the order status: $ref: '#/components/schemas/apistatusStatus' title: 'status of the order. pending (QA lead review the order), in progress (labeling in progress), ready for release (passed clarifai QA and client can review) success (released)' auto_release: type: boolean description: if set to true, automatically release the labels once passed clarifai review. allow_empty_tag: type: boolean description: allow input without any tag. desired_fulfill_time: type: string format: date-time title: User desired estimation when the task should be done estimate_fulfill_time: type: string format: date-time description: Clarifai estimation when the task should be done . task: $ref: '#/components/schemas/apiTask' title: task for this label order created_at: type: string format: date-time description: 'When the label order was created. The format is https://www.ietf.org/rfc/rfc3339.txt. Example: "2006-01-02T15:04:05.999999Z".' modified_at: type: string format: date-time description: 'Most recent time when the label order was updated. The format is https://www.ietf.org/rfc/rfc3339.txt. Example: "2006-01-02T15:04:05.999999Z".' title: LabelOrder apiModelTypeEnumOptionAlias: type: object properties: id_int: type: string format: int64 description: Integer alias for id. wildcard_string: type: string description: String that can contain wild cards and the regex needs to match. apiGeoPoint: type: object properties: longitude: type: number format: float latitude: type: number format: float title: GeoPoint apiOrchestrationStepSpec: type: object properties: argo_orchestration_step_spec: $ref: '#/components/schemas/apiArgoOrchestrationStepSpec' title: Argo orchestration step template apiMultiModelVersionResponse: type: object properties: status: $ref: '#/components/schemas/apistatusStatus' model_versions: type: array items: type: object $ref: '#/components/schemas/apiModelVersion' title: MultiModelVersionResponse apiMultiModelTypeResponse: type: object properties: status: $ref: '#/components/schemas/apistatusStatus' description: Status of the response. model_types: type: array items: type: object $ref: '#/components/schemas/apiModelType' description: List of ModelType objects. model_importers: $ref: '#/components/schemas/apiModelTypeField' title: List of model importers triton_conda_envs_info: type: array items: type: object $ref: '#/components/schemas/apiTritonCondaEnvInfo' title: Triton model envs that can be used for model upload title: MultiModelTypeResponse apiComputeCluster: type: object properties: id: type: string description: type: string description: Short description of cluster region. cloud_provider: $ref: '#/components/schemas/apiCloudProvider' description: 'The cloud provider where this cluster is hosted. Some example cloud provider IDs may be aws, gcp, azure, local, kubernetes, etc.' region: type: string description: 'The region. The naming here depends on the cluster choice above and will be validated against which clusters+regions that Clarifai currently supports.' user_id: type: string description: The user/org that this compute cluster belongs to. created_at: type: string format: date-time description: When the compute cluster was created. modified_at: type: string format: date-time description: When the compute cluster was last modified. visibility: $ref: '#/components/schemas/clarifaiapiVisibility' description: 'The visibility field represents whether this message is privately/publicly visible. To be visible to the public the App that contains it AND the User that contains the App must also be publicly visible.' cluster_type: type: string description: 'We offer different types of compute clusters such as: ''shared'' which only Clarifai can create. ''dedicated'' where you''re in control of defining the nodepools within the cluster ''local-dev'' which means you''re responsible for starting runners manually which is great for local development but not recommended for production use cases.' managed_by: type: string description: 'Managed by represents who is responsible for the cluster. This is currently either "clarifai" where we fully manage the infrastructure. Or, "user" where the user is responsible for the underlying infrastructure.' key: $ref: '#/components/schemas/apiKey' description: 'Key to use within the compute cluster for all requests to the API. You can post with the key.id filled in to set the key for the compute cluster. The responses will intentionaly only return the description of the key for security purposes since you may have other people through orgs/teams having access to this compute cluster who should not view your key. This must be a valid key created before creating the ComputeCluster. Deleting this key will not be prevented, which means all resources in this ComputeCluster will lose connection to the API, so delete keys at your own risk. The user_id who owns the key must match the user_id provided in the ComputeCluster.' description: 'We define a cluster here to be used in Nodepools and by the cloud provider. There will be one cloud provider per Cluster. This allows us to define Clusters that are VPCs within one physical cloud and have that managed by one cloud provider which can list all nodepools for that VPC to deploy them and orchestrate work within them.' apiOutputInfo: type: object properties: data: $ref: '#/components/schemas/apiData' description: List of concepts or other output related data for the model. output_config: $ref: '#/components/schemas/apiOutputConfig' title: 'Model configuration...going away in favor of output_info.params and train_params over time. TO BE DEPRECATED' message: type: string description: For returning where to look for the Output info if not returning it. fields_map: type: object description: 'Map from the api.Data field names to the underlying model graph''s outputs. When using a PretrainedModelConfig the values in this map need to match the Triton config.pbtxt output names.' params: type: object description: 'For predicting with the various ModelType''s we accept a Struct (JSON object) worth of args that the ModelTypeField defines. During inference, the settings contained within are sent to the model predictor to alter predictions from this Model.' params_specs: type: array items: type: object $ref: '#/components/schemas/apiModelTypeField' description: 'These allow you to specifcy addition fields that a specific model supports beyond those defined in it''s ModelType. This field is to be deprecated and will be replaced by MethodSignature proto.' description: 'OutputInfo defines some of the settings for each model version that PatchModels can effect. These parameters control some of the training or inference operations that this model can do. As the number of parameters continued to grow when we launched more ModelTypes we decided to move to using the OutputInfo.params field which is a Struct (or JSON object if you''re using our JSON REST APIs). This allows each ModelType to define the set of fields, their default values and description of each field so that we can display those in Portal and make the creation of Model''s very extensible. The OutputConfig object will eventually go away in favor of output_info.params struct.' apiAuditLogTarget: type: object properties: user: $ref: '#/components/schemas/apiUser' role: $ref: '#/components/schemas/apiRole' team: $ref: '#/components/schemas/apiTeam' app: $ref: '#/components/schemas/apiApp' workflow: $ref: '#/components/schemas/apiWorkflow' workflow_version: $ref: '#/components/schemas/apiWorkflowVersion' model: $ref: '#/components/schemas/apiModel' model_version: $ref: '#/components/schemas/apiModelVersion' compute_cluster: $ref: '#/components/schemas/apiComputeCluster' nodepool: $ref: '#/components/schemas/apiNodepool' deployment: $ref: '#/components/schemas/apiDeployment' description: 'AuditLogTarget is a resource on which an operation recorded in an audit log was performed.' apiPoint: type: object properties: row: type: number format: float description: 'The row location of the point. This has a [0.0-1.0] range with 0.0 being top row and 1.0 being the bottom row.' col: type: number format: float description: 'The column location of the point. This has a [0.0-1.0] range with 0.0 being left col and 1.0 being the right col.' z: type: number format: float description: Depth if applicable for the point. visibility: $ref: '#/components/schemas/apiPointVisibility' title: Point V2PostModelMigrationBody: type: object properties: user_app_id: type: object description: Common message to identify the app in a url endpoint. apiEvalMetrics: type: object properties: status: $ref: '#/components/schemas/apistatusStatus' user_id: type: string title: user id that owns this evaluation app_id: type: string title: app id that owns this evaluation id: type: string title: Id of this evaluation model: $ref: '#/components/schemas/apiModel' title: Model to evaluate ground_truth_dataset: $ref: '#/components/schemas/apiDataset' title: The ground truth dataset predictions_dataset: $ref: '#/components/schemas/apiDataset' title: The dataset with predictions summary: $ref: '#/components/schemas/apiMetricsSummary' confusion_matrix: $ref: '#/components/schemas/apiConfusionMatrix' cooccurrence_matrix: $ref: '#/components/schemas/apiCooccurrenceMatrix' label_counts: $ref: '#/components/schemas/apiLabelDistribution' binary_metrics: type: array items: type: object $ref: '#/components/schemas/apiBinaryMetrics' test_set: type: array items: type: object $ref: '#/components/schemas/apiEvalTestSetEntry' metrics_by_area: type: array items: type: object $ref: '#/components/schemas/apiBinaryMetrics' metrics_by_class: type: array items: type: object $ref: '#/components/schemas/apiBinaryMetrics' tracker_metrics: type: array items: type: object $ref: '#/components/schemas/apiTrackerMetrics' eval_info: $ref: '#/components/schemas/apiEvalInfo' description: 'Evaluation parameters to pass. Expected to match what is defined in the model type for the respective model.' extended_metrics: $ref: '#/components/schemas/apiExtendedMetrics' title: EvalMetrics apiMultiConceptCountResponse: type: object properties: status: $ref: '#/components/schemas/apistatusStatus' description: The response status. concept_counts: type: array items: type: object $ref: '#/components/schemas/apiConceptCount' description: The returned concept counts. title: MultiConceptCountResponse apiCollaborator: type: object properties: id: type: string title: id of this collaborator app: $ref: '#/components/schemas/apiApp' description: 'the app this collaborator has access to FIXME(zeiler): this should be in the user_app_id.app_id already from the endpoint.' user: $ref: '#/components/schemas/apiUser' title: who is this collaborator scopes: type: array items: type: string title: the permission this collaborator endpoints: type: array items: type: string created_at: type: string format: date-time title: 'When the app was shared with. We follow the XXXX timestamp format. We use https://www.ietf.org/rfc/rfc3339.txt format: "2006-01-02T15:04:05.999999Z" so you can expect results like the following from the API: "2017-04-11T21:50:50.223962Z"' modified_at: type: string format: date-time description: When the collaborator was updated. deleted_at: type: string format: date-time description: When the collaborator was removed from app. title: Collaborator - invited user, who shares an access to an application TaskInputSourceTaskInputSourceType: type: string enum: - INPUT_SOURCE_TYPE_NOT_SET - ALL_INPUTS - SAVED_SEARCH - DATASET - INPUT default: INPUT_SOURCE_TYPE_NOT_SET title: "- ALL_INPUTS: Use all inputs in the app.\n - SAVED_SEARCH: Use the inputs from a saved search.\n - DATASET: Inputs from a dataset.\n - INPUT: Single input (e.g. video livestream input)" apiTimeSegment: type: object properties: id: type: string description: A unique id for the time segment. data: $ref: '#/components/schemas/apiData' time_info: $ref: '#/components/schemas/apiTimeInfo' title: TimeSegment V2GenerateModelOutputsBody: type: object properties: user_app_id: type: object description: Common message to identify the app in a url endpoint. version_id: type: string inputs: type: array items: type: object $ref: '#/components/schemas/apiInput' model: $ref: '#/components/schemas/apiModel' description: 'This allows you to specify config options for the model such as the language which appear''s in the model''s output_info.' runner_selector: $ref: '#/components/schemas/apiRunnerSelector' title: Allow filtering of prediction requests down to specific Nodepools, Deployments or Runners use_predict_cache: type: boolean title: Configure the prediction cache to avoid expensive compute for predict requests enable_log_summary_on_error: type: boolean title: Configuration to provide logs summarization when request errors out description: '////////////////////////////////////////////////// Model prediction related stuff needs inputs and produces outputs. ////////////////////////////////////////////////// Model prediction.' apiSyncStateRequest: type: object properties: operation_type: type: string description: 'The operation that was performed: create, update, delete.' compute_clusters: type: array items: type: object $ref: '#/components/schemas/apiComputeCluster' description: Objects that were affected. nodepools: type: array items: type: object $ref: '#/components/schemas/apiNodepool' runners: type: array items: type: object $ref: '#/components/schemas/apiRunner' pipeline_version_runs: type: array items: type: object $ref: '#/components/schemas/apiPipelineVersionRun' secrets: type: array items: type: object $ref: '#/components/schemas/apiSecret' description: 'SyncStateRequest is a message that the control plane sends to the agent runner to notify it of changes to objects.' apiDataset: type: object properties: id: type: string title: The ID for the dataset created_at: type: string format: date-time description: 'When the dataset was created. The format is https://www.ietf.org/rfc/rfc3339.txt. Example: "2006-01-02T15:04:05.999999Z".' modified_at: type: string format: date-time description: 'When the dataset was modified. The format is https://www.ietf.org/rfc/rfc3339.txt. Example: "2006-01-02T15:04:05.999999Z".' app_id: type: string description: The app the dataset belongs to. user_id: type: string description: The user the dataset belongs to. description: type: string title: Description of the dataset metadata: type: object title: 'To handle arbitrary json metadata you can use a struct field: https://github.com/google/protobuf/blob/master/src/google/protobuf/struct.proto' visibility: $ref: '#/components/schemas/clarifaiapiVisibility' description: 'The visibility field represents whether this message is privately/publicly visible. To be visible to the public the App that contains it AND the User that contains the App must also be publicly visible.' default_annotation_filter: $ref: '#/components/schemas/apiAnnotationFilter' description: Default annotation filter used for this dataset. default_processing_info: $ref: '#/components/schemas/apiDatasetVersionProcessingInfo' description: Default processing info used for this dataset. notes: type: string description: 'Notes for the dataset This field should be used for in-depth notes and supports up to 64Kbs.' version: $ref: '#/components/schemas/apiDatasetVersion' description: 'Dataset version associated with this dataset. This is used in listing Datasets and including the latest version.' is_starred: type: boolean description: Whether the dataset is starred by the requesting user. star_count: type: integer format: int32 description: Number of users that starred this dataset. bookmark_origin: $ref: '#/components/schemas/apiBookmarkOrigin' description: 'bookmark info. When set, this dataset is a bookmarked dataset of this app. Info in this field will allow you to find/access original dataset.' image: $ref: '#/components/schemas/apiImage' title: Representative image for this dataset title: Dataset apiInstanceType: type: object properties: id: type: string description: type: string description: Short description of instance type. compute_info: $ref: '#/components/schemas/apiComputeInfo' price: type: string cloud_provider: $ref: '#/components/schemas/apiCloudProvider' description: The cloud provider where this instance type is available, if any. region: type: string description: The region where this instance type is available, if any. allowed_capacity_types: $ref: '#/components/schemas/apiNodeCapacityType' description: The capacity types allowed for this instance type. If empty - all capacity types are allowed. feature_flag_group: type: string description: The feature flag group associated with this instance type. special_handling: type: array items: type: object $ref: '#/components/schemas/apiSpecialHandling' description: List of special handling instructions for this instance type. architecture: type: string description: Hardware architecture of the instance type (e.g., "linux/amd64", "linux/arm64"). available_compute_info: $ref: '#/components/schemas/apiComputeInfo' description: 'Available compute info after accounting for system overhead (daemonsets, kubelet, etc.). This represents the actual resources available for user workloads.' description: 'The instance types that will be available in this pool of nodes. Clarifai offers multiple different choices that combine cpu cores, memory and accelerator.' utilsTimeOfDay: type: object properties: hours: type: integer format: int32 description: Hours of day in 24 hour format. Must be from 0 to 23. minutes: type: integer format: int32 description: Minutes of hour of day. Must be from 0 to 59. seconds: type: integer format: int32 description: Seconds of minutes of the time. Must be from 0 to 59. nanos: type: integer format: int32 description: Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999. apiWorkflowNode: type: object properties: id: type: string description: 'An identifier for this node in the graph. This is used when connecting NodeInputs together.' model: $ref: '#/components/schemas/apiModel' description: 'The model that will do the processing at this node. We only vlidate the model.id and model.model_version.id fields.' node_inputs: type: array items: type: object $ref: '#/components/schemas/apiNodeInput' description: 'Each WorkflowNode can connect to multiple input nodes so that we can handle multi-model data and more complex workflow operations.' suppress_output: type: boolean title: suppress the output for workflow prediction output_info_override: $ref: '#/components/schemas/apiOutputInfo' description: 'Used to override the output_info.data and output_info.params of the model specified by the node. Values for fields_map, message, and output_config are ignored.' title: WorkflowNode apiSingleAppDuplicationResponse: type: object properties: status: $ref: '#/components/schemas/apistatusStatus' app_duplication: $ref: '#/components/schemas/apiAppDuplication' title: 'Deprecated: App duplication is no longer supported. SingleAppDuplicationResponse' V2PostInputsSearchesBody: type: object properties: user_app_id: type: object description: The user_id and app_id to query from. title: The user_id and app_id to query from. searches: type: array items: type: object $ref: '#/components/schemas/apiSearch' title: The searched to be executed or saved pagination: $ref: '#/components/schemas/apiPagination' description: Pagination information to paginate through search result Hits. only_count: type: boolean description: 'If only_count is set, then the response will not contain hits, but hit_counts instead.' title: Execute a new input search and optionally save it V2PostInputsUploadsBody: type: object properties: user_app_id: type: object description: Common message to identify the app in a url endpoint. inputs_uploads: type: array items: type: object $ref: '#/components/schemas/apiInputsUpload' description: 'Start uploading a file archive containing inputs. Will create and return an inputs-add-job for tracking progress. Associated inputs-add-job contains an upload id which should be completed through `PutUploadContentParts` endpoint. Completing the upload will automatically begin unpacking the archive and uploading the contents as inputs.' MetricDataMetricSample: type: object properties: timestamp: type: string format: date-time description: 'The format is https://www.ietf.org/rfc/rfc3339.txt. Example: "2006-01-02T15:04:05.999999Z".' value: type: number format: double apiConceptTypeCount: type: object properties: positive: type: integer format: int64 description: 'The number of inputs that have a concept with a value of 1.0 (indicating presence of the concept in an input).' negative: type: integer format: int64 description: 'The number of inputs that have a concept with a value of 0.0 (indicating absence of the concept in an input).' title: ConceptTypeCount V2PatchNodepoolsBody: type: object properties: user_app_id: type: object properties: app_id: type: string description: Common message to identify the app in a url endpoint. nodepools: type: array items: type: object $ref: '#/components/schemas/apiNodepool' action: type: string title: 'The action to perform on the patched objects For now actions ''merge'', ''overwrite'', and ''remove'' are supported' title: PatchNodepoolsRequest apiEventType: type: string enum: - EVENT_TYPE_NOT_SET - ORGANIZATION_MEMBER_ADD - ORGANIZATION_MEMBER_CHANGE - ORGANIZATION_MEMBER_REMOVE - ORGANIZATION_MEMBER_INVITATION_CREATE - ORGANIZATION_MEMBER_INVITATION_CANCEL - ORGANIZATION_MEMBER_INVITATION_ACCEPT - ORGANIZATION_MEMBER_INVITATION_DECLINE - ORGANIZATION_TEAM_CREATE - ORGANIZATION_TEAM_UPDATE - ORGANIZATION_TEAM_DELETE - ORGANIZATION_TEAM_MEMBER_ADD - ORGANIZATION_TEAM_MEMBER_REMOVE - ORGANIZATION_TEAM_APP_ADD - ORGANIZATION_TEAM_APP_REMOVE - MODEL_CREATE - MODEL_UPDATE - MODEL_DELETE - MODEL_VERSION_CREATE - MODEL_VERSION_UPDATE - MODEL_VERSION_DELETE - WORKFLOW_CREATE - WORKFLOW_UPDATE - WORKFLOW_DELETE - WORKFLOW_VERSION_CREATE - WORKFLOW_VERSION_UPDATE - WORKFLOW_VERSION_DELETE - APPLICATION_CREATE - APPLICATION_UPDATE - APPLICATION_DELETE - COLLABORATOR_ADD - COLLABORATOR_UPDATE - COLLABORATOR_REMOVE - USER_UPDATE - COMPUTE_CLUSTER_CREATE - COMPUTE_CLUSTER_UPDATE - COMPUTE_CLUSTER_DELETE - NODEPOOL_CREATE - NODEPOOL_UPDATE - NODEPOOL_DELETE - DEPLOYMENT_CREATE - DEPLOYMENT_UPDATE - DEPLOYMENT_DELETE default: EVENT_TYPE_NOT_SET title: "- ORGANIZATION_MEMBER_ADD: Event types related to organization memberships and teams: 100 - 199\n - MODEL_CREATE: Event types related to models: 300 - 399\n - WORKFLOW_CREATE: Event types related to workflows: 400 - 499\n - APPLICATION_CREATE: Event types related to applications: 600 - 699\n - COLLABORATOR_ADD: Event types related to collaborators: 700 - 799\n - USER_UPDATE: Event types related to users: 800 - 899\n - COMPUTE_CLUSTER_CREATE: Event types related to compute clusters: 900-999\n - NODEPOOL_CREATE: Event types related to nodepools: 1000-1099\n - DEPLOYMENT_CREATE: Event types related to deployments: 1100-1199" apiOpenRouterInfo: type: object properties: params: type: object apiPatchAction: type: object properties: op: type: string title: 'The operation to perform on the patched metadata given a path For now only operations ''overwrite'', ''delete, and ''merge'' is supported' merge_conflict_resolution: type: string description: "Option 'append' will simply create a list on conflicts. For example in above example\nthe final result would be\n{\n \"tag\": [\n {\n \"id\": \"1\",\n \"data\": 1\n },\n {\n \"id\": \"2\",\n \"data\": [2, 3]\n }\n ]\n}" title: "If the action is 'merge' and there is a conflict, how to resolve it.\nThe options are\n'overwrite_by_id', 'remove_by_id', 'merge_by_id','overwrite', 'append' and 'do_nothing'\nNote that for conflict resolutions '*_by_id' to work on a list, the list should contain\nobjects with an 'id' field which will be used to uniquely identify each field. For example\nPatching existing json\n{\n \"tag\": [\n {\n \"id\": \"1\",\n \"data\": 1\n },\n {\n \"id\": \"2\",\n \"data\": 2\n }\n ]\n}\nwith op 'merge' and merge_conflict_resolution 'overwrite_by_id'\n{\n \"tag\": [\n {\n \"id\": \"2\",\n \"data\": 3\n }\n ]\n}\nwould produce\n{\n \"tag\": [\n {\n \"id\": \"1\",\n \"data\": 1\n },\n {\n \"id\": \"2\",\n \"data\": 3\n }\n ]\n}\nwhile with merge_conflict_resolution 'remove_by_id' it would produce\n{\n \"tag\": [\n {\n \"id\": \"1\",\n \"data\": 1\n }\n ]\n}" path: type: string description: 'Path for the change. For example ''tag[1].data'' is a valid path in above example. Default path is root level i.e. ''''.' title: PatchAction apiMultiModelLanguageResponse: type: object properties: status: $ref: '#/components/schemas/apistatusStatus' languages: type: array items: type: string apiV2DeleteAnnotationsBody: type: object properties: user_app_id: type: object description: Common message to identify the app in a url endpoint. ids: type: array items: type: string title: Delete annotations with IDs input_ids: type: array items: type: string title: 'Delete annotations for these Input IDs Note that ''ids'' are optional but if the are provided the number and order in ''ids'' and ''input_ids'' should match If you do not specifiy ''ids'' all the annotations for ''input_ids'' are deleted However you need to specify at least one value for ''input_ids'' i.e. this API does not support deleting all annotations' description: Request to delete several things by the list of ids. apiSingleInputsExtractionJobResponse: type: object properties: status: $ref: '#/components/schemas/apistatusStatus' inputs_extraction_job: $ref: '#/components/schemas/apiInputsExtractionJob' apiSingleConceptResponse: type: object properties: status: $ref: '#/components/schemas/apistatusStatus' description: The response status. concept: $ref: '#/components/schemas/apiConcept' description: The returned concept. title: SingleConceptResponse apiMetricsQueryResponse: type: object properties: status: $ref: '#/components/schemas/apistatusStatus' data: $ref: '#/components/schemas/apiMetricData' resolution: type: string V2PatchPipelinesBody: type: object properties: user_app_id: type: object description: Common message to identify the app in a url endpoint. pipelines: type: array items: type: object $ref: '#/components/schemas/apiPipeline' action: type: string title: 'The action to perform on the patched objects For now actions ''overwrite'' are supported' V2PostModelsBody: type: object properties: user_app_id: type: object description: Common message to identify the app in a url endpoint. model: $ref: '#/components/schemas/apiModel' description: 'NOTE: inconsistent since "model" is not plural, please use "models" below. Previously you could only create one model at a time. We still support this but you should pass it as models=[model] so that this endpoint is consistent with the rest of our API.' models: type: array items: type: object $ref: '#/components/schemas/apiModel' description: This allows you to create one or more model by posting it to the API. title: PostModelsRequest apiMultiWorkerResponse: type: object properties: status: $ref: '#/components/schemas/apistatusStatus' workers: type: array items: type: object $ref: '#/components/schemas/apiWorker' title: MultiWorkerResponse BookmarkOriginBookmarkType: type: string enum: - unknown - model - workflow - dataset default: unknown apiMultiInputsAddJobResponse: type: object properties: status: $ref: '#/components/schemas/apistatusStatus' inputs_add_jobs: type: array items: type: object $ref: '#/components/schemas/apiInputsAddJob' title: MultiInputsAddJobResponse apiBuildInfo: type: object properties: docker_image_name: type: string title: Docker image name docker_image_tag: type: string title: Docker image tag docker_image_digest: type: string title: Docker image digest platform: type: string title: Platform(s) the model was built for (e.g., "linux/amd64,linux/arm64") apiFullTag: type: object properties: name: type: string title: Display name of the tag. Ex. "English" id: type: string title: Id value for referencing. Ex. "en" apiTritonCondaEnvInfo: type: object properties: conda_pack_url: type: string conda_yaml_url: type: string apiUpload: type: object properties: id: type: string title: ID of upload created_at: type: string format: date-time description: 'When the upload was started. The format is https://www.ietf.org/rfc/rfc3339.txt. Example: "2006-01-02T15:04:05.999999Z".' modified_at: type: string format: date-time description: 'Most recent time when the upload was updated. The format is https://www.ietf.org/rfc/rfc3339.txt. Example: "2006-01-02T15:04:05.999999Z".' expires_at: type: string format: date-time description: 'When the upload will expire and be deleted The format is https://www.ietf.org/rfc/rfc3339.txt. Example: "2006-01-02T15:04:05.999999Z".' status: $ref: '#/components/schemas/apistatusStatus' title: Status of the upload content_name: type: string title: name of uploaded content (e.g. filename) content_length: type: string format: uint64 title: Total size of the upload content content_url: type: string title: Url of uploaded content apiSingleEvalMetricsResponse: type: object properties: status: $ref: '#/components/schemas/apistatusStatus' eval_metrics: $ref: '#/components/schemas/apiEvalMetrics' V2DeleteCollaboratorsBody: type: object properties: user_app_id: type: object description: Common message to identify the app in a url endpoint. collaborator_ids: type: array items: type: string user_emails: type: array items: type: string title: DeleteCollaboratorsRequest apiVideo: type: object properties: url: type: string description: 'This is a URL to a publicly accessible video file. The platform will download this file server side and then process.' base64: type: string format: byte description: 'The base64 field is using video file bytes directly in the request. NOTE: if you''re sending a json request, then this MUST be base64 encoded before sending (hence the name here). When using our grpc clients, you DO NOT need to base64 encode it yourself since the clients know how to do this for you automatically and will avoid the base64 encoding if they send a binary request.' allow_duplicate_url: type: boolean thumbnail_url: type: string title: 'URL of thumbnail image, which is currently frame at position of 1s. This field is currently used only in response. Deprecated in favour of thumbnail_hosted, which also contains alternate sizes of thumbnail' hosted: $ref: '#/components/schemas/apiHostedURL' description: 'The hosted field lists original video hosted in Clarifai storage. This field is currently used only in response.' hosted_thumbnail: $ref: '#/components/schemas/apiHostedURL' description: 'The hosted field lists various sizes of the vide thumbnail hosted in Clarifai storage, with ''thumbnail'' as the full size This field is currently used only in response.' video_info: $ref: '#/components/schemas/apiVideoInfo' title: video info title: Video V2PatchAnnotationTracksBody: type: object properties: user_app_id: $ref: '#/components/schemas/apiUserAppIDSet' annotation_tracks: type: array items: type: object $ref: '#/components/schemas/apiAnnotationTrack' action: type: string title: Use always 'overwrite' title: PatchAnnotationTracksRequest V2PatchPipelineVersionRunsBody: type: object properties: user_app_id: type: object description: Common message to identify the app in a url endpoint. pipeline_version_runs: type: array items: type: object $ref: '#/components/schemas/apiPipelineVersionRun' title: '########## Supported fields ########## - app_id - id - orchestration_status - pipeline_version.id - pipeline_version.pipeline_id - user_id' action: type: string title: 'Supported action: ''overwrite'' -> allows to overwrite WorkflowStatus of PipelineVersionRun' apiMultiInputResponse: type: object properties: status: $ref: '#/components/schemas/apistatusStatus' inputs: type: array items: type: object $ref: '#/components/schemas/apiInput' inputs_add_job: $ref: '#/components/schemas/apiInputsAddJob' title: MultiInputResponse apiRunnerItemMetadata: type: object properties: user_id: type: string description: The user ID of the requester. Used for sticky routing to the same runner replica. block_hashes: type: array items: type: string format: uint64 title: chained block hashes of input for prefix cache routing apiAppDuplicationFilters: type: object properties: copy_inputs: type: boolean description: Copy inputs. copy_concepts: type: boolean description: Copy concepts. copy_annotations: type: boolean description: Copy annotations. copy_models: type: boolean description: Copy models. copy_workflows: type: boolean description: Copy workflows. title: 'Deprecated: App duplication is no longer supported. AppDuplicationFilters' apiRoleType: type: string enum: - TEAM - ORG default: TEAM apiMultiModelCheckConsentResponse: type: object properties: status: $ref: '#/components/schemas/apistatusStatus' check_consents: type: array items: type: string apiWorkflowModelUseCase: type: string enum: - WORKFLOW_MODEL_USE_CASE_NOT_SET - CLASSIFICATION - DETECTION default: WORKFLOW_MODEL_USE_CASE_NOT_SET description: " - CLASSIFICATION: Classifier models without a detector parent (recursive check) in a workflow\nare used for classification.\n - DETECTION: Detector models in a workflow are used for detection.\nClassifier models that run after a detector model are also used for detection." apiPutTaskAssignmentsRequestAction: type: string enum: - PUT_TASK_ASSIGNMENTS_REQUEST_ACTION_NOT_SET - LABEL_START - LABEL_SUBMIT - REVIEW_START - REVIEW_APPROVE - REVIEW_REQUEST_CHANGES - REVIEW_REJECT default: PUT_TASK_ASSIGNMENTS_REQUEST_ACTION_NOT_SET title: "- LABEL_START: Create a list of task assignments for labeler => 10 inputs are assigned to the labeler.\nThis is a fully sync action.\nIf task assignments already exist, then return existing task assignments.\n - LABEL_SUBMIT: Submit task assignments => mark task assignment work as completed.\nThis is a partially sync action.\nSync: task assignments are updated as follows:\n* when review_strategy is NONE, then task assignment status is updated to SUCCESS.\n* when review strategy is CONSENSUS, then task assignment status is updated to AWAITING_CONSENSUS_REVIEW.\n* when review strategy is MANUAL, then task assignment status is updated to AWAITING_REVIEW.\nIf task assignments are already submitted, then no update is performed on them.\nAsync: annotations added for the same input as the task assignment are updated as follows:\n* when review_strategy is NONE, then annotation status is updated to SUCCESS.\n* when review strategy is CONSENSUS, then annotation status is updated to SUCCESS (if it reaches consensus) or AWAITING_REVIEW (if it does not reach consensus).\n* when review strategy is MANUAL, then annotation status is updated to AWAITING_REVIEW.\n - REVIEW_START: Assign task assignments for reviewer to review => 10 task assignments are assigned to the reviewer.\nThis is a fully sync action.\nIf task assignments are already assigned for review, then return existing task assignments.\n - REVIEW_APPROVE: Approve task assignments.\nThere are two types of configurations:\n* Batch approve: approve a list of task assignment IDs;\n* Bulk approve: approve all task assignments from a list of workers.\nThis is a partially sync action.\nSync: task assignments are updated to SUCCESS\nAsync: annotations added for the same input as the task assignment are updated to SUCCESS\n - REVIEW_REQUEST_CHANGES: Request changes for task assignments.\nThere are two types of configurations:\n* Batch request changes: request changes for a list of task assignment IDs;\n* Bulk request changes: request changes for all task assignments from a list of workers.\nThis is a partially sync action.\nSync: task assignments are updated to PENDING\nAsync: annotations added for the same input as the task assignment are updated to PENDING\n - REVIEW_REJECT: Reject task assignments.\nThere are two types of configurations:\n* Batch reject: reject a list of task assignment IDs;\n* Bulk reject: reject all task assignments from a list of workers.\nThis is a partially sync action.\nSync: task assignments are updated to REVIEW_DENIED\nAsync: annotations added for the same input as the task assignment are updated to REVIEW_DENIED" apiPipelineVersion: type: object properties: id: type: string app_id: type: string description: The app the pipeline version belongs to. user_id: type: string description: The user the pipeline version belongs to. orchestration_spec: $ref: '#/components/schemas/apiOrchestrationSpec' title: Orchestration Specification using oneof pipeline_id: type: string title: Pipeline's Id description: type: string title: Short description about this pipeline version visibility: $ref: '#/components/schemas/clarifaiapiVisibility' description: 'The visibility field represents whether this message is privately/publicly visible. To be visible to the public the App that contains it AND the User that contains the App must also be publicly visible.' metadata: type: object title: 'To handle arbitrary json metadata, use a struct field https://github.com/google/protobuf/blob/master/src/google/protobuf/struct.proto' created_at: type: string format: date-time title: When the pipeline was created modified_at: type: string format: date-time title: When the pipeline was last modified config: $ref: '#/components/schemas/apiPipelineVersionConfig' title: Pipeline version configuration including step secrets apiArtifactVersion: type: object properties: id: type: string title: ID of artifact version description: type: string title: Description of the artifact version artifact: $ref: '#/components/schemas/apiArtifact' title: Reference to the artifact resource upload: $ref: '#/components/schemas/apiUpload' title: Reference to the upload resource which contains the actual file location and metadata visibility: $ref: '#/components/schemas/clarifaiapiVisibility' description: 'The visibility field represents whether this is privately/publicly visible. To be visible to the public the App that contains it AND the User that contains the App must also be publicly visible.' expires_at: type: string format: date-time description: 'When the artifact version will expire and be deleted. The format is https://www.ietf.org/rfc/rfc3339.txt. Example: "2006-01-02T15:04:05.999999Z". If not set, the artifact version will be retained indefinitely and will not be automatically deleted by lifecycle policies.' created_at: type: string format: date-time description: When the artifact version was created. modified_at: type: string format: date-time description: Most recent time when the artifact version was updated. deleted_at: type: string format: date-time description: When the artifact version was deleted. description: ArtifactVersion represents a specific version of the artifact. apiColor: type: object properties: raw_hex: type: string w3c: $ref: '#/components/schemas/apiW3C' value: type: number format: float title: Color data apiConceptRelation: type: object properties: id: type: string title: ID of the concept relation subject_concept: $ref: '#/components/schemas/apiConcept' title: The subject concept (i.e. source) of the concept relation object_concept: $ref: '#/components/schemas/apiConcept' title: The subject concept (i.e. destination) of the concept relation predicate: type: string description: 'The predicate (i.e. edge) linking the subject and the object Both subject_concept and object_concept are concepts. The predicate is the type of relationship. That predicate acts on the subject. There are three current types of predicates: 1) "hyponym" 2) "hypernym" 3) "synonym" 1) For example, ''hyponym'' is a type of predicate which represents ''is_a_kind_of'' relation so the following relationship: ''honey'' (subject), ''hyponym'' (predicate), ''food'' (object) Can more easily be read as: ''honey'' ''is a kind of'' ''food'' 2) The ''hypernym'' relation is the opposite of ''hyponym'' and when you add one of the relationships the opposite will automatically appear for you in queries. The ''hypernym'' can be read as ''is a parent of'' so: ''food'' (subject), ''hypernym'' (predicate), ''honey'' (object) Can more easily be read as: ''food'' is a parent of ''honey'' 3) The ''synonym'' relation defines two concepts that essential mean the same thing. This is more like a "is" relationship. So for example a ''synonym'' relationship could be: "puppy" is "pup" The reverse is also true once the former is added so: "pup" is "puppy" will appear in queries as well.' knowledge_graph_id: type: string description: 'The knowledge graph id that this edge belongs to. If using the app''s global knowledge graph and not a specific one then this should be the empty string "".' visibility: $ref: '#/components/schemas/clarifaiapiVisibility' description: 'The visibility field represents whether this message is privately/publicly visible. To be visible to the public the App that contains it AND the User that contains the App must also be publicly visible.' title: This represents a relation (i.e. edge) between the subject concept and the object concept apiPipelineVersionRun: type: object properties: id: type: string pipeline_version: $ref: '#/components/schemas/apiPipelineVersion' title: Pipeline Version associated with this run nodepools: type: array items: type: object $ref: '#/components/schemas/apiNodepool' title: Nodepool(s) used for the Pipeline Version Run orchestration_status: $ref: '#/components/schemas/apiOrchestrationStatus' title: Orchestration Status for this run, supporting multiple orchestration systems user_id: type: string title: The user the pipeline belongs to app_id: type: string title: The app the pipeline belongs to created_at: type: string format: date-time title: When the pipeline was created modified_at: type: string format: date-time title: When the pipeline was last modified input_args_override: $ref: '#/components/schemas/apiOrchestrationArgsOverride' description: 'Optional: Overrides to input arguments for the orchestration system.' orchestration_spec: $ref: '#/components/schemas/apiOrchestrationSpec' description: 'Final merged orchestration spec snapshot submitted to backend. This field is read-only and cannot be set during creation.' started_at: type: string format: date-time title: When the pipeline run started executing (first JOB_RUNNING status) ended_at: type: string format: date-time title: When the pipeline run finished executing (terminal status) total_run_duration: type: string title: Total cumulative run duration excluding pause time V2PatchModelsBody: type: object properties: user_app_id: type: object description: Common message to identify the app in a url endpoint. models: type: array items: type: object $ref: '#/components/schemas/apiModel' action: type: string description: 'Note that ''remove'' can be used to remove the model image by setting ''image.url'' in the request to the current value returned for that model. This cannot be used in a request that is patching other fields as well.' title: 'The action to perform on the patched objects For now actions ''merge'', ''overwrite'', and ''remove'' are supported' title: PatchModelsRequest apiWorkflowState: type: object properties: id: type: string description: 'A unique ID for the workflow state. To start saving a state in a PostWorkflowResults request set this ID to "init" and it will return a newly generated unique state id that you can then pass in subsequent PostWorkflowResults calls. These state expire after 5 minutes between calls.' title: WorkflowState apiInputsAddJob: type: object properties: id: type: string title: id of the job call_back_url: type: string description: If call back url is set, we will send a Post request to this endpoint with job status. app_pat: type: string title: Personal Access Token to the application to which inputs are added progress: $ref: '#/components/schemas/apiInputsAddJobProgress' title: Progress of an on-going Input Ingestion task created_at: type: string format: date-time description: 'When the job was created. The format is https://www.ietf.org/rfc/rfc3339.txt. Example: "2006-01-02T15:04:05.999999Z".' modified_at: type: string format: date-time description: 'Most recent time when the job was updated. The format is https://www.ietf.org/rfc/rfc3339.txt. Example: "2006-01-02T15:04:05.999999Z".' extraction_jobs: type: array items: type: object $ref: '#/components/schemas/apiInputsExtractionJob' title: Sub-jobs that extract inputs from the cloud and/or archives uploads: type: array items: type: object $ref: '#/components/schemas/apiUpload' title: Archive uploads status: $ref: '#/components/schemas/apistatusStatus' title: Status of the job statusStatusCode: type: string enum: - ZERO - SUCCESS - MIXED_STATUS - FAILURE - TRY_AGAIN - NOT_IMPLEMENTED - MOVED - TEAPOT - ACCEPTED - CONN_ACCOUNT_ISSUES - CONN_TOKEN_INVALID - CONN_CREDENTIALS_INVALID - CONN_EXCEED_HOURLY_LIMIT - CONN_EXCEED_MONTHLY_LIMIT - CONN_THROTTLED - CONN_EXCEEDS_LIMITS - CONN_INSUFFICIENT_SCOPES - CONN_KEY_INVALID - CONN_KEY_NOT_FOUND - CONN_BAD_REQUEST_FORMAT - CONN_DOES_NOT_EXIST - CONN_INVALID_REQUEST - CONN_METHOD_NOT_ALLOWED - CONN_NO_GDPR_CONSENT - CONN_INVALID_RANGE - CONN_AUTH_METHOD_DISABLED - MODEL_TRAINED - MODEL_TRAINING - MODEL_UNTRAINED - MODEL_QUEUED_FOR_TRAINING - MODEL_UPLOADING - MODEL_UPLOADING_FAILED - MODEL_TRAINING_FAILED - MODEL_BUILDING - MODEL_BUILDING_FAILED - MODEL_BUILD_UNEXPECTED_ERROR - MODEL_TRAINING_NO_DATA - MODEL_TRAINING_NO_POSITIVES - MODEL_TRAINING_ONE_VS_N_SINGLE_CLASS - MODEL_TRAINING_TIMED_OUT - MODEL_TRAINING_WAITING_ERROR - MODEL_TRAINING_UNKNOWN_ERROR - MODEL_TRAINING_MSG_REDELIVER - MODEL_TRAINING_INSUFFICIENT_DATA - MODEL_TRAINING_INVALID_PARAMS - MODEL_TRAINING_INVALID_DATA_TOLERANCE_EXCEEDED - MODEL_MODIFY_SUCCESS - MODEL_MODIFY_PENDING - MODEL_MODIFY_FAILED - MODEL_DOES_NOT_EXIST - MODEL_PERMISSION_DENIED - MODEL_INVALID_ARGUMENT - MODEL_INVALID_REQUEST - MODEL_EVALUATED - MODEL_EVALUATING - MODEL_NOT_EVALUATED - MODEL_QUEUED_FOR_EVALUATION - MODEL_EVALUATION_TIMED_OUT - MODEL_EVALUATION_WAITING_ERROR - MODEL_EVALUATION_UNKNOWN_ERROR - MODEL_PREDICTION_FAILED - MODEL_EVALUATION_MSG_REDELIVER - MODEL_EVALUATION_NEED_LABELS - MODEL_EVALUATION_NEED_INPUTS - MODEL_EVALUATION_FAILED - MODEL_DEPLOYMENT_FAILED - MODEL_DEPLOYING - MODEL_QUEUED_FOR_DEPLOYMENT - MODEL_NOT_DEPLOYED - MODEL_BUSY_PLEASE_RETRY - MODEL_LOADING - MODEL_REFERENCE_INVALID_ARGUMENT - MODEL_EXAMPLE_INPUT_INVALID_ARGUMENT - MODEL_EXPORTED - MODEL_EXPORTING - MODEL_EXPORTING_FAILED - MODEL_EXPORT_PENDING - WORKFLOW_NO_MATCHING_INPUT - WORKFLOW_REQUIRE_TRAINED_MODEL - WORKFLOW_DUPLICATE - WORKFLOW_UNSUPPORTED_FORMAT - WORKFLOW_DOES_NOT_EXIST - WORKFLOW_PERMISSION_DENIED - WORKFLOW_INVALID_ARGUMENT - WORKFLOW_INVALID_RECIPE - WORKFLOW_INVALID_TEMPLATE - WORKFLOW_INVALID_GRAPH - WORKFLOW_INTERNAL_FAILURE - WORKFLOW_INVALID_REQUEST - WORKFLOW_MODIFY_SUCCESS - WORKFLOW_MODIFY_PENDING - WORKFLOW_MODIFY_FAILED - WORKFLOW_REINDEX_FAILED - CONCEPT_MODIFY_SUCCESS - CONCEPT_MODIFY_PENDING - CONCEPT_MODIFY_FAILED - ANNOTATION_SUCCESS - ANNOTATION_PENDING - ANNOTATION_FAILED - ANNOTATION_UNKNOWN_STATUS - ANNOTATION_INVALID_ARGUMENT - ANNOTATION_PERMISSION_DENIED - ANNOTATION_AWAITING_REVIEW - ANNOTATION_AWAITING_CONSENSUS_REVIEW - ANNOTATION_REVIEW_DENIED - ANNOTATION_MODIFY_SUCCESS - ANNOTATION_MODIFY_PENDING - ANNOTATION_MODIFY_FAILED - ANNOTATION_TRACK_IDLE - ANNOTATION_TRACK_IN_PROGRESS - ANNOTATION_TRACK_PENDING - ANNOTATION_TRACK_APPROVED - ANNOTATION_TRACK_FAILED - METADATA_INVALID_PATCH_ARGUMENTS - METADATA_PARSING_ISSUE - METADATA_MANIPULATION_ISSUE - TRAINER_JOB_STATE_NONE - TRAINER_JOB_STATE_QUEUED - TRAINER_JOB_STATE_RUNNING - TRAINER_JOB_STATE_COMPLETE - TRAINER_JOB_STATE_ERROR - DATA_DUMP_SUCCESS - DATA_DUMP_PENDING - DATA_DUMP_FAILED - DATA_DUMP_IN_PROGRESS - DATA_DUMP_NO_DATA - DATA_DUMP_UNEXPECTED_ERROR - DATA_DUMP_EXPORT_SUCCESS - DATA_DUMP_EXPORT_PENDING - DATA_DUMP_EXPORT_FAILED - DATA_DUMP_EXPORT_IN_PROGRESS - DATA_DUMP_EXPORT_UNEXPECTED_ERROR - APP_DUPLICATION_SUCCESS - APP_DUPLICATION_FAILED - APP_DUPLICATION_PENDING - APP_DUPLICATION_IN_PROGRESS - APP_DUPLICATION_INVALID_REQUEST - MODULE_DOES_NOT_EXIST - MODULE_PERMISSION_DENIED - MODULE_INVALID_ARGUMENT - MODULE_INVALID_REQUEST - BULK_OPERATION_SUCCESS - BULK_OPERATION_FAILED - BULK_OPERATION_PENDING - BULK_OPERATION_IN_PROGRESS - BULK_OPERATION_INVALID_REQUEST - BULK_OPERATION_CANCELLED - BULK_OPERATION_UNEXPECTED_ERROR - RUNNER_DOES_NOT_EXIST - RUNNER_PERMISSION_DENIED - RUNNER_INVALID_ARGUMENT - RUNNER_INVALID_REQUEST - RUNNER_NEEDS_RETRY - RUNNER_STREAM_START - RUNNER_STREAM_END - RUNNER_ITEM_CANCELLED - RUNNER_PROCESSING_FAILED - RUNNER_SPECIAL_HANDLING_NOT_COMPLETE - NODEPOOL_DOES_NOT_EXIST - NODEPOOL_INVALID_ARGUMENT - NODEPOOL_INVALID_REQUEST - COMPUTE_CLUSTER_DOES_NOT_EXIST - COMPUTE_CLUSTER_INVALID_ARGUMENT - COMPUTE_CLUSTER_INVALID_REQUEST - DEPLOYMENT_DOES_NOT_EXIST - DEPLOYMENT_INVALID_ARGUMENT - DEPLOYMENT_INVALID_REQUEST - DEPLOYMENT_DISABLED - INSTANCE_TYPE_DOES_NOT_EXIST - INSTANCE_TYPE_INVALID_ARGUMENT - INSTANCE_TYPE_INVALID_REQUEST - COMPUTE_PLANE_METRICS_INVALID_REQUEST - PIPELINE_STEP_DOES_NOT_EXIST - PIPELINE_STEP_INVALID_ARGUMENT - PIPELINE_STEP_INVALID_REQUEST - PIPELINE_STEP_UPLOADING - PIPELINE_STEP_UPLOADING_FAILED - PIPELINE_STEP_BUILDING - PIPELINE_STEP_BUILDING_FAILED - PIPELINE_STEP_BUILD_UNEXPECTED_ERROR - PIPELINE_STEP_READY - PIPELINE_STEP_NOT_READY - PIPELINE_DOES_NOT_EXIST - PIPELINE_INVALID_ARGUMENT - PIPELINE_INVALID_REQUEST - ARTIFACT_DOES_NOT_EXIST - ARTIFACT_INVALID_ARGUMENT - ARTIFACT_INVALID_REQUEST - ARTIFACT_VERSION_DOES_NOT_EXIST - ARTIFACT_VERSION_INVALID_ARGUMENT - ARTIFACT_VERSION_INVALID_REQUEST - INPUT_SUCCESS - INPUT_PENDING - INPUT_FAILED - INPUT_IN_PROGRESS - INPUT_DOWNLOAD_SUCCESS - INPUT_DOWNLOAD_PENDING - INPUT_DOWNLOAD_FAILED - INPUT_DOWNLOAD_IN_PROGRESS - INPUT_STATUS_UPDATE_FAILED - INPUT_DELETE_FAILED - INPUT_DUPLICATE - INPUT_UNSUPPORTED_FORMAT - INPUT_DOES_NOT_EXIST - INPUT_PERMISSION_DENIED - INPUT_INVALID_ARGUMENT - INPUT_OVER_LIMIT - INPUT_INVALID_URL - INPUT_MODIFY_SUCCESS - INPUT_MODIFY_PENDING - INPUT_MODIFY_FAILED - INPUT_STORAGE_HOST_FAILED - ALL_INPUT_INVALID_BYTES - INPUT_CLUSTER_SUCCESS - INPUT_CLUSTER_PENDING - INPUT_CLUSTER_FAILED - INPUT_CLUSTER_IN_PROGRESS - INPUT_REINDEX_SUCCESS - INPUT_REINDEX_PENDING - INPUT_REINDEX_FAILED - INPUT_REINDEX_IN_PROGRESS - INPUT_VIDEO_DOWNLOAD_SUCCESS - INPUT_VIDEO_DOWNLOAD_PENDING - INPUT_VIDEO_DOWNLOAD_FAILED - INPUT_VIDEO_DUPLICATE - INPUT_VIDEO_UNSUPPORTED_FORMAT - INPUT_VIDEO_DOES_NOT_EXIST - INPUT_VIDEO_PERMISSION_DENIED - INPUT_VIDEO_INVALID_ARGUMENT - INPUT_VIDEO_OVER_LIMIT - INPUT_VIDEO_INVALID_URL - INPUT_VIDEO_MODIFY_SUCCESS - INPUT_VIDEO_MODIFY_PENDING - INPUT_VIDEO_MODIFY_FAILED - INPUT_VIDEO_STORAGE_HOST_FAILED - ALL_INPUT_VIDEOS_INVALID_BYTES - INPUT_VIDEO_PROCESSING_SUCCESS - INPUT_VIDEO_PROCESSING_PENDING - INPUT_VIDEO_PROCESSING_FAILED - INPUT_VIDEO_STORAGE_INCONSISTENCY - INPUT_VIDEO_STORAGE_FAILURE - INPUT_VIDEO_URL_GENERATION_FAILURE - INPUT_CONNECTION_FAILED - REQUEST_DISABLED_FOR_MAINTENANCE - INPUT_WRITES_DISABLED_FOR_MAINTENANCE - INPUT_INVALID_REQUEST - PREDICT_INVALID_REQUEST - SEARCH_INVALID_REQUEST - CONCEPTS_INVALID_REQUEST - STATS_INVALID_REQUEST - DATABASE_DUPLICATE_KEY - DATABASE_STATEMENT_TIMEOUT - DATABASE_INVALID_ROWS_AFFECTED - DATABASE_DEADLOCK_DETECTED - DATABASE_FAIL_TASK - DATABASE_FAIL_TO_GET_CONNECTIONS - DATABASE_TOO_MANY_CLIENTS - DATABASE_CONSTRAINT_VIOLATED - DATABASE_CANCELED - ASYNC_WORKER_MULTI_ERRORS - RPC_REQUEST_QUEUE_FULL - RPC_SERVER_UNAVAILABLE - RPC_REQUEST_TIMEOUT - RPC_MAX_MESSAGE_SIZE_EXCEEDED - RPC_CANCELED - RPC_UNKNOWN_METHOD - REQUEST_CANCELED_BY_USER - CLUSTER_INTERNAL_FAILURE - EXTERNAL_CONNECTION_ERROR - QUERY_INVALID_SYNTAX - QUEUE_CONN_ERROR - QUEUE_CLOSE_REQUEST_TIMEOUT - QUEUE_CONN_CLOSED - QUEUE_PUBLISH_ACK_TIMEOUT - QUEUE_PUBLISH_ERROR - QUEUE_SUBSCRIPTION_TIMEOUT - QUEUE_SUBSCRIPTION_ERROR - QUEUE_MARSHALLING_FAILED - QUEUE_UNMARSHALLING_FAILED - QUEUE_MAX_MSG_REDELIVERY_EXCEEDED - QUEUE_ACK_FAILURE - SQS_OVERLIMIT - SQS_INVALID_RECEIPT_HANDLE - SQS_UNKNOWN - SEARCH_INTERNAL_FAILURE - SEARCH_PROJECTION_FAILURE - SEARCH_PREDICTION_FAILURE - SEARCH_BY_NOT_FULLY_INDEXED_INPUT - SAVED_SEARCH_MODIFY_FAILED - SEARCH_COUNTS_UNAVAILABLE - EVALUATION_QUEUED - EVALUATION_IN_PROGRESS - EVALUATION_SUCCESS - EVALUATION_FAILED_TO_RETRIEVE_DATA - EVALUATION_INVALID_ARGUMENT - EVALUATION_FAILED - EVALUATION_PENDING - EVALUATION_TIMED_OUT - EVALUATION_UNEXPECTED_ERROR - EVALUATION_MIXED - STRIPE_EVENT_ERROR - STRIPE_UNEXPECTED_ERROR - CACHE_MISS - REDIS_SCRIPT_EXITED_WITH_FAILURE - REDIS_STREAM_ERR - REDIS_NO_CONSUMERS - REDIS_STREAM_BACKOFF - REDIS_CHANNEL_ERR - SIGNUP_EVENT_ERROR - SIGNUP_FLAGGED - FILETYPE_UNSUPPORTED - LOGIN_EVENT_ERROR - SIFT_UNCATEGORIZED_ERROR - USER_FLAGGED - APP_COUNT_INVALID_MESSAGE - APP_COUNT_UPDATE_INCREMENT_FAILED - APP_COUNT_REBUILD_FAILED - APP_COUNT_INTERNAL_FAILURE - MP_DOWNLOAD_ERROR - MP_RESOLVE_DNS_ERROR - MP_DOWNLOAD_MAX_SIZE_EXCEEDED_ERROR - MP_IMAGE_DECODE_ERROR - MP_INVALID_ARGUMENT - MP_IMAGE_PROCESSING_ERROR - DATATIER_CONN_ERROR - USER_CONSENT_FACE - WORKER_MISSING - WORKER_ACTIVE - WORKER_INACTIVE - SSO_IDENTITY_PROVIDER_DOES_NOT_EXIST - TASK_IN_PROGRESS - TASK_DONE - TASK_WONT_DO - TASK_FAILED - TASK_IDLE - TASK_CONFLICT - TASK_NOT_IMPLEMENTED - TASK_MISSING - TASK_PERMISSION_DENIED - TASK_ASSIGNMENT_SUCCESS - TASK_ASSIGNMENT_PENDING - TASK_ASSIGNMENT_AWAITING_REVIEW - TASK_ASSIGNMENT_AWAITING_CONSENSUS_REVIEW - TASK_ASSIGNMENT_REJECTED - TASK_ASSIGNMENT_REVIEW_SUCCESS - TASK_ASSIGNMENT_REVIEW_PENDING - TASK_ASSIGNMENT_REVIEW_DISMISSED - LABEL_ORDER_PENDING - LABEL_ORDER_IN_PROGRESS - LABEL_ORDER_SUCCESS - LABEL_ORDER_CANCELED - LICENSE_ACTIVE - LICENSE_DOES_NOT_EXIST - LICENSE_NEED_UPDATE - LICENSE_EXPIRED - LICENSE_REVOKED - LICENSE_DELETED - LICENSE_VOLUME_EXCEEDED - PASSWORD_VALIDATION_SUCCESS - PASSWORD_VALIDATION_FAILED - PASSWORDPOLICY_INVALID_ARGUMENT - FEATUREFLAG_CONFIG_NOT_FOUND - FEATUREFLAG_INVALID_ARGUMENT - FEATUREFLAG_BLOCKED - FEATUREFLAG_NOT_FOUND - MAINTENANCE_SUCCESS - MAINTENANCE_FAILED - DATASET_VERSION_PENDING - DATASET_VERSION_IN_PROGRESS - DATASET_VERSION_READY - DATASET_VERSION_FAILURE - DATASET_VERSION_UNEXPECTED_ERROR - DATASET_VERSION_CONFLICT - DATASET_INPUT_SUCCESS - DATASET_INPUT_DUPLICATE - DATASET_VERSION_EXPORT_SUCCESS - DATASET_VERSION_EXPORT_PENDING - DATASET_VERSION_EXPORT_FAILED - DATASET_VERSION_EXPORT_IN_PROGRESS - DATASET_VERSION_EXPORT_UNEXPECTED_ERROR - JOB_QUEUED - JOB_RUNNING - JOB_COMPLETED - JOB_FAILED - JOB_CANCELLED - JOB_UNEXPECTED_ERROR - JOB_CONFLICT - JOB_PAUSED - AUTH_MISSING_IDP_ASSOC - LIST_OBJECTS_FAILED - ARCHIVE_EXTRACT_FAILED - UPLOAD_IN_PROGRESS - UPLOAD_DONE - UPLOAD_FAILED - UPLOAD_UNEXPECTED_ERROR - UPLOAD_EXPIRED - UPLOAD_CANCELED - UPLOAD_CONFLICT - BILLING_INVALID_INFO - BILLING_MISSING_TOKENS - LOG_ENTRIES_INVALID_REQUEST - TWILIO_MAX_VERIFICATION_BEGIN_EXCEEDED - TWILIO_MAX_VERIFICATION_CHECK_EXCEEDED - TWILIO_PHONE_NUMBER_BLOCKED - INTERNAL_SERVER_ISSUE - INTERNAL_FETCHING_ISSUE - INTERNAL_DATABASE_ISSUE - INTERNAL_CONTEXT_CANCELED - INTERNAL_UNEXPECTED_TIMEOUT - INTERNAL_UNEXPECTED_V1 - INTERNAL_UNEXPECTED_PANIC - INTERNAL_UNEXPECTED_SPIRE - INTERNAL_REDIS_UNAVAILABLE - INTERNAL_RESOURCE_EXHAUSTED - INTERNAL_REDIS_UNCATEGORIZED - INTERNAL_AWS_UNCATEGORIZED - INTERNAL_AZURE_UNCATEGORIZED - INTERNAL_VECTORDB_UNCATEGORIZED - INTERNAL_ORACLE_UNCATEGORIZED - INTERNAL_VULTR_UNCATEGORIZED - INTERNAL_GCP_UNCATEGORIZED - CONN_UNCATEGORIZED - MODEL_UNCATEGORIZED - INPUT_UNCATEGORIZED - ANNOTATION_UNCATEGORIZED - BILLING_UNCATEGORIZED - INTERNAL_UNCATEGORIZED - BAD_REQUEST - SERVER_ERROR default: ZERO description: "expired cc, still in trial, feature not supported in your tier\n - CONN_TOKEN_INVALID: invalid auth token used. Deprecated: we should return CONN_KEY_INVALID instead now in all cases.\n - CONN_CREDENTIALS_INVALID: invalid auth credentials\n - CONN_EXCEED_HOURLY_LIMIT: throttle hourly limit exceeded\n - CONN_EXCEED_MONTHLY_LIMIT: throttle monthly limit exceeded\n - CONN_THROTTLED: throttler and billing stuff\n - CONN_EXCEEDS_LIMITS: throttler and billing stuff\n - CONN_INSUFFICIENT_SCOPES: api key has insufficient permissions\n - CONN_KEY_INVALID: api key is invalid\n - CONN_KEY_NOT_FOUND: api key not found\n - CONN_BAD_REQUEST_FORMAT: multipart form parsing, broken json, etc\n - CONN_DOES_NOT_EXIST: when path is bad\n - CONN_INVALID_REQUEST: something wrong with a header\n - CONN_METHOD_NOT_ALLOWED: when a request method is not allowed\n - CONN_NO_GDPR_CONSENT: lack GDPR consent\n - CONN_INVALID_RANGE: when invalid range of a resource is requested\n - CONN_AUTH_METHOD_DISABLED: authentication method is disabled\n - MODEL_TRAINED: Model/Custom Training related 20xxx\n\nCustom model has been already trained.\n - MODEL_TRAINING: Custom model is currently training.\n - MODEL_UNTRAINED: Custom model has not yet been trained.\n - MODEL_QUEUED_FOR_TRAINING: Custom model is currently in queue for training, waiting on assets to process first.\n - MODEL_TRAINING_FAILED: generic err msg for any type of model training err.\n - MODEL_BUILDING: For new V3 DockerInternalType models which are built images\n - MODEL_BUILDING_FAILED: Failed to build image for model.\n - MODEL_BUILD_UNEXPECTED_ERROR: Failed to build image for model.\n - MODEL_TRAINING_NO_DATA: Custom model training had no data. FIXME(yang): deprecate this. Use the 21106 + errStatusMsg\n - MODEL_TRAINING_NO_POSITIVES: Custom model training had no positive examples. FIXME(yang): deprecate this. Use the 21106 + errStatusMsg\n - MODEL_TRAINING_ONE_VS_N_SINGLE_CLASS: Custom model training was ONE_VS_N but with a single class. FIXME(yang): deprecate this. Use the 21106 + errStatusMsg\n - MODEL_TRAINING_TIMED_OUT: Training took longer than hard coded timeouts. FIXME(yang): deprecate this. Use the 21106 + errStatusMsg\n - MODEL_TRAINING_WAITING_ERROR: Training got error waiting on asset pipeline to finish. FIXME(yang): deprecate this. Use the 21106 + errStatusMsg\n - MODEL_TRAINING_UNKNOWN_ERROR: Training threw an unknown exception.\n - MODEL_TRAINING_MSG_REDELIVER: Training message was redelivered. FIXME(yang): deprecate this. Use the 21106 + errStatusMsg\n - MODEL_TRAINING_INSUFFICIENT_DATA: Training got error due to insufficient labelled data. FIXME(yang): deprecate this. Use the 21106 + errStatusMsg\n - MODEL_TRAINING_INVALID_PARAMS: FIXME(yang): deprecate this. Use the 21106 + errStatusMsg\n - MODEL_TRAINING_INVALID_DATA_TOLERANCE_EXCEEDED: Training is stopped because too much data was dropped. FIXME(yang): deprecate this. Use the 21106 + errStatusMsg\n - MODEL_EVALUATION_TIMED_OUT: Evaluation took longer than hard coded timeouts. FIXME(yang): deprecate this. Use the 21317 + errStatusMsg\n - MODEL_EVALUATION_WAITING_ERROR: Evaluation got error waiting on asset pipeline to finish.FIXME(yang): deprecate this. Use the 21317 + errStatusMsg\n - MODEL_EVALUATION_UNKNOWN_ERROR: EVALUATION THREW AN UNKNOWN EXCEPTION.\n - MODEL_EVALUATION_MSG_REDELIVER: Eval message was redelivered. FIXME(yang): deprecate this. Use the 21317 + errStatusMsg\n - MODEL_EVALUATION_NEED_LABELS: Don't have enough concepts labelled to perform evaluation. FIXME(yang): deprecate this. Use the 21317 + errStatusMsg\n - MODEL_EVALUATION_NEED_INPUTS: Don't have enough inputs per concept to perform evaluation. FIXME(yang): deprecate this. Use the 21317 + errStatusMsg\n - MODEL_EVALUATION_FAILED: Generic err code for eval failure.\n - MODEL_DEPLOYMENT_FAILED: Used when inference coordinator failed to deploy spire and throws an error\n - MODEL_DEPLOYING: Used when calling the inference coordinator to deploy a spire\n - MODEL_QUEUED_FOR_DEPLOYMENT: Used when training is completed\n - MODEL_NOT_DEPLOYED: Used when model spire deployment is manually taken down or due to inactivity\n - MODEL_LOADING: Used when the model pod is running, but not yet ready to serve requests.\n - MODEL_REFERENCE_INVALID_ARGUMENT: Used when a model reference field is not set properly\n - MODEL_EXAMPLE_INPUT_INVALID_ARGUMENT: Used when a model example input field is not set properly\n - MODEL_EXPORTED: Model Export status codes\n - WORKFLOW_NO_MATCHING_INPUT: specified model input not in workflow\n - WORKFLOW_REQUIRE_TRAINED_MODEL: specified model must be trained\n - WORKFLOW_INVALID_ARGUMENT: error in the request somewhere\n - WORKFLOW_INVALID_REQUEST: error in the request somewhere\n - CONCEPT_MODIFY_SUCCESS: Concept related 23xxx\n - ANNOTATION_SUCCESS: Annotation related 24xxx\n - ANNOTATION_AWAITING_REVIEW: Annotation is awaiting review from task REVIEWERS.\n - ANNOTATION_AWAITING_CONSENSUS_REVIEW: Annotation is awaiting consensus review from task LABELERS.\n - ANNOTATION_TRACK_IDLE: Annotation (video) tracks are groups of annotations per frame\nIDLE -> PROCESSING --> PENDING --> APPROVED --> (DELETED)\nPROCESSING --> FAILED --> (DELETED)\nPROCESSING --> (DELETED)\n - METADATA_INVALID_PATCH_ARGUMENTS: Metadata related 249xx\n - TRAINER_JOB_STATE_NONE: Training service related 25xxx\n - DATA_DUMP_SUCCESS: Data Dump related 251xx\n - DATA_DUMP_NO_DATA: DEPRECATED: Not used anymore. Now for an empty data dump, DATA_DUMP_SUCCESS is returned. To detect an empty data dump, check if the inptus count is 0.\n - APP_DUPLICATION_SUCCESS: Duplicate related 252xx - DEPRECATED: App duplication is no longer supported.\n - MODULE_DOES_NOT_EXIST: Module related codes 253xx\n - BULK_OPERATION_SUCCESS: Bulk Operation related codes 254xx\n - RUNNER_DOES_NOT_EXIST: Runner related codes 256xx\n - NODEPOOL_DOES_NOT_EXIST: Nodepool related codes 257xx\n - COMPUTE_CLUSTER_DOES_NOT_EXIST: ComputeCluster related codes 258xx\n - DEPLOYMENT_DOES_NOT_EXIST: Deployment related codes 259xx\n - DEPLOYMENT_DISABLED: The deployment is disabled and cannot serve traffic.\n - INSTANCE_TYPE_DOES_NOT_EXIST: InstanceType related codes 260xx\n - COMPUTE_PLANE_METRICS_INVALID_REQUEST: Compute plane related codes 261xx\n - PIPELINE_STEP_DOES_NOT_EXIST: PipelineStep related codes 262xx\n - PIPELINE_DOES_NOT_EXIST: Pipeline related codes 263xx\n - ARTIFACT_DOES_NOT_EXIST: Artifact related codes 264xx\n - INPUT_SUCCESS: Input:Image related 30xxx\n - INPUT_PENDING: when things are async, this is the default status.\n - INPUT_FAILED: any type of error downloading and processing\n - INPUT_DOWNLOAD_SUCCESS: use INPUT_SUCCESS, INPUT_PENDING, INPUT_FAILED, INPUT_IN_PROGRESS instead\nDOWNLOAD is no longer correct, but keep old statuses for backward compatibility\n - INPUT_VIDEO_DOWNLOAD_SUCCESS: Input:Video related 31xxx -- Deprecated\n - INPUT_WRITES_DISABLED_FOR_MAINTENANCE: deprecate this one. Use REQUEST_DISABLED_FOR_MAINTENANCE\n - PREDICT_INVALID_REQUEST: API formatting issues 4000x\n - DATABASE_DUPLICATE_KEY: Other related 400xx\n - EXTERNAL_CONNECTION_ERROR: could not connect to external services\n - QUEUE_CONN_ERROR: Queue related errors 41xxx\n - SQS_OVERLIMIT: SQS related errors 411xx\n - SEARCH_INTERNAL_FAILURE: Search related errors 43xxxx\n - EVALUATION_QUEUED: Workflow evaluation err code\n - STRIPE_EVENT_ERROR: Stripe 44xxx\n - CACHE_MISS: Redis/Cache 45xxx\n - SIGNUP_EVENT_ERROR: Sift Science 46xxx\n - APP_COUNT_INVALID_MESSAGE: Application counts related errors 470xx\n - MP_DOWNLOAD_ERROR: Media processor related errors 471xx -- DEPRECATED\n - DATATIER_CONN_ERROR: DataTier related error 472xx\n - USER_CONSENT_FACE: User legal consent stauts related 50xxx\n - WORKER_MISSING: Workers 51xxx\n - SSO_IDENTITY_PROVIDER_DOES_NOT_EXIST: SSO 53xxx\n - TASK_IN_PROGRESS: Tasks 54xxx\nThe task was created.\n - TASK_DONE: The task is completed.\n - TASK_WONT_DO: The task is marked as abandoned.\n - TASK_FAILED: An error occurred during add-task-annotations or add-auto-annotations pipeline.\n - TASK_IDLE: Task is waiting for user action.\nExamples:\n- When an Auto Annotation task job has finished processing its last batch and is waiting for more dataset assets.\n- When an Auto Annotation task job for a video livestream input is waiting for user to create a task deployment.\n - TASK_CONFLICT: The task operation is in conflict with the current state of the server.\n - TASK_NOT_IMPLEMENTED: Certain task-related scenarios are not implemented.\n - TASK_MISSING: Task was not found.\n - TASK_PERMISSION_DENIED: Not allowed to perform a task-related action.\n - TASK_ASSIGNMENT_SUCCESS: Task Assignments 542xx\n - TASK_ASSIGNMENT_REVIEW_SUCCESS: Task Assignment Reviews 543xx\n - LABEL_ORDER_PENDING: Label Order Related Status Code 55xxx\n - LICENSE_ACTIVE: License Related Status Code 600xx\nDEPRECATED: License feature is fully deprecated now.\n - LICENSE_DELETED: hidden state not reflected to users\n - PASSWORD_VALIDATION_SUCCESS: Password Related Status Code\n - FEATUREFLAG_CONFIG_NOT_FOUND: Feature flags status code\n - MAINTENANCE_SUCCESS: Maintenance status code\n - DATASET_VERSION_PENDING: Datasets 64xxx\nThe dataset version is pending to be processed.\n - DATASET_VERSION_IN_PROGRESS: The dataset version is currently being processed.\n - DATASET_VERSION_READY: The dataset version is ready to be used.\n - DATASET_VERSION_FAILURE: An error occurred during the dataset version processing.\n - DATASET_VERSION_UNEXPECTED_ERROR: An unexpected error occurred during the dataset version processing.\n - DATASET_VERSION_CONFLICT: An alteration to dataset version would create a conflict\n - DATASET_INPUT_SUCCESS: The dataset input was successfully added.\n - DATASET_INPUT_DUPLICATE: The dataset input is a duplicate.\nDeprecated: Unused.\n - DATASET_VERSION_EXPORT_SUCCESS: The dataset version export is completed.\n - DATASET_VERSION_EXPORT_PENDING: The dataset version is pending to be exported.\n - DATASET_VERSION_EXPORT_FAILED: An error occurred during the dataset version export.\n - DATASET_VERSION_EXPORT_IN_PROGRESS: The dataset version is currently being exported.\n - DATASET_VERSION_EXPORT_UNEXPECTED_ERROR: An unexpected error occurred during the dataset version export.\n - JOB_QUEUED: Generic Job status codes\n - AUTH_MISSING_IDP_ASSOC: auth issues\n\nTODO: Knowledge graph related 80xxx\n - UPLOAD_IN_PROGRESS: Multipart uploading status codes\n - BILLING_INVALID_INFO: Billing related issues: 69xxx\n - LOG_ENTRIES_INVALID_REQUEST: Logs related issues: 70000;\n - TWILIO_MAX_VERIFICATION_BEGIN_EXCEEDED: Twilio related issues: 71xxx\n - TWILIO_PHONE_NUMBER_BLOCKED: The provided phone number was rejected or blocked by Twilio.\n - INTERNAL_SERVER_ISSUE: Internal issues: 98xxx\n - CONN_UNCATEGORIZED: Uncategorized: 99xxx: move off as soon as known\n - BAD_REQUEST: Deprecated: migrate off to one of the internal issues\n - SERVER_ERROR: Deprecated: migrate off to one of the internal issues" title: "- ZERO: to be revised and greatly expanded\n - SUCCESS: Generic\n - MOVED: Resource moved. Respond with Http status 307 and add new Location header to response\n - ACCEPTED: Request has been accepted. Respond with Http status 202.\n - CONN_ACCOUNT_ISSUES: Clarifai Connection Codes: 11xxx" apiDatasetVersion: type: object properties: id: type: string title: The ID for the dataset version created_at: type: string format: date-time description: 'When the dataset version was created. The format is https://www.ietf.org/rfc/rfc3339.txt. Example: "2006-01-02T15:04:05.999999Z".' modified_at: type: string format: date-time description: 'When the dataset version was modified. The format is https://www.ietf.org/rfc/rfc3339.txt. Example: "2006-01-02T15:04:05.999999Z".' app_id: type: string description: The app the dataset version belongs to. user_id: type: string description: The user the dataset version belongs to. dataset_id: type: string description: The dataset the dataset version belongs to. annotation_filter_config: $ref: '#/components/schemas/apiAnnotationFilterConfig' description: The dataset version will be generated based on a single annotation filter. model_predict_config: $ref: '#/components/schemas/apiModelPredictConfig' description: The dataset version will be generated based on model version inferences. status: $ref: '#/components/schemas/apistatusStatus' description: Status for this dataset version. description: type: string title: Description of the dataset version processing_info: $ref: '#/components/schemas/apiDatasetVersionProcessingInfo' description: 'Dataset version processing. If this is not set when the dataset version is created, then the dataset default_processing_info is copied instead. Later updates to default_processing_info will not apply to existing versions.' metrics: type: object additionalProperties: $ref: '#/components/schemas/apiDatasetVersionMetrics' title: Dataset version metrics export_info: $ref: '#/components/schemas/apiDatasetVersionExportInfo' title: Dataset version exports metadata: type: object title: 'To handle arbitrary json metadata you can use a struct field: https://github.com/google/protobuf/blob/master/src/google/protobuf/struct.proto' visibility: $ref: '#/components/schemas/clarifaiapiVisibility' description: 'The visibility field represents whether this message is privately/publicly visible. To be visible to the public the App that contains it AND the User that contains the App must also be publicly visible.' embed_model_version_ids: type: array items: type: string description: The embedding models to return embeddings for. If empty, no embeddings are returned. request_origin: $ref: '#/components/schemas/apiDatasetVersionRequestOrigin' title: 'Read Only. Cannot be Set Origin of request for new dataset version' title: DatasetVersion apiReviewRejectConfig: type: object properties: task_assignments: type: array items: type: object $ref: '#/components/schemas/apiTaskAssignment' workers: type: array items: type: object $ref: '#/components/schemas/apiWorker' apiKeypointEdge: type: object properties: k1: type: integer format: int64 k2: type: integer format: int64 V2PostValidatePasswordBody: type: object properties: user_app_id: type: object properties: app_id: type: string description: Common message to identify the app in a url endpoint. password: $ref: '#/components/schemas/apiPassword' title: password to be validated title: PostValidatePasswordRequest apiMetricValue: type: object properties: string_value: type: string float_value: type: number format: float int_value: type: integer format: int32 ModelSource: type: string enum: - UNKNOWN_SOURCE - HOSTED - WRAPPED default: UNKNOWN_SOURCE title: Source of Model apiConceptQuery: type: object properties: name: type: string description: The name of the concept to search. language: type: string description: The language of the concept name in a search. Defaults to English. workflow_id: type: string description: 'Deprecated: Use workflow.id instead. @exclude TODO (EAGLE-4506): Remove this field and associated code' use_cases: type: array items: $ref: '#/components/schemas/apiWorkflowModelUseCase' description: 'The concepts must belong to models with specified use cases. Multiple values are joined using an OR condition.' model: $ref: '#/components/schemas/apiModel' workflow: $ref: '#/components/schemas/apiWorkflow' ignore_app_concepts: type: boolean description: 'By default, we return app concepts combined with source (model or workflow) concepts. If source is not set, then we only return app concepts. If ignore_app_concepts is true, then we only return source concepts. When use_cases are set, then ignore_app_concepts is always true, because concept use cases can only be determined in relation to a model or a workflow.' title: ConceptQuery apiHit: type: object properties: score: type: number format: float description: 'This is the score for the ranked Hit results of the search query. This score is a number between 0.0 and 1.0 as it represents a confidence in the search Hit. For example, if you search for "car" and get a close matching Hit, the score should be close to 1.0. If you get a score of close to 0.0 that means it''s very disimilar to your query, in this case NOT a "car". There is a special intermediate score of 0.5 that means that the Hit is not really correlated with your search query (ie. not similar or dissimlar to the query) which is a common occurrence when using negate queries. Note: some queries that are just filtering down your app of inputs may just return a score of 1.0 for all Hits.' input: $ref: '#/components/schemas/apiInput' description: 'This is the matched input returned from the search query. This will contain information about the Input such as the url, created_at time and trusted annotation information (for backwards compatibility with apps that existed before Annotations were introduced.' annotation: $ref: '#/components/schemas/clarifaiapiAnnotation' description: 'We also provide back the specific matched annotation for the above input. We do this in order to support more complex Annotation queries in the And message below. For example if we match the search results to a region in your input, or a frame in a video input, this annotation field will be that matched annotation info and the input will be the image/video that the user originally added which contains those regions / frames.' user_id: type: string description: The customer-facing id of the user who owns the app the asset came from. app_id: type: string description: The cfid of the app the asset came from. title: Hit apistatusStatus: type: object properties: code: $ref: '#/components/schemas/statusStatusCode' description: Status code from internal codes. description: type: string description: A short description of the error. details: type: string description: 'More details of the given error. These details may be exposed to non-technical users. For technical details, try to use developer_notes field.' stack_trace: type: array items: type: string description: 'For some environment we may return a stack trace to help debug any issues.' percent_completed: type: integer format: int64 title: specifically for long running jobs time_remaining: type: integer format: int64 title: if status is pending, how much time is remaining (in seconds) req_id: type: string title: A request ID may be present, to help monitoring and tracking requests internal_details: type: string description: Internal Annotation (do not set in production, for internal Clarifai use only). redirect_info: $ref: '#/components/schemas/statusRedirectInfo' description: Resource location info for redirect, when resource location has been changed. developer_notes: type: string description: 'Notes for developer. These notes are rather technical details for developers how to interpret the status, e.g. why an error occurred and how to avoid getting the error.' http_status_code: type: integer format: int64 description: The HTTP status code of the response. apiPretrainedModelConfig: type: object properties: input_fields_map: type: object description: 'This is the internal id of the pretrained model. Map from the api.Data field names to the Triton config.pbtxt input.' output_fields_map: type: object description: Map from the api.Data field names to the Triton config.pbtxt output. model_zip_url: type: string title: "Url to a zipped up model in triton format with the following files and folders at the root:\n config.pbtxt\n version 1 folder that contains model files (onnx graph, torch script, python BE model, and etc.)" local_dev: type: boolean title: 'Whether to overwrite the model for the existing internal id If this is a local dev model that runs external to the platform, set this to true. This helps during development of models before uploading them to the platform. These models MUST run in an associated compute cluster with cluster_type = "local-dev"' title: PretrainedModelConfig apiMultiUploadResponse: type: object properties: status: $ref: '#/components/schemas/apistatusStatus' uploads: type: array items: type: object $ref: '#/components/schemas/apiUpload' apiReviewStartConfig: type: object properties: workers: type: array items: type: object $ref: '#/components/schemas/apiWorker' description: 'Review the work done by these workers. If empty, review the work for all workers.' V2PostKeysBody: type: object properties: user_app_id: type: object properties: app_id: type: string description: Common message to identify the app in a url endpoint. keys: type: array items: type: object $ref: '#/components/schemas/apiKey' title: PostKeysRequest apiDeleteMetadata: type: object properties: metadata: type: object title: 'To handle arbitrary json metadata you can use a struct field: https://github.com/google/protobuf/blob/master/src/google/protobuf/struct.proto' apiDatasetSplit: type: object properties: dataset: $ref: '#/components/schemas/apiDataset' title: Expected to have ID percentage: type: integer format: int64 title: 'For RANDOM_PERCENTAGE_SPLIT. Values from (0,100]'