Clarifai AI API
  1. results
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.
      • 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.
    • 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.
            POST
        • 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.
          GET
        • Delete a single workflow.
          DELETE
      • List all the workflows.
        GET
      • Delete multiple workflows in one request.
        DELETE
      • Add a workflow to an app.
        POST
      • Patch one or more workflows.
        PATCH
  1. results

Predict using a workflow.

开发环境
http://dev-cn.your-api-server.com
开发环境
http://dev-cn.your-api-server.com
POST
/v2/workflows/{workflowId}/results
V2

请求参数

Path 参数
workflowId
string 
必需
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
Body 参数application/json
userAppId
object (apiUserAppIDSet) 
可选
Common message to identify the app in a url endpoint.
userId
string 
Note user_id 'me' is reserved - it is the alias for the id of authorized user
可选
appId
string 
可选
versionId
string 
Workflow version ID to retrieve If no ID is specified, latest workflow version is used
可选
inputs
array[object (Input) {6}] 
可选
id
string 
The ID for the input
可选
data
object (Data) 
可选
createdAt
string <date-time>
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"
可选
modifiedAt
string <date-time>
可选
When the input was modified.
status
object (apistatusStatus) 
可选
datasetIds
array[string]
可选
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.
outputConfig
object (apiOutputConfig) 
可选
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 infer_params and
train_params in OutputInfo which are cleaner and more extensible for many ModelTypes.
conceptsMutuallyExclusive
boolean 
可选
For custom concept model training: whether the concept predictions must sum to 1.
existingModelId
string 
可选
DEPRECATED: For custom models, this is the base model to use for image embeddings.
Default is general model.
language
string 
可选
For concept model predictions: Overrides the default_language for the app in a predict call.
hyperParameters
string 
可选
DEPRECATED: Hyper-parameters for custom training.
Use new hyper_params field instead.
maxConcepts
integer <int64>
可选
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.
minValue
number <float>
可选
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.
selectConcepts
array[object (Concept or tag) {12}] 
For concept model predictions: Select concepts in result by name or by id
可选
trainingTimeout
integer <int64>
For custom concept model training: Training timeout of the model (in seconds)
可选
sampleMs
integer <int64>
For model predictions on video: Sample delay for video predicting (1 frame per N milliseconds)
可选
hyperParams
object 
For custom model training: Hyperparameters for custom training
可选
embedModelVersionId
string 
可选
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.
failOnMissingPositiveExamples
boolean 
For custom model training: Use this flag to fail on missing positive examples By default we fill in the missing with random examples
可选
modelMetadata
object 
可选
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.
favorClarifaiWorkflows
boolean 
Use this flag to look into clarifai published workflows first for a Workflow ID
可选
workflowState
object (WorkflowState) 
可选
id
string 
可选
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.
示例
{
  "userAppId": {
    "userId": "string",
    "appId": "string"
  },
  "versionId": "string",
  "inputs": [
    {
      "id": "string",
      "data": {
        "image": {
          "url": "string",
          "base64": "string",
          "allowDuplicateUrl": true,
          "hosted": {
            "prefix": "string",
            "suffix": "string",
            "sizes": [
              "string"
            ],
            "crossorigin": "string"
          },
          "imageInfo": {
            "width": 0,
            "height": 0,
            "format": "string",
            "colorMode": "string"
          }
        },
        "video": {
          "url": "string",
          "base64": "string",
          "allowDuplicateUrl": true,
          "thumbnailUrl": "string",
          "hosted": {
            "prefix": "string",
            "suffix": "string",
            "sizes": [
              "string"
            ],
            "crossorigin": "string"
          },
          "videoInfo": {
            "width": 0,
            "height": 0,
            "fps": 0,
            "videoFormat": "string",
            "bitRate": 0,
            "frameCount": 0,
            "durationSeconds": 0
          }
        },
        "concepts": [
          {
            "id": "string",
            "name": "string",
            "value": 0,
            "createdAt": "2019-08-24T14:15:22Z",
            "language": "string",
            "appId": "string",
            "definition": "string",
            "vocabId": "string",
            "visibility": {
              "gettable": "UNKNOWN_VISIBILITY"
            },
            "userId": "string",
            "keypointInfo": {
              "keypointNames": [
                "string"
              ],
              "skeleton": [
                {
                  "k1": 0,
                  "k2": 0
                }
              ]
            },
            "extraInfo": {
              "isRankable": true
            }
          }
        ],
        "metadata": {},
        "geo": {
          "geoPoint": {
            "longitude": 0,
            "latitude": 0
          },
          "geoLimit": {
            "type": "string",
            "value": 0
          },
          "geoBox": [
            {
              "geoPoint": {
                "longitude": 0,
                "latitude": 0
              }
            }
          ]
        },
        "colors": [
          {
            "rawHex": "string",
            "w3c": {
              "hex": "string",
              "name": "string"
            },
            "value": 0
          }
        ],
        "clusters": [
          {
            "id": "string",
            "count": 0,
            "score": 0,
            "hits": [
              {
                "score": 0,
                "input": {},
                "annotation": {
                  "id": "string",
                  "inputId": "string",
                  "data": {},
                  "annotationInfo": {},
                  "userId": "string",
                  "modelVersionId": "string",
                  "embedModelVersionId": "string",
                  "status": {
                    "code": {},
                    "description": "string",
                    "details": "string",
                    "stackTrace": [
                      "string"
                    ],
                    "percentCompleted": 0,
                    "timeRemaining": 0,
                    "reqId": "string",
                    "internalDetails": "string",
                    "redirectInfo": {
                      "url": "string",
                      "resourceType": "string",
                      "oldResourceId": "string",
                      "newResourceId": "string"
                    }
                  },
                  "createdAt": "2019-08-24T14:15:22Z",
                  "modifiedAt": "2019-08-24T14:15:22Z",
                  "trusted": true,
                  "inputLevel": true,
                  "consensusInfo": {},
                  "taskId": "string",
                  "workflowVersionId": "string"
                },
                "userId": "string",
                "appId": "string"
              }
            ],
            "projection": [
              0
            ]
          }
        ],
        "embeddings": [
          {
            "vector": [
              0
            ],
            "numDimensions": 0
          }
        ],
        "regions": [
          {
            "id": "string",
            "regionInfo": {
              "boundingBox": {
                "topRow": 0,
                "leftCol": 0,
                "bottomRow": 0,
                "rightCol": 0
              },
              "mask": {
                "image": {
                  "url": "string",
                  "base64": "string",
                  "allowDuplicateUrl": true,
                  "hosted": {
                    "prefix": "string",
                    "suffix": "string",
                    "sizes": [
                      "string"
                    ],
                    "crossorigin": "string"
                  },
                  "imageInfo": {
                    "width": 0,
                    "height": 0,
                    "format": "string",
                    "colorMode": "string"
                  }
                }
              },
              "polygon": {
                "points": [
                  {
                    "row": 0,
                    "col": 0,
                    "z": 0,
                    "visibility": "NOT_SET"
                  }
                ]
              },
              "point": {
                "row": 0,
                "col": 0,
                "z": 0,
                "visibility": "NOT_SET"
              },
              "span": {
                "charStart": 0,
                "charEnd": 0,
                "rawText": "string"
              },
              "token": {
                "charStart": 0,
                "charEnd": 0,
                "rawText": "string"
              },
              "keypointLocations": [
                {
                  "row": 0,
                  "col": 0,
                  "z": 0,
                  "visibility": "NOT_SET"
                }
              ]
            },
            "data": {},
            "value": 0,
            "trackId": "string"
          }
        ],
        "frames": [
          {
            "frameInfo": {
              "index": 0,
              "time": 0
            },
            "data": {},
            "id": "string"
          }
        ],
        "text": {
          "raw": "string",
          "url": "string",
          "allowDuplicateUrl": true,
          "hosted": {
            "prefix": "string",
            "suffix": "string",
            "sizes": [
              "string"
            ],
            "crossorigin": "string"
          },
          "textInfo": {
            "charCount": 0,
            "encoding": "string"
          }
        },
        "audio": {
          "url": "string",
          "base64": "string",
          "allowDuplicateUrl": true,
          "hosted": {
            "prefix": "string",
            "suffix": "string",
            "sizes": [
              "string"
            ],
            "crossorigin": "string"
          },
          "audioInfo": {
            "audioFormat": "string",
            "sampleRate": 0,
            "durationSeconds": 0,
            "bitRate": 0
          }
        },
        "tracks": [
          {
            "id": "string",
            "data": {},
            "timeInfo": {
              "numFrames": 0,
              "beginTime": 0,
              "endTime": 0
            },
            "quality": 0
          }
        ],
        "timeSegments": [
          {
            "id": "string",
            "data": {},
            "timeInfo": {
              "numFrames": 0,
              "beginTime": 0,
              "endTime": 0
            }
          }
        ],
        "hits": [
          {
            "score": 0,
            "input": {},
            "annotation": {
              "id": "string",
              "inputId": "string",
              "data": {},
              "annotationInfo": {},
              "userId": "string",
              "modelVersionId": "string",
              "embedModelVersionId": "string",
              "status": {
                "code": {},
                "description": "string",
                "details": "string",
                "stackTrace": [
                  "string"
                ],
                "percentCompleted": 0,
                "timeRemaining": 0,
                "reqId": "string",
                "internalDetails": "string",
                "redirectInfo": {
                  "url": "string",
                  "resourceType": "string",
                  "oldResourceId": "string",
                  "newResourceId": "string"
                }
              },
              "createdAt": "2019-08-24T14:15:22Z",
              "modifiedAt": "2019-08-24T14:15:22Z",
              "trusted": true,
              "inputLevel": true,
              "consensusInfo": {},
              "taskId": "string",
              "workflowVersionId": "string"
            },
            "userId": "string",
            "appId": "string"
          }
        ],
        "heatmaps": [
          {
            "url": "string",
            "base64": "string",
            "allowDuplicateUrl": true,
            "hosted": {
              "prefix": "string",
              "suffix": "string",
              "sizes": [
                "string"
              ],
              "crossorigin": "string"
            },
            "imageInfo": {
              "width": 0,
              "height": 0,
              "format": "string",
              "colorMode": "string"
            }
          }
        ]
      },
      "createdAt": "2019-08-24T14:15:22Z",
      "modifiedAt": "2019-08-24T14:15:22Z",
      "status": {
        "code": {},
        "description": "string",
        "details": "string",
        "stackTrace": [
          "string"
        ],
        "percentCompleted": 0,
        "timeRemaining": 0,
        "reqId": "string",
        "internalDetails": "string",
        "redirectInfo": {
          "url": "string",
          "resourceType": "string",
          "oldResourceId": "string",
          "newResourceId": "string"
        }
      },
      "datasetIds": [
        "string"
      ]
    }
  ],
  "outputConfig": {
    "conceptsMutuallyExclusive": true,
    "existingModelId": "string",
    "language": "string",
    "hyperParameters": "string",
    "maxConcepts": 0,
    "minValue": 0,
    "selectConcepts": [
      {
        "id": "string",
        "name": "string",
        "value": 0,
        "createdAt": "2019-08-24T14:15:22Z",
        "language": "string",
        "appId": "string",
        "definition": "string",
        "vocabId": "string",
        "visibility": {
          "gettable": "UNKNOWN_VISIBILITY"
        },
        "userId": "string",
        "keypointInfo": {
          "keypointNames": [
            "string"
          ],
          "skeleton": [
            {
              "k1": 0,
              "k2": 0
            }
          ]
        },
        "extraInfo": {
          "isRankable": true
        }
      }
    ],
    "trainingTimeout": 0,
    "sampleMs": 0,
    "hyperParams": {},
    "embedModelVersionId": "string",
    "failOnMissingPositiveExamples": true,
    "modelMetadata": {}
  },
  "favorClarifaiWorkflows": true,
  "workflowState": {
    "id": "string"
  }
}

示例代码

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request POST 'http://dev-cn.your-api-server.com/v2/workflows//results' \
--header 'Content-Type: application/json' \
--data-raw '{
    "userAppId": {
        "userId": "string",
        "appId": "string"
    },
    "versionId": "string",
    "inputs": [
        {
            "id": "string",
            "data": {
                "image": {
                    "url": "string",
                    "base64": "string",
                    "allowDuplicateUrl": true,
                    "hosted": {
                        "prefix": "string",
                        "suffix": "string",
                        "sizes": [
                            "string"
                        ],
                        "crossorigin": "string"
                    },
                    "imageInfo": {
                        "width": 0,
                        "height": 0,
                        "format": "string",
                        "colorMode": "string"
                    }
                },
                "video": {
                    "url": "string",
                    "base64": "string",
                    "allowDuplicateUrl": true,
                    "thumbnailUrl": "string",
                    "hosted": {
                        "prefix": "string",
                        "suffix": "string",
                        "sizes": [
                            "string"
                        ],
                        "crossorigin": "string"
                    },
                    "videoInfo": {
                        "width": 0,
                        "height": 0,
                        "fps": 0,
                        "videoFormat": "string",
                        "bitRate": 0,
                        "frameCount": 0,
                        "durationSeconds": 0
                    }
                },
                "concepts": [
                    {
                        "id": "string",
                        "name": "string",
                        "value": 0,
                        "createdAt": "2019-08-24T14:15:22Z",
                        "language": "string",
                        "appId": "string",
                        "definition": "string",
                        "vocabId": "string",
                        "visibility": {
                            "gettable": "UNKNOWN_VISIBILITY"
                        },
                        "userId": "string",
                        "keypointInfo": {
                            "keypointNames": [
                                "string"
                            ],
                            "skeleton": [
                                {
                                    "k1": 0,
                                    "k2": 0
                                }
                            ]
                        },
                        "extraInfo": {
                            "isRankable": true
                        }
                    }
                ],
                "metadata": {},
                "geo": {
                    "geoPoint": {
                        "longitude": 0,
                        "latitude": 0
                    },
                    "geoLimit": {
                        "type": "string",
                        "value": 0
                    },
                    "geoBox": [
                        {
                            "geoPoint": {
                                "longitude": 0,
                                "latitude": 0
                            }
                        }
                    ]
                },
                "colors": [
                    {
                        "rawHex": "string",
                        "w3c": {
                            "hex": "string",
                            "name": "string"
                        },
                        "value": 0
                    }
                ],
                "clusters": [
                    {
                        "id": "string",
                        "count": 0,
                        "score": 0,
                        "hits": [
                            {
                                "score": 0,
                                "input": {},
                                "annotation": {
                                    "id": "string",
                                    "inputId": "string",
                                    "data": {},
                                    "annotationInfo": {},
                                    "userId": "string",
                                    "modelVersionId": "string",
                                    "embedModelVersionId": "string",
                                    "status": {
                                        "code": {},
                                        "description": "string",
                                        "details": "string",
                                        "stackTrace": [
                                            "string"
                                        ],
                                        "percentCompleted": 0,
                                        "timeRemaining": 0,
                                        "reqId": "string",
                                        "internalDetails": "string",
                                        "redirectInfo": {
                                            "url": "string",
                                            "resourceType": "string",
                                            "oldResourceId": "string",
                                            "newResourceId": "string"
                                        }
                                    },
                                    "createdAt": "2019-08-24T14:15:22Z",
                                    "modifiedAt": "2019-08-24T14:15:22Z",
                                    "trusted": true,
                                    "inputLevel": true,
                                    "consensusInfo": {},
                                    "taskId": "string",
                                    "workflowVersionId": "string"
                                },
                                "userId": "string",
                                "appId": "string"
                            }
                        ],
                        "projection": [
                            0
                        ]
                    }
                ],
                "embeddings": [
                    {
                        "vector": [
                            0
                        ],
                        "numDimensions": 0
                    }
                ],
                "regions": [
                    {
                        "id": "string",
                        "regionInfo": {
                            "boundingBox": {
                                "topRow": 0,
                                "leftCol": 0,
                                "bottomRow": 0,
                                "rightCol": 0
                            },
                            "mask": {
                                "image": {
                                    "url": "string",
                                    "base64": "string",
                                    "allowDuplicateUrl": true,
                                    "hosted": {
                                        "prefix": "string",
                                        "suffix": "string",
                                        "sizes": [
                                            "string"
                                        ],
                                        "crossorigin": "string"
                                    },
                                    "imageInfo": {
                                        "width": 0,
                                        "height": 0,
                                        "format": "string",
                                        "colorMode": "string"
                                    }
                                }
                            },
                            "polygon": {
                                "points": [
                                    {
                                        "row": 0,
                                        "col": 0,
                                        "z": 0,
                                        "visibility": "NOT_SET"
                                    }
                                ]
                            },
                            "point": {
                                "row": 0,
                                "col": 0,
                                "z": 0,
                                "visibility": "NOT_SET"
                            },
                            "span": {
                                "charStart": 0,
                                "charEnd": 0,
                                "rawText": "string"
                            },
                            "token": {
                                "charStart": 0,
                                "charEnd": 0,
                                "rawText": "string"
                            },
                            "keypointLocations": [
                                {
                                    "row": 0,
                                    "col": 0,
                                    "z": 0,
                                    "visibility": "NOT_SET"
                                }
                            ]
                        },
                        "data": {},
                        "value": 0,
                        "trackId": "string"
                    }
                ],
                "frames": [
                    {
                        "frameInfo": {
                            "index": 0,
                            "time": 0
                        },
                        "data": {},
                        "id": "string"
                    }
                ],
                "text": {
                    "raw": "string",
                    "url": "string",
                    "allowDuplicateUrl": true,
                    "hosted": {
                        "prefix": "string",
                        "suffix": "string",
                        "sizes": [
                            "string"
                        ],
                        "crossorigin": "string"
                    },
                    "textInfo": {
                        "charCount": 0,
                        "encoding": "string"
                    }
                },
                "audio": {
                    "url": "string",
                    "base64": "string",
                    "allowDuplicateUrl": true,
                    "hosted": {
                        "prefix": "string",
                        "suffix": "string",
                        "sizes": [
                            "string"
                        ],
                        "crossorigin": "string"
                    },
                    "audioInfo": {
                        "audioFormat": "string",
                        "sampleRate": 0,
                        "durationSeconds": 0,
                        "bitRate": 0
                    }
                },
                "tracks": [
                    {
                        "id": "string",
                        "data": {},
                        "timeInfo": {
                            "numFrames": 0,
                            "beginTime": 0,
                            "endTime": 0
                        },
                        "quality": 0
                    }
                ],
                "timeSegments": [
                    {
                        "id": "string",
                        "data": {},
                        "timeInfo": {
                            "numFrames": 0,
                            "beginTime": 0,
                            "endTime": 0
                        }
                    }
                ],
                "hits": [
                    {
                        "score": 0,
                        "input": {},
                        "annotation": {
                            "id": "string",
                            "inputId": "string",
                            "data": {},
                            "annotationInfo": {},
                            "userId": "string",
                            "modelVersionId": "string",
                            "embedModelVersionId": "string",
                            "status": {
                                "code": {},
                                "description": "string",
                                "details": "string",
                                "stackTrace": [
                                    "string"
                                ],
                                "percentCompleted": 0,
                                "timeRemaining": 0,
                                "reqId": "string",
                                "internalDetails": "string",
                                "redirectInfo": {
                                    "url": "string",
                                    "resourceType": "string",
                                    "oldResourceId": "string",
                                    "newResourceId": "string"
                                }
                            },
                            "createdAt": "2019-08-24T14:15:22Z",
                            "modifiedAt": "2019-08-24T14:15:22Z",
                            "trusted": true,
                            "inputLevel": true,
                            "consensusInfo": {},
                            "taskId": "string",
                            "workflowVersionId": "string"
                        },
                        "userId": "string",
                        "appId": "string"
                    }
                ],
                "heatmaps": [
                    {
                        "url": "string",
                        "base64": "string",
                        "allowDuplicateUrl": true,
                        "hosted": {
                            "prefix": "string",
                            "suffix": "string",
                            "sizes": [
                                "string"
                            ],
                            "crossorigin": "string"
                        },
                        "imageInfo": {
                            "width": 0,
                            "height": 0,
                            "format": "string",
                            "colorMode": "string"
                        }
                    }
                ]
            },
            "createdAt": "2019-08-24T14:15:22Z",
            "modifiedAt": "2019-08-24T14:15:22Z",
            "status": {
                "code": {},
                "description": "string",
                "details": "string",
                "stackTrace": [
                    "string"
                ],
                "percentCompleted": 0,
                "timeRemaining": 0,
                "reqId": "string",
                "internalDetails": "string",
                "redirectInfo": {
                    "url": "string",
                    "resourceType": "string",
                    "oldResourceId": "string",
                    "newResourceId": "string"
                }
            },
            "datasetIds": [
                "string"
            ]
        }
    ],
    "outputConfig": {
        "conceptsMutuallyExclusive": true,
        "existingModelId": "string",
        "language": "string",
        "hyperParameters": "string",
        "maxConcepts": 0,
        "minValue": 0,
        "selectConcepts": [
            {
                "id": "string",
                "name": "string",
                "value": 0,
                "createdAt": "2019-08-24T14:15:22Z",
                "language": "string",
                "appId": "string",
                "definition": "string",
                "vocabId": "string",
                "visibility": {
                    "gettable": "UNKNOWN_VISIBILITY"
                },
                "userId": "string",
                "keypointInfo": {
                    "keypointNames": [
                        "string"
                    ],
                    "skeleton": [
                        {
                            "k1": 0,
                            "k2": 0
                        }
                    ]
                },
                "extraInfo": {
                    "isRankable": true
                }
            }
        ],
        "trainingTimeout": 0,
        "sampleMs": 0,
        "hyperParams": {},
        "embedModelVersionId": "string",
        "failOnMissingPositiveExamples": true,
        "modelMetadata": {}
    },
    "favorClarifaiWorkflows": true,
    "workflowState": {
        "id": "string"
    }
}'

返回响应

🟢200A successful response.
application/json
Body
status
object (apistatusStatus) 
可选
code
object 
可选
description
string 
可选
A longer description of the error.
details
string 
可选
More details of the given error.
stackTrace
array[string]
可选
For some environment we may return a stack trace to help debug
any issues.
percentCompleted
integer <int64>
specifically for long running jobs
可选
timeRemaining
integer <int64>
if status is pending, how much time is remaining (in seconds)
可选
reqId
string 
If we want to return a request id in the base status field
可选
internalDetails
string 
可选
Internal Annotation (do not set in production, for internal Clarifai use only).
redirectInfo
object (statusRedirectInfo) 
可选
workflow
object (Workflow) 
可选
id
string 
可选
The workflows's unique id.
appId
string 
The app the workflow belongs to
可选
createdAt
string <date-time>
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
array[object (WorkflowNode) {5}] 
可选
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
object 
To handle arbitrary json metadata you can use a struct field: https://github.com/google/protobuf/blob/master/src/google/protobuf/struct.proto
可选
visibility
object (clarifaiapiVisibility) 
可选
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.
userId
string 
The user the workflow belongs to
可选
modifiedAt
string <date-time>
When the workflow was last modified
可选
version
object (WorkflowVersion) 
可选
isStarred
boolean 
Is starred by the requesting user (only showed on get/list requests) Please use PostWorkflowStars/DeleteWorkflowStars endpoints to star/unstar a workflow
可选
starCount
integer <int32>
How many users have starred the workflow (only showed on get/list requests) Computed value, not editable
可选
description
string 
Short description about this workflow
可选
notes
string 
可选
Notes for the workflow
This field should be used for in-depth notes and supports up to 64Kbs.
useCases
array[string]
Tags from use_cases category
可选
checkConsents
array[string]
Tags for check consents
可选
bookmarkOrigin
object (apiBookmarkOrigin) 
可选
results
array[object (WorkflowResult) {7}] 
可选
The resulting predictions of all models in the workflow.
id
string 
可选
status
object (apistatusStatus) 
可选
createdAt
string <date-time>
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
object 
可选
input
object (Input) 
可选
outputs
array[object (Output) {6}] 
可选
suppressOutput
boolean 
可选
Indicate if the output of this model is suppressed.
workflowState
object (WorkflowState) 
可选
id
string 
可选
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.
示例
🔴500An unexpected error response.
上一页
Compare embeddings distances using a workflow
下一页
V2_PostWorkflowVersionsUnPublish2
Built with