Skip to main content

Create a pipeline

POST 

/pipelines

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.

The request also names the default text splitter, the classifications that documents in the pipeline can carry and an optional metadata schema. A request with an unknown field, such as has_full_text_search of earlier releases, returns HTTP 422. The key that creates the pipeline receives all three permissions on the new pipeline, with the allow-list *. The response body is the new pipeline.

Permissions. Write on the pipelines object type, write on the text splitter named in default_text_splitter_id and, when the request names one, write on the embedding model.

See Pipelines.

Request​

Responses​

The pipeline was created. The body is the new pipeline, with its search indexes.