跳到主要内容

删除 Pipeline

Drop a specific pipeline.

DELETE
/v1/pipelines/{PIPELINE_ID}
Base URL

该 API 的 Base URL 格式如下:

https://controller.api.${CLOUD_REGION}.zilliz.com.cn

📘说明
export CLOUD_REGION="ali-cn-hangzhou"
export BASE_URL="https://controller.api.${CLOUD_REGION}.zilliz.com.cn"
参数
Authorizationstringheaderrequired

认证令牌,应为具备适当权限的 API 密钥或用冒号分隔的用户名和密码,如 username:password

示例值:Bearer {{TOKEN}}
PIPELINE_IDstringpathrequired

The ID of the pipeline to drop.

示例值:pipe-xxxxxxxxxxxxxxxxxxxxxxx
export TOKEN="YOUR_API_KEY"
export PIPELINE_ID="pipe-xxxxxxxxxxxxxxxxxxxxxxx"

curl --request DELETE \
--url "${BASE_URL}/v1/pipelines/${PIPELINE_ID}" \
--header "Authorization: Bearer ${TOKEN}" \
--header "Content-Type: application/json"
响应200 - application/json
codeinteger

表示当前操作是否成功。

dataobject

当指定 Pipeline 为 Ingestion Pipeline 时,返回的响应数据。

pipelineIdinteger

Pipeline 的 ID。

namestring

Pipeline 的名称。

typestring

Pipeline 的类型。Ingestion pipeline 的该参数值仅可以是 INGESTION

createTimestampinteger

Pipeline 的创建时间戳。

descriptionstring

Pipeline 的描述。

statusstring

Pipeline 的当前状态。如果值不是 SERVING,则 Pipeline 不工作。

totalUsagearray

Pipeline 的总用量。

[]totalUsageobject

Statistics on the total token usage of the pipeline.

embeddingstring必填项

Embedding 模型 Token 总用量。

functionsarray

Pipeline 中添加的 Function 名称。Ingestion pipeline 中必须包含且仅可包含 1 个 INDEX 类型的 Function 和 0-50 个 PRESERVE 类型的 Function。

[]functionsoneOf

A list of functions included in this pipeline

Functions of a text ingestion pipeline.

namestring必填项

Function 名称。

actionstring必填项

Function 类型。文本 Ingestion pipeline 的该参数值仅可以是 INDEX_TEXTPRESERVE

inputFieldsarrayrequired

根据您的需求为输入字段命名。文本 Ingestion pipeline 的输入字段中用于输入需要 Ingest 的文本列表。

[]inputFieldsstring

输入字段。

langaugestring必填项

您的源数据的语言。

embeddingstring必填项

使用的 Embedding 模型。

Functions of a doc ingestion pipeline.

namestring必填项

Function 名称。

actionstring必填项

Function 类型。文档 Ingestion pipeline 的该参数值仅可以是 INDEX_DOCPRESERVE

inputFieldstring必填项

根据您的需求为输入字段命名。文本 Ingestion pipeline 的输入字段用于输入需要 Ingest 的文档的预签名 URL。

langaugestring必填项

您的源数据的语言。

chunkSizeinteger

分割文档片段的最大大小。该参数取决于使用的 Embedding 模型。具体限制信息请参阅 使用限制

embeddingstring必填项

使用的 Embedding 模型。

splitByarray

用于分割文本的 Splitter。Ingestion Pipeline 会根据定义的字符按顺序将文本分割成小片段。默认使用["\n\n", "\n", " ", ""] 作为分隔符。

[]splitBystring

Splitter。

Functions of an image ingestion pipeline.

namestring必填项

Function 名称。

actionstring必填项

Function 类型。图像 Ingestion pipeline 的该参数值仅可以是 INDEX_IMAGEPRESERVE

inputFieldsarrayrequired

根据您的需求为输入字段命名。图像 Ingestion pipeline 的输入字段中用于输入需要 Ingest 的图像对象存储预签名 URL(image_url)和图像 ID(image_id)。

[]inputFieldsstring

输入字段。

embeddingstring必填项

使用的 Embedding 模型。

Functions for an ingestion pipeline to preserve metadata.

namestring

Function 名称。

actionstring

Function 类型。用于保留元数据的 Ingestion pipeline 的该参数值仅可以是 PRESERVE

inputFieldstring

输入字段名称。Zilliz Cloud 将在创建 Collection 时使用该名称作为 Collection 字段名称。

outputFieldstring

输出字段名称。该字段值应该与输入字段的值保持一致。

fieldTypestring

目标 Collection 中创建的字段数据类型。

CLUSTER_IDstring

Pipeline 所属的集群名称。

collectionNamestring

Pipeline 所属的 Collection。

codeinteger

表示当前操作是否成功。

dataobject

当 Pipeline 为 Search Pipeline 时返回的响应数据。

pipelineIdinteger

Pipeline 的 ID。

namestring

Pipeline 的名称。

typestring

Pipeline 的类型。Search pipeline 的该参数值仅可以是 SEARCH

descriptionstring

Pipeline 的描述。

statusstring

Pipeline 的当前状态。如果值不是 SERVING,则 Pipeline 不工作。

totalUsagearray

Pipeline 的总用量。

[]totalUsageobject

Statistics of the total token usage of the pipeline.

embeddingstring

Embedding 模型 Token 总用量。

rerankstring

Reranker 模型 Token 总用量。

functionsarray

Pipeline 中添加的 Function 名称。Search pipeline 中仅可包含 1 个 Function。

[]functionsoneOf

A list of functions included in this pipeline.

Functions of a text search pipeline.

namestring

Function 名称。

actionstring

Function 类型。文本 Search pipeline 的该参数值仅可以是 SEARCH_TEXT

inputFieldsarray

根据您的需求为输入字段命名。文本 Search pipeline 的输入字段用于输入需要搜索的查询文本(query_text)。

[]inputFieldsstring

输入字段。

embeddingstring

使用的 Embedding 模型。

rerankerstring

使用的 Reranker 模型。

collectionNamestring

Pipeline 所属的目标 Collection 名称。

clusterIdstring

Pipeline 所属的目标集群 ID。

Functions of a doc search pipeline.

namestring

Function 名称。Function 名称应该在 3-64 个字符内,且只可包含数字、字母和下划线。

actionstring

Function 类型。文档 Search pipeline 的该参数值仅可以是 SEARCH_DOC_CHUNK

clusterIdstring

Pipeline 所属的集群 ID。

collectionNamestring

Pipeline 所属的 Collection 名称。

embeddingstring

向量搜索时使用的 Embedding 模型。该模型应该与 Pipeline 配套的 Collection 中使用的 Embedding 模型保持一致。更多 Embedding 模型相关信息,请参见Zilliz Cloud Pipelines 使用哪些 Embedding 模型?

rerankerstring

向量搜索时使用的 Reranking 模型。使用 Reranker 可以对输出结果进行重新排序,提高搜索结果质量。目前,仅支持 zilliz/bge-reranker-base 作为 Reranker 模型。更多信息,请参考Reranker

inputFieldsarray

根据您的需求为输入字段命名。文档 Search pipeline 的输入字段用于输入需要搜索的查询文本(query_text)。

[]inputFieldsstring

输入字段。

Functions of an image search pipeline.

namestring

需要添加的 Function 名称。Function 名称应该在 3-64 个字符内,且只可包含数字、字母和下划线。

actionstring

需要添加的 Function 类型。图像(以图搜图) Search pipeline 的该参数值仅可以是 SEARCH_IMAGE_BY_IMAGE

clusterIdstring

Pipeline 所属的集群 ID。

collectionNamestring

Pipeline 所属的 Collection 名称。

embeddingstring

向量搜索时使用的 Embedding 模型。该模型应该与 Pipeline 配套的 Collection 中使用的 Embedding 模型保持一致。更多 Embedding 模型相关信息,请参见Zilliz Cloud Pipelines 使用哪些 Embedding 模型?

rerankerstring

使用的 Reranker 模型。

inputFieldsarray

根据您的需求为输入字段命名。以图搜图 Search pipeline 的输入字段用于输入需要搜索的查询图像 URL(query_image_url)。

[]inputFieldsstring

输入字段。

Functions of a reverse image search pipeline.

namestring

需要添加的 Function 名称。Function 名称应该在 3-64 个字符内,且只可包含数字、字母和下划线。

actionstring

需要添加的 Function 类型。图像(以图搜图) Search pipeline 的该参数值仅可以是 SEARCH_IMAGE_BY_IMAGE

clusterIdstring

Pipeline 所属的集群 ID。

collectionNamestring

Pipeline 所属的 Collection 名称。

embeddingstring

向量搜索时使用的 Embedding 模型。该模型应该与 Pipeline 配套的 Collection 中使用的 Embedding 模型保持一致。更多 Embedding 模型相关信息,请参见Zilliz Cloud Pipelines 使用哪些 Embedding 模型?

rerankerstring

使用的 Reranker 模型。

inputFieldsarray

根据您的需求为输入字段命名。以文本搜图 Search pipeline 的输入字段用于输入需要搜索的查询文本(query_text)。

[]inputFieldsstring

输入字段。

codeinteger

表示当前操作是否成功。

dataobject

当 Pipeline 为 Deletion Pipeline 时,返回的响应数据。

pipelineIdinteger

Pipeline 的 ID。

namestring

Pipeline 的名称。

typestring

Pipeline 的类型。Ingestion pipeline 的该参数值仅可以是 INGESTION

createTimestampinteger

Pipeline 的创建时间戳。

descriptionstring

Pipeline 的描述。

statusstring

Pipeline 的当前状态。如果值不是 SERVING,则 Pipeline 不工作。

functionsoneOf

Functions in the pipeline. An ingestion pipeline must have one and only one INDEX function and can have 0-50 PRESERVE functions.

Functions of a text ingestion pipeline.

namestring

Function 名称。

actionstring

Function 类型。文本 Deletion pipeline 的该参数值仅可以是 PURGE_TEXT_INDEXPURGE_BY_EXPRESSION

inputFieldsarray

根据您的需求为输入字段命名。文本 Deletion pipeline 的输入字段用于输入需要删除的文本 ID(id)或表达式(expression)。

[]inputFieldsstring

输入字段。

Functions of a doc ingestion pipeline.

namestring

Function 名称。

actionstring

Function 类型。文档 Deletion pipeline 的该参数值仅可以是 PURGE_DOC_INDEXPURGE_BY_EXPRESSION

inputFieldsstring

根据您的需求为输入字段命名。文本 Deletion pipeline 的输入字段用于输入需要删除的文档名称(doc_name)或表达式(expression)。

Functions of an image ingestion pipeline.

namestring

Function 名称。Function 名称应该在 3-64 个字符内,且只可包含数字、字母和下划线。

actionstring

Function 类型。图像 Deletion pipeline 的该参数值仅可以是 PURGE_IMAGE_INDEXPURGE_BY_EXPRESSION

inputFieldsarray

根据您的需求为输入字段命名。图像 Deletion pipeline 的输入字段用于输入需要删除的图像 ID(image_id)或表达式(expression)。

[]inputFieldsstring

输入字段。

CLUSTER_IDstring

Pipeline 所属的集群名称。

collectionNamestring

Pipeline 所属的 Collection。

Returns an error message.

codeinteger

响应码。

messagestring

错误描述。

{
"code": 200,
"data": {
"pipelineId": "pipe-xxx",
"name": "my_text_ingestion_pipeline",
"type": "INGESTION",
"createTimestamp": 1721187300000,
"description": "A pipeline that generates text embeddings and stores additional fields.",
"status": "SERVING",
"totalUsage": {
"embedding": 0
},
"functions": [
{
"name": "index_my_text",
"action": "INDEX_TEXT",
"inputFields": [
"text_list"
],
"language": "ENGLISH",
"embedding": "zilliz/bge-base-en-v1.5"
},
{
"name": "keep_text_info",
"action": "PRESERVE",
"inputField": "source",
"outputField": "source",
"fieldType": "VarChar"
}
],
"clusterId": "inxx-xxxx",
"collectionName": "my_collection"
}
}
{
"code": 200,
"message": "The token is illegal."
}