Pipelines
Pipelines, the classifications of a pipeline and the metadata indexes of a pipeline. Pipelines describes the settings of a pipeline.
List pipelines
Returns a page of pipelines that the key can read. The response is a paginated envelope. Results can be filtered by field and ordered, as described in [API conventions](../01-api-conventions.md).
Create a pipeline
Creates a pipeline. The embedding model and the full-text search setting are fixed at creation and cannot change afterwards. The request names the classifications the pipeline defines and an optional metadata schema. The response body is the new pipeline.
Get a pipeline
Returns a pipeline by identifier. The response body is the pipeline together with the embedding models the pipeline uses, keyed by vector embedding identifier.
Update a pipeline
Changes the name, description, default text splitter or metadata schema of a pipeline. The embedding model, the full-text search setting and the classifications cannot be changed through this operation. The response body shows the pipeline as it was before the change, so a client application reads the pipeline with `GET /pipelines/{pipeline_id}` to confirm the new values.
Delete a pipeline
Deletes a pipeline, every document and version in the pipeline, and the pipeline's tables. The deletion is permanent. The response has no body.
List pipeline classifications
Returns the classifications the pipeline defines and the inheritance relationships between them. The `hierarchy` field is a list of pairs, each holding a classification and the inherited classification.
Modify pipeline classifications
Adds and removes classifications and inheritance relationships in one transaction. The request body holds an `add` list and a `remove` list, each using the classification forms of the create request. Additions are processed before removals. Removing a classification permanently deletes every document that carries the classification. The response has no body.
List metadata indexes
Returns the metadata indexes defined on a pipeline. The response body is a JSON array. Each element holds the index identifier and the metadata fields the index covers.
Create a metadata index
Creates a metadata index on one or more top-level metadata fields of a pipeline. Each field named in `columns` must be a top-level field declared in the pipeline's metadata schema with a scalar type. The response body is the new index.
Get a metadata index
Returns a metadata index of a pipeline by identifier. The response body holds the index identifier and the fields the index covers.
Delete a metadata index
Deletes a metadata index of a pipeline. The operation does not check that the index exists, so a request for an index that does not exist also returns HTTP 204. The response has no body.