Get Pipeline
client.pipelines.get(stringpipelineID, RequestOptionsoptions?): Pipeline { id, embedding_config, name, 15 more }
GET/api/v1/pipelines/{pipeline_id}
Get a pipeline by ID for a given project.
Parameters
pipelineID: string
Returns
Get Pipeline
import LlamaCloud from '@llamaindex/llama-cloud';
const client = new LlamaCloud({
apiKey: process.env['LLAMA_CLOUD_API_KEY'], // This is the default and can be omitted
});
const pipeline = await client.pipelines.get('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e');
console.log(pipeline.id);{
"id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
"embedding_config": {
"component": {
"class_name": "class_name",
"embed_batch_size": 1,
"model_name": "openai-text-embedding-3-small",
"num_workers": 0
},
"type": "MANAGED_OPENAI_EMBEDDING"
},
"name": "name",
"project_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
"config_hash": {
"embedding_config_hash": "embedding_config_hash",
"parsing_config_hash": "parsing_config_hash",
"transform_config_hash": "transform_config_hash"
},
"created_at": "2019-12-27T18:11:19.117Z",
"data_sink": {
"id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
"component": {
"foo": "bar"
},
"name": "name",
"project_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
"sink_type": "PINECONE",
"created_at": "2019-12-27T18:11:19.117Z",
"updated_at": "2019-12-27T18:11:19.117Z"
},
"embedding_model_config": {
"id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
"embedding_config": {
"component": {
"additional_kwargs": {
"foo": "bar"
},
"api_base": "api_base",
"api_key": "api_key",
"api_version": "api_version",
"azure_deployment": "azure_deployment",
"azure_endpoint": "azure_endpoint",
"class_name": "class_name",
"default_headers": {
"foo": "string"
},
"dimensions": 0,
"embed_batch_size": 1,
"max_retries": 0,
"model_name": "model_name",
"num_workers": 0,
"reuse_client": true,
"timeout": 0
},
"type": "AZURE_EMBEDDING"
},
"name": "name",
"project_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
"created_at": "2019-12-27T18:11:19.117Z",
"updated_at": "2019-12-27T18:11:19.117Z"
},
"embedding_model_config_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
"llama_parse_parameters": {
"adaptive_long_table": true,
"aggressive_table_extraction": true,
"annotate_links": true,
"auto_mode": true,
"auto_mode_configuration_json": "auto_mode_configuration_json",
"auto_mode_trigger_on_image_in_page": true,
"auto_mode_trigger_on_regexp_in_page": "auto_mode_trigger_on_regexp_in_page",
"auto_mode_trigger_on_table_in_page": true,
"auto_mode_trigger_on_text_in_page": "auto_mode_trigger_on_text_in_page",
"azure_openai_api_version": "azure_openai_api_version",
"azure_openai_deployment_name": "azure_openai_deployment_name",
"azure_openai_endpoint": "azure_openai_endpoint",
"azure_openai_key": "azure_openai_key",
"bbox_bottom": 0,
"bbox_left": 0,
"bbox_right": 0,
"bbox_top": 0,
"bounding_box": "bounding_box",
"compact_markdown_table": true,
"complemental_formatting_instruction": "complemental_formatting_instruction",
"content_guideline_instruction": "content_guideline_instruction",
"continuous_mode": true,
"disable_image_extraction": true,
"disable_ocr": true,
"disable_reconstruction": true,
"do_not_cache": true,
"do_not_unroll_columns": true,
"enable_cost_optimizer": true,
"extract_charts": true,
"extract_layout": true,
"extract_printed_page_number": true,
"fast_mode": true,
"formatting_instruction": "formatting_instruction",
"gpt4o_api_key": "gpt4o_api_key",
"gpt4o_mode": true,
"guess_xlsx_sheet_name": true,
"hide_footers": true,
"hide_headers": true,
"high_res_ocr": true,
"html_make_all_elements_visible": true,
"html_remove_fixed_elements": true,
"html_remove_navigation_elements": true,
"http_proxy": "http_proxy",
"ignore_document_elements_for_layout_detection": true,
"images_to_save": [
"screenshot"
],
"inline_images_in_markdown": true,
"input_s3_path": "input_s3_path",
"input_s3_region": "input_s3_region",
"input_url": "input_url",
"internal_is_screenshot_job": true,
"invalidate_cache": true,
"is_formatting_instruction": true,
"job_timeout_extra_time_per_page_in_seconds": 0,
"job_timeout_in_seconds": 0,
"keep_page_separator_when_merging_tables": true,
"languages": [
"af"
],
"layout_aware": true,
"line_level_bounding_box": true,
"markdown_table_multiline_header_separator": "markdown_table_multiline_header_separator",
"max_pages": 0,
"max_pages_enforced": 0,
"merge_tables_across_pages_in_markdown": true,
"model": "model",
"outlined_table_extraction": true,
"output_pdf_of_document": true,
"output_s3_path_prefix": "output_s3_path_prefix",
"output_s3_region": "output_s3_region",
"output_tables_as_HTML": true,
"page_error_tolerance": 0,
"page_footer_prefix": "page_footer_prefix",
"page_footer_suffix": "page_footer_suffix",
"page_header_prefix": "page_header_prefix",
"page_header_suffix": "page_header_suffix",
"page_prefix": "page_prefix",
"page_separator": "page_separator",
"page_suffix": "page_suffix",
"parse_mode": "parse_page_without_llm",
"parsing_instruction": "parsing_instruction",
"precise_bounding_box": true,
"premium_mode": true,
"presentation_out_of_bounds_content": true,
"presentation_skip_embedded_data": true,
"preserve_layout_alignment_across_pages": true,
"preserve_very_small_text": true,
"preset": "preset",
"priority": "low",
"project_id": "project_id",
"remove_hidden_text": true,
"replace_failed_page_mode": "raw_text",
"replace_failed_page_with_error_message_prefix": "replace_failed_page_with_error_message_prefix",
"replace_failed_page_with_error_message_suffix": "replace_failed_page_with_error_message_suffix",
"save_images": true,
"skip_diagonal_text": true,
"specialized_chart_parsing_agentic": true,
"specialized_chart_parsing_efficient": true,
"specialized_chart_parsing_plus": true,
"specialized_image_parsing": true,
"spreadsheet_extract_sub_tables": true,
"spreadsheet_force_formula_computation": true,
"strict_mode_buggy_font": true,
"strict_mode_image_extraction": true,
"strict_mode_image_ocr": true,
"strict_mode_reconstruction": true,
"structured_output": true,
"structured_output_json_schema": "structured_output_json_schema",
"structured_output_json_schema_name": "structured_output_json_schema_name",
"system_prompt": "system_prompt",
"system_prompt_append": "system_prompt_append",
"take_screenshot": true,
"target_pages": "target_pages",
"tier": "tier",
"use_vendor_multimodal_model": true,
"user_prompt": "user_prompt",
"vendor_multimodal_api_key": "vendor_multimodal_api_key",
"vendor_multimodal_model_name": "vendor_multimodal_model_name",
"version": "version",
"webhook_configurations": [
{
"webhook_events": [
"extract.pending"
],
"webhook_headers": {
"foo": "string"
},
"webhook_output_format": "webhook_output_format",
"webhook_url": "webhook_url"
}
],
"webhook_url": "webhook_url"
},
"managed_pipeline_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
"metadata_config": {
"excluded_embed_metadata_keys": [
"string"
],
"excluded_llm_metadata_keys": [
"string"
]
},
"pipeline_type": "PLAYGROUND",
"preset_retrieval_parameters": {
"alpha": 0,
"class_name": "class_name",
"dense_similarity_cutoff": 0,
"dense_similarity_top_k": 1,
"enable_reranking": true,
"files_top_k": 1,
"rerank_top_n": 1,
"retrieval_mode": "chunks",
"retrieve_image_nodes": true,
"retrieve_page_figure_nodes": true,
"retrieve_page_screenshot_nodes": true,
"search_filters": {
"filters": [
{
"key": "key",
"value": 0,
"operator": "=="
}
],
"condition": "and"
},
"search_filters_inference_schema": {
"foo": {
"foo": "bar"
}
},
"sparse_similarity_top_k": 1
},
"sparse_model_config": {
"class_name": "class_name",
"model_type": "splade"
},
"status": "CREATED",
"transform_config": {
"chunk_overlap": 0,
"chunk_size": 1,
"mode": "auto"
},
"updated_at": "2019-12-27T18:11:19.117Z"
}Returns Examples
{
"id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
"embedding_config": {
"component": {
"class_name": "class_name",
"embed_batch_size": 1,
"model_name": "openai-text-embedding-3-small",
"num_workers": 0
},
"type": "MANAGED_OPENAI_EMBEDDING"
},
"name": "name",
"project_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
"config_hash": {
"embedding_config_hash": "embedding_config_hash",
"parsing_config_hash": "parsing_config_hash",
"transform_config_hash": "transform_config_hash"
},
"created_at": "2019-12-27T18:11:19.117Z",
"data_sink": {
"id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
"component": {
"foo": "bar"
},
"name": "name",
"project_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
"sink_type": "PINECONE",
"created_at": "2019-12-27T18:11:19.117Z",
"updated_at": "2019-12-27T18:11:19.117Z"
},
"embedding_model_config": {
"id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
"embedding_config": {
"component": {
"additional_kwargs": {
"foo": "bar"
},
"api_base": "api_base",
"api_key": "api_key",
"api_version": "api_version",
"azure_deployment": "azure_deployment",
"azure_endpoint": "azure_endpoint",
"class_name": "class_name",
"default_headers": {
"foo": "string"
},
"dimensions": 0,
"embed_batch_size": 1,
"max_retries": 0,
"model_name": "model_name",
"num_workers": 0,
"reuse_client": true,
"timeout": 0
},
"type": "AZURE_EMBEDDING"
},
"name": "name",
"project_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
"created_at": "2019-12-27T18:11:19.117Z",
"updated_at": "2019-12-27T18:11:19.117Z"
},
"embedding_model_config_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
"llama_parse_parameters": {
"adaptive_long_table": true,
"aggressive_table_extraction": true,
"annotate_links": true,
"auto_mode": true,
"auto_mode_configuration_json": "auto_mode_configuration_json",
"auto_mode_trigger_on_image_in_page": true,
"auto_mode_trigger_on_regexp_in_page": "auto_mode_trigger_on_regexp_in_page",
"auto_mode_trigger_on_table_in_page": true,
"auto_mode_trigger_on_text_in_page": "auto_mode_trigger_on_text_in_page",
"azure_openai_api_version": "azure_openai_api_version",
"azure_openai_deployment_name": "azure_openai_deployment_name",
"azure_openai_endpoint": "azure_openai_endpoint",
"azure_openai_key": "azure_openai_key",
"bbox_bottom": 0,
"bbox_left": 0,
"bbox_right": 0,
"bbox_top": 0,
"bounding_box": "bounding_box",
"compact_markdown_table": true,
"complemental_formatting_instruction": "complemental_formatting_instruction",
"content_guideline_instruction": "content_guideline_instruction",
"continuous_mode": true,
"disable_image_extraction": true,
"disable_ocr": true,
"disable_reconstruction": true,
"do_not_cache": true,
"do_not_unroll_columns": true,
"enable_cost_optimizer": true,
"extract_charts": true,
"extract_layout": true,
"extract_printed_page_number": true,
"fast_mode": true,
"formatting_instruction": "formatting_instruction",
"gpt4o_api_key": "gpt4o_api_key",
"gpt4o_mode": true,
"guess_xlsx_sheet_name": true,
"hide_footers": true,
"hide_headers": true,
"high_res_ocr": true,
"html_make_all_elements_visible": true,
"html_remove_fixed_elements": true,
"html_remove_navigation_elements": true,
"http_proxy": "http_proxy",
"ignore_document_elements_for_layout_detection": true,
"images_to_save": [
"screenshot"
],
"inline_images_in_markdown": true,
"input_s3_path": "input_s3_path",
"input_s3_region": "input_s3_region",
"input_url": "input_url",
"internal_is_screenshot_job": true,
"invalidate_cache": true,
"is_formatting_instruction": true,
"job_timeout_extra_time_per_page_in_seconds": 0,
"job_timeout_in_seconds": 0,
"keep_page_separator_when_merging_tables": true,
"languages": [
"af"
],
"layout_aware": true,
"line_level_bounding_box": true,
"markdown_table_multiline_header_separator": "markdown_table_multiline_header_separator",
"max_pages": 0,
"max_pages_enforced": 0,
"merge_tables_across_pages_in_markdown": true,
"model": "model",
"outlined_table_extraction": true,
"output_pdf_of_document": true,
"output_s3_path_prefix": "output_s3_path_prefix",
"output_s3_region": "output_s3_region",
"output_tables_as_HTML": true,
"page_error_tolerance": 0,
"page_footer_prefix": "page_footer_prefix",
"page_footer_suffix": "page_footer_suffix",
"page_header_prefix": "page_header_prefix",
"page_header_suffix": "page_header_suffix",
"page_prefix": "page_prefix",
"page_separator": "page_separator",
"page_suffix": "page_suffix",
"parse_mode": "parse_page_without_llm",
"parsing_instruction": "parsing_instruction",
"precise_bounding_box": true,
"premium_mode": true,
"presentation_out_of_bounds_content": true,
"presentation_skip_embedded_data": true,
"preserve_layout_alignment_across_pages": true,
"preserve_very_small_text": true,
"preset": "preset",
"priority": "low",
"project_id": "project_id",
"remove_hidden_text": true,
"replace_failed_page_mode": "raw_text",
"replace_failed_page_with_error_message_prefix": "replace_failed_page_with_error_message_prefix",
"replace_failed_page_with_error_message_suffix": "replace_failed_page_with_error_message_suffix",
"save_images": true,
"skip_diagonal_text": true,
"specialized_chart_parsing_agentic": true,
"specialized_chart_parsing_efficient": true,
"specialized_chart_parsing_plus": true,
"specialized_image_parsing": true,
"spreadsheet_extract_sub_tables": true,
"spreadsheet_force_formula_computation": true,
"strict_mode_buggy_font": true,
"strict_mode_image_extraction": true,
"strict_mode_image_ocr": true,
"strict_mode_reconstruction": true,
"structured_output": true,
"structured_output_json_schema": "structured_output_json_schema",
"structured_output_json_schema_name": "structured_output_json_schema_name",
"system_prompt": "system_prompt",
"system_prompt_append": "system_prompt_append",
"take_screenshot": true,
"target_pages": "target_pages",
"tier": "tier",
"use_vendor_multimodal_model": true,
"user_prompt": "user_prompt",
"vendor_multimodal_api_key": "vendor_multimodal_api_key",
"vendor_multimodal_model_name": "vendor_multimodal_model_name",
"version": "version",
"webhook_configurations": [
{
"webhook_events": [
"extract.pending"
],
"webhook_headers": {
"foo": "string"
},
"webhook_output_format": "webhook_output_format",
"webhook_url": "webhook_url"
}
],
"webhook_url": "webhook_url"
},
"managed_pipeline_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
"metadata_config": {
"excluded_embed_metadata_keys": [
"string"
],
"excluded_llm_metadata_keys": [
"string"
]
},
"pipeline_type": "PLAYGROUND",
"preset_retrieval_parameters": {
"alpha": 0,
"class_name": "class_name",
"dense_similarity_cutoff": 0,
"dense_similarity_top_k": 1,
"enable_reranking": true,
"files_top_k": 1,
"rerank_top_n": 1,
"retrieval_mode": "chunks",
"retrieve_image_nodes": true,
"retrieve_page_figure_nodes": true,
"retrieve_page_screenshot_nodes": true,
"search_filters": {
"filters": [
{
"key": "key",
"value": 0,
"operator": "=="
}
],
"condition": "and"
},
"search_filters_inference_schema": {
"foo": {
"foo": "bar"
}
},
"sparse_similarity_top_k": 1
},
"sparse_model_config": {
"class_name": "class_name",
"model_type": "splade"
},
"status": "CREATED",
"transform_config": {
"chunk_overlap": 0,
"chunk_size": 1,
"mode": "auto"
},
"updated_at": "2019-12-27T18:11:19.117Z"
}