Clarifai AI API
  1. API 接口
  2. inputs
Clarifai AI API
  • CLARIFAI API 基础知识
    • Clarifai API 基础知识
    • gRPC 与 HTTP 通道
    • 支持的格式
  • API 接口
    • annotation_filters
      • {annotationFilterId}
        • Get a specific annotation filter.
      • List all the annotation filters.
      • Delete one or more annotation filters in a single request.
      • Add annotation filters.
      • Patch one or more annotation filters.
    • annotations
      • searches
        • metrics
          • {id}
            • Get the evaluation results between two search requests
          • List the evaluation results between two search requests
          • Evaluate the results of two search requests
        • Execute a search over annotations
        • Patch saved annotations searches by ids.
      • List all the annotation.
      • Delete multiple annotations in one request.
      • Post annotations.
      • Patch one or more annotations.
    • apps
      • List all the apps.
    • bulk_operations
      • {id}
        • Get the bulk operation details by ID
      • List all the bulk operations
      • delete one or more terminated bulk operations
      • Perform bulk operations on a list of inputs based on input source. Operation include add, update, delete of concepts, metadata and geo data. This is an Asynchronous process. Use ListBulkOperations or GetBulkOperation to check the status.
      • Cancel one or more bulk operations
    • collectors
      • {collectorId}
        • Get a specific collector from an app.
      • List all the collectors.
      • Delete multiple collectors in one request. This call is asynchronous. Use DeleteCollector if you want a synchronous version.
      • Add a list of Collectors to an app. In the handler of this endpoint we also check for all the scopes of the POST /inputs endpoint. Those current scopes are listed here as a hard requirement. They are needed when adding the collectors just so we now that
      • Patch one or more collectors.
    • concepts
      • knowledge_graphs
        • List all domain graphs.
        • Post domain graphs.
      • mappings
        • jobs
          • Start concept mapping jobs.
      • searches
        • Search over the concepts to find one or more you're looking for. This leverage the "body" parameter because we also have page and per_page as url query param variables in this request.
      • status
        • List all the concepts with their positive and negative counts
      • {conceptId}
        • languages
          • {language}
            • Get a specific concept from an app.
          • List the concept in all the translated languages.
          • Add a new translation for this concept.
          • Patch the name for a given language names by passing in a list of concepts with the new names for the languages.
        • Get a specific concept from an app.
      • List all the concepts.
      • Add a concept to an app.
      • Patch one or more concepts.
    • datasets
      • inputs
        • search_add
          • jobs
            • {jobId}
              • Get a specific job.
      • {datasetId}
        • inputs
          • {inputId}
            • Get a specific dataset input.
          • List all the dataset inputs in a dataset.
          • Delete one or more dataset inputs in a single request.
          • Add dataset inputs to a dataset. The process is not atomic, i.e. if there are errors with some dataset inputs, others might still be added. The response reports - SUCCESS if all dataset inputs were added, - MIXED_STATUS if only some dataset inputs wer
        • versions
          • {datasetVersionId}
            • exports
              • Create export of a dataset version.
            • metrics
              • V2_ListDatasetVersionMetricsGroups2
            • Get a specific dataset version.
          • List all the dataset versions.
          • Delete one or more dataset versions in a single request.
          • Add dataset versions to a dataset.
          • Patch one or more dataset versions.
        • Get a specific dataset.
      • List all the datasets.
      • Delete one or more datasets in a single request.
      • Add datasets to an app. The process is atomic, i.e. either all or no datasets are added. If there is an error for one dataset, the process will stop, revert the transaction and return the error.
      • Patch one or more datasets. The process is atomic, i.e. either all or no datasets are patched. If there is an error for one dataset, the process will stop, revert the transaction and return the error.
    • evaluations
      • {evaluationId}
        • V2_GetEvaluation2
      • V2_ListEvaluations3
      • V2_PostEvaluations2
    • inputs
      • annotations
        • Delete multiple annotations in one request.
      • data_sources
        • 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.
      • jobs
        • add
          • {id}
            • Get the input add job details by ID
            • cancel the input add job by ID
          • List all the inputs add jobs
        • extraction
          • {inputsExtractionJobId}
            • Get the input extraction job details by ID
          • List all the input extraction jobs
          • V2_CancelInputsExtractionJobs2
      • searches
        • Execute a search over inputs
        • Patch saved inputs searches by ids.
      • status
        • Get input count per status.
      • stream
        • Streams all the inputs starting from oldest assets.
      • uploads
        • Start uploading a file archive containing inputs. Will create and return an inputs-add-job for tracking progress.
      • {inputId}
        • annotations
          • {annotationId}
            • Get a specific annotation from an app.
            • Delete a single annotation.
        • video_manifest
          • Get a video input manifest.
        • Get a specific input from an app.
        • Delete a single input asynchronously.
      • List all the inputs.
        GET
      • Delete multiple inputs in one request. This call is asynchronous.
        DELETE
      • Add 1 or more input to an app. The actual inputs processing is asynchronous.
        POST
      • Patch one or more inputs.
        PATCH
    • label_orders
      • {labelOrderId}
        • Get a label order.
      • List label orders.
      • Delete multiple label orders in one request. this do not change task status
      • Add Label orders.
      • Patch one or more label orders.
      • List label orders.
      • Patch one or more label orders.
    • models
      • searches
        • Search over the models to find one or more you're looking for. This leverage the "body" parameter because we also have page and per_page as url query param variables in this request.
      • types
        • {modelTypeId}
          • Get a specific model type.
        • List all the model types available in the platform. This MUST be above ListModels so that the /models/types endpoint takes precedence.
      • {modelId}
        • check_consents
          • Update model check consents
        • inputs
          • List all the inputs.
        • languages
          • Update model languages tags
        • output_info
          • Get a the output info for a given model_id or model_id/version_id combo.
        • outputs
          • Get predicted outputs from the model.
        • publish
          • PostModelVersionsPublish
        • references
          • Lists model references tied to a particular model id.
        • toolkits
          • Update model toolkits tags
        • unpublish
          • PostModelVersionsUnPublish
        • usecases
          • Update model use_cases tags
        • versions
          • {modelVersionId}
            • evaluations
              • {evaluationId}
              • Deprecated, use GetEvaluation instead List the evaluation metrics for a model version.
              • Deprecated, use PostEvaluations instead
            • input_examples
              • {exampleId}
                • GetModelVersionInputExample
              • ListModelVersionInputExamples
          • {versionId}
            • inputs
              • List all the inputs.
            • metrics
              • Deprecated: Use GetEvaluation instead Get the evaluation metrics for a model version.
              • Deprecated, use PostEvaluations instead Run the evaluation metrics for a model version.
            • output_info
              • Get a the output info for a given model_id or model_id/version_id combo.
            • outputs
              • Get predicted outputs from the model.
            • Get a specific model from an app.
            • Delete a single model.
          • List all the models.
          • Create a new model version to trigger training of the model.
        • Get a specific model from an app.
        • Delete a single model.
      • List all the models.
      • Delete multiple models in one request.
      • Add a models to an app.
      • Patch one or more models.
    • modules
      • List all the modules in community, by user or by app.
    • my_scopes
      • API Keys in the public API -- request is itself Key authorized, and will tell the user the scopes/access of the key/credential they're providing, as computed by our authorizer:
    • myscopes
      • API Keys in the public API -- request is itself Key authorized, and will tell the user the scopes/access of the key/credential they're providing, as computed by our authorizer:
    • myscopesroot
      • V2_MyScopesRoot
    • open_source_licenses
      • List all the supported open source licenses in the platform.
    • resource_counts
      • List the resource counts for the app.
    • searches
      • {id}
        • Get a saved legacy search.
        • Delete a saved search.
        • Execute a previously saved legacy search.
      • List all saved legacy searches.
      • Execute a new search and optionally save it.
      • Patch saved legacy searches by ids.
    • stats
      • values
        • aggregate
          • PostStatValuesAggregate
        • PostStatValues
    • status_codes
      • {statusCodeId}
        • Get more details for a status code.
      • List all status codes.
    • tasks
      • {taskId}
        • annotations
          • count
            • Task annotation count
        • assignments
          • List next non-labeled and unassigned inputs from task's dataset
        • inputs
          • count
            • Task Input count
          • samples
            • Get a specific input from an app.
        • Get a specific task from an app.
      • List tasks from an app.
      • Delete multiple tasks in one request.
      • Add tasks to an app.
      • Patch one or more tasks.
    • trending_metrics
      • views
        • {viewType}
          • List the view metrics for a detail view
    • uploads
      • {uploadId}
        • content_parts
          • Upload a part of a multipart upload. Behaviour on completion depends on the endpoint that was used to initiate the upload.
        • V2_GetUpload2
      • V2 List Uploads2
      • V2_DeleteUploads2
      • V2_PostUploads2
    • users
      • {userAppId.userId}
        • apps
          • ids
            • Patch apps ids.
          • searches
            • Search over the applications to find one or more you're looking for.
          • {userAppId.appId}
            • annotation_filters
              • {annotationFilterId}
                • Get a specific annotation filter.
              • List all the annotation filters.
              • Delete one or more annotation filters in a single request.
              • Add annotation filters.
              • Patch one or more annotation filters.
            • annotations
              • searches
                • metrics
                  • {id}
                    • Get the evaluation results between two search requests
                    • DeleteAnnotationSearchMetrics
                  • List the evaluation results between two search requests
                  • Evaluate the results of two search requests
                • Execute a search over annotations
                • Patch saved annotations searches by ids.
              • List all the annotation.
              • Delete multiple annotations in one request.
              • Post annotations.
              • Patch one or more annotations.
            • bulk_operations
              • {id}
                • Get the bulk operation details by ID
              • List all the bulk operations
              • delete one or more terminated bulk operations
              • Perform bulk operations on a list of inputs based on input source. Operation include add, update, delete of concepts, metadata and geo data. This is an Asynchronous process. Use ListBulkOperations or GetBulkOperation to check the status.
              • Cancel one or more bulk operations
            • collaborators
              • owner list users who the app is shared with
              • Delete existing collaborators.
              • add collaborators to an app.
              • Patch existing collaborators.
            • collectors
              • {collectorId}
                • Get a specific collector from an app.
              • List all the collectors.
              • Delete multiple collectors in one request. This call is asynchronous. Use DeleteCollector if you want a synchronous version.
              • Add a list of Collectors to an app. In the handler of this endpoint we also check for all the scopes of the POST /inputs endpoint. Those current scopes are listed here as a hard requirement. They are needed when adding the collectors just so we now that
              • Patch one or more collectors.
            • concepts
              • knowledge_graphs
                • List all domain graphs.
                • Post domain graphs.
              • mappings
                • jobs
                  • Start concept mapping jobs.
              • relations
                • List concept relations between concepts in the platform. MUST be above ListConcepts so that if concept_id is empty this will still match /concepts/relations to list all the concept relations in the app.
              • searches
                • Search over the concepts to find one or more you're looking for. This leverage the "body" parameter because we also have page and per_page as url query param variables in this request.
              • status
                • List all the concepts with their positive and negative counts
              • {conceptId}
                • languages
                  • {language}
                    • Get a specific concept from an app.
                  • List the concept in all the translated languages.
                  • Add a new translation for this concept.
                  • Patch the name for a given language names by passing in a list of concepts with the new names for the languages.
                • relations
                  • List concept relations between concepts in the platform. MUST be above ListConcepts so that if concept_id is empty this will still match /concepts/relations to list all the concept relations in the app.
                  • Post concept relations to create relations between concepts in the platform.
                  • Post concept relations to create relations between concepts in the platform.
                • Get a specific concept from an app.
              • List all the concepts.
              • Add a concept to an app.
              • Patch one or more concepts.
            • datasets
              • inputs
                • search_add
                  • jobs
                    • {jobId}
                      • Get a specific job.
              • {datasetId}
                • inputs
                  • {inputId}
                    • Get a specific dataset input.
                  • List all the dataset inputs in a dataset.
                  • Delete one or more dataset inputs in a single request.
                  • Add dataset inputs to a dataset. The process is not atomic, i.e. if there are errors with some dataset inputs, others might still be added. The response reports - SUCCESS if all dataset inputs were added, - MIXED_STATUS if only some dataset inputs wer
                • versions
                  • {datasetVersionId}
                    • exports
                      • Create export of a dataset version.
                    • metrics
                      • V2 List Dataset Version Metrics Groups
                    • Get a specific dataset version.
                  • List all the dataset versions.
                  • Delete one or more dataset versions in a single request.
                  • Add dataset versions to a dataset.
                  • Patch one or more dataset versions.
                • Get a specific dataset.
              • List all the datasets.
              • Delete one or more datasets in a single request.
              • Add datasets to an app. The process is atomic, i.e. either all or no datasets are added. If there is an error for one dataset, the process will stop, revert the transaction and return the error.
              • Patch one or more datasets. The process is atomic, i.e. either all or no datasets are patched. If there is an error for one dataset, the process will stop, revert the transaction and return the error.
            • duplications
              • start to duplicate an app which copies all the inputs, annotations, models, concepts etc. to a new app. this is an async process, you should use ListAppDuplications or GetAppDuplication to check the status.
            • evaluations
              • {evaluationId}
                • V2 Get Evaluation
              • V2 List Evaluations
              • V2 Post Evaluations
            • inputs
              • annotations
                • Delete multiple annotations in one request.
              • data_sources
                • 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.
              • jobs
                • add
                  • {id}
                    • Get the input add job details by ID
                    • cancel the input add job by ID
                  • List all the inputs add jobs
                • extraction
                  • {inputsExtractionJobId}
                    • Get the input extraction job details by ID
                  • List all the input extraction jobs
                  • V2_CancelInputsExtractionJobs
              • searches
                • Execute a search over inputs
                • Patch saved inputs searches by ids.
              • status
                • Get input count per status.
              • stream
                • Streams all the inputs starting from oldest assets.
              • uploads
                • Start uploading a file archive containing inputs. Will create and return an inputs-add-job for tracking progress.
              • {inputId}
                • annotations
                  • {annotationId}
                    • Get a specific annotation from an app.
                    • Delete a single annotation.
                • video_manifest
                  • Get a video input manifest.
                • Get a specific input from an app.
                • Delete a single input asynchronously.
              • List all the inputs.
              • Delete multiple inputs in one request. This call is asynchronous.
              • Add 1 or more input to an app. The actual inputs processing is asynchronous.
              • Patch one or more inputs.
            • installed_module_versions
              • {installedModuleVersionId}
                • key
                  • Assign a key that the caller owns to be used when accessing this installed module version If this endpoint is called with a different key then it overwrites what is there.
                • Get installed modules vesrions for an app.
              • List installed modules vesrions for an app.
              • Uninstall an installed module version which will deploy the specific ModuleVersion to the app in the url. This cleaned up any associated caller keys so needs the Keys_Delete scope.
              • Install a new module version which will deploy the specific ModuleVersion to the app in the url.
            • keys
              • List keys by app_id
            • label_orders
              • {labelOrderId}
                • Get a label order.
              • List label orders.
              • Delete multiple label orders in one request. this do not change task status
              • Add Label orders.
              • Patch one or more label orders.
              • List label orders.
              • Delete multiple label orders in one request. this do not change task status
            • models
              • ids
                • Patch one or more models ids.
              • searches
                • Search over the models to find one or more you're looking for. This leverage the "body" parameter because we also have page and per_page as url query param variables in this request.
              • types
                • {modelTypeId}
                  • Get a specific model type.
                • List all the model types available in the platform. This MUST be above ListModels so that the /models/types endpoint takes precedence.
              • {modelId}
                • check_consents
                  • Update model check consents
                • concepts
                  • List models concepts.
                • inputs
                  • List all the inputs.
                • languages
                  • Update model languages tags
                • output_info
                  • Get a the output info for a given model_id or model_id/version_id combo.
                • outputs
                  • Get predicted outputs from the model.
                • publish
                  • PostModelVersionsPublish
                • references
                  • Lists model references tied to a particular model id.
                • toolkits
                  • Update model toolkits tags
                • unpublish
                  • PostModelVersionsUnPublish
                • usecases
                  • Update model use_cases tags
                • versions
                  • {modelVersionId}
                    • evaluations
                      • {evaluationId}
                        • Deprecated, use GetEvaluation instead Get an evaluation metrics for a model version.
                      • Deprecated, use GetEvaluation instead List the evaluation metrics for a model version.
                      • Deprecated, use PostEvaluations instead
                    • input_examples
                      • {exampleId}
                        • GetModelVersionInputExample
                      • ListModelVersionInputExamples
                  • {versionId}
                    • concepts
                      • List models concepts.
                    • inputs
                      • List all the inputs.
                    • metrics
                      • Deprecated: Use GetEvaluation instead Get the evaluation metrics for a model version.
                      • Deprecated, use PostEvaluations instead Run the evaluation metrics for a model version.
                    • output_info
                      • Get a the output info for a given model_id or model_id/version_id combo.
                    • outputs
                      • Get predicted outputs from the model.
                    • Get a specific model from an app.
                    • Delete a single model.
                  • List all the models.
                  • Create a new model version to trigger training of the model.
                  • PatchModelVersions
                • Get a specific model from an app.
                • Delete a single model.
              • List all the models.
              • Delete multiple models in one request.
              • Add a models to an app.
              • Patch one or more models.
            • modules
              • {moduleId}
                • versions
                  • {moduleVersionId}
                    • Get a specific module version for a module.
                  • List all the modules versions for a given module.
                  • Delete a multiple module version.
                  • Create a new module version to trigger training of the module.
                • Get a specific module from an app.
              • List all the modules in community, by user or by app.
              • Delete multiple modules in one request.
              • Add a modules to an app.
              • Patch one or more modules.
            • myscopes
              • API Keys in the public API -- request is itself Key authorized, and will tell the user the scopes/access of the key/credential they're providing, as computed by our authorizer:
            • resource_counts
              • List the resource counts for the app.
            • searches
              • {id}
                • Get a saved legacy search.
                • Delete a saved search.
                • Execute a previously saved legacy search.
              • List all saved legacy searches.
              • Execute a new search and optionally save it.
              • Patch saved legacy searches by ids.
            • stats
              • values
                • aggregate
                  • PostStatValuesAggregate
                • PostStatValues
            • task
              • {taskId}
                • annotations
                  • status
                    • Patch annotations status by worker id and task id.
            • tasks
              • {taskId}
                • annotations
                  • count
                    • Task annotation count
                • assignments
                  • List next non-labeled and unassigned inputs from task's dataset
                  • PutTaskAssignments evaluates all the annotations by labeler (authenticated user) for given task (task_id) and input (input_id).
                • inputs
                  • count
                    • Task Input count
                  • samples
                    • Get a specific input from an app.
                • Get a specific task from an app.
              • List tasks from an app.
              • Delete multiple tasks in one request.
              • Add tasks to an app.
              • Patch one or more tasks.
            • trending_metrics
              • views
                • {viewType}
                  • {objectId}
                    • Increase the view metric for a detail view
                  • List the view metrics for a detail view
            • uploads
              • {uploadId}
                • content_parts
                  • Upload a part of a multipart upload. Behaviour on completion depends on the endpoint that was used to initiate the upload.
                • V2 Get Upload
              • V2_ListUploads
              • V2_DeleteUploads
              • V2_PostUploads
            • workflows
              • ids
                • Patch one or more workflows ids.
              • {workflowId}
                • publish
                  • V2 Post Workflow Versions Publish
                • results
                  • similarity
                    • Compare embeddings distances using a workflow
                  • Predict using a workflow.
                • unpublish
                  • V2 Post Workflow Versions Un Publish
                • versions
                  • {versionId}
                    • results
                      • similarity
                        • Compare embeddings distances using a workflow
                      • Predict using a workflow.
                  • {workflowVersionId}
                    • Get single workflow version.
                  • List workflow versions.
                  • Delete workflow versions.
                  • Patch workflow versions.
                • Get a specific workflow from an app.
                • Delete a single workflow.
              • List all the workflows.
              • Delete multiple workflows in one request.
              • Add a workflow to an app.
              • Patch one or more workflows.
            • Get a specific app from an app.
            • Search over the apps to find one or more you're looking for. This leverage the "body" parameter because we also have page and per_page as url query param variables in this request.
            • Patch one app.
          • List all the apps.
          • Add a app to an app. This needs to load the default workflow to make a copy, validating all the models in it, and then writing the new workflow back to this new app.
          • Patch one or more apps.
        • collaborations
          • Collaboration includes the app user are invitied to work on
        • datasets
          • List all the datasets.
        • duplications
          • {appDuplicationId}
            • get the app duplication status
          • list all the app duplications user triggers
        • evaluations
          • V2_ListEvaluations2
        • keys
          • {keyId}
            • Get a specific key from an app.
            • Search over the keys to find one or more you're looking for. This leverage the "body" parameter because we also have page and per_page as url query param variables in this request.
          • List all the keys.
          • Add a key to an app.
          • Patch one or more keys.
        • models
          • List all the models.
        • modules
          • List all the modules in community, by user or by app.
        • myscopes
          • V2_MyScopesUser
        • runners
          • {runnerId}
            • items
              • {itemId}
                • outputs
                  • Post back outputs from remote runners
              • List items for the remote runner to work on.
            • Get a specific runner from an app.
          • List all the runners in community, by user or by app.
          • Delete multiple runners in one request.
          • Add a runners to an app.
        • scopes
          • List all auth scopes available to me as a user.
        • validate_password
          • Validate new password in real-time for a user
        • workflows
          • List all the workflows.
        • Get user information
    • validate_password
      • Validate new password in real-time for a user
    • workflows
      • {workflowId}
        • publish
          • V2_PostWorkflowVersionsPublish2
        • results
          • similarity
            • Compare embeddings distances using a workflow
          • Predict using a workflow.
        • unpublish
          • V2_PostWorkflowVersionsUnPublish2
        • versions
          • {workflowVersionId}
            • Get single workflow version.
          • List workflow versions.
          • Delete workflow versions.
          • Patch workflow versions.
        • Get a specific workflow from an app.
        • Delete a single workflow.
      • List all the workflows.
      • Delete multiple workflows in one request.
      • Add a workflow to an app.
      • Patch one or more workflows.
  1. API 接口
  2. inputs

List all the inputs.

开发环境
开发环境
GET
/v2/inputs

请求参数

Query 参数
userAppId.userId
string 
必需
Note user_id 'me' is reserved - it is the alias for the id of authorized user
示例值:
<string>
userAppId.appId
string 
必需
示例值:
<string>
page
string 
必需
(optional URL parameter) The page number. Pagination is used to split the results into chunks.
Defaults to 1.
示例值:
<long>
perPage
string 
必需
(optional URL parameter) The number of results that will be contained in each page. Defaults
to 128.
示例值:
<long>
status.code
string 
必需
Status code from internal codes.
ZERO: to be revised and greatly expanded
SUCCESS: Generic
MOVED: Resource moved. Respond with Http status 307 and add new Location header to response
CONN_ACCOUNT_ISSUES: Clarifai Connection Codes: 11xxx
expired cc, still in trial, feature not supported in your tier
CONN_TOKEN_INVALID: invalid auth token used. Deprecated: we should return CONN_KEY_INVALID instead now in all cases.
CONN_CREDENTIALS_INVALID: invalid auth credentials
CONN_EXCEED_HOURLY_LIMIT: throttle hourly limit exceeded
CONN_EXCEED_MONTHLY_LIMIT: throttle monthly limit exceeded
CONN_THROTTLED: throttler and billing stuff
CONN_EXCEEDS_LIMITS: throttler and billing stuff
CONN_INSUFFICIENT_SCOPES: api key has insufficient permissions
CONN_KEY_INVALID: api key is invalid
CONN_KEY_NOT_FOUND: api key not found
CONN_BAD_REQUEST_FORMAT: multipart form parsing, broken json, etc
CONN_DOES_NOT_EXIST: when path is bad
CONN_INVALID_REQUEST: something wrong with a header
CONN_METHOD_NOT_ALLOWED: when a request method is not allowed
CONN_NO_GDPR_CONSENT: lack GDPR consent
CONN_AUTH_METHOD_DISABLED: authentication method is disabled
MODEL_TRAINED: Model/Custom Training related 20xxx
Custom model has been already trained.
MODEL_TRAINING: Custom model is currently training.
MODEL_UNTRAINED: Custom model has not yet been trained.
MODEL_QUEUED_FOR_TRAINING: Custom model is currently in queue for training, waiting on assets to process first.
MODEL_TRAINING_FAILED: generic err msg for any type of model training err.
MODEL_TRAINING_NO_DATA: Custom model training had no data. FIXME(yang): deprecate this. Use the 21106 + errStatusMsg
MODEL_TRAINING_NO_POSITIVES: Custom model training had no positive examples. FIXME(yang): deprecate this. Use the 21106 + errStatusMsg
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
MODEL_TRAINING_TIMED_OUT: Training took longer than hard coded timeouts. FIXME(yang): deprecate this. Use the 21106 + errStatusMsg
MODEL_TRAINING_WAITING_ERROR: Training got error waiting on asset pipeline to finish. FIXME(yang): deprecate this. Use the 21106 + errStatusMsg
MODEL_TRAINING_UNKNOWN_ERROR: Training threw an unknown exception.
MODEL_TRAINING_MSG_REDELIVER: Training message was redelivered. FIXME(yang): deprecate this. Use the 21106 + errStatusMsg
MODEL_TRAINING_INSUFFICIENT_DATA: Training got error due to insufficient labelled data. FIXME(yang): deprecate this. Use the 21106 + errStatusMsg
MODEL_TRAINING_INVALID_PARAMS: FIXME(yang): deprecate this. Use the 21106 + errStatusMsg
MODEL_TRAINING_INVALID_DATA_TOLERANCE_EXCEEDED: Training is stopped because too much data was dropped. FIXME(yang): deprecate this. Use the 21106 + errStatusMsg
MODEL_EVALUATION_TIMED_OUT: Evaluation took longer than hard coded timeouts. FIXME(yang): deprecate this. Use the 21317 + errStatusMsg
MODEL_EVALUATION_WAITING_ERROR: Evaluation got error waiting on asset pipeline to finish.FIXME(yang): deprecate this. Use the 21317 + errStatusMsg
MODEL_EVALUATION_UNKNOWN_ERROR: EVALUATION THREW AN UNKNOWN EXCEPTION.
MODEL_EVALUATION_MSG_REDELIVER: Eval message was redelivered. FIXME(yang): deprecate this. Use the 21317 + errStatusMsg
MODEL_EVALUATION_NEED_LABELS: Don't have enough concepts labelled to perform evaluation. FIXME(yang): deprecate this. Use the 21317 + errStatusMsg
MODEL_EVALUATION_NEED_INPUTS: Don't have enough inputs per concept to perform evaluation. FIXME(yang): deprecate this. Use the 21317 + errStatusMsg
MODEL_EVALUATION_FAILED: Generic err code for eval failure.
MODEL_DEPLOYMENT_FAILED: Used when inference coordinator failed to deploy spire and throws an error
MODEL_DEPLOYING: Used when calling the inference coordinator to deploy a spire
MODEL_QUEUED_FOR_DEPLOYMENT: Used when training is completed
MODEL_NOT_DEPLOYED: Used when model spire deployment is manually taken down or due to inactivity
MODEL_REFERENCE_INVALID_ARGUMENT: Used when a model reference field is not set properly
MODEL_EXAMPLE_INPUT_INVALID_ARGUMENT: Used when a model example input field is not set properly
WORKFLOW_NO_MATCHING_INPUT: specified model input not in workflow
WORKFLOW_REQUIRE_TRAINED_MODEL: specified model must be trained
WORKFLOW_INVALID_ARGUMENT: error in the request somewhere
WORKFLOW_INVALID_REQUEST: error in the request somewhere
CONCEPT_MODIFY_SUCCESS: Concept related 23xxx
ANNOTATION_SUCCESS: Annotation related 24xxx
METADATA_INVALID_PATCH_ARGUMENTS: Metadata related 249xx
TRAINER_JOB_STATE_NONE: Training service related 25xxx
DATA_DUMP_SUCCESS: Data Dump related 251xx
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.
APP_DUPLICATION_SUCCESS: Duplicate related 252xx
MODULE_DOES_NOT_EXIST: Module related codes 253xx
BULK_OPERATION_SUCCESS: Bulk Operation related codes 254xx
RUNNER_DOES_NOT_EXIST: Runner related codes 256xx
INPUT_DOWNLOAD_SUCCESS: Input:Image related 30xxx
INPUT_DOWNLOAD_PENDING: when things are async, this is the default status.
INPUT_DOWNLOAD_FAILED: any type of error downloading and processing
INPUT_VIDEO_DOWNLOAD_SUCCESS: Input:Video related 31xxx -- Deprecated
INPUT_WRITES_DISABLED_FOR_MAINTENANCE: deprecate this one. Use REQUEST_DISABLED_FOR_MAINTENANCE
PREDICT_INVALID_REQUEST: API formatting issues 4000x
DATABASE_DUPLICATE_KEY: Other related 400xx
EXTERNAL_CONNECTION_ERROR: could not connect to external services
QUEUE_CONN_ERROR: Queue related errors 41xxx
SQS_OVERLIMIT: SQS related errors 411xx
SEARCH_INTERNAL_FAILURE: Search related errors 43xxxx
EVALUATION_QUEUED: Workflow evaluation err code
STRIPE_EVENT_ERROR: Stripe 44xxx
CACHE_MISS: Redis/Cache 45xxx
SIGNUP_EVENT_ERROR: Sift Science 46xxx
APP_COUNT_INVALID_MESSAGE: Application counts related errors 470xx
MP_DOWNLOAD_ERROR: Media processor related errors 471xx -- DEPRECATED
DATATIER_CONN_ERROR: DataTier related error 472xx
USER_CONSENT_FACE: User legal consent stauts related 50xxx
WORKER_MISSING: Workers 51xxx
COLLECTOR_MISSING: Collectors 52xxx
SSO_IDENTITY_PROVIDER_DOES_NOT_EXIST: SSO 53xxx
TASK_IN_PROGRESS: Tasks 54xxx
The task was created.
TASK_DONE: The task is completed.
TASK_WONT_DO: The task is marked as abandoned.
TASK_FAILED: An error occurred during add-task-annotations or add-auto-annotations pipeline.
TASK_IDLE: When an Auto Annotation task job has finished processing its last batch and is waiting for more dataset assets.
TASK_CONFLICT: The task operation is in conflict with the current state of the server.
TASK_NOT_IMPLEMENTED: Certain task-related scenarios are not implemented.
TASK_MISSING: Task was not found.
LABEL_ORDER_PENDING: Label Order Related Status Code 55xxx
LICENSE_ACTIVE: License Related Status Code 600xx
LICENSE_DELETED: hidden state not reflected to users
PASSWORD_VALIDATION_SUCCESS: Password Related Status Code
FEATUREFLAG_CONFIG_NOT_FOUND: Feature flags status code
MAINTENANCE_SUCCESS: Maintenance status code
DATASET_VERSION_PENDING: Datasets 64xxx
The dataset version is pending to be processed.
DATASET_VERSION_IN_PROGRESS: The dataset version is currently being processed.
DATASET_VERSION_READY: The dataset version is ready to be used.
DATASET_VERSION_FAILURE: An error occurred during the dataset version processing.
DATASET_VERSION_UNEXPECTED_ERROR: An unexpected error occurred during the dataset version processing.
DATASET_VERSION_CONFLICT: An alteration to dataset version would create a conflict
DATASET_INPUT_SUCCESS: The dataset input was successfully added.
DATASET_INPUT_DUPLICATE: The dataset input is a duplicate.
Deprecated: Unused.
DATASET_VERSION_EXPORT_SUCCESS: The dataset version export is completed.
DATASET_VERSION_EXPORT_PENDING: The dataset version is pending to be exported.
DATASET_VERSION_EXPORT_FAILED: An error occurred during the dataset version export.
DATASET_VERSION_EXPORT_IN_PROGRESS: The dataset version is currently being exported.
DATASET_VERSION_EXPORT_UNEXPECTED_ERROR: An unexpected error occurred during the dataset version export.
JOB_QUEUED: Generic Job status codes
AUTH_MISSING_IDP_ASSOC: auth issues
TODO: Knowledge graph related 80xxx
UPLOAD_IN_PROGRESS: Multipart uploading status codes
BILLING_INVALID_INFO: Billing related issues: 69xxx
INTERNAL_SERVER_ISSUE: Internal issues: 98xxx
CONN_UNCATEGORIZED: Uncategorized: 99xxx: move off as soon as known
BAD_REQUEST: Deprecated: migrate off to one of the internal issues
SERVER_ERROR: Deprecated: migrate off to one of the internal issues
示例值:
ZERO
status.description
string 
必需
A longer description of the error.
示例值:
<string>
status.details
string 
必需
More details of the given error.
示例值:
<string>
status.stackTrace
array[string]
必需
For some environment we may return a stack trace to help debug
any issues.
示例值:
["<string>","<string>"]
status.percentCompleted
string 
必需
specifically for long running jobs
示例值:
<long>
status.timeRemaining
string 
必需
if status is pending, how much time is remaining (in seconds)
示例值:
<long>
status.reqId
string 
必需
If we want to return a request id in the base status field
示例值:
<string>
status.internalDetails
string 
必需
Internal Annotation (do not set in production, for internal Clarifai use only).
示例值:
<string>
status.redirectInfo.url
string 
必需
New location for the resource. Used to set response Location header.
示例值:
<string>
status.redirectInfo.resourceType
string 
必需
Resource type
示例值:
<string>
status.redirectInfo.oldResourceId
string 
必需
Old resource id
示例值:
<string>
status.redirectInfo.newResourceId
string 
必需
New resource id
示例值:
<string>
ids
array[string]
必需
示例值:
["<string>","<string>"]
Header 参数
Accept
string 
必需
示例值:
application/json

示例代码

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request GET 'http://dev-cn.your-api-server.com/v2/inputs?userAppId.userId=<string>&userAppId.appId=<string>&page=<long>&perPage=<long>&status.code=ZERO&status.description=<string>&status.details=<string>&status.stackTrace=<string>&status.stackTrace=<string>&status.percentCompleted=<long>&status.timeRemaining=<long>&status.reqId=<string>&status.internalDetails=<string>&status.redirectInfo.url=<string>&status.redirectInfo.resourceType=<string>&status.redirectInfo.oldResourceId=<string>&status.redirectInfo.newResourceId=<string>&ids=<string>&ids=<string>' \
--header 'Accept: application/json'

返回响应

🟢200A successful response.
application/json
Body
status
object 
必需
code
string 
必需
description
string 
必需
details
string 
必需
stackTrace
array[string]
必需
percentCompleted
string 
必需
timeRemaining
string 
必需
reqId
string 
必需
internalDetails
string 
必需
redirectInfo
object 
必需
inputs
array [object {6}] 
必需
id
string 
可选
data
object 
可选
createdAt
string 
可选
modifiedAt
string 
可选
status
object 
可选
datasetIds
array[string]
可选
inputsAddJob
object 
必需
id
string 
必需
callBackUrl
string 
必需
appPat
string 
必需
progress
object 
必需
createdAt
string 
必需
modifiedAt
string 
必需
extractionJobs
array [object {7}] 
必需
uploads
array [object {8}] 
必需
status
object 
必需
示例
{
  "status": {
    "code": "ZERO",
    "description": "<string>",
    "details": "<string>",
    "stackTrace": [
      "<string>"
    ],
    "percentCompleted": "<long>",
    "timeRemaining": "<long>",
    "reqId": "<string>",
    "internalDetails": "<string>",
    "redirectInfo": {
      "url": "<string>",
      "resourceType": "<string>",
      "oldResourceId": "<string>",
      "newResourceId": "<string>"
    }
  },
  "inputs": [
    {
      "id": "<string>",
      "data": {
        "image": {
          "url": "<string>",
          "base64": "<string>",
          "allowDuplicateUrl": "<boolean>",
          "hosted": {
            "prefix": "<string>",
            "suffix": "<string>",
            "sizes": [
              "<string>"
            ],
            "crossorigin": "<string>"
          },
          "imageInfo": {
            "width": "<integer>",
            "height": "<integer>",
            "format": "<string>",
            "colorMode": "<string>"
          }
        },
        "video": {
          "url": "<string>",
          "base64": "<string>",
          "allowDuplicateUrl": "<boolean>",
          "thumbnailUrl": "<string>",
          "hosted": {
            "prefix": "<string>",
            "suffix": "<string>",
            "sizes": [
              "<string>"
            ],
            "crossorigin": "<string>"
          },
          "videoInfo": {
            "width": "<integer>",
            "height": "<integer>",
            "fps": "<float>",
            "videoFormat": "<string>",
            "bitRate": "<integer>",
            "frameCount": "<integer>",
            "durationSeconds": "<float>"
          }
        },
        "concepts": [
          {
            "id": "<string>",
            "name": "<string>",
            "value": "<float>",
            "createdAt": "<dateTime>",
            "language": "<string>",
            "appId": "<string>",
            "definition": "<string>",
            "vocabId": "<string>",
            "visibility": {
              "gettable": "UNKNOWN_VISIBILITY"
            },
            "userId": "<string>",
            "keypointInfo": {
              "keypointNames": [
                "<string>"
              ],
              "skeleton": [
                {
                  "k1": "<long>",
                  "k2": "<long>"
                }
              ]
            },
            "extraInfo": {
              "isRankable": "<boolean>"
            }
          }
        ],
        "metadata": {},
        "geo": {
          "geoPoint": {
            "longitude": "<float>",
            "latitude": "<float>"
          },
          "geoLimit": {
            "type": "<string>",
            "value": "<float>"
          },
          "geoBox": [
            {
              "geoPoint": {
                "longitude": "<float>",
                "latitude": "<float>"
              }
            }
          ]
        },
        "colors": [
          {
            "rawHex": "<string>",
            "w3c": {
              "hex": "<string>",
              "name": "<string>"
            },
            "value": "<float>"
          }
        ],
        "clusters": [
          {
            "id": "<string>",
            "count": "<long>",
            "score": "<float>",
            "hits": [
              {
                "score": "<float>",
                "input": {
                  "value": "<Circular reference to #/components/schemas/apiInput detected>"
                },
                "annotation": {
                  "id": "<string>",
                  "inputId": "<string>",
                  "data": {
                    "value": "<Circular reference to #/components/schemas/apiData detected>"
                  },
                  "annotationInfo": {},
                  "userId": "<string>",
                  "modelVersionId": "<string>",
                  "embedModelVersionId": "<string>",
                  "status": {
                    "code": "ZERO",
                    "description": "<string>",
                    "details": "<string>",
                    "stackTrace": [
                      "<string>"
                    ],
                    "percentCompleted": "<long>",
                    "timeRemaining": "<long>",
                    "reqId": "<string>",
                    "internalDetails": "<string>",
                    "redirectInfo": {
                      "url": "<string>",
                      "resourceType": "<string>",
                      "oldResourceId": "<string>",
                      "newResourceId": "<string>"
                    }
                  },
                  "createdAt": "<dateTime>",
                  "modifiedAt": "<dateTime>",
                  "trusted": "<boolean>",
                  "inputLevel": "<boolean>",
                  "consensusInfo": {},
                  "taskId": "<string>",
                  "workflowVersionId": "<string>"
                },
                "userId": "<string>",
                "appId": "<string>"
              }
            ],
            "projection": [
              "<float>"
            ]
          }
        ],
        "embeddings": [
          {
            "vector": [
              "<float>"
            ],
            "numDimensions": "<long>"
          }
        ],
        "regions": [
          {
            "id": "<string>",
            "regionInfo": {
              "boundingBox": {
                "topRow": "<float>",
                "leftCol": "<float>",
                "bottomRow": "<float>",
                "rightCol": "<float>"
              },
              "mask": {
                "image": {
                  "url": "<string>",
                  "base64": "<string>",
                  "allowDuplicateUrl": "<boolean>",
                  "hosted": {
                    "prefix": "<string>",
                    "suffix": "<string>",
                    "sizes": [
                      "<string>"
                    ],
                    "crossorigin": "<string>"
                  },
                  "imageInfo": {
                    "width": "<integer>",
                    "height": "<integer>",
                    "format": "<string>",
                    "colorMode": "<string>"
                  }
                }
              },
              "polygon": {
                "points": [
                  {
                    "row": "<float>",
                    "col": "<float>",
                    "z": "<float>",
                    "visibility": "NOT_SET"
                  }
                ]
              },
              "point": {
                "row": "<float>",
                "col": "<float>",
                "z": "<float>",
                "visibility": "NOT_SET"
              },
              "span": {
                "charStart": "<long>",
                "charEnd": "<long>",
                "rawText": "<string>"
              },
              "token": {
                "charStart": "<long>",
                "charEnd": "<long>",
                "rawText": "<string>"
              },
              "keypointLocations": [
                {
                  "row": "<float>",
                  "col": "<float>",
                  "z": "<float>",
                  "visibility": "NOT_SET"
                }
              ]
            },
            "data": {
              "value": "<Circular reference to #/components/schemas/apiData detected>"
            },
            "value": "<float>",
            "trackId": "<string>"
          }
        ],
        "frames": [
          {
            "frameInfo": {
              "index": "<long>",
              "time": "<long>"
            },
            "data": {
              "value": "<Circular reference to #/components/schemas/apiData detected>"
            },
            "id": "<string>"
          }
        ],
        "text": {
          "raw": "<string>",
          "url": "<string>",
          "allowDuplicateUrl": "<boolean>",
          "hosted": {
            "prefix": "<string>",
            "suffix": "<string>",
            "sizes": [
              "<string>"
            ],
            "crossorigin": "<string>"
          },
          "textInfo": {
            "charCount": "<integer>",
            "encoding": "<string>"
          }
        },
        "audio": {
          "url": "<string>",
          "base64": "<string>",
          "allowDuplicateUrl": "<boolean>",
          "hosted": {
            "prefix": "<string>",
            "suffix": "<string>",
            "sizes": [
              "<string>"
            ],
            "crossorigin": "<string>"
          },
          "audioInfo": {
            "audioFormat": "<string>",
            "sampleRate": "<integer>",
            "durationSeconds": "<float>",
            "bitRate": "<integer>"
          }
        },
        "tracks": [
          {
            "id": "<string>",
            "data": {
              "value": "<Circular reference to #/components/schemas/apiData detected>"
            },
            "timeInfo": {
              "numFrames": "<long>",
              "beginTime": "<long>",
              "endTime": "<long>"
            },
            "quality": "<float>"
          }
        ],
        "timeSegments": [
          {
            "id": "<string>",
            "data": {
              "value": "<Circular reference to #/components/schemas/apiData detected>"
            },
            "timeInfo": {
              "numFrames": "<long>",
              "beginTime": "<long>",
              "endTime": "<long>"
            }
          }
        ],
        "hits": [
          {
            "score": "<float>",
            "input": {
              "value": "<Circular reference to #/components/schemas/apiInput detected>"
            },
            "annotation": {
              "id": "<string>",
              "inputId": "<string>",
              "data": {
                "value": "<Circular reference to #/components/schemas/apiData detected>"
              },
              "annotationInfo": {},
              "userId": "<string>",
              "modelVersionId": "<string>",
              "embedModelVersionId": "<string>",
              "status": {
                "code": "ZERO",
                "description": "<string>",
                "details": "<string>",
                "stackTrace": [
                  "<string>"
                ],
                "percentCompleted": "<long>",
                "timeRemaining": "<long>",
                "reqId": "<string>",
                "internalDetails": "<string>",
                "redirectInfo": {
                  "url": "<string>",
                  "resourceType": "<string>",
                  "oldResourceId": "<string>",
                  "newResourceId": "<string>"
                }
              },
              "createdAt": "<dateTime>",
              "modifiedAt": "<dateTime>",
              "trusted": "<boolean>",
              "inputLevel": "<boolean>",
              "consensusInfo": {},
              "taskId": "<string>",
              "workflowVersionId": "<string>"
            },
            "userId": "<string>",
            "appId": "<string>"
          }
        ],
        "heatmaps": [
          {
            "url": "<string>",
            "base64": "<string>",
            "allowDuplicateUrl": "<boolean>",
            "hosted": {
              "prefix": "<string>",
              "suffix": "<string>",
              "sizes": [
                "<string>"
              ],
              "crossorigin": "<string>"
            },
            "imageInfo": {
              "width": "<integer>",
              "height": "<integer>",
              "format": "<string>",
              "colorMode": "<string>"
            }
          }
        ]
      },
      "createdAt": "<dateTime>",
      "modifiedAt": "<dateTime>",
      "status": {
        "code": "ZERO",
        "description": "<string>",
        "details": "<string>",
        "stackTrace": [
          "<string>"
        ],
        "percentCompleted": "<long>",
        "timeRemaining": "<long>",
        "reqId": "<string>",
        "internalDetails": "<string>",
        "redirectInfo": {
          "url": "<string>",
          "resourceType": "<string>",
          "oldResourceId": "<string>",
          "newResourceId": "<string>"
        }
      },
      "datasetIds": [
        "<string>"
      ]
    }
  ],
  "inputsAddJob": {
    "id": "<string>",
    "callBackUrl": "<string>",
    "appPat": "<string>",
    "progress": {
      "pendingCount": "<string>",
      "inProgressCount": "<string>",
      "successCount": "<string>",
      "failedCount": "<string>"
    },
    "createdAt": "<dateTime>",
    "modifiedAt": "<dateTime>",
    "extractionJobs": [
      {
        "status": {
          "code": "ZERO",
          "description": "<string>",
          "details": "<string>",
          "stackTrace": [
            "<string>"
          ],
          "percentCompleted": "<long>",
          "timeRemaining": "<long>",
          "reqId": "<string>",
          "internalDetails": "<string>",
          "redirectInfo": {
            "url": "<string>",
            "resourceType": "<string>",
            "oldResourceId": "<string>",
            "newResourceId": "<string>"
          }
        },
        "id": "<string>",
        "url": "<string>",
        "progress": {
          "audioInputsCount": "<string>",
          "imageInputsCount": "<string>",
          "videoInputsCount": "<string>",
          "textInputsCount": "<string>",
          "pendingArchivesCount": "<string>",
          "inProgressArchivesCount": "<string>",
          "completedArchivesCount": "<string>",
          "failedArchivesCount": "<string>"
        },
        "createdAt": "<dateTime>",
        "modifiedAt": "<dateTime>",
        "inputIdConflictResolution": "INPUT_ID_CONFLICT_RESOLUTION_NOT_SET"
      }
    ],
    "uploads": [
      {
        "id": "<string>",
        "createdAt": "<dateTime>",
        "modifiedAt": "<dateTime>",
        "expiresAt": "<dateTime>",
        "status": {
          "code": "ZERO",
          "description": "<string>",
          "details": "<string>",
          "stackTrace": [
            "<string>"
          ],
          "percentCompleted": "<long>",
          "timeRemaining": "<long>",
          "reqId": "<string>",
          "internalDetails": "<string>",
          "redirectInfo": {
            "url": "<string>",
            "resourceType": "<string>",
            "oldResourceId": "<string>",
            "newResourceId": "<string>"
          }
        },
        "contentName": "<string>",
        "contentLength": "<string>",
        "contentUrl": "<string>"
      }
    ],
    "status": {
      "code": "ZERO",
      "description": "<string>",
      "details": "<string>",
      "stackTrace": [
        "<string>"
      ],
      "percentCompleted": "<long>",
      "timeRemaining": "<long>",
      "reqId": "<string>",
      "internalDetails": "<string>",
      "redirectInfo": {
        "url": "<string>",
        "resourceType": "<string>",
        "oldResourceId": "<string>",
        "newResourceId": "<string>"
      }
    }
  }
}
🔴500An unexpected error response.
修改于 2023-12-11 04:12:06
上一页
Delete a single input asynchronously.
下一页
Delete multiple inputs in one request. This call is asynchronous.
Built with