Update a pipeline
PATCH/pipelines/:pipeline_id
Changes the name, description, default text splitter or metadata schema of a pipeline. Fields that the request omits keep their values, and "description": null clears the description. A new default text splitter applies to the documents submitted after the change. Search indexes and classifications are not changed through this operation: a request with an index field, or any other unknown field, returns HTTP 422, the operations under /pipelines/{pipeline_id}/search-indexers add, switch and remove indexes, and POST /pipelines/{pipeline_id}/classifications changes the classifications. The response body is the pipeline with the new settings.
Permissions. Write on the pipeline and, for a new default text splitter, write on that text splitter.
Settings that can change explains why a client sends every change to a pipeline in one request.
Request
Responses
- 200
- 400
- 401
- 403
- 404
- 409
- 422
The pipeline was updated. The body is the pipeline with the new settings.
The new metadata schema is not a valid schema (Schema error, with the reason in details.error and the field in details.field), or the body is not valid JSON.
The authentication headers are missing or invalid, or the API key is inactive or expired. Errors lists the messages.
The license does not allow the change (Invalid license: <reason>).
No pipeline with this identifier exists, or the key lacks write permission on the pipeline (Pipeline not found), or the new default text splitter does not exist or the key lacks write permission on the text splitter (Text Splitter not found). details.id holds the identifier.
The new name is already in use (Conflict unique error).
The body does not match the request schema, for example a value of the wrong type or an unknown field, such as an index field.