> ## Documentation Index > Fetch the complete documentation index at: https://docs.noxus.ai/llms.txt > Use this file to discover all available pages before exploring further. # Update Knowledge Base > Update a knowledge base ## OpenAPI ````yaml patch /v1/knowledge-bases/{knowledge_base_id} openapi: 3.1.0 info: title: Noxus Backend description: >- Backend API for the Noxus Platform. More information can be found at https://docs.noxus.ai version: 1.1.0 servers: [] security: [] paths: /v1/knowledge-bases/{knowledge_base_id}: patch: tags: - V1 - Knowledge Bases summary: Update Knowledge Base V2 operationId: update_knowledge_base_v2 parameters: - name: knowledge_base_id in: path required: true schema: type: string title: Knowledge Base Id requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/UpdateKnowledgeBase' responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/KnowledgeBaseV2' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] components: schemas: UpdateKnowledgeBase: properties: name: anyOf: - type: string - type: 'null' title: Name description: anyOf: - type: string - type: 'null' title: Description status: anyOf: - $ref: '#/components/schemas/TrainStatus' - type: 'null' document_types: anyOf: - items: type: string type: array - type: 'null' title: Document Types kb_type: anyOf: - $ref: '#/components/schemas/KBType' - type: 'null' error: anyOf: - additionalProperties: true type: object - type: 'null' title: Error summary: anyOf: - type: string - type: 'null' title: Summary summary_embedding: anyOf: - items: type: number type: array - type: 'null' title: Summary Embedding needs_summary_update: anyOf: - type: boolean - type: 'null' title: Needs Summary Update settings_: anyOf: - $ref: '#/components/schemas/KnowledgeBaseSettings-Input' - $ref: '#/components/schemas/KBConfig' - type: 'null' title: Settings version: anyOf: - type: string - type: 'null' title: Version meta: anyOf: - additionalProperties: true type: object - type: 'null' title: Meta type: object title: UpdateKnowledgeBase KnowledgeBaseV2: properties: id: type: string format: uuid title: Id group_id: type: string format: uuid title: Group Id name: type: string title: Name status: $ref: '#/components/schemas/TrainStatus' description: type: string title: Description document_types: items: type: string type: array title: Document Types kb_type: $ref: '#/components/schemas/KBType' size: type: number title: Size num_docs: type: integer title: Num Docs created_at: type: string format: date-time title: Created At updated_at: type: string format: date-time title: Updated At error: anyOf: - additionalProperties: true type: object - type: 'null' title: Error version: type: string enum: - v2 - v3 title: Version meta: anyOf: - additionalProperties: true type: object - type: 'null' title: Meta total_documents: type: integer title: Total Documents training_documents: type: integer title: Training Documents trained_documents: type: integer title: Trained Documents error_documents: type: integer title: Error Documents uploaded_documents: type: integer title: Uploaded Documents source_types: additionalProperties: type: integer propertyNames: $ref: '#/components/schemas/SourceType' type: object title: Source Types training_source_types: items: $ref: '#/components/schemas/SourceType' type: array title: Training Source Types settings_: anyOf: - $ref: '#/components/schemas/KBConfig' - $ref: '#/components/schemas/KnowledgeBaseSettings-Output' - type: 'null' title: Settings type: object required: - id - group_id - name - status - description - document_types - kb_type - size - num_docs - created_at - updated_at - error - version - total_documents - training_documents - trained_documents - error_documents - uploaded_documents - source_types - training_source_types title: KnowledgeBaseV2 HTTPValidationError: properties: detail: items: $ref: '#/components/schemas/ValidationError' type: array title: Detail type: object title: HTTPValidationError TrainStatus: type: string enum: - created - trained - training - error title: TrainStatus KBType: type: string enum: - temporary - entity title: KBType KnowledgeBaseSettings-Input: properties: allowed_sources: items: $ref: '#/components/schemas/SourceType' type: array title: Allowed Sources default: - Document - Google Drive - OneDrive - Website ingestion: $ref: '#/components/schemas/IngestionSettings-Input' default: batch_size: 8 default_chunk_size: 1024 default_chunk_overlap: 256 enrich_chunks_mode: inject_summary enrich_pre_made_qa: false methods: application/csv: auto_detect_delimiter: true chunk_overlap: 256 chunk_size: 1024 encoding: utf-8 enrich_chunks_mode: inject_summary extract_qa_pairs: false include_headers: true row_as_document: true supported_mime_types: - text/csv - application/csv type: csv application/pdf: chunk_overlap: 256 chunk_size: 1024 enrich_chunks_mode: inject_summary extract_images: true extract_qa_pairs: false supported_mime_types: - application/pdf - >- application/vnd.openxmlformats-officedocument.wordprocessingml.document - >- application/vnd.openxmlformats-officedocument.presentationml.presentation - application/msword - application/vnd.ms-powerpoint type: pdf default: chunk_size: 1024 chunk_overlap: 256 enrich_chunks_mode: inject_summary extract_qa_pairs: false type: default supported_mime_types: - text/plain - text/html - text/markdown - application/json - application/xml - text/xml - application/rtf image/*: supported_mime_types: - image/jpeg - image/png - image/tiff - image/bmp type: image message/rfc822: chunk_overlap: 256 chunk_size: 1024 enrich_chunks_mode: inject_summary extract_qa_pairs: false extract_text_only: true include_images: false include_tables: true supported_mime_types: - message/rfc822 type: email text/csv: auto_detect_delimiter: true chunk_overlap: 256 chunk_size: 1024 encoding: utf-8 enrich_chunks_mode: inject_summary extract_qa_pairs: false include_headers: true row_as_document: true supported_mime_types: - text/csv - application/csv type: csv text/html: chunk_overlap: 256 chunk_size: 1024 enrich_chunks_mode: inject_summary extract_qa_pairs: false extract_text_only: true include_images: false include_tables: true supported_mime_types: - text/html type: html text/plain: chunk_overlap: 256 chunk_size: 1024 chunking: true enrich_chunks_mode: inject_summary extract_qa_pairs: false preserve_formatting: true supported_mime_types: - text/plain - text/html - text/markdown - application/json - application/xml - text/xml - application/rtf type: text retrieval: oneOf: - $ref: '#/components/schemas/FullTextSearchMethod' - $ref: '#/components/schemas/SemanticSearchMethod' - $ref: '#/components/schemas/HybridSearchMethod' - $ref: '#/components/schemas/RRFHybridMethod' - $ref: '#/components/schemas/HybridRerankingSettings-Input' title: Retrieval default: type: hybrid_reranking hybrid_settings: fts_weight: 0.7 full_text_search: top_k: 25 type: full_text_search semantic_search: sets_threshold: false threshold: 0 top_k: 25 type: semantic semantic_weight: 0.3 threshold: 0 type: hybrid_relative_score reranker_settings: model_name: semantic-ranker-512@latest ranking_config: default_ranking_config sets_threshold: false threshold: 0 top_k: 10 type: vertex discriminator: propertyName: type mapping: full_text_search: $ref: '#/components/schemas/FullTextSearchMethod' hybrid_relative_score: $ref: '#/components/schemas/HybridSearchMethod' hybrid_reranking: $ref: '#/components/schemas/HybridRerankingSettings-Input' hybrid_rrf: $ref: '#/components/schemas/RRFHybridMethod' semantic: $ref: '#/components/schemas/SemanticSearchMethod' embeddings: $ref: '#/components/schemas/EmbeddingsSettings' default: text_model: vertexai/text-multilingual-embedding-002 mm_model: vertexai/multimodalembedding@001 type: object title: KnowledgeBaseSettings KBConfig: properties: retrieval_info: type: string title: Retrieval Info description: Information about retrieval settings default: '' display: col_span: 12 is_disabled: false is_subconfig: false label: '' needs_confirmation: false show_optional_label: false small_text: >- Configure how documents are retrieved from your Knowledge Base. These settings set the defaults when using a specific retrieval method. title: Retrieval settings type: ui_text_display tab: Retrieval tool_mode: hidden retrieval_method: type: string title: Retrieval Method default: hybrid_relative_score display: col_span: 12 is_clearable: false is_disabled: false is_horizontal: false is_searchable: true is_subconfig: false label: Retrieval method needs_confirmation: false show_optional_label: false type: select values: - description: Uses vector embeddings for meaning-based search label: Semantic search value: semantic - description: Traditional keyword-based search with ranking label: Keyword search value: full_text_search - description: Combines semantic and keyword search with score fusion label: Hybrid search value: hybrid_relative_score - description: Hybrid search followed by AI-powered reranking label: Hybrid with reranking value: hybrid_reranking - description: Combines semantic and keyword search with RRF score fusion label: RRF hybrid search value: hybrid_rrf rules: - type: sets_connector_or_config_visibility tab: Retrieval tool_mode: hidden retrieval_top_k: type: integer title: Retrieval Top K description: Maximum number of results to return default: 25 display: col_span: 12 hide_number: true is_disabled: false is_subconfig: false label: Max results max: 100 min: 1 needs_confirmation: false show_optional_label: false step: 1 type: number_slider tab: Retrieval tool_mode: hidden fts_weight: type: number title: Fts Weight description: Weight for keyword search in hybrid methods default: 0.7 display: col_span: 12 hide_number: true is_disabled: false is_subconfig: false label: Keyword search weight max: 1 min: 0 needs_confirmation: false show_optional_label: false step: 0.1 type: number_slider rules: - conds: - config_source: retrieval_method type: visible_if value: hybrid_relative_score - config_source: retrieval_method type: visible_if value: hybrid_reranking mode: or type: visible_if_group tab: Retrieval tool_mode: hidden semantic_weight: type: number title: Semantic Weight description: Weight for semantic search in hybrid methods default: 0.3 display: col_span: 12 hide_number: true is_disabled: false is_subconfig: false label: Semantic search weight max: 1 min: 0 needs_confirmation: false show_optional_label: false step: 0.1 type: number_slider rules: - conds: - config_source: retrieval_method type: visible_if value: hybrid_relative_score - config_source: retrieval_method type: visible_if value: hybrid_reranking mode: or type: visible_if_group tab: Retrieval tool_mode: hidden rrf_k: type: integer title: Rrf K description: RRF constant k - higher values reduce the impact of rank differences default: 60 display: col_span: 12 hide_number: true is_disabled: false is_subconfig: false label: RRF constant (k) max: 200 min: 1 needs_confirmation: false show_optional_label: false step: 1 type: number_slider rules: - config_source: retrieval_method type: visible_if value: hybrid_rrf tab: Retrieval tool_mode: hidden threshold_enabled: type: boolean title: Threshold Enabled description: >- The system will only return results with a score above the defined threshold. default: false display: col_span: 12 is_disabled: false is_subconfig: false label: Enable score threshold needs_confirmation: false show_optional_label: false type: toggle tab: Retrieval tool_mode: hidden visible: false threshold: type: number title: Threshold description: Minimum score threshold for results default: 0 display: col_span: 12 hide_number: true is_disabled: false is_subconfig: false label: Score threshold max: 1 min: 0 needs_confirmation: false show_optional_label: false step: 0.01 type: number_slider rules: - config_source: threshold_enabled type: visible_if value: true tab: Retrieval tool_mode: hidden reranker_type: type: string title: Reranker Type description: The reranking method to use after initial retrieval default: vertex display: col_span: 12 is_clearable: false is_disabled: false is_horizontal: false is_searchable: true is_subconfig: false label: Reranker type needs_confirmation: false show_optional_label: false type: select values: - description: Google's semantic ranking service label: Vertex AI reranker value: vertex rules: - config_source: retrieval_method type: visible_if value: hybrid_reranking - type: sets_connector_or_config_visibility tab: Retrieval tool_mode: hidden reranker_top_k: type: integer title: Reranker Top K description: Number of results to return from reranker default: 10 display: col_span: 12 hide_number: true is_disabled: false is_subconfig: false label: Reranker top k max: 25 min: 1 needs_confirmation: false show_optional_label: false step: 1 type: number_slider rules: - config_source: retrieval_method type: visible_if value: hybrid_reranking tab: Retrieval tool_mode: hidden reranker_threshold_enabled: type: boolean title: Reranker Threshold Enabled description: Enable minimum score threshold for reranker default: false display: col_span: 12 is_disabled: false is_subconfig: false label: Enable reranker score threshold needs_confirmation: false show_optional_label: false type: toggle rules: - config_source: retrieval_method type: visible_if value: hybrid_reranking tab: Retrieval tool_mode: hidden reranker_threshold: type: number title: Reranker Threshold description: Minimum score threshold for reranker results default: 0 display: col_span: 12 hide_number: true is_disabled: false is_subconfig: false label: Reranker score threshold max: 1 min: 0 needs_confirmation: false show_optional_label: false step: 0.01 type: number_slider rules: - conds: - config_source: retrieval_method type: visible_if value: hybrid_reranking - config_source: reranker_threshold_enabled type: visible_if value: true mode: and type: visible_if_group tab: Retrieval tool_mode: hidden vertex_model: type: string title: Vertex Model description: Vertex AI ranking model to use default: semantic-ranker-512@latest display: col_span: 12 is_clearable: false is_disabled: false is_horizontal: false is_searchable: true is_subconfig: false label: Vertex model needs_confirmation: false show_optional_label: false type: select values: - label: Semantic ranker 512 value: semantic-ranker-512@latest rules: - conds: - config_source: reranker_type type: visible_if value: vertex - config_source: retrieval_method type: visible_if value: hybrid_reranking mode: and type: visible_if_group tab: Retrieval tool_mode: hidden ingestion_info: type: string title: Ingestion Info description: Information about ingestion settings default: '' display: col_span: 12 is_disabled: false is_subconfig: false label: '' needs_confirmation: false show_optional_label: false small_text: >- Configure how documents are processed and stored in your Knowledge Base. These settings control chunking, enrichment, and file-specific processing options. title: Ingestion settings type: ui_text_display optional: true tab: Ingestion tool_mode: hidden embedding_model: items: type: string type: array title: Embedding Model description: The model to use for embedding documents default: - vertexai/text-multilingual-embedding-002 display: col_span: 12 endpoint: /models/embeddings hide_disabled_models: true is_disabled: false is_subconfig: false label: Embedding model layout: side_by_side model_limit: 1 model_type: embeddings needs_confirmation: false show_inline_presets: false show_optional_label: false show_presets: false type: model_select tab: Ingestion tool_mode: hidden mm_embedding_model: items: type: string type: array title: Mm Embedding Model description: The model to use for embedding documents default: - vertexai/multimodalembedding display: col_span: 12 endpoint: /models/embeddings?multimodal=true hide_disabled_models: true is_disabled: false is_subconfig: false label: Embedding model layout: side_by_side model_limit: 3 model_type: embeddings needs_confirmation: false show_inline_presets: false show_optional_label: false show_presets: false type: model_select tab: Ingestion tool_mode: hidden visible: false batch_size: type: integer title: Batch Size description: Number of documents to process in each batch default: 8 display: col_span: 12 hide_number: true is_disabled: false is_subconfig: false label: Batch size max: 32 min: 1 needs_confirmation: false show_optional_label: false step: 1 type: number_slider tab: Ingestion tool_mode: hidden visible: false default_chunk_size: type: integer title: Default Chunk Size description: Default size for text chunks in characters default: 2048 display: col_span: 12 hide_number: true is_disabled: false is_subconfig: false label: Default chunk size max: 4096 min: 256 needs_confirmation: false show_optional_label: false step: 256 type: number_slider tab: Ingestion tool_mode: hidden default_chunk_overlap: type: integer title: Default Chunk Overlap description: Default overlap between chunks in characters default: 512 display: col_span: 12 hide_number: true is_disabled: false is_subconfig: false label: Default chunk overlap max: 1024 min: 0 needs_confirmation: false show_optional_label: false step: 64 type: number_slider tab: Ingestion tool_mode: hidden enrich_chunks_mode: type: string title: Enrich Chunks Mode description: How to enrich chunks with additional context default: inject_summary display: col_span: 12 is_clearable: false is_disabled: false is_horizontal: false is_searchable: true is_subconfig: false label: Chunk enrichment mode needs_confirmation: false show_optional_label: false type: select values: - description: Add document summary to each chunk for better context label: Inject summary value: inject_summary - description: Generate contextual information for each chunk label: Contextual value: contextual tab: Ingestion tool_mode: hidden visible: false enrich_pre_made_qa: type: boolean title: Enrich Pre Made Qa description: Generate Q&A pairs from the document content default: false display: col_span: 12 is_disabled: false is_subconfig: false label: Generate Q&A pairs needs_confirmation: false show_optional_label: false type: toggle tab: Ingestion tool_mode: hidden visible: false pdf_info: type: string title: Pdf Info description: PDF-specific processing settings default: '' accordion: PDF Options display: col_span: 12 is_disabled: false is_subconfig: false label: '' needs_confirmation: false show_optional_label: false small_text: >- Configure settings specific to PDF document processing including OCR, image extraction, and chunking parameters. title: PDF Processing type: ui_text_display optional: true tab: Ingestion tool_mode: hidden visible: false pdf_extract_images: type: boolean title: Pdf Extract Images description: Extract and process images from PDF files default: true accordion: PDF Options display: col_span: 12 is_disabled: false is_subconfig: false label: Extract images from PDFs needs_confirmation: false show_optional_label: false type: toggle tab: Ingestion tool_mode: hidden visible: false pdf_chunk_size: type: integer title: Pdf Chunk Size description: Chunk size for PDF documents default: 1024 accordion: PDF Options display: col_span: 12 hide_number: true is_disabled: false is_subconfig: false label: PDF chunk size max: 4096 min: 256 needs_confirmation: false show_optional_label: false step: 256 type: number_slider tab: Ingestion tool_mode: hidden visible: false pdf_chunk_overlap: type: integer title: Pdf Chunk Overlap description: Chunk overlap for PDF documents default: 256 accordion: PDF Options display: col_span: 12 hide_number: true is_disabled: false is_subconfig: false label: PDF chunk overlap max: 1024 min: 0 needs_confirmation: false show_optional_label: false step: 64 type: number_slider tab: Ingestion tool_mode: hidden visible: false pdf_ocr_enabled: type: boolean title: Pdf Ocr Enabled description: Enable OCR processing for scanned PDFs default: false accordion: PDF Options display: col_span: 12 is_disabled: false is_subconfig: false label: Enable OCR needs_confirmation: false show_optional_label: false type: toggle rules: - type: sets_connector_or_config_visibility tab: Ingestion tool_mode: hidden visible: false pdf_ocr_confidence: type: number title: Pdf Ocr Confidence description: Minimum confidence threshold for OCR text recognition default: 0.7 accordion: PDF Options display: col_span: 12 hide_number: true is_disabled: false is_subconfig: false label: OCR confidence threshold max: 1 min: 0.1 needs_confirmation: false show_optional_label: false step: 0.1 type: number_slider rules: - config_source: pdf_ocr_enabled type: visible_if value: true tab: Ingestion tool_mode: hidden visible: false pdf_ocr_language: type: string title: Pdf Ocr Language description: Language hint for OCR processing default: auto accordion: PDF Options display: col_span: 12 is_clearable: false is_disabled: false is_horizontal: false is_searchable: true is_subconfig: false label: OCR language needs_confirmation: false show_optional_label: false type: select values: - label: Auto-detect value: auto - label: English value: en - label: Spanish value: es - label: French value: fr - label: German value: de - label: Portuguese value: pt - label: Chinese value: zh - label: Japanese value: ja rules: - config_source: pdf_ocr_enabled type: visible_if value: true tab: Ingestion tool_mode: hidden visible: false text_info: type: string title: Text Info description: Text-specific processing settings default: '' accordion: Plain Text Options display: col_span: 12 is_disabled: false is_subconfig: false label: '' needs_confirmation: false show_optional_label: false small_text: >- Configure settings for plain text document processing including chunking and formatting options. title: Text Processing type: ui_text_display optional: true tab: Ingestion tool_mode: hidden visible: false text_chunking_enabled: type: boolean title: Text Chunking Enabled description: Enable automatic chunking for text files default: true accordion: Plain Text Options display: col_span: 12 is_disabled: false is_subconfig: false label: Enable text chunking needs_confirmation: false show_optional_label: false type: toggle rules: - type: sets_connector_or_config_visibility tab: Ingestion tool_mode: hidden visible: false text_chunk_size: type: integer title: Text Chunk Size description: Chunk size for text documents default: 1024 accordion: Plain Text Options display: col_span: 12 hide_number: true is_disabled: false is_subconfig: false label: Text chunk size max: 4096 min: 256 needs_confirmation: false show_optional_label: false step: 256 type: number_slider rules: - config_source: text_chunking_enabled type: visible_if value: true tab: Ingestion tool_mode: hidden visible: false text_chunk_overlap: type: integer title: Text Chunk Overlap description: Chunk overlap for text documents default: 256 accordion: Plain Text Options display: col_span: 12 hide_number: true is_disabled: false is_subconfig: false label: Text chunk overlap max: 1024 min: 0 needs_confirmation: false show_optional_label: false step: 64 type: number_slider rules: - config_source: text_chunking_enabled type: visible_if value: true tab: Ingestion tool_mode: hidden visible: false text_preserve_formatting: type: boolean title: Text Preserve Formatting description: Preserve original text formatting and structure default: true accordion: Plain Text Options display: col_span: 12 is_disabled: false is_subconfig: false label: Preserve formatting needs_confirmation: false show_optional_label: false type: toggle tab: Ingestion tool_mode: hidden visible: false html_info: type: string title: Html Info description: HTML-specific processing settings default: '' accordion: HTML Options display: col_span: 12 is_disabled: false is_subconfig: false label: '' needs_confirmation: false show_optional_label: false small_text: >- Configure settings for HTML document processing including content extraction and chunking parameters. title: HTML Processing type: ui_text_display optional: true tab: Ingestion tool_mode: hidden visible: false html_extract_text_only: type: boolean title: Html Extract Text Only description: Extract only text content from HTML default: true accordion: HTML Options display: col_span: 12 is_disabled: false is_subconfig: false label: Extract text only needs_confirmation: false show_optional_label: false type: toggle tab: Ingestion tool_mode: hidden visible: false html_include_tables: type: boolean title: Html Include Tables description: Include table content from HTML default: true accordion: HTML Options display: col_span: 12 is_disabled: false is_subconfig: false label: Include tables needs_confirmation: false show_optional_label: false type: toggle tab: Ingestion tool_mode: hidden visible: false html_include_images: type: boolean title: Html Include Images description: Include image references from HTML default: false accordion: HTML Options display: col_span: 12 is_disabled: false is_subconfig: false label: Include images needs_confirmation: false show_optional_label: false type: toggle tab: Ingestion tool_mode: hidden visible: false image_info: type: string title: Image Info description: Image-specific processing settings default: '' accordion: Image Options display: col_span: 12 is_disabled: false is_subconfig: false label: '' needs_confirmation: false show_optional_label: false small_text: >- Configure settings for image document processing including vision model settings and content extraction. title: Image processing type: ui_text_display optional: true tab: Ingestion tool_mode: hidden visible: false image_ocr_enabled: type: boolean title: Image Ocr Enabled description: Enable OCR processing for images default: false accordion: Image Options display: col_span: 12 is_disabled: false is_subconfig: false label: Enable OCR for images needs_confirmation: false show_optional_label: false type: toggle rules: - type: sets_connector_or_config_visibility tab: Ingestion tool_mode: hidden visible: false image_ocr_confidence: type: number title: Image Ocr Confidence description: Minimum confidence threshold for image OCR default: 0.7 accordion: Image Options display: col_span: 12 hide_number: true is_disabled: false is_subconfig: false label: Image OCR confidence max: 1 min: 0.1 needs_confirmation: false show_optional_label: false step: 0.1 type: number_slider rules: - config_source: image_ocr_enabled type: visible_if value: true tab: Ingestion tool_mode: hidden visible: false csv_row_as_document: type: boolean title: Csv Row As Document description: Treat each row as a separate chunk. default: true accordion: CSV ingestion options display: col_span: 12 is_disabled: false is_subconfig: false label: Row as chunk needs_confirmation: false show_optional_label: false type: toggle tab: Ingestion tool_mode: hidden csv_include_headers: type: boolean title: Csv Include Headers description: Include headers in the text representation default: true accordion: CSV ingestion options display: col_span: 12 is_disabled: false is_subconfig: false label: Include headers needs_confirmation: false show_optional_label: false type: toggle tab: Ingestion tool_mode: hidden visible: false csv_auto_detect_delimiter: type: boolean title: Csv Auto Detect Delimiter description: Automatically detect CSV delimiter default: true accordion: CSV ingestion options display: col_span: 12 is_disabled: false is_subconfig: false label: Auto-detect delimiter needs_confirmation: false show_optional_label: false type: toggle rules: - type: sets_connector_or_config_visibility tab: Ingestion tool_mode: hidden visible: false csv_delimiter: type: string title: Csv Delimiter description: Custom delimiter for CSV parsing default: ',' accordion: CSV ingestion options display: col_span: 12 is_clearable: false is_disabled: false is_horizontal: false is_searchable: true is_subconfig: false label: CSV delimiter needs_confirmation: false show_optional_label: false type: select values: - label: Comma (,) value: ',' - label: Semicolon (;) value: ; - label: Tab value: "\t" - label: Pipe (|) value: '|' rules: - config_source: csv_auto_detect_delimiter type: visible_if value: false tab: Ingestion tool_mode: hidden visible: false csv_encoding: type: string title: Csv Encoding description: File encoding for CSV files default: utf-8 accordion: CSV ingestion options display: col_span: 12 is_clearable: false is_disabled: false is_horizontal: false is_searchable: true is_subconfig: false label: CSV encoding needs_confirmation: false show_optional_label: false type: select values: - label: UTF-8 value: utf-8 - label: ASCII value: ascii - label: ISO-8859-1 value: iso-8859-1 - label: Windows-1252 value: cp1252 tab: Ingestion tool_mode: hidden visible: false type: object title: KBConfig SourceType: type: string enum: - Document - Google Drive - Notion - Website - OneDrive - Slack - Linear - Github - Teams - Sharepoint - ServiceNow - Custom title: SourceType KnowledgeBaseSettings-Output: properties: allowed_sources: items: $ref: '#/components/schemas/SourceType' type: array title: Allowed Sources default: - Document - Google Drive - OneDrive - Website ingestion: $ref: '#/components/schemas/IngestionSettings-Output' default: batch_size: 8 default_chunk_size: 1024 default_chunk_overlap: 256 enrich_chunks_mode: inject_summary enrich_pre_made_qa: false methods: application/csv: auto_detect_delimiter: true chunk_overlap: 256 chunk_size: 1024 encoding: utf-8 enrich_chunks_mode: inject_summary extract_qa_pairs: false include_headers: true row_as_document: true supported_mime_types: - text/csv - application/csv type: csv application/pdf: chunk_overlap: 256 chunk_size: 1024 enrich_chunks_mode: inject_summary extract_images: true extract_qa_pairs: false supported_mime_types: - application/pdf - >- application/vnd.openxmlformats-officedocument.wordprocessingml.document - >- application/vnd.openxmlformats-officedocument.presentationml.presentation - application/msword - application/vnd.ms-powerpoint type: pdf default: chunk_size: 1024 chunk_overlap: 256 enrich_chunks_mode: inject_summary extract_qa_pairs: false type: default supported_mime_types: - text/plain - text/html - text/markdown - application/json - application/xml - text/xml - application/rtf image/*: supported_mime_types: - image/jpeg - image/png - image/tiff - image/bmp type: image message/rfc822: chunk_overlap: 256 chunk_size: 1024 enrich_chunks_mode: inject_summary extract_qa_pairs: false extract_text_only: true include_images: false include_tables: true supported_mime_types: - message/rfc822 type: email text/csv: auto_detect_delimiter: true chunk_overlap: 256 chunk_size: 1024 encoding: utf-8 enrich_chunks_mode: inject_summary extract_qa_pairs: false include_headers: true row_as_document: true supported_mime_types: - text/csv - application/csv type: csv text/html: chunk_overlap: 256 chunk_size: 1024 enrich_chunks_mode: inject_summary extract_qa_pairs: false extract_text_only: true include_images: false include_tables: true supported_mime_types: - text/html type: html text/plain: chunk_overlap: 256 chunk_size: 1024 chunking: true enrich_chunks_mode: inject_summary extract_qa_pairs: false preserve_formatting: true supported_mime_types: - text/plain - text/html - text/markdown - application/json - application/xml - text/xml - application/rtf type: text retrieval: oneOf: - $ref: '#/components/schemas/FullTextSearchMethod' - $ref: '#/components/schemas/SemanticSearchMethod' - $ref: '#/components/schemas/HybridSearchMethod' - $ref: '#/components/schemas/RRFHybridMethod' - $ref: '#/components/schemas/HybridRerankingSettings-Output' title: Retrieval default: type: hybrid_reranking hybrid_settings: fts_weight: 0.7 full_text_search: top_k: 25 type: full_text_search semantic_search: sets_threshold: false threshold: 0 top_k: 25 type: semantic semantic_weight: 0.3 threshold: 0 type: hybrid_relative_score reranker_settings: model_name: semantic-ranker-512@latest ranking_config: default_ranking_config sets_threshold: false threshold: 0 top_k: 10 type: vertex discriminator: propertyName: type mapping: full_text_search: $ref: '#/components/schemas/FullTextSearchMethod' hybrid_relative_score: $ref: '#/components/schemas/HybridSearchMethod' hybrid_reranking: $ref: '#/components/schemas/HybridRerankingSettings-Output' hybrid_rrf: $ref: '#/components/schemas/RRFHybridMethod' semantic: $ref: '#/components/schemas/SemanticSearchMethod' embeddings: $ref: '#/components/schemas/EmbeddingsSettings' default: text_model: vertexai/text-multilingual-embedding-002 mm_model: vertexai/multimodalembedding@001 type: object title: KnowledgeBaseSettings ValidationError: properties: loc: items: anyOf: - type: string - type: integer type: array title: Location msg: type: string title: Message type: type: string title: Error Type type: object required: - loc - msg - type title: ValidationError IngestionSettings-Input: properties: batch_size: type: integer maximum: 128 minimum: 1 title: Batch Size default: 8 default_chunk_size: type: integer maximum: 4096 minimum: 1 title: Default Chunk Size default: 1024 default_chunk_overlap: type: integer maximum: 1024 minimum: 1 title: Default Chunk Overlap default: 256 enrich_chunks_mode: type: string enum: - inject_summary - contextual title: Enrich Chunks Mode default: inject_summary enrich_pre_made_qa: type: boolean title: Enrich Pre Made Qa default: false methods: additionalProperties: oneOf: - $ref: '#/components/schemas/DefaultIngestionMethod' - $ref: '#/components/schemas/PDFIngestionMethod' - $ref: '#/components/schemas/ImageIngestionMethod' - $ref: '#/components/schemas/HTMLIngestionMethod' - $ref: '#/components/schemas/TextIngestionMethod' - $ref: '#/components/schemas/CSVIngestionMethod' - $ref: '#/components/schemas/EmailIngestionMethod' discriminator: propertyName: type mapping: csv: $ref: '#/components/schemas/CSVIngestionMethod' default: $ref: '#/components/schemas/DefaultIngestionMethod' email: $ref: '#/components/schemas/EmailIngestionMethod' html: $ref: '#/components/schemas/HTMLIngestionMethod' image: $ref: '#/components/schemas/ImageIngestionMethod' pdf: $ref: '#/components/schemas/PDFIngestionMethod' text: $ref: '#/components/schemas/TextIngestionMethod' type: object title: Methods default: application/pdf: chunk_overlap: 256 chunk_size: 1024 enrich_chunks_mode: inject_summary extract_images: true extract_qa_pairs: false supported_mime_types: - application/pdf - >- application/vnd.openxmlformats-officedocument.wordprocessingml.document - >- application/vnd.openxmlformats-officedocument.presentationml.presentation - application/msword - application/vnd.ms-powerpoint type: pdf image/*: supported_mime_types: - image/jpeg - image/png - image/tiff - image/bmp type: image text/html: chunk_overlap: 256 chunk_size: 1024 enrich_chunks_mode: inject_summary extract_qa_pairs: false extract_text_only: true include_images: false include_tables: true supported_mime_types: - text/html type: html text/plain: chunk_overlap: 256 chunk_size: 1024 chunking: true enrich_chunks_mode: inject_summary extract_qa_pairs: false preserve_formatting: true supported_mime_types: - text/plain - text/html - text/markdown - application/json - application/xml - text/xml - application/rtf type: text text/csv: auto_detect_delimiter: true chunk_overlap: 256 chunk_size: 1024 encoding: utf-8 enrich_chunks_mode: inject_summary extract_qa_pairs: false include_headers: true row_as_document: true supported_mime_types: - text/csv - application/csv type: csv application/csv: auto_detect_delimiter: true chunk_overlap: 256 chunk_size: 1024 encoding: utf-8 enrich_chunks_mode: inject_summary extract_qa_pairs: false include_headers: true row_as_document: true supported_mime_types: - text/csv - application/csv type: csv message/rfc822: chunk_overlap: 256 chunk_size: 1024 enrich_chunks_mode: inject_summary extract_qa_pairs: false extract_text_only: true include_images: false include_tables: true supported_mime_types: - message/rfc822 type: email default: chunk_size: 1024 chunk_overlap: 256 enrich_chunks_mode: inject_summary extract_qa_pairs: false type: default supported_mime_types: - text/plain - text/html - text/markdown - application/json - application/xml - text/xml - application/rtf type: object title: IngestionSettings FullTextSearchMethod: properties: type: type: string const: full_text_search title: Type default: full_text_search top_k: type: integer maximum: 100 minimum: 1 title: Top K default: 25 type: object title: FullTextSearchMethod SemanticSearchMethod: properties: type: type: string const: semantic title: Type default: semantic sets_threshold: type: boolean title: Sets Threshold default: false threshold: type: number maximum: 1 minimum: 0 title: Threshold default: 0 top_k: type: integer maximum: 100 minimum: 1 title: Top K default: 25 type: object title: SemanticSearchMethod HybridSearchMethod: properties: type: type: string const: hybrid_relative_score title: Type default: hybrid_relative_score threshold: anyOf: - type: number - type: 'null' title: Threshold default: 0 fts_weight: type: number maximum: 1 minimum: 0 title: Fts Weight default: 0.7 semantic_weight: type: number maximum: 1 minimum: 0 title: Semantic Weight default: 0.3 full_text_search: $ref: '#/components/schemas/FullTextSearchMethod' default: type: full_text_search top_k: 25 semantic_search: $ref: '#/components/schemas/SemanticSearchMethod' default: type: semantic sets_threshold: false threshold: 0 top_k: 25 type: object title: HybridSearchMethod RRFHybridMethod: properties: type: type: string const: hybrid_rrf title: Type default: hybrid_rrf threshold: anyOf: - type: number - type: 'null' title: Threshold default: 0 rrf_k: type: integer minimum: 1 title: Rrf K default: 60 top_k_multiplier: type: integer minimum: 1 title: Top K Multiplier default: 2 full_text_search: $ref: '#/components/schemas/FullTextSearchMethod' default: type: full_text_search top_k: 25 semantic_search: $ref: '#/components/schemas/SemanticSearchMethod' default: type: semantic sets_threshold: false threshold: 0 top_k: 25 type: object title: RRFHybridMethod HybridRerankingSettings-Input: properties: type: type: string const: hybrid_reranking title: Type default: hybrid_reranking hybrid_settings: $ref: '#/components/schemas/HybridSearchMethod' default: type: hybrid_relative_score threshold: 0 fts_weight: 0.7 semantic_weight: 0.3 full_text_search: top_k: 25 type: full_text_search semantic_search: sets_threshold: false threshold: 0 top_k: 25 type: semantic reranker_settings: $ref: '#/components/schemas/VertexRerankingOpts' default: type: vertex model_name: semantic-ranker-512@latest ranking_config: default_ranking_config top_k: 10 sets_threshold: false threshold: 0 type: object title: HybridRerankingSettings EmbeddingsSettings: properties: text_model: type: string title: Text Model default: vertexai/text-multilingual-embedding-002 mm_model: type: string title: Mm Model default: vertexai/multimodalembedding@001 type: object title: EmbeddingsSettings IngestionSettings-Output: properties: batch_size: type: integer maximum: 128 minimum: 1 title: Batch Size default: 8 default_chunk_size: type: integer maximum: 4096 minimum: 1 title: Default Chunk Size default: 1024 default_chunk_overlap: type: integer maximum: 1024 minimum: 1 title: Default Chunk Overlap default: 256 enrich_chunks_mode: type: string enum: - inject_summary - contextual title: Enrich Chunks Mode default: inject_summary enrich_pre_made_qa: type: boolean title: Enrich Pre Made Qa default: false methods: additionalProperties: oneOf: - $ref: '#/components/schemas/DefaultIngestionMethod' - $ref: '#/components/schemas/PDFIngestionMethod' - $ref: '#/components/schemas/ImageIngestionMethod' - $ref: '#/components/schemas/HTMLIngestionMethod' - $ref: '#/components/schemas/TextIngestionMethod' - $ref: '#/components/schemas/CSVIngestionMethod' - $ref: '#/components/schemas/EmailIngestionMethod' discriminator: propertyName: type mapping: csv: $ref: '#/components/schemas/CSVIngestionMethod' default: $ref: '#/components/schemas/DefaultIngestionMethod' email: $ref: '#/components/schemas/EmailIngestionMethod' html: $ref: '#/components/schemas/HTMLIngestionMethod' image: $ref: '#/components/schemas/ImageIngestionMethod' pdf: $ref: '#/components/schemas/PDFIngestionMethod' text: $ref: '#/components/schemas/TextIngestionMethod' type: object title: Methods default: application/pdf: chunk_overlap: 256 chunk_size: 1024 enrich_chunks_mode: inject_summary extract_images: true extract_qa_pairs: false supported_mime_types: - application/pdf - >- application/vnd.openxmlformats-officedocument.wordprocessingml.document - >- application/vnd.openxmlformats-officedocument.presentationml.presentation - application/msword - application/vnd.ms-powerpoint type: pdf image/*: supported_mime_types: - image/jpeg - image/png - image/tiff - image/bmp type: image text/html: chunk_overlap: 256 chunk_size: 1024 enrich_chunks_mode: inject_summary extract_qa_pairs: false extract_text_only: true include_images: false include_tables: true supported_mime_types: - text/html type: html text/plain: chunk_overlap: 256 chunk_size: 1024 chunking: true enrich_chunks_mode: inject_summary extract_qa_pairs: false preserve_formatting: true supported_mime_types: - text/plain - text/html - text/markdown - application/json - application/xml - text/xml - application/rtf type: text text/csv: auto_detect_delimiter: true chunk_overlap: 256 chunk_size: 1024 encoding: utf-8 enrich_chunks_mode: inject_summary extract_qa_pairs: false include_headers: true row_as_document: true supported_mime_types: - text/csv - application/csv type: csv application/csv: auto_detect_delimiter: true chunk_overlap: 256 chunk_size: 1024 encoding: utf-8 enrich_chunks_mode: inject_summary extract_qa_pairs: false include_headers: true row_as_document: true supported_mime_types: - text/csv - application/csv type: csv message/rfc822: chunk_overlap: 256 chunk_size: 1024 enrich_chunks_mode: inject_summary extract_qa_pairs: false extract_text_only: true include_images: false include_tables: true supported_mime_types: - message/rfc822 type: email default: chunk_size: 1024 chunk_overlap: 256 enrich_chunks_mode: inject_summary extract_qa_pairs: false type: default supported_mime_types: - text/plain - text/html - text/markdown - application/json - application/xml - text/xml - application/rtf type: object title: IngestionSettings HybridRerankingSettings-Output: properties: type: type: string const: hybrid_reranking title: Type default: hybrid_reranking hybrid_settings: $ref: '#/components/schemas/HybridSearchMethod' default: type: hybrid_relative_score threshold: 0 fts_weight: 0.7 semantic_weight: 0.3 full_text_search: top_k: 25 type: full_text_search semantic_search: sets_threshold: false threshold: 0 top_k: 25 type: semantic reranker_settings: $ref: '#/components/schemas/VertexRerankingOpts' default: type: vertex model_name: semantic-ranker-512@latest ranking_config: default_ranking_config top_k: 10 sets_threshold: false threshold: 0 type: object title: HybridRerankingSettings DefaultIngestionMethod: properties: chunk_size: type: integer title: Chunk Size default: 1024 chunk_overlap: type: integer title: Chunk Overlap default: 256 enrich_chunks_mode: type: string enum: - inject_summary - contextual title: Enrich Chunks Mode default: inject_summary extract_qa_pairs: type: boolean title: Extract Qa Pairs default: false type: type: string const: default title: Type default: default supported_mime_types: anyOf: - items: type: string type: array - type: 'null' title: Supported Mime Types default: - text/plain - text/html - text/markdown - application/json - application/xml - text/xml - application/rtf type: object title: DefaultIngestionMethod PDFIngestionMethod: properties: chunk_size: type: integer title: Chunk Size default: 1024 chunk_overlap: type: integer title: Chunk Overlap default: 256 enrich_chunks_mode: type: string enum: - inject_summary - contextual title: Enrich Chunks Mode default: inject_summary extract_qa_pairs: type: boolean title: Extract Qa Pairs default: false type: type: string const: pdf title: Type default: pdf supported_mime_types: items: type: string type: array title: Supported Mime Types default: - application/pdf - >- application/vnd.openxmlformats-officedocument.wordprocessingml.document - >- application/vnd.openxmlformats-officedocument.presentationml.presentation - application/msword - application/vnd.ms-powerpoint ocr_settings: anyOf: - $ref: '#/components/schemas/OCRSettings' - type: 'null' extract_images: type: boolean title: Extract Images default: true type: object title: PDFIngestionMethod ImageIngestionMethod: properties: type: type: string const: image title: Type default: image supported_mime_types: items: type: string type: array title: Supported Mime Types default: - image/jpeg - image/png - image/tiff - image/bmp ocr_settings: anyOf: - $ref: '#/components/schemas/OCRSettings' - type: 'null' type: object title: ImageIngestionMethod HTMLIngestionMethod: properties: chunk_size: type: integer maximum: 10240 minimum: 1 title: Chunk Size default: 1024 chunk_overlap: type: integer maximum: 1024 minimum: 1 title: Chunk Overlap default: 256 enrich_chunks_mode: type: string enum: - inject_summary - contextual title: Enrich Chunks Mode default: inject_summary extract_qa_pairs: type: boolean title: Extract Qa Pairs default: false type: type: string const: html title: Type default: html supported_mime_types: items: type: string type: array title: Supported Mime Types default: - text/html extract_text_only: type: boolean title: Extract Text Only default: true include_tables: type: boolean title: Include Tables default: true include_images: type: boolean title: Include Images default: false type: object title: HTMLIngestionMethod TextIngestionMethod: properties: chunk_size: type: integer title: Chunk Size default: 1024 chunk_overlap: type: integer title: Chunk Overlap default: 256 enrich_chunks_mode: type: string enum: - inject_summary - contextual title: Enrich Chunks Mode default: inject_summary extract_qa_pairs: type: boolean title: Extract Qa Pairs default: false type: type: string const: text title: Type default: text chunking: type: boolean title: Chunking default: true preserve_formatting: type: boolean title: Preserve Formatting default: true supported_mime_types: anyOf: - items: type: string type: array - type: 'null' title: Supported Mime Types default: - text/plain - text/html - text/markdown - application/json - application/xml - text/xml - application/rtf type: object title: TextIngestionMethod CSVIngestionMethod: properties: chunk_size: type: integer maximum: 10240 minimum: 1 title: Chunk Size default: 1024 chunk_overlap: type: integer maximum: 1024 minimum: 1 title: Chunk Overlap default: 256 enrich_chunks_mode: type: string enum: - inject_summary - contextual title: Enrich Chunks Mode default: inject_summary extract_qa_pairs: type: boolean title: Extract Qa Pairs default: false type: type: string const: csv title: Type default: csv row_as_document: type: boolean title: Row As Document default: true include_headers: type: boolean title: Include Headers default: true auto_detect_delimiter: type: boolean title: Auto Detect Delimiter default: true delimiter: anyOf: - type: string - type: 'null' title: Delimiter encoding: type: string title: Encoding default: utf-8 max_rows: anyOf: - type: integer - type: 'null' title: Max Rows supported_mime_types: anyOf: - items: type: string type: array - type: 'null' title: Supported Mime Types default: - text/csv - application/csv type: object title: CSVIngestionMethod EmailIngestionMethod: properties: chunk_size: type: integer maximum: 10240 minimum: 1 title: Chunk Size default: 1024 chunk_overlap: type: integer maximum: 1024 minimum: 1 title: Chunk Overlap default: 256 enrich_chunks_mode: type: string enum: - inject_summary - contextual title: Enrich Chunks Mode default: inject_summary extract_qa_pairs: type: boolean title: Extract Qa Pairs default: false type: type: string const: email title: Type default: email supported_mime_types: items: type: string type: array title: Supported Mime Types default: - message/rfc822 extract_text_only: type: boolean title: Extract Text Only default: true include_tables: type: boolean title: Include Tables default: true include_images: type: boolean title: Include Images default: false type: object title: EmailIngestionMethod VertexRerankingOpts: properties: type: type: string const: vertex title: Type default: vertex model_name: type: string const: semantic-ranker-512@latest title: Model Name default: semantic-ranker-512@latest ranking_config: type: string const: default_ranking_config title: Ranking Config default: default_ranking_config top_k: anyOf: - type: integer maximum: 25 minimum: 1 - type: 'null' title: Top K default: 10 sets_threshold: type: boolean title: Sets Threshold default: false threshold: type: number maximum: 1 minimum: 0 title: Threshold default: 0 type: object title: VertexRerankingOpts OCRSettings: properties: confidence_threshold: type: number title: Confidence Threshold default: 0.7 language: anyOf: - type: string - type: 'null' title: Language type: object title: OCRSettings securitySchemes: APIKeyHeader: type: apiKey in: header name: X-API-Key ````