Skip to main content

Pipelines

Pipelines, the classifications of a pipeline and the metadata indexes of a pipeline. Pipelines describes the settings of a pipeline.

📄️Create a pipeline

Creates a pipeline with its first search indexes. `embedding_model_id` creates a vector index on VectorChord for similarity and maximal marginal relevance (MMR) search, and `full_text_search` creates a full-text index (`fts`) or a BM25 index (`bm25`) for full-text search, with the tokenizer in `bm25_tokenizer`. Each index becomes the default index of its kind. A pipeline created with neither field has no search index and supports only history search. The search indexes are not fixed at creation: the operations under `/pipelines/{pipeline_id}/search-indexers` add, switch and remove indexes later.

📄️Update a pipeline

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.