Skip to main content

Get Pipeline

GET 
/api/v1/pipelines/:pipeline_id

Get a pipeline by ID for a given project.

Request​

Path Parameters

    pipeline_id uuidrequired

Cookie Parameters

    session any

Responses​

Successful Response

Schema

    id uuidrequired

    Unique identifier

    created_at

    object

    Creation datetime

    anyOf

    string

    updated_at

    object

    Update datetime

    anyOf

    string

    name Name (string)required
    project_id uuidrequired
    pipeline_type PipelineType (string)

    Possible values: [PLAYGROUND, MANAGED]

    Default value: MANAGED

    Enum for representing the type of a pipeline

    managed_pipeline_id

    object

    The ID of the ManagedPipeline this playground pipeline is linked to.

    anyOf

    string

    embedding_config

    object

    required

    oneOf

    type Type (string)

    Possible values: [AZURE_EMBEDDING]

    Default value: AZURE_EMBEDDING

    Type of the embedding model.

    component

    object

    Configuration for the Azure OpenAI embedding model.

    model_name Model Name (string)

    Default value: text-embedding-ada-002

    The name of the OpenAI embedding model.

    embed_batch_size Embed Batch Size (integer)

    Possible values: > 0 and <= 2048

    Default value: 10

    The batch size for embedding calls.

    num_workers

    object

    The number of workers to use for async embedding calls.

    anyOf

    integer

    additional_kwargs object

    Additional kwargs for the OpenAI API.

    api_key

    object

    The OpenAI API key.

    anyOf

    string

    api_base Api Base (string)

    The base URL for Azure deployment.

    api_version Api Version (string)

    The version for Azure OpenAI API.

    max_retries Max Retries (integer)

    Default value: 10

    Maximum number of retries.

    timeout Timeout (number)

    Default value: 60

    Timeout for each request.

    default_headers

    object

    The default headers for API requests.

    anyOf

    reuse_client Reuse Client (boolean)

    Default value: true

    Reuse the OpenAI client between requests. When doing anything with large volumes of async API calls, setting this to false can improve stability.

    dimensions

    object

    The number of dimensions on the output embedding vectors. Works only with v3 embedding models.

    anyOf

    integer

    azure_endpoint

    object

    The Azure endpoint to use.

    anyOf

    string

    azure_deployment

    object

    The Azure deployment to use.

    anyOf

    string

    class_name Class Name (string)

    Default value: AzureOpenAIEmbedding

    configured_transformations

    object[]

    Deprecated don't use it, List of configured transformations.

  • Array [

    • id uuid
    configurable_transformation_type ConfigurableTransformationNames (string)required

    Possible values: [CHARACTER_SPLITTER, PAGE_SPLITTER_NODE_PARSER, CODE_NODE_PARSER, SENTENCE_AWARE_NODE_PARSER, TOKEN_AWARE_NODE_PARSER, MARKDOWN_NODE_PARSER, MARKDOWN_ELEMENT_NODE_PARSER]

    Name for the type of transformation this is (e.g. SIMPLE_NODE_PARSER). Can also be an enum instance of llama_index.ingestion.transformations.ConfigurableTransformations. This will be converted to ConfigurableTransformationNames.

    component

    object

    required

    Component that implements the transformation

    anyOf

    include_metadata Include Metadata (boolean)

    Default value: true

    Whether or not to consider metadata when splitting.

    include_prev_next_rel Include Prev Next Rel (boolean)

    Default value: true

    Include prev/next node relationships.

    callback_manager Callback Manager

    id_func

    object

    Function to generate node IDs.

    anyOf

    string

    chunk_size Chunk Size (integer)

    Possible values: > 0

    Default value: 1024

    The token chunk size for each chunk.

    chunk_overlap Chunk Overlap (integer)

    Default value: 200

    The token overlap of each chunk when splitting.

    separator Separator (string)

    Default value:

    Default separator for splitting into words

    paragraph_separator Paragraph Separator (string)

    Default value: `

    `

    Separator between paragraphs.

    secondary_chunking_regex

    object

    Backup regex for splitting into sentences.

    anyOf

    string

    class_name Class Name (string)

    Default value: SentenceSplitter

  • ]

    • config_hash

    object

    Hashes for the configuration of the pipeline.

    anyOf

    embedding_config_hash

    object

    Hash of the embedding config.

    anyOf

    string

    parsing_config_hash

    object

    Hash of the llama parse parameters.

    anyOf

    string

    transform_config_hash

    object

    Hash of the transform config.

    anyOf

    string

    transform_config

    object

    Configuration for the transformation.

    anyOf

    mode Mode (string)

    Possible values: [auto]

    Default value: auto

    chunk_size Chunk Size (integer)

    Possible values: > 0

    Default value: 1024

    Chunk size for the transformation.

    chunk_overlap Chunk Overlap (integer)

    Default value: 200

    Chunk overlap for the transformation.

    preset_retrieval_parameters

    object

    Preset retrieval parameters for the pipeline.

    dense_similarity_top_k

    object

    Number of nodes for dense retrieval.

    anyOf

    integer

    Possible values: >= 1 and <= 100

    sparse_similarity_top_k

    object

    Number of nodes for sparse retrieval.

    anyOf

    integer

    Possible values: >= 1 and <= 100

    enable_reranking

    object

    Enable reranking for retrieval

    anyOf

    boolean

    rerank_top_n

    object

    Number of reranked nodes for returning.

    anyOf

    integer

    Possible values: >= 1 and <= 100

    alpha

    object

    Alpha value for hybrid retrieval to determine the weights between dense and sparse retrieval. 0 is sparse retrieval and 1 is dense retrieval.

    anyOf

    number

    Possible values: <= 1

    search_filters

    object

    Search filters for retrieval.

    anyOf

    filters

    object[]

    required

  • Array [

    • anyOf

    key Key (string)required

    value

    object

    required

    anyOf

    integer

    operator FilterOperator (string)

    Possible values: [==, >, <, !=, >=, <=, in, nin, any, all, text_match, contains, is_empty]

    Default value: ==

    Vector store filter operator.

  • ]

    • condition

    object

    anyOf

    string

    Possible values: [and, or]

    files_top_k

    object

    Number of files to retrieve (only for retrieval mode files_via_metadata and files_via_content).

    anyOf

    integer

    Possible values: >= 1 and <= 5

    retrieval_mode RetrievalMode (string)

    Possible values: [chunks, files_via_metadata, files_via_content]

    Default value: chunks

    The retrieval mode for the query.

    retrieve_image_nodes Retrieve Image Nodes (boolean)

    Whether to retrieve image nodes.

    class_name Class Name (string)

    Default value: base_component

    eval_parameters

    object

    Eval parameters for the pipeline.

    llm_model SupportedLLMModelNames (string)

    Possible values: [GPT_3_5_TURBO, GPT_4, GPT_4_TURBO, GPT_4O, GPT_4O_MINI, AZURE_OPENAI]

    Default value: GPT_4O

    The LLM model to use within eval execution.

    qa_prompt_tmpl Qa Prompt Tmpl (string)

    Default value: `Context information is below.

    {context_str}

    Given the context information and not prior knowledge, answer the query. Query: {query_str} Answer: `

    The template to use for the question answering prompt.

    llama_parse_parameters

    object

    Settings that can be configured for how to use LlamaParse to parse files within a LlamaCloud pipeline.

    anyOf

    languages ParserLanguages (string)[]

    Possible values: [af, az, bs, cs, cy, da, de, en, es, et, fr, ga, hr, hu, id, is, it, ku, la, lt, lv, mi, ms, mt, nl, no, oc, pi, pl, pt, ro, rs_latin, sk, sl, sq, sv, sw, tl, tr, uz, vi, ar, fa, ug, ur, bn, as, mni, ru, rs_cyrillic, be, bg, uk, mn, abq, ady, kbd, ava, dar, inh, che, lbe, lez, tab, tjk, hi, mr, ne, bh, mai, ang, bho, mah, sck, new, gom, sa, bgc, th, ch_sim, ch_tra, ja, ko, ta, te, kn], >= 1

    parsing_instruction Parsing Instruction (string)
    disable_ocr Disable Ocr (boolean)
    disable_reconstruction Disable Reconstruction (boolean)
    invalidate_cache Invalidate Cache (boolean)
    do_not_cache Do Not Cache (boolean)
    fast_mode Fast Mode (boolean)

    Default value: true

    skip_diagonal_text Skip Diagonal Text (boolean)
    gpt4o_mode Gpt4O Mode (boolean)
    gpt4o_api_key Gpt4O Api Key (string)
    do_not_unroll_columns Do Not Unroll Columns (boolean)

    page_separator

    object

    anyOf

    string

    bounding_box Bounding Box (string)
    target_pages Target Pages (string)
    use_vendor_multimodal_model Use Vendor Multimodal Model (boolean)
    vendor_multimodal_model_name Vendor Multimodal Model Name (string)
    vendor_multimodal_api_key Vendor Multimodal Api Key (string)
    page_prefix Page Prefix (string)
    page_suffix Page Suffix (string)
    webhook_url Webhook Url (string)
    take_screenshot Take Screenshot (boolean)
    premium_mode Premium Mode (boolean)
    s3_input_path S3 Input Path (string)
    s3_output_path_prefix S3 Output Path Prefix (string)

    azure_openai_deployment_name

    object

    anyOf

    string

    azure_openai_endpoint

    object

    anyOf

    string

    azure_openai_api_version

    object

    anyOf

    string

    azure_openai_key

    object

    anyOf

    string

    data_sink

    object

    The data sink for the pipeline. If None, the pipeline will use the fully managed data sink.

    anyOf

    id uuidrequired

    Unique identifier

    created_at

    object

    Creation datetime

    anyOf

    string

    updated_at

    object

    Update datetime

    anyOf

    string

    name Name (string)required

    The name of the data sink.

    sink_type ConfigurableDataSinkNames (string)required

    Possible values: [PINECONE, POSTGRES, QDRANT, AZUREAI_SEARCH, MONGODB_ATLAS, MILVUS]

    component

    object

    required

    anyOf

    supports_nested_metadata_filters Supports Nested Metadata Filters (boolean)

    Possible values: [true]

    Default value: true

    index_name Index Name (string)required

    namespace

    object

    anyOf

    string

    insert_kwargs

    object

    anyOf

    class_name Class Name (string)

    Default value: CloudPineconeVectorStore

    project_id uuidrequired
Loading...