Describe Pipeline

Describe a specific pipeline by its name.

GET

https://controller.${CLOUD_REGION}.zillizcloud.com/v1/pipelines/{PIPELINE_ID}

Example

📘Notes

This API requires an API key as the authentication token.

export CLOUD_REGION="gcp-us-west1"
export API_KEY=""

curl --location --request GET "https://controller.api.${CLOUD_REGION}.zillizcloud.com/v1/pipelines/pipe-xxxxxxxxxxxxxxxxxxxxxxxxx" \
--header "Authorization: Bearer ${API_KEY}" 

Possible return is similar to the following.

{
    "code": 200,
    "data": {
        "pipelineId": "pipe-xxxxxxxxxxxxxxxxxxxxxxxx",
        "name": "my_doc_ingestion_pipeline",
        "type": "INGESTION",
        "createTimestamp": 1720601290000,
        "description": "A doc ingestion pipeline",
        "status": "SERVING",
        "totalUsage": {
            "embedding": 0
        },
        "functions": [
            {
                "name": "index_my_doc",
                "action": "INDEX_DOC",
                "inputFields": [
                    "doc_url",
                    "doc_name"
                ],
                "language": "ENGLISH",
                "chunkSize": 500,
                "splitBy": [
                    "\n\n",
                    "\n",
                    " ",
                    ""
                ],
                "embedding": "zilliz/bge-base-en-v1.5"
            },
            {
                "name": "keep_doc_info",
                "action": "PRESERVE",
                "inputField": "publish_year",
                "outputField": "publish_year",
                "fieldType": "Int16"
            }
        ],
        "clusterId": "inxx-xxxxxxxxxxxxxxx",
        "collectionName": "doc_pipeline"
    }
}

Request

Parameters

No query parameters required
Path parameters

Parameter Description
PIPELINE_ID string(required)
A valid pipeline ID obtained from either the list-pipelines API endpoints or Zilliz Cloud console.
No header parameters required

Parameter	Description
PIPELINE_ID	string(required) A valid pipeline ID obtained from either the list-pipelines API endpoints or Zilliz Cloud console.

Request Body

No request body required

Response

Returns a pipeline in detail.

Response Body

{
    "code": "integer",
    "data": {
        "oneOf": [
            {
                "pipelineId": "integer",
                "name": "string",
                "type": "string",
                "description": "string",
                "status": "string",
                "functions": {
                    "oneOf": [
                        {
                            "name": "string",
                            "action": "string",
                            "inputField": "string",
                            "langauge": "string",
                            "chunkSize": "integer",
                            "embedding": "string",
                            "splitBy": "string"
                        },
                        {
                            "name": "string",
                            "action": "string",
                            "inputField": "string",
                            "outputField": "string",
                            "fieldType": "string"
                        }
                    ]
                },
                "clusterID": "string",
                "collectionName": "string"
            },
            {
                "pipelineId": "integer",
                "name": "string",
                "type": "string",
                "description": "string",
                "status": "string",
                "functions": [
                    {
                        "name": "string",
                        "action": "string",
                        "inputField": "string",
                        "clusterID": "string",
                        "collectionName": "string"
                    }
                ],
                "clusterId": "string",
                "collectionName": "string"
            },
            {
                "pipelineId": "integer",
                "name": "string",
                "type": "string",
                "description": "string",
                "status": "string",
                "functions": [
                    {
                        "name": "string",
                        "action": "string",
                        "inputField": "string"
                    }
                ],
                "clusterID": "string",
                "collectionName": "string"
            }
        ]
    }
}

Property	Description
code	integer Indicates whether the request succeeds. `0`: The request succeeds. Others: Some error occurs.
data	object \| object \| object
data[opt_1]	object
data[opt_1].pipelineId	integer A pipeline ID.
data[opt_1].name	string Name of the pipeline.
data[opt_1].type	string Type of the pipeline. For an ingestion pipeline, the value should be `INGESTION`.
data[opt_1].description	string Description of the pipeline.
data[opt_1].status	string Current status of the pipeline. If the value is other than `SERVING`, the pipeline is not working.
functions	object \| object Functions in the pipeline. For an ingestion pipeline, there should be only one `INDEX_DOC` function.
functions[opt_1]	object
functions[opt_1].name	string Name of the function to create.
functions[opt_1].action	string Type of the function to create. For an ingestion pipeline, possible values are `INDEX_DOC` and `PRESERVE`.
functions[opt_1].inputField	string Name the field according to your needs. In an `INDEX_DOC` function of an ingestion pipeline, use it for pre-signed document URLs in GCS or AWS S3 buckets.
functions[opt_1].langauge	string Language that your document is in. Possible values are `english` or `chinese`. The parameter applies only to ingestion pipelines.
functions[opt_1].chunkSize	integer The maximum size of a splitted document segment.
functions[opt_1].embedding	string Name of the embedding model in use.
functions[opt_1].splitBy	string The splitters that Zilliz Cloud uses to split the specified docs.
functions[opt_2]	object
functions[opt_2].name	string Name of the function to create.
functions[opt_2].action	string Type of the function to create. For an ingestion pipeline, possible values are `INDEX_DOC` and `PRESERVE`.
functions[opt_2].inputField	string Name the field according to your needs. In a preserve function of an ingestion pipeline, Zilliz Cloud uses the value as the name of a field in the collection to create.
functions[opt_2].outputField	string Name of the output field. The value should be the same as that of `input_field`.
functions[opt_2].fieldType	string Data type of the field to create in the target collection. Possible values are `BOOL`, `INT8`, `INT16`, `INT32`, `INT64`, `FLOAT`, `DOUBLE`, and `VARCHAR`.
data[opt_1].clusterID	string The target cluster to which the pipeline applies.
data[opt_1].collectionName	string The target collection to which the pipeline applies.
data[opt_2]	object
data[opt_2].pipelineId	integer A pipeline ID.
data[opt_2].name	string Name of the pipeline
data[opt_2].type	string Type of the pipeline. For a search pipeline, the value should be `SEARCH`.
data[opt_2].description	string Description of the pipeline.
data[opt_2].status	string Current status of the pipeline. If the value is not `SERVING`, the pipeline is not working.
data[opt_2][].functions	array Functions in the pipeline. For a search pipeline, each of its member functions targets at a different collection.
data[opt_2][].functions[]	object
data[opt_2][].functions[].name	string Name of the function.
data[opt_2][].functions[].action	string Type of the function. For a search function, the value should be `SEARCH_DOC_CHUNKS`.
data[opt_2][].functions[].inputField	string Name of the input field. For a `SEARCH_DOC_CHUNKS` function, the value should be your query text.
data[opt_2][].functions[].clusterID	string Target cluster of this function.
data[opt_2][].functions[].collectionName	string Target collection of this function.
data[opt_2].clusterId	string Target cluster of the pipeline.
data[opt_2].collectionName	string Target collection of the pipeline.
data[opt_3]	object
data[opt_3].pipelineId	integer A pipeline ID.
data[opt_3].name	string Name of the pipeline.
data[opt_3].type	string Type of the pipeline. For a deletion pipeline, the value should be `DELETION`.
data[opt_3].description	string Description of the pipeline.
data[opt_3].status	string Current status of the pipeline. If the value is not `SERVING`, the pipeline is not working.
data[opt_3][].functions	array Functions in the pipeline. For a deletion pipeline, there can be multiple member functions with each representing a deletion request.
data[opt_3][].functions[]	object
data[opt_3][].functions[].name	string Name of the function.
data[opt_3][].functions[].action	string Type of the function. For a deletion pipeline, its member functions should be of `PURGE_DOC_INDEX`.
data[opt_3][].functions[].inputField	string Name of the input field. For a `PURGE_DOC_INDEX` function, the value should be the name of the doc to delete.
data[opt_3].clusterID	string Target cluster of the pipeline.
data[opt_3].collectionName	string Target collection of the pipeline.

Error Response

{
    "code": integer,
    "message": string
}

Property	Description
code	integer Indicates whether the request succeeds. `0`: The request succeeds. Others: Some error occurs.
message	string Indicates the possible reason for the reported error.

Example​

Request​

Parameters​

Request Body​

Response​

Response Body​

Error Response​