Clarifai AI API
CLARIFAI API 基础知识
复制页面
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.
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.
CLARIFAI API 基础知识
复制页面
Clarifai API 基础知识
Clarifai API (应用程序编程接口)是允许客户端和服务器相互“对话”的接口。这用于“软件到软件”的通信,对于在您自己的产品和工具中以编程方式实施 Clarifai 的 AI 技术非常有用。
Clarifai API 充当我们软件的“看门人”,翻译 Python、Node 和 Java 等客户端。这些客户端用于发出请求,API 将其转换为软件可以理解的命令。
Clarifai 的 API 允许用户通过四种请求类型访问 Clarifai 平台:
POST
- 上传输入和信息
PATCH
- 更新或修改现有信息
GET
- 请求信息
删除
- 删除现有信息
您可以通过 HTTPS 访问 Clarifai 的 API
https://api.clarifai.com
。
重要的
我们建议使用**
客户端库
**来访问我们的 API。我们为官方客户提供多种编程语言。
要访问其他语言的 Clarifai API,请直接使用 REST API。有关 REST 文档,请参阅 cURL 示例。
修改于
2023-12-11 06:58:14
下一页
gRPC 与 HTTP 通道