{ "$schema": "https://json-schema.org/draft/2020-12/schema", "$id": "https://catalog.lintel.tools/schemas/schemastore/haystack-pipeline/_shared/latest--haystack-pipeline-1.18.0.schema.json", "title": "Haystack Pipeline", "description": "Haystack Pipeline YAML file describing the nodes of the pipelines. For more info read the docs at: ", "x-lintel": { "source": "https://raw.githubusercontent.com/deepset-ai/haystack-json-schema/main/json-schema/haystack-pipeline-1.18.0.schema.json", "sourceSha256": "8efcce16446929e2262862b2cb0d6dd5c08b0374d9905501560ff022f599a869" }, "type": "object", "properties": { "version": { "title": "Version", "description": "Version of the Haystack Pipeline file.", "type": "string", "const": "1.18.0" }, "extras": { "title": "Additional properties group", "description": "To be specified only if contains special pipelines (for example, if this is a Ray pipeline)", "type": "string", "enum": [ "ray" ] }, "components": { "title": "Components", "description": "Component nodes and their configurations, to later be used in the pipelines section. Define here all the building blocks for the pipelines.", "type": "array", "items": { "anyOf": [ { "$ref": "#/$defs/DeepsetCloudDocumentStoreComponent" }, { "$ref": "#/$defs/ElasticsearchDocumentStoreComponent" }, { "$ref": "#/$defs/FAISSDocumentStoreComponent" }, { "$ref": "#/$defs/InMemoryDocumentStoreComponent" }, { "$ref": "#/$defs/OpenSearchDocumentStoreComponent" }, { "$ref": "#/$defs/PineconeDocumentStoreComponent" }, { "$ref": "#/$defs/SQLDocumentStoreComponent" }, { "$ref": "#/$defs/WeaviateDocumentStoreComponent" }, { "$ref": "#/$defs/AnswerParserComponent" }, { "$ref": "#/$defs/AzureConverterComponent" }, { "$ref": "#/$defs/BM25RetrieverComponent" }, { "$ref": "#/$defs/BaseOutputParserComponent" }, { "$ref": "#/$defs/CohereRankerComponent" }, { "$ref": "#/$defs/CrawlerComponent" }, { "$ref": "#/$defs/CsvTextConverterComponent" }, { "$ref": "#/$defs/DensePassageRetrieverComponent" }, { "$ref": "#/$defs/Docs2AnswersComponent" }, { "$ref": "#/$defs/DocumentMergerComponent" }, { "$ref": "#/$defs/DocxToTextConverterComponent" }, { "$ref": "#/$defs/EmbeddingRetrieverComponent" }, { "$ref": "#/$defs/EntityExtractorComponent" }, { "$ref": "#/$defs/FARMReaderComponent" }, { "$ref": "#/$defs/FileTypeClassifierComponent" }, { "$ref": "#/$defs/FilterRetrieverComponent" }, { "$ref": "#/$defs/ImageToTextConverterComponent" }, { "$ref": "#/$defs/JoinAnswersComponent" }, { "$ref": "#/$defs/JoinDocumentsComponent" }, { "$ref": "#/$defs/JsonConverterComponent" }, { "$ref": "#/$defs/LangdetectDocumentLanguageClassifierComponent" }, { "$ref": "#/$defs/MarkdownConverterComponent" }, { "$ref": "#/$defs/MultiModalRetrieverComponent" }, { "$ref": "#/$defs/MultihopEmbeddingRetrieverComponent" }, { "$ref": "#/$defs/OpenAIAnswerGeneratorComponent" }, { "$ref": "#/$defs/PDFToTextConverterComponent" }, { "$ref": "#/$defs/ParsrConverterComponent" }, { "$ref": "#/$defs/PreProcessorComponent" }, { "$ref": "#/$defs/PromptModelComponent" }, { "$ref": "#/$defs/PromptNodeComponent" }, { "$ref": "#/$defs/PromptTemplateComponent" }, { "$ref": "#/$defs/PseudoLabelGeneratorComponent" }, { "$ref": "#/$defs/QuestionGeneratorComponent" }, { "$ref": "#/$defs/RCIReaderComponent" }, { "$ref": "#/$defs/RouteDocumentsComponent" }, { "$ref": "#/$defs/SentenceTransformersRankerComponent" }, { "$ref": "#/$defs/ShaperComponent" }, { "$ref": "#/$defs/SklearnQueryClassifierComponent" }, { "$ref": "#/$defs/TableReaderComponent" }, { "$ref": "#/$defs/TableTextRetrieverComponent" }, { "$ref": "#/$defs/TextConverterComponent" }, { "$ref": "#/$defs/TfidfRetrieverComponent" }, { "$ref": "#/$defs/TikaConverterComponent" }, { "$ref": "#/$defs/TopPSamplerComponent" }, { "$ref": "#/$defs/TransformersDocumentClassifierComponent" }, { "$ref": "#/$defs/TransformersDocumentLanguageClassifierComponent" }, { "$ref": "#/$defs/TransformersImageToTextComponent" }, { "$ref": "#/$defs/TransformersQueryClassifierComponent" }, { "$ref": "#/$defs/TransformersReaderComponent" }, { "$ref": "#/$defs/TransformersSummarizerComponent" }, { "$ref": "#/$defs/TransformersTranslatorComponent" }, { "$ref": "#/$defs/WebRetrieverComponent" }, { "$ref": "#/$defs/WebSearchComponent" }, { "$ref": "#/$defs/WhisperTranscriberComponent" } ] }, "required": [ "type", "name" ], "additionalProperties": true }, "pipelines": { "title": "Pipelines", "description": "Multiple pipelines can be defined using the components from the same YAML file.", "type": "array", "items": { "type": "object", "properties": { "name": { "title": "Name", "description": "Name of the pipeline.", "type": "string" }, "nodes": { "title": "Nodes", "description": "Nodes to be used by this particular pipeline", "type": "array", "items": { "type": "object", "properties": { "name": { "title": "Name", "description": "The name of this particular node in the pipeline. This should be one of the names from the components defined in the same file.", "type": "string" }, "inputs": { "title": "Inputs", "description": "Input parameters for this node.", "type": "array", "items": { "type": "string" } }, "serve_deployment_kwargs": { "title": "serve_deployment_kwargs", "description": "Arguments to be passed to the Ray Serve `deployment()` method (only for Ray pipelines)", "type": "object", "properties": { "num_replicas": { "description": "How many replicas Ray should create for this node (only for Ray pipelines)", "type": "integer" }, "version": { "type": "string" }, "prev_version": { "type": "string" }, "init_args": { "type": "array" }, "init_kwargs": { "type": "object" }, "router_prefix": { "type": "string" }, "ray_actor_options": { "type": "object" }, "user_config": {}, "max_concurrent_queries": { "type": "integer" } }, "additionalProperties": true } }, "required": [ "name", "inputs" ], "additionalProperties": false }, "required": [ "name", "nodes" ], "additionalProperties": false }, "additionalProperties": false }, "additionalProperties": false } } }, "required": [ "version", "components", "pipelines" ], "additionalProperties": false, "oneOf": [ { "not": { "required": [ "extras" ] }, "properties": { "pipelines": { "title": "Pipelines", "items": { "properties": { "nodes": { "items": { "not": { "required": [ "serve_deployment_kwargs" ] } } } } } } }, "type": "object" }, { "properties": { "extras": { "enum": [ "ray" ] } }, "required": [ "extras" ], "type": "object" } ], "$defs": { "DeepsetCloudDocumentStoreComponent": { "type": "object", "properties": { "name": { "title": "Name", "description": "Custom name for the component. Helpful for visualization and debugging.", "type": "string" }, "type": { "title": "Type", "description": "Haystack Class name for the component.", "type": "string", "const": "DeepsetCloudDocumentStore" }, "params": { "title": "Parameters", "type": "object", "properties": { "api_key": { "title": "Api Key", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "workspace": { "title": "Workspace", "default": "default", "type": "string" }, "index": { "title": "Index", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "duplicate_documents": { "title": "Duplicate Documents", "default": "overwrite", "type": "string" }, "api_endpoint": { "title": "Api Endpoint", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "similarity": { "title": "Similarity", "default": "dot_product", "type": "string" }, "return_embedding": { "title": "Return Embedding", "default": false, "type": "boolean" }, "label_index": { "title": "Label Index", "default": "default", "type": "string" }, "embedding_dim": { "title": "Embedding Dim", "default": 768, "type": "integer" }, "use_prefiltering": { "title": "Use Prefiltering", "default": false, "type": "boolean" } }, "description": "Each parameter can reference other components defined in the same YAML file.", "additionalProperties": false } }, "required": [ "type", "name" ], "additionalProperties": false }, "ElasticsearchDocumentStoreComponent": { "type": "object", "properties": { "name": { "title": "Name", "description": "Custom name for the component. Helpful for visualization and debugging.", "type": "string" }, "type": { "title": "Type", "description": "Haystack Class name for the component.", "type": "string", "const": "ElasticsearchDocumentStore" }, "params": { "title": "Parameters", "type": "object", "properties": { "host": { "title": "Host", "default": "localhost", "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "port": { "title": "Port", "default": 9200, "anyOf": [ { "type": "integer" }, { "type": "array", "items": { "type": "integer" } } ] }, "username": { "title": "Username", "default": "", "type": "string" }, "password": { "title": "Password", "default": "", "type": "string" }, "api_key_id": { "title": "Api Key Id", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "api_key": { "title": "Api Key", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "aws4auth": { "title": "Aws4Auth" }, "index": { "title": "Index", "default": "document", "type": "string" }, "label_index": { "title": "Label Index", "default": "label", "type": "string" }, "search_fields": { "title": "Search Fields", "default": "content", "anyOf": [ { "type": "string" }, { "type": "array", "items": {} } ] }, "content_field": { "title": "Content Field", "default": "content", "type": "string" }, "name_field": { "title": "Name Field", "default": "name", "type": "string" }, "embedding_field": { "title": "Embedding Field", "default": "embedding", "type": "string" }, "embedding_dim": { "title": "Embedding Dim", "default": 768, "type": "integer" }, "custom_mapping": { "title": "Custom Mapping", "anyOf": [ { "type": "object" }, { "type": "null" } ] }, "excluded_meta_data": { "title": "Excluded Meta Data", "anyOf": [ { "type": "array", "items": {} }, { "type": "null" } ] }, "analyzer": { "title": "Analyzer", "default": "standard", "type": "string" }, "scheme": { "title": "Scheme", "default": "http", "type": "string" }, "ca_certs": { "title": "Ca Certs", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "verify_certs": { "title": "Verify Certs", "default": true, "type": "boolean" }, "recreate_index": { "title": "Recreate Index", "default": false, "type": "boolean" }, "create_index": { "title": "Create Index", "default": true, "type": "boolean" }, "refresh_type": { "title": "Refresh Type", "default": "wait_for", "type": "string" }, "similarity": { "title": "Similarity", "default": "dot_product", "type": "string" }, "timeout": { "title": "Timeout", "default": 300, "type": "integer" }, "return_embedding": { "title": "Return Embedding", "default": false, "type": "boolean" }, "duplicate_documents": { "title": "Duplicate Documents", "default": "overwrite", "type": "string" }, "scroll": { "title": "Scroll", "default": "1d", "type": "string" }, "skip_missing_embeddings": { "title": "Skip Missing Embeddings", "default": true, "type": "boolean" }, "synonyms": { "title": "Synonyms", "anyOf": [ { "type": "array", "items": {} }, { "type": "null" } ] }, "synonym_type": { "title": "Synonym Type", "default": "synonym", "type": "string" }, "use_system_proxy": { "title": "Use System Proxy", "default": false, "type": "boolean" }, "batch_size": { "title": "Batch Size", "default": 10000, "type": "integer" } }, "description": "Each parameter can reference other components defined in the same YAML file.", "additionalProperties": false } }, "required": [ "type", "name" ], "additionalProperties": false }, "FAISSDocumentStoreComponent": { "type": "object", "properties": { "name": { "title": "Name", "description": "Custom name for the component. Helpful for visualization and debugging.", "type": "string" }, "type": { "title": "Type", "description": "Haystack Class name for the component.", "type": "string", "const": "FAISSDocumentStore" }, "params": { "title": "Parameters", "type": "object", "properties": { "sql_url": { "title": "Sql Url", "default": "sqlite:///faiss_document_store.db", "type": "string" }, "vector_dim": { "title": "Vector Dim", "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "embedding_dim": { "title": "Embedding Dim", "default": 768, "type": "integer" }, "faiss_index_factory_str": { "title": "Faiss Index Factory Str", "default": "Flat", "type": "string" }, "faiss_index": { "title": "Faiss Index" }, "return_embedding": { "title": "Return Embedding", "default": false, "type": "boolean" }, "index": { "title": "Index", "default": "document", "type": "string" }, "similarity": { "title": "Similarity", "default": "dot_product", "type": "string" }, "embedding_field": { "title": "Embedding Field", "default": "embedding", "type": "string" }, "progress_bar": { "title": "Progress Bar", "default": true, "type": "boolean" }, "duplicate_documents": { "title": "Duplicate Documents", "default": "overwrite", "type": "string" }, "faiss_index_path": { "title": "Faiss Index Path", "anyOf": [ { "type": "string" }, { "type": "string", "format": "path" }, { "type": "null" } ] }, "faiss_config_path": { "title": "Faiss Config Path", "anyOf": [ { "type": "string" }, { "type": "string", "format": "path" }, { "type": "null" } ] }, "isolation_level": { "title": "Isolation Level", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "n_links": { "title": "N Links", "default": 64, "type": "integer" }, "ef_search": { "title": "Ef Search", "default": 20, "type": "integer" }, "ef_construction": { "title": "Ef Construction", "default": 80, "type": "integer" }, "validate_index_sync": { "title": "Validate Index Sync", "default": true, "type": "boolean" } }, "description": "Each parameter can reference other components defined in the same YAML file.", "additionalProperties": false } }, "required": [ "type", "name" ], "additionalProperties": false }, "InMemoryDocumentStoreComponent": { "type": "object", "properties": { "name": { "title": "Name", "description": "Custom name for the component. Helpful for visualization and debugging.", "type": "string" }, "type": { "title": "Type", "description": "Haystack Class name for the component.", "type": "string", "const": "InMemoryDocumentStore" }, "params": { "title": "Parameters", "type": "object", "properties": { "index": { "title": "Index", "default": "document", "type": "string" }, "label_index": { "title": "Label Index", "default": "label", "type": "string" }, "embedding_field": { "title": "Embedding Field", "default": "embedding", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "embedding_dim": { "title": "Embedding Dim", "default": 768, "type": "integer" }, "return_embedding": { "title": "Return Embedding", "default": false, "type": "boolean" }, "similarity": { "title": "Similarity", "default": "dot_product", "type": "string" }, "progress_bar": { "title": "Progress Bar", "default": true, "type": "boolean" }, "duplicate_documents": { "title": "Duplicate Documents", "default": "overwrite", "type": "string" }, "use_gpu": { "title": "Use Gpu", "default": true, "type": "boolean" }, "scoring_batch_size": { "title": "Scoring Batch Size", "default": 500000, "type": "integer" }, "devices": { "title": "Devices", "anyOf": [ { "type": "array", "items": { "anyOf": [ { "type": "string" }, {} ] } }, { "type": "null" } ] }, "use_bm25": { "title": "Use Bm25", "default": false, "type": "boolean" }, "bm25_tokenization_regex": { "title": "Bm25 Tokenization Regex", "default": "(?u)\\b\\w\\w+\\b", "type": "string" }, "bm25_algorithm": { "title": "Bm25 Algorithm", "default": "BM25Okapi", "enum": [ "BM25Okapi", "BM25L", "BM25Plus" ], "type": "string" }, "bm25_parameters": { "title": "Bm25 Parameters", "anyOf": [ { "type": "object" }, { "type": "null" } ] } }, "description": "Each parameter can reference other components defined in the same YAML file.", "additionalProperties": false } }, "required": [ "type", "name" ], "additionalProperties": false }, "OpenSearchDocumentStoreComponent": { "type": "object", "properties": { "name": { "title": "Name", "description": "Custom name for the component. Helpful for visualization and debugging.", "type": "string" }, "type": { "title": "Type", "description": "Haystack Class name for the component.", "type": "string", "const": "OpenSearchDocumentStore" }, "params": { "title": "Parameters", "type": "object", "properties": { "scheme": { "title": "Scheme", "default": "https", "type": "string" }, "username": { "title": "Username", "default": "admin", "type": "string" }, "password": { "title": "Password", "default": "admin", "type": "string" }, "host": { "title": "Host", "default": "localhost", "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "port": { "title": "Port", "default": 9200, "anyOf": [ { "type": "integer" }, { "type": "array", "items": { "type": "integer" } } ] }, "api_key_id": { "title": "Api Key Id", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "api_key": { "title": "Api Key", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "aws4auth": { "title": "Aws4Auth" }, "index": { "title": "Index", "default": "document", "type": "string" }, "label_index": { "title": "Label Index", "default": "label", "type": "string" }, "search_fields": { "title": "Search Fields", "default": "content", "anyOf": [ { "type": "string" }, { "type": "array", "items": {} } ] }, "content_field": { "title": "Content Field", "default": "content", "type": "string" }, "name_field": { "title": "Name Field", "default": "name", "type": "string" }, "embedding_field": { "title": "Embedding Field", "default": "embedding", "type": "string" }, "embedding_dim": { "title": "Embedding Dim", "default": 768, "type": "integer" }, "custom_mapping": { "title": "Custom Mapping", "anyOf": [ { "type": "object" }, { "type": "null" } ] }, "excluded_meta_data": { "title": "Excluded Meta Data", "anyOf": [ { "type": "array", "items": {} }, { "type": "null" } ] }, "analyzer": { "title": "Analyzer", "default": "standard", "type": "string" }, "ca_certs": { "title": "Ca Certs", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "verify_certs": { "title": "Verify Certs", "default": false, "type": "boolean" }, "recreate_index": { "title": "Recreate Index", "default": false, "type": "boolean" }, "create_index": { "title": "Create Index", "default": true, "type": "boolean" }, "refresh_type": { "title": "Refresh Type", "default": "wait_for", "type": "string" }, "similarity": { "title": "Similarity", "default": "dot_product", "type": "string" }, "timeout": { "title": "Timeout", "default": 300, "type": "integer" }, "return_embedding": { "title": "Return Embedding", "default": false, "type": "boolean" }, "duplicate_documents": { "title": "Duplicate Documents", "default": "overwrite", "type": "string" }, "index_type": { "title": "Index Type", "default": "flat", "type": "string" }, "scroll": { "title": "Scroll", "default": "1d", "type": "string" }, "skip_missing_embeddings": { "title": "Skip Missing Embeddings", "default": true, "type": "boolean" }, "synonyms": { "title": "Synonyms", "anyOf": [ { "type": "array", "items": {} }, { "type": "null" } ] }, "synonym_type": { "title": "Synonym Type", "default": "synonym", "type": "string" }, "use_system_proxy": { "title": "Use System Proxy", "default": false, "type": "boolean" }, "knn_engine": { "title": "Knn Engine", "default": "nmslib", "type": "string" }, "knn_parameters": { "title": "Knn Parameters", "anyOf": [ { "type": "object" }, { "type": "null" } ] }, "ivf_train_size": { "title": "Ivf Train Size", "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "batch_size": { "title": "Batch Size", "default": 10000, "type": "integer" } }, "description": "Each parameter can reference other components defined in the same YAML file.", "additionalProperties": false } }, "required": [ "type", "name" ], "additionalProperties": false }, "PineconeDocumentStoreComponent": { "type": "object", "properties": { "name": { "title": "Name", "description": "Custom name for the component. Helpful for visualization and debugging.", "type": "string" }, "type": { "title": "Type", "description": "Haystack Class name for the component.", "type": "string", "const": "PineconeDocumentStore" }, "params": { "title": "Parameters", "type": "object", "properties": { "api_key": { "title": "Api Key", "type": "string" }, "environment": { "title": "Environment", "default": "us-west1-gcp", "type": "string" }, "pinecone_index": { "title": "Pinecone Index" }, "embedding_dim": { "title": "Embedding Dim", "default": 768, "type": "integer" }, "return_embedding": { "title": "Return Embedding", "default": false, "type": "boolean" }, "index": { "title": "Index", "default": "document", "type": "string" }, "similarity": { "title": "Similarity", "default": "cosine", "type": "string" }, "replicas": { "title": "Replicas", "default": 1, "type": "integer" }, "shards": { "title": "Shards", "default": 1, "type": "integer" }, "embedding_field": { "title": "Embedding Field", "default": "embedding", "type": "string" }, "progress_bar": { "title": "Progress Bar", "default": true, "type": "boolean" }, "duplicate_documents": { "title": "Duplicate Documents", "default": "overwrite", "type": "string" }, "recreate_index": { "title": "Recreate Index", "default": false, "type": "boolean" }, "metadata_config": { "title": "Metadata Config", "anyOf": [ { "type": "object" }, { "type": "null" } ] }, "validate_index_sync": { "title": "Validate Index Sync", "default": true, "type": "boolean" } }, "required": [ "api_key" ], "description": "Each parameter can reference other components defined in the same YAML file.", "additionalProperties": false } }, "required": [ "type", "name" ], "additionalProperties": false }, "SQLDocumentStoreComponent": { "type": "object", "properties": { "name": { "title": "Name", "description": "Custom name for the component. Helpful for visualization and debugging.", "type": "string" }, "type": { "title": "Type", "description": "Haystack Class name for the component.", "type": "string", "const": "SQLDocumentStore" }, "params": { "title": "Parameters", "type": "object", "properties": { "url": { "title": "Url", "default": "sqlite://", "type": "string" }, "index": { "title": "Index", "default": "document", "type": "string" }, "label_index": { "title": "Label Index", "default": "label", "type": "string" }, "duplicate_documents": { "title": "Duplicate Documents", "default": "overwrite", "type": "string" }, "check_same_thread": { "title": "Check Same Thread", "default": false, "type": "boolean" }, "isolation_level": { "title": "Isolation Level", "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "description": "Each parameter can reference other components defined in the same YAML file.", "additionalProperties": false } }, "required": [ "type", "name" ], "additionalProperties": false }, "WeaviateDocumentStoreComponent": { "type": "object", "properties": { "name": { "title": "Name", "description": "Custom name for the component. Helpful for visualization and debugging.", "type": "string" }, "type": { "title": "Type", "description": "Haystack Class name for the component.", "type": "string", "const": "WeaviateDocumentStore" }, "params": { "title": "Parameters", "type": "object", "properties": { "host": { "title": "Host", "default": "http://localhost", "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "port": { "title": "Port", "default": 8080, "anyOf": [ { "type": "integer" }, { "type": "array", "items": { "type": "integer" } } ] }, "timeout_config": { "title": "Timeout Config", "default": [ 5, 15 ], "type": "array", "items": {} }, "username": { "title": "Username", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "password": { "title": "Password", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "scope": { "title": "Scope", "default": "offline_access", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "api_key": { "title": "Api Key", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "use_embedded": { "title": "Use Embedded", "default": false, "type": "boolean" }, "embedded_options": { "title": "Embedded Options", "anyOf": [ { "type": "object" }, { "type": "null" } ] }, "additional_headers": { "title": "Additional Headers", "anyOf": [ { "type": "object" }, { "type": "null" } ] }, "index": { "title": "Index", "default": "Document", "type": "string" }, "embedding_dim": { "title": "Embedding Dim", "default": 768, "type": "integer" }, "content_field": { "title": "Content Field", "default": "content", "type": "string" }, "name_field": { "title": "Name Field", "default": "name", "type": "string" }, "similarity": { "title": "Similarity", "default": "cosine", "type": "string" }, "index_type": { "title": "Index Type", "default": "hnsw", "type": "string" }, "custom_schema": { "title": "Custom Schema", "anyOf": [ { "type": "object" }, { "type": "null" } ] }, "return_embedding": { "title": "Return Embedding", "default": false, "type": "boolean" }, "embedding_field": { "title": "Embedding Field", "default": "embedding", "type": "string" }, "progress_bar": { "title": "Progress Bar", "default": true, "type": "boolean" }, "duplicate_documents": { "title": "Duplicate Documents", "default": "overwrite", "type": "string" }, "recreate_index": { "title": "Recreate Index", "default": false, "type": "boolean" }, "replication_factor": { "title": "Replication Factor", "default": 1, "type": "integer" }, "batch_size": { "title": "Batch Size", "default": 10000, "type": "integer" } }, "description": "Each parameter can reference other components defined in the same YAML file.", "additionalProperties": false } }, "required": [ "type", "name" ], "additionalProperties": false }, "AnswerParserComponent": { "type": "object", "properties": { "name": { "title": "Name", "description": "Custom name for the component. Helpful for visualization and debugging.", "type": "string" }, "type": { "title": "Type", "description": "Haystack Class name for the component.", "type": "string", "const": "AnswerParser" }, "params": { "title": "Parameters", "type": "object", "properties": { "pattern": { "title": "Pattern", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "reference_pattern": { "title": "Reference Pattern", "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "description": "Each parameter can reference other components defined in the same YAML file.", "additionalProperties": false } }, "required": [ "type", "name" ], "additionalProperties": false }, "AzureConverterComponent": { "type": "object", "properties": { "name": { "title": "Name", "description": "Custom name for the component. Helpful for visualization and debugging.", "type": "string" }, "type": { "title": "Type", "description": "Haystack Class name for the component.", "type": "string", "const": "AzureConverter" }, "params": { "title": "Parameters", "type": "object", "properties": { "endpoint": { "title": "Endpoint", "type": "string" }, "credential_key": { "title": "Credential Key", "type": "string" }, "model_id": { "title": "Model Id", "default": "prebuilt-document", "type": "string" }, "valid_languages": { "title": "Valid Languages", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "save_json": { "title": "Save Json", "default": false, "type": "boolean" }, "preceding_context_len": { "title": "Preceding Context Len", "default": 3, "type": "integer" }, "following_context_len": { "title": "Following Context Len", "default": 3, "type": "integer" }, "merge_multiple_column_headers": { "title": "Merge Multiple Column Headers", "default": true, "type": "boolean" }, "id_hash_keys": { "title": "Id Hash Keys", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "add_page_number": { "title": "Add Page Number", "default": true, "type": "boolean" } }, "required": [ "endpoint", "credential_key" ], "description": "Each parameter can reference other components defined in the same YAML file.", "additionalProperties": false } }, "required": [ "type", "name" ], "additionalProperties": false }, "BM25RetrieverComponent": { "type": "object", "properties": { "name": { "title": "Name", "description": "Custom name for the component. Helpful for visualization and debugging.", "type": "string" }, "type": { "title": "Type", "description": "Haystack Class name for the component.", "type": "string", "const": "BM25Retriever" }, "params": { "title": "Parameters", "type": "object", "properties": { "document_store": { "title": "Document Store", "default": null, "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "top_k": { "title": "Top K", "default": 10, "type": "integer" }, "all_terms_must_match": { "title": "All Terms Must Match", "default": false, "type": "boolean" }, "custom_query": { "title": "Custom Query", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "scale_score": { "title": "Scale Score", "default": true, "type": "boolean" } }, "description": "Each parameter can reference other components defined in the same YAML file.", "additionalProperties": false } }, "required": [ "type", "name" ], "additionalProperties": false }, "BaseOutputParserComponent": { "type": "object", "properties": { "name": { "title": "Name", "description": "Custom name for the component. Helpful for visualization and debugging.", "type": "string" }, "type": { "title": "Type", "description": "Haystack Class name for the component.", "type": "string", "const": "BaseOutputParser" }, "params": { "title": "Parameters", "type": "object", "properties": { "func": { "title": "Func", "type": "string" }, "outputs": { "title": "Outputs", "type": "array", "items": { "type": "string" } }, "inputs": { "title": "Inputs", "anyOf": [ { "type": "object" }, { "type": "null" } ], "additionalProperties": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "string" } ] } }, "params": { "title": "Params", "anyOf": [ { "type": "object" }, { "type": "null" } ] }, "publish_outputs": { "title": "Publish Outputs", "default": true, "anyOf": [ { "type": "boolean" }, { "type": "array", "items": { "type": "string" } } ] } }, "required": [ "func", "outputs" ], "description": "Each parameter can reference other components defined in the same YAML file.", "additionalProperties": false } }, "required": [ "type", "name" ], "additionalProperties": false }, "CohereRankerComponent": { "type": "object", "properties": { "name": { "title": "Name", "description": "Custom name for the component. Helpful for visualization and debugging.", "type": "string" }, "type": { "title": "Type", "description": "Haystack Class name for the component.", "type": "string", "const": "CohereRanker" }, "params": { "title": "Parameters", "type": "object", "properties": { "api_key": { "title": "Api Key", "type": "string" }, "model_name_or_path": { "title": "Model Name Or Path", "type": "string" }, "top_k": { "title": "Top K", "default": 10, "type": "integer" }, "max_chunks_per_doc": { "title": "Max Chunks Per Doc", "anyOf": [ { "type": "integer" }, { "type": "null" } ] } }, "required": [ "api_key", "model_name_or_path" ], "description": "Each parameter can reference other components defined in the same YAML file.", "additionalProperties": false } }, "required": [ "type", "name" ], "additionalProperties": false }, "CrawlerComponent": { "type": "object", "properties": { "name": { "title": "Name", "description": "Custom name for the component. Helpful for visualization and debugging.", "type": "string" }, "type": { "title": "Type", "description": "Haystack Class name for the component.", "type": "string", "const": "Crawler" }, "params": { "title": "Parameters", "type": "object", "properties": { "urls": { "title": "Urls", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "crawler_depth": { "title": "Crawler Depth", "default": 1, "type": "integer" }, "filter_urls": { "title": "Filter Urls", "anyOf": [ { "type": "array", "items": {} }, { "type": "null" } ] }, "id_hash_keys": { "title": "Id Hash Keys", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "extract_hidden_text": { "title": "Extract Hidden Text", "default": true }, "loading_wait_time": { "title": "Loading Wait Time", "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "output_dir": { "title": "Output Dir", "anyOf": [ { "type": "string" }, { "type": "string", "format": "path" }, { "type": "null" } ] }, "overwrite_existing_files": { "title": "Overwrite Existing Files", "default": true }, "file_path_meta_field_name": { "title": "File Path Meta Field Name", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "crawler_naming_function": { "title": "Crawler Naming Function", "default": null, "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "webdriver_options": { "title": "Webdriver Options", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } }, "description": "Each parameter can reference other components defined in the same YAML file.", "additionalProperties": false } }, "required": [ "type", "name" ], "additionalProperties": false }, "CsvTextConverterComponent": { "type": "object", "properties": { "name": { "title": "Name", "description": "Custom name for the component. Helpful for visualization and debugging.", "type": "string" }, "type": { "title": "Type", "description": "Haystack Class name for the component.", "type": "string", "const": "CsvTextConverter" }, "params": { "title": "Parameters", "type": "object", "properties": { "remove_numeric_tables": { "title": "Remove Numeric Tables", "default": false, "type": "boolean" }, "valid_languages": { "title": "Valid Languages", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "id_hash_keys": { "title": "Id Hash Keys", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "progress_bar": { "title": "Progress Bar", "default": true, "type": "boolean" } }, "description": "Each parameter can reference other components defined in the same YAML file.", "additionalProperties": false } }, "required": [ "type", "name" ], "additionalProperties": false }, "DensePassageRetrieverComponent": { "type": "object", "properties": { "name": { "title": "Name", "description": "Custom name for the component. Helpful for visualization and debugging.", "type": "string" }, "type": { "title": "Type", "description": "Haystack Class name for the component.", "type": "string", "const": "DensePassageRetriever" }, "params": { "title": "Parameters", "type": "object", "properties": { "document_store": { "title": "Document Store", "default": null, "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "query_embedding_model": { "title": "Query Embedding Model", "default": "facebook/dpr-question_encoder-single-nq-base", "anyOf": [ { "type": "string", "format": "path" }, { "type": "string" } ] }, "passage_embedding_model": { "title": "Passage Embedding Model", "default": "facebook/dpr-ctx_encoder-single-nq-base", "anyOf": [ { "type": "string", "format": "path" }, { "type": "string" } ] }, "model_version": { "title": "Model Version", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "max_seq_len_query": { "title": "Max Seq Len Query", "default": 64, "type": "integer" }, "max_seq_len_passage": { "title": "Max Seq Len Passage", "default": 256, "type": "integer" }, "top_k": { "title": "Top K", "default": 10, "type": "integer" }, "use_gpu": { "title": "Use Gpu", "default": true, "type": "boolean" }, "batch_size": { "title": "Batch Size", "default": 16, "type": "integer" }, "embed_title": { "title": "Embed Title", "default": true, "type": "boolean" }, "use_fast_tokenizers": { "title": "Use Fast Tokenizers", "default": true, "type": "boolean" }, "similarity_function": { "title": "Similarity Function", "default": "dot_product", "type": "string" }, "global_loss_buffer_size": { "title": "Global Loss Buffer Size", "default": 150000, "type": "integer" }, "progress_bar": { "title": "Progress Bar", "default": true, "type": "boolean" }, "devices": { "title": "Devices", "anyOf": [ { "type": "array", "items": { "anyOf": [ { "type": "string" }, {} ] } }, { "type": "null" } ] }, "use_auth_token": { "title": "Use Auth Token", "anyOf": [ { "type": "boolean" }, { "type": "string" }, { "type": "null" } ] }, "scale_score": { "title": "Scale Score", "default": true, "type": "boolean" } }, "description": "Each parameter can reference other components defined in the same YAML file.", "additionalProperties": false } }, "required": [ "type", "name" ], "additionalProperties": false }, "Docs2AnswersComponent": { "type": "object", "properties": { "name": { "title": "Name", "description": "Custom name for the component. Helpful for visualization and debugging.", "type": "string" }, "type": { "title": "Type", "description": "Haystack Class name for the component.", "type": "string", "const": "Docs2Answers" }, "params": { "title": "Parameters", "type": "object", "properties": { "progress_bar": { "title": "Progress Bar", "default": true, "type": "boolean" } }, "description": "Each parameter can reference other components defined in the same YAML file.", "additionalProperties": false } }, "required": [ "type", "name" ], "additionalProperties": false }, "DocumentMergerComponent": { "type": "object", "properties": { "name": { "title": "Name", "description": "Custom name for the component. Helpful for visualization and debugging.", "type": "string" }, "type": { "title": "Type", "description": "Haystack Class name for the component.", "type": "string", "const": "DocumentMerger" }, "params": { "title": "Parameters", "type": "object", "properties": { "separator": { "title": "Separator", "default": " ", "type": "string" } }, "description": "Each parameter can reference other components defined in the same YAML file.", "additionalProperties": false } }, "required": [ "type", "name" ], "additionalProperties": false }, "DocxToTextConverterComponent": { "type": "object", "properties": { "name": { "title": "Name", "description": "Custom name for the component. Helpful for visualization and debugging.", "type": "string" }, "type": { "title": "Type", "description": "Haystack Class name for the component.", "type": "string", "const": "DocxToTextConverter" }, "params": { "title": "Parameters", "type": "object", "properties": { "remove_numeric_tables": { "title": "Remove Numeric Tables", "default": false, "type": "boolean" }, "valid_languages": { "title": "Valid Languages", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "id_hash_keys": { "title": "Id Hash Keys", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "progress_bar": { "title": "Progress Bar", "default": true, "type": "boolean" } }, "description": "Each parameter can reference other components defined in the same YAML file.", "additionalProperties": false } }, "required": [ "type", "name" ], "additionalProperties": false }, "EmbeddingRetrieverComponent": { "type": "object", "properties": { "name": { "title": "Name", "description": "Custom name for the component. Helpful for visualization and debugging.", "type": "string" }, "type": { "title": "Type", "description": "Haystack Class name for the component.", "type": "string", "const": "EmbeddingRetriever" }, "params": { "title": "Parameters", "type": "object", "properties": { "embedding_model": { "title": "Embedding Model", "type": "string" }, "document_store": { "title": "Document Store", "default": null, "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "model_version": { "title": "Model Version", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "use_gpu": { "title": "Use Gpu", "default": true, "type": "boolean" }, "batch_size": { "title": "Batch Size", "default": 32, "type": "integer" }, "max_seq_len": { "title": "Max Seq Len", "default": 512, "type": "integer" }, "model_format": { "title": "Model Format", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "pooling_strategy": { "title": "Pooling Strategy", "default": "reduce_mean", "type": "string" }, "emb_extraction_layer": { "title": "Emb Extraction Layer", "default": -1, "type": "integer" }, "top_k": { "title": "Top K", "default": 10, "type": "integer" }, "progress_bar": { "title": "Progress Bar", "default": true, "type": "boolean" }, "devices": { "title": "Devices", "anyOf": [ { "type": "array", "items": { "anyOf": [ { "type": "string" }, {} ] } }, { "type": "null" } ] }, "use_auth_token": { "title": "Use Auth Token", "anyOf": [ { "type": "boolean" }, { "type": "string" }, { "type": "null" } ] }, "scale_score": { "title": "Scale Score", "default": true, "type": "boolean" }, "embed_meta_fields": { "title": "Embed Meta Fields", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "api_key": { "title": "Api Key", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "azure_api_version": { "title": "Azure Api Version", "default": "2022-12-01", "type": "string" }, "azure_base_url": { "title": "Azure Base Url", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "azure_deployment_name": { "title": "Azure Deployment Name", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "api_base": { "title": "Api Base", "default": "https://api.openai.com/v1", "type": "string" } }, "required": [ "embedding_model" ], "description": "Each parameter can reference other components defined in the same YAML file.", "additionalProperties": false } }, "required": [ "type", "name" ], "additionalProperties": false }, "EntityExtractorComponent": { "type": "object", "properties": { "name": { "title": "Name", "description": "Custom name for the component. Helpful for visualization and debugging.", "type": "string" }, "type": { "title": "Type", "description": "Haystack Class name for the component.", "type": "string", "const": "EntityExtractor" }, "params": { "title": "Parameters", "type": "object", "properties": { "model_name_or_path": { "title": "Model Name Or Path", "default": "elastic/distilbert-base-cased-finetuned-conll03-english", "type": "string" }, "model_version": { "title": "Model Version", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "use_gpu": { "title": "Use Gpu", "default": true, "type": "boolean" }, "batch_size": { "title": "Batch Size", "default": 16, "type": "integer" }, "progress_bar": { "title": "Progress Bar", "default": true, "type": "boolean" }, "use_auth_token": { "title": "Use Auth Token", "anyOf": [ { "type": "boolean" }, { "type": "string" }, { "type": "null" } ] }, "devices": { "title": "Devices", "anyOf": [ { "type": "array", "items": { "anyOf": [ { "type": "string" }, {} ] } }, { "type": "null" } ] }, "aggregation_strategy": { "title": "Aggregation Strategy", "default": "first", "enum": [ "simple", "first", "average", "max" ], "type": "string" }, "add_prefix_space": { "title": "Add Prefix Space", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "num_workers": { "title": "Num Workers", "default": 0, "type": "integer" }, "flatten_entities_in_meta_data": { "title": "Flatten Entities In Meta Data", "default": false, "type": "boolean" }, "max_seq_len": { "title": "Max Seq Len", "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "pre_split_text": { "title": "Pre Split Text", "default": false, "type": "boolean" }, "ignore_labels": { "title": "Ignore Labels", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } }, "description": "Each parameter can reference other components defined in the same YAML file.", "additionalProperties": false } }, "required": [ "type", "name" ], "additionalProperties": false }, "FARMReaderComponent": { "type": "object", "properties": { "name": { "title": "Name", "description": "Custom name for the component. Helpful for visualization and debugging.", "type": "string" }, "type": { "title": "Type", "description": "Haystack Class name for the component.", "type": "string", "const": "FARMReader" }, "params": { "title": "Parameters", "type": "object", "properties": { "model_name_or_path": { "title": "Model Name Or Path", "type": "string" }, "model_version": { "title": "Model Version", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "context_window_size": { "title": "Context Window Size", "default": 150, "type": "integer" }, "batch_size": { "title": "Batch Size", "default": 50, "type": "integer" }, "use_gpu": { "title": "Use Gpu", "default": true, "type": "boolean" }, "devices": { "title": "Devices", "anyOf": [ { "type": "array", "items": { "anyOf": [ { "type": "string" }, {} ] } }, { "type": "null" } ] }, "no_ans_boost": { "title": "No Ans Boost", "default": 0.0, "type": "number" }, "return_no_answer": { "title": "Return No Answer", "default": false, "type": "boolean" }, "top_k": { "title": "Top K", "default": 10, "type": "integer" }, "top_k_per_candidate": { "title": "Top K Per Candidate", "default": 3, "type": "integer" }, "top_k_per_sample": { "title": "Top K Per Sample", "default": 1, "type": "integer" }, "num_processes": { "title": "Num Processes", "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "max_seq_len": { "title": "Max Seq Len", "default": 256, "type": "integer" }, "doc_stride": { "title": "Doc Stride", "default": 128, "type": "integer" }, "progress_bar": { "title": "Progress Bar", "default": true, "type": "boolean" }, "duplicate_filtering": { "title": "Duplicate Filtering", "default": 0, "type": "integer" }, "use_confidence_scores": { "title": "Use Confidence Scores", "default": true, "type": "boolean" }, "confidence_threshold": { "title": "Confidence Threshold", "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "proxies": { "title": "Proxies", "anyOf": [ { "type": "object" }, { "type": "null" } ], "additionalProperties": { "type": "string" } }, "local_files_only": { "title": "Local Files Only", "default": false }, "force_download": { "title": "Force Download", "default": false }, "use_auth_token": { "title": "Use Auth Token", "anyOf": [ { "type": "boolean" }, { "type": "string" }, { "type": "null" } ] }, "max_query_length": { "title": "Max Query Length", "default": 64, "type": "integer" }, "preprocessing_batch_size": { "title": "Preprocessing Batch Size", "anyOf": [ { "type": "integer" }, { "type": "null" } ] } }, "required": [ "model_name_or_path" ], "description": "Each parameter can reference other components defined in the same YAML file.", "additionalProperties": false } }, "required": [ "type", "name" ], "additionalProperties": false }, "FileTypeClassifierComponent": { "type": "object", "properties": { "name": { "title": "Name", "description": "Custom name for the component. Helpful for visualization and debugging.", "type": "string" }, "type": { "title": "Type", "description": "Haystack Class name for the component.", "type": "string", "const": "FileTypeClassifier" }, "params": { "title": "Parameters", "type": "object", "properties": { "supported_types": { "title": "Supported Types", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } }, "description": "Each parameter can reference other components defined in the same YAML file.", "additionalProperties": false } }, "required": [ "type", "name" ], "additionalProperties": false }, "FilterRetrieverComponent": { "type": "object", "properties": { "name": { "title": "Name", "description": "Custom name for the component. Helpful for visualization and debugging.", "type": "string" }, "type": { "title": "Type", "description": "Haystack Class name for the component.", "type": "string", "const": "FilterRetriever" }, "params": { "title": "Parameters", "type": "object", "properties": { "document_store": { "title": "Document Store", "default": null, "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "top_k": { "title": "Top K", "default": 10, "type": "integer" }, "all_terms_must_match": { "title": "All Terms Must Match", "default": false, "type": "boolean" }, "custom_query": { "title": "Custom Query", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "scale_score": { "title": "Scale Score", "default": true, "type": "boolean" } }, "description": "Each parameter can reference other components defined in the same YAML file.", "additionalProperties": false } }, "required": [ "type", "name" ], "additionalProperties": false }, "ImageToTextConverterComponent": { "type": "object", "properties": { "name": { "title": "Name", "description": "Custom name for the component. Helpful for visualization and debugging.", "type": "string" }, "type": { "title": "Type", "description": "Haystack Class name for the component.", "type": "string", "const": "ImageToTextConverter" }, "params": { "title": "Parameters", "type": "object", "properties": { "remove_numeric_tables": { "title": "Remove Numeric Tables", "default": false, "type": "boolean" }, "valid_languages": { "title": "Valid Languages", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "id_hash_keys": { "title": "Id Hash Keys", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } }, "description": "Each parameter can reference other components defined in the same YAML file.", "additionalProperties": false } }, "required": [ "type", "name" ], "additionalProperties": false }, "JoinAnswersComponent": { "type": "object", "properties": { "name": { "title": "Name", "description": "Custom name for the component. Helpful for visualization and debugging.", "type": "string" }, "type": { "title": "Type", "description": "Haystack Class name for the component.", "type": "string", "const": "JoinAnswers" }, "params": { "title": "Parameters", "type": "object", "properties": { "join_mode": { "title": "Join Mode", "default": "concatenate", "type": "string" }, "weights": { "title": "Weights", "anyOf": [ { "type": "array", "items": { "type": "number" } }, { "type": "null" } ] }, "top_k_join": { "title": "Top K Join", "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "sort_by_score": { "title": "Sort By Score", "default": true, "type": "boolean" } }, "description": "Each parameter can reference other components defined in the same YAML file.", "additionalProperties": false } }, "required": [ "type", "name" ], "additionalProperties": false }, "JoinDocumentsComponent": { "type": "object", "properties": { "name": { "title": "Name", "description": "Custom name for the component. Helpful for visualization and debugging.", "type": "string" }, "type": { "title": "Type", "description": "Haystack Class name for the component.", "type": "string", "const": "JoinDocuments" }, "params": { "title": "Parameters", "type": "object", "properties": { "join_mode": { "title": "Join Mode", "default": "concatenate", "type": "string" }, "weights": { "title": "Weights", "anyOf": [ { "type": "array", "items": { "type": "number" } }, { "type": "null" } ] }, "top_k_join": { "title": "Top K Join", "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "sort_by_score": { "title": "Sort By Score", "default": true, "type": "boolean" } }, "description": "Each parameter can reference other components defined in the same YAML file.", "additionalProperties": false } }, "required": [ "type", "name" ], "additionalProperties": false }, "JsonConverterComponent": { "type": "object", "properties": { "name": { "title": "Name", "description": "Custom name for the component. Helpful for visualization and debugging.", "type": "string" }, "type": { "title": "Type", "description": "Haystack Class name for the component.", "type": "string", "const": "JsonConverter" }, "params": { "title": "Parameters", "type": "object", "properties": { "remove_numeric_tables": { "title": "Remove Numeric Tables", "default": false, "type": "boolean" }, "valid_languages": { "title": "Valid Languages", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "id_hash_keys": { "title": "Id Hash Keys", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "progress_bar": { "title": "Progress Bar", "default": true, "type": "boolean" } }, "description": "Each parameter can reference other components defined in the same YAML file.", "additionalProperties": false } }, "required": [ "type", "name" ], "additionalProperties": false }, "LangdetectDocumentLanguageClassifierComponent": { "type": "object", "properties": { "name": { "title": "Name", "description": "Custom name for the component. Helpful for visualization and debugging.", "type": "string" }, "type": { "title": "Type", "description": "Haystack Class name for the component.", "type": "string", "const": "LangdetectDocumentLanguageClassifier" }, "params": { "title": "Parameters", "type": "object", "properties": { "route_by_language": { "title": "Route By Language", "default": true, "type": "boolean" }, "languages_to_route": { "title": "Languages To Route", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } }, "description": "Each parameter can reference other components defined in the same YAML file.", "additionalProperties": false } }, "required": [ "type", "name" ], "additionalProperties": false }, "MarkdownConverterComponent": { "type": "object", "properties": { "name": { "title": "Name", "description": "Custom name for the component. Helpful for visualization and debugging.", "type": "string" }, "type": { "title": "Type", "description": "Haystack Class name for the component.", "type": "string", "const": "MarkdownConverter" }, "params": { "title": "Parameters", "type": "object", "properties": { "remove_numeric_tables": { "title": "Remove Numeric Tables", "default": false, "type": "boolean" }, "valid_languages": { "title": "Valid Languages", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "id_hash_keys": { "title": "Id Hash Keys", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "progress_bar": { "title": "Progress Bar", "default": true, "type": "boolean" }, "remove_code_snippets": { "title": "Remove Code Snippets", "default": true, "type": "boolean" }, "extract_headlines": { "title": "Extract Headlines", "default": false, "type": "boolean" }, "add_frontmatter_to_meta": { "title": "Add Frontmatter To Meta", "default": false, "type": "boolean" } }, "description": "Each parameter can reference other components defined in the same YAML file.", "additionalProperties": false } }, "required": [ "type", "name" ], "additionalProperties": false }, "MultiModalRetrieverComponent": { "type": "object", "properties": { "name": { "title": "Name", "description": "Custom name for the component. Helpful for visualization and debugging.", "type": "string" }, "type": { "title": "Type", "description": "Haystack Class name for the component.", "type": "string", "const": "MultiModalRetriever" }, "params": { "title": "Parameters", "type": "object", "properties": { "document_store": { "title": "Document Store", "type": "string" }, "query_embedding_model": { "title": "Query Embedding Model", "anyOf": [ { "type": "string", "format": "path" }, { "type": "string" } ] }, "document_embedding_models": { "title": "Document Embedding Models", "type": "object", "additionalProperties": { "anyOf": [ { "type": "string", "format": "path" }, { "type": "string" } ] } }, "query_type": { "title": "Query Type", "default": "text", "type": "string" }, "query_feature_extractor_params": { "title": "Query Feature Extractor Params", "anyOf": [ { "type": "object" }, { "type": "null" } ] }, "document_feature_extractors_params": { "title": "Document Feature Extractors Params", "anyOf": [ { "type": "object" }, { "type": "null" } ], "additionalProperties": { "type": "object" } }, "top_k": { "title": "Top K", "default": 10, "type": "integer" }, "batch_size": { "title": "Batch Size", "default": 16, "type": "integer" }, "embed_meta_fields": { "title": "Embed Meta Fields", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "similarity_function": { "title": "Similarity Function", "default": "dot_product", "type": "string" }, "progress_bar": { "title": "Progress Bar", "default": true, "type": "boolean" }, "devices": { "title": "Devices", "anyOf": [ { "type": "array", "items": { "anyOf": [ { "type": "string" }, {} ] } }, { "type": "null" } ] }, "use_auth_token": { "title": "Use Auth Token", "anyOf": [ { "type": "boolean" }, { "type": "string" }, { "type": "null" } ] }, "scale_score": { "title": "Scale Score", "default": true, "type": "boolean" } }, "required": [ "document_store", "query_embedding_model", "document_embedding_models" ], "description": "Each parameter can reference other components defined in the same YAML file.", "additionalProperties": false } }, "required": [ "type", "name" ], "additionalProperties": false }, "MultihopEmbeddingRetrieverComponent": { "type": "object", "properties": { "name": { "title": "Name", "description": "Custom name for the component. Helpful for visualization and debugging.", "type": "string" }, "type": { "title": "Type", "description": "Haystack Class name for the component.", "type": "string", "const": "MultihopEmbeddingRetriever" }, "params": { "title": "Parameters", "type": "object", "properties": { "embedding_model": { "title": "Embedding Model", "type": "string" }, "document_store": { "title": "Document Store", "default": null, "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "model_version": { "title": "Model Version", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "num_iterations": { "title": "Num Iterations", "default": 2, "type": "integer" }, "use_gpu": { "title": "Use Gpu", "default": true, "type": "boolean" }, "batch_size": { "title": "Batch Size", "default": 32, "type": "integer" }, "max_seq_len": { "title": "Max Seq Len", "default": 512, "type": "integer" }, "model_format": { "title": "Model Format", "default": "farm", "type": "string" }, "pooling_strategy": { "title": "Pooling Strategy", "default": "reduce_mean", "type": "string" }, "emb_extraction_layer": { "title": "Emb Extraction Layer", "default": -1, "type": "integer" }, "top_k": { "title": "Top K", "default": 10, "type": "integer" }, "progress_bar": { "title": "Progress Bar", "default": true, "type": "boolean" }, "devices": { "title": "Devices", "anyOf": [ { "type": "array", "items": { "anyOf": [ { "type": "string" }, {} ] } }, { "type": "null" } ] }, "use_auth_token": { "title": "Use Auth Token", "anyOf": [ { "type": "boolean" }, { "type": "string" }, { "type": "null" } ] }, "scale_score": { "title": "Scale Score", "default": true, "type": "boolean" }, "embed_meta_fields": { "title": "Embed Meta Fields", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } }, "required": [ "embedding_model" ], "description": "Each parameter can reference other components defined in the same YAML file.", "additionalProperties": false } }, "required": [ "type", "name" ], "additionalProperties": false }, "OpenAIAnswerGeneratorComponent": { "type": "object", "properties": { "name": { "title": "Name", "description": "Custom name for the component. Helpful for visualization and debugging.", "type": "string" }, "type": { "title": "Type", "description": "Haystack Class name for the component.", "type": "string", "const": "OpenAIAnswerGenerator" }, "params": { "title": "Parameters", "type": "object", "properties": { "api_key": { "title": "Api Key", "type": "string" }, "azure_base_url": { "title": "Azure Base Url", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "azure_deployment_name": { "title": "Azure Deployment Name", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "model": { "title": "Model", "default": "text-davinci-003", "type": "string" }, "max_tokens": { "title": "Max Tokens", "default": 50, "type": "integer" }, "api_version": { "title": "Api Version", "default": "2022-12-01", "type": "string" }, "top_k": { "title": "Top K", "default": 5, "type": "integer" }, "temperature": { "title": "Temperature", "default": 0.2, "type": "number" }, "presence_penalty": { "title": "Presence Penalty", "default": 0.1, "type": "number" }, "frequency_penalty": { "title": "Frequency Penalty", "default": 0.1, "type": "number" }, "examples_context": { "title": "Examples Context", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "examples": { "title": "Examples", "anyOf": [ { "type": "array", "items": { "type": "array", "items": { "type": "string" } } }, { "type": "null" } ] }, "stop_words": { "title": "Stop Words", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "progress_bar": { "title": "Progress Bar", "default": true, "type": "boolean" }, "prompt_template": { "title": "Prompt Template", "default": null, "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "context_join_str": { "title": "Context Join Str", "default": " ", "type": "string" }, "moderate_content": { "title": "Moderate Content", "default": false, "type": "boolean" }, "api_base": { "title": "Api Base", "default": "https://api.openai.com/v1", "type": "string" } }, "required": [ "api_key" ], "description": "Each parameter can reference other components defined in the same YAML file.", "additionalProperties": false } }, "required": [ "type", "name" ], "additionalProperties": false }, "PDFToTextConverterComponent": { "type": "object", "properties": { "name": { "title": "Name", "description": "Custom name for the component. Helpful for visualization and debugging.", "type": "string" }, "type": { "title": "Type", "description": "Haystack Class name for the component.", "type": "string", "const": "PDFToTextConverter" }, "params": { "title": "Parameters", "type": "object", "properties": { "remove_numeric_tables": { "title": "Remove Numeric Tables", "default": false, "type": "boolean" }, "valid_languages": { "title": "Valid Languages", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "id_hash_keys": { "title": "Id Hash Keys", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "encoding": { "title": "Encoding", "default": "UTF-8", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "keep_physical_layout": { "title": "Keep Physical Layout", "default": false, "type": "boolean" } }, "description": "Each parameter can reference other components defined in the same YAML file.", "additionalProperties": false } }, "required": [ "type", "name" ], "additionalProperties": false }, "ParsrConverterComponent": { "type": "object", "properties": { "name": { "title": "Name", "description": "Custom name for the component. Helpful for visualization and debugging.", "type": "string" }, "type": { "title": "Type", "description": "Haystack Class name for the component.", "type": "string", "const": "ParsrConverter" }, "params": { "title": "Parameters", "type": "object", "properties": { "parsr_url": { "title": "Parsr Url", "default": "http://localhost:3001", "type": "string" }, "extractor": { "title": "Extractor", "default": "pdfminer", "enum": [ "pdfminer", "pdfjs" ], "type": "string" }, "table_detection_mode": { "title": "Table Detection Mode", "default": "lattice", "enum": [ "lattice", "stream" ], "type": "string" }, "preceding_context_len": { "title": "Preceding Context Len", "default": 3, "type": "integer" }, "following_context_len": { "title": "Following Context Len", "default": 3, "type": "integer" }, "remove_page_headers": { "title": "Remove Page Headers", "default": false, "type": "boolean" }, "remove_page_footers": { "title": "Remove Page Footers", "default": false, "type": "boolean" }, "remove_table_of_contents": { "title": "Remove Table Of Contents", "default": false, "type": "boolean" }, "valid_languages": { "title": "Valid Languages", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "id_hash_keys": { "title": "Id Hash Keys", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "add_page_number": { "title": "Add Page Number", "default": true, "type": "boolean" }, "extract_headlines": { "title": "Extract Headlines", "default": true, "type": "boolean" }, "timeout": { "title": "Timeout", "default": 10.0, "anyOf": [ { "type": "number" }, { "type": "array", "minItems": 2, "maxItems": 2, "prefixItems": [ { "type": "number" }, { "type": "number" } ] } ] } }, "description": "Each parameter can reference other components defined in the same YAML file.", "additionalProperties": false } }, "required": [ "type", "name" ], "additionalProperties": false }, "PreProcessorComponent": { "type": "object", "properties": { "name": { "title": "Name", "description": "Custom name for the component. Helpful for visualization and debugging.", "type": "string" }, "type": { "title": "Type", "description": "Haystack Class name for the component.", "type": "string", "const": "PreProcessor" }, "params": { "title": "Parameters", "type": "object", "properties": { "clean_whitespace": { "title": "Clean Whitespace", "default": true, "type": "boolean" }, "clean_header_footer": { "title": "Clean Header Footer", "default": false, "type": "boolean" }, "clean_empty_lines": { "title": "Clean Empty Lines", "default": true, "type": "boolean" }, "remove_substrings": { "title": "Remove Substrings", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "split_by": { "title": "Split By", "default": "word", "enum": [ "word", "sentence", "passage" ], "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "split_length": { "title": "Split Length", "default": 200, "type": "integer" }, "split_overlap": { "title": "Split Overlap", "default": 0, "type": "integer" }, "split_respect_sentence_boundary": { "title": "Split Respect Sentence Boundary", "default": true, "type": "boolean" }, "tokenizer_model_folder": { "title": "Tokenizer Model Folder", "anyOf": [ { "type": "string" }, { "type": "string", "format": "path" }, { "type": "null" } ] }, "language": { "title": "Language", "default": "en", "type": "string" }, "id_hash_keys": { "title": "Id Hash Keys", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "progress_bar": { "title": "Progress Bar", "default": true, "type": "boolean" }, "add_page_number": { "title": "Add Page Number", "default": false, "type": "boolean" }, "max_chars_check": { "title": "Max Chars Check", "default": 10000, "type": "integer" } }, "description": "Each parameter can reference other components defined in the same YAML file.", "additionalProperties": false } }, "required": [ "type", "name" ], "additionalProperties": false }, "PromptModelComponent": { "type": "object", "properties": { "name": { "title": "Name", "description": "Custom name for the component. Helpful for visualization and debugging.", "type": "string" }, "type": { "title": "Type", "description": "Haystack Class name for the component.", "type": "string", "const": "PromptModel" }, "params": { "title": "Parameters", "type": "object", "properties": { "model_name_or_path": { "title": "Model Name Or Path", "default": "google/flan-t5-base", "type": "string" }, "max_length": { "title": "Max Length", "default": 100, "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "api_key": { "title": "Api Key", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "use_auth_token": { "title": "Use Auth Token", "anyOf": [ { "type": "boolean" }, { "type": "string" }, { "type": "null" } ] }, "use_gpu": { "title": "Use Gpu", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "devices": { "title": "Devices", "anyOf": [ { "type": "array", "items": { "anyOf": [ { "type": "string" }, {} ] } }, { "type": "null" } ] }, "invocation_layer_class": { "title": "Invocation Layer Class" }, "model_kwargs": { "title": "Model Kwargs", "anyOf": [ { "type": "object" }, { "type": "null" } ] } }, "description": "Each parameter can reference other components defined in the same YAML file.", "additionalProperties": false } }, "required": [ "type", "name" ], "additionalProperties": false }, "PromptNodeComponent": { "type": "object", "properties": { "name": { "title": "Name", "description": "Custom name for the component. Helpful for visualization and debugging.", "type": "string" }, "type": { "title": "Type", "description": "Haystack Class name for the component.", "type": "string", "const": "PromptNode" }, "params": { "title": "Parameters", "type": "object", "properties": { "model_name_or_path": { "title": "Model Name Or Path", "default": "google/flan-t5-base", "anyOf": [ { "type": "string" }, { "type": "string" } ] }, "default_prompt_template": { "title": "Default Prompt Template", "anyOf": [ { "type": "string" }, { "type": "string" }, { "type": "null" } ] }, "output_variable": { "title": "Output Variable", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "max_length": { "title": "Max Length", "default": 100, "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "api_key": { "title": "Api Key", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "use_auth_token": { "title": "Use Auth Token", "anyOf": [ { "type": "boolean" }, { "type": "string" }, { "type": "null" } ] }, "use_gpu": { "title": "Use Gpu", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "devices": { "title": "Devices", "anyOf": [ { "type": "array", "items": { "anyOf": [ { "type": "string" }, {} ] } }, { "type": "null" } ] }, "stop_words": { "title": "Stop Words", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "top_k": { "title": "Top K", "default": 1, "type": "integer" }, "debug": { "title": "Debug", "default": false, "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "model_kwargs": { "title": "Model Kwargs", "anyOf": [ { "type": "object" }, { "type": "null" } ] } }, "description": "Each parameter can reference other components defined in the same YAML file.", "additionalProperties": false } }, "required": [ "type", "name" ], "additionalProperties": false }, "PromptTemplateComponent": { "type": "object", "properties": { "name": { "title": "Name", "description": "Custom name for the component. Helpful for visualization and debugging.", "type": "string" }, "type": { "title": "Type", "description": "Haystack Class name for the component.", "type": "string", "const": "PromptTemplate" }, "params": { "title": "Parameters", "type": "object", "properties": { "prompt": { "title": "Prompt", "type": "string" }, "output_parser": { "title": "Output Parser", "anyOf": [ { "type": "object" }, { "type": "string" }, { "type": "null" } ] } }, "required": [ "prompt" ], "description": "Each parameter can reference other components defined in the same YAML file.", "additionalProperties": false } }, "required": [ "type", "name" ], "additionalProperties": false }, "PseudoLabelGeneratorComponent": { "type": "object", "properties": { "name": { "title": "Name", "description": "Custom name for the component. Helpful for visualization and debugging.", "type": "string" }, "type": { "title": "Type", "description": "Haystack Class name for the component.", "type": "string", "const": "PseudoLabelGenerator" }, "params": { "title": "Parameters", "type": "object", "properties": { "question_producer": { "title": "Question Producer", "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "object", "additionalProperties": { "type": "string" } } } ] }, "retriever": { "title": "Retriever" }, "cross_encoder_model_name_or_path": { "title": "Cross Encoder Model Name Or Path", "default": "cross-encoder/ms-marco-MiniLM-L-6-v2", "type": "string" }, "max_questions_per_document": { "title": "Max Questions Per Document", "default": 3, "type": "integer" }, "top_k": { "title": "Top K", "default": 50, "type": "integer" }, "batch_size": { "title": "Batch Size", "default": 16, "type": "integer" }, "progress_bar": { "title": "Progress Bar", "default": true, "type": "boolean" }, "use_auth_token": { "title": "Use Auth Token", "anyOf": [ { "type": "boolean" }, { "type": "string" }, { "type": "null" } ] }, "use_gpu": { "title": "Use Gpu", "default": true, "type": "boolean" }, "devices": { "title": "Devices", "anyOf": [ { "type": "array", "items": { "anyOf": [ { "type": "string" }, {} ] } }, { "type": "null" } ] } }, "required": [ "question_producer", "retriever" ], "description": "Each parameter can reference other components defined in the same YAML file.", "additionalProperties": false } }, "required": [ "type", "name" ], "additionalProperties": false }, "QuestionGeneratorComponent": { "type": "object", "properties": { "name": { "title": "Name", "description": "Custom name for the component. Helpful for visualization and debugging.", "type": "string" }, "type": { "title": "Type", "description": "Haystack Class name for the component.", "type": "string", "const": "QuestionGenerator" }, "params": { "title": "Parameters", "type": "object", "properties": { "model_name_or_path": { "title": "Model Name Or Path", "default": "valhalla/t5-base-e2e-qg", "type": "string" }, "model_version": { "title": "Model Version", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "num_beams": { "title": "Num Beams", "default": 4, "type": "integer" }, "max_length": { "title": "Max Length", "default": 256, "type": "integer" }, "no_repeat_ngram_size": { "title": "No Repeat Ngram Size", "default": 3, "type": "integer" }, "length_penalty": { "title": "Length Penalty", "default": 1.5, "type": "number" }, "early_stopping": { "title": "Early Stopping", "default": true, "type": "boolean" }, "split_length": { "title": "Split Length", "default": 50, "type": "integer" }, "split_overlap": { "title": "Split Overlap", "default": 10, "type": "integer" }, "use_gpu": { "title": "Use Gpu", "default": true, "type": "boolean" }, "prompt": { "title": "Prompt", "default": "generate questions:", "type": "string" }, "num_queries_per_doc": { "title": "Num Queries Per Doc", "default": 1, "type": "integer" }, "sep_token": { "title": "Sep Token", "default": "", "type": "string" }, "batch_size": { "title": "Batch Size", "default": 16, "type": "integer" }, "progress_bar": { "title": "Progress Bar", "default": true, "type": "boolean" }, "use_auth_token": { "title": "Use Auth Token", "anyOf": [ { "type": "boolean" }, { "type": "string" }, { "type": "null" } ] }, "devices": { "title": "Devices", "anyOf": [ { "type": "array", "items": { "anyOf": [ { "type": "string" }, {} ] } }, { "type": "null" } ] } }, "description": "Each parameter can reference other components defined in the same YAML file.", "additionalProperties": false } }, "required": [ "type", "name" ], "additionalProperties": false }, "RCIReaderComponent": { "type": "object", "properties": { "name": { "title": "Name", "description": "Custom name for the component. Helpful for visualization and debugging.", "type": "string" }, "type": { "title": "Type", "description": "Haystack Class name for the component.", "type": "string", "const": "RCIReader" }, "params": { "title": "Parameters", "type": "object", "properties": { "row_model_name_or_path": { "title": "Row Model Name Or Path", "default": "michaelrglass/albert-base-rci-wikisql-row", "type": "string" }, "column_model_name_or_path": { "title": "Column Model Name Or Path", "default": "michaelrglass/albert-base-rci-wikisql-col", "type": "string" }, "row_model_version": { "title": "Row Model Version", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "column_model_version": { "title": "Column Model Version", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "row_tokenizer": { "title": "Row Tokenizer", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "column_tokenizer": { "title": "Column Tokenizer", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "use_gpu": { "title": "Use Gpu", "default": true, "type": "boolean" }, "top_k": { "title": "Top K", "default": 10, "type": "integer" }, "max_seq_len": { "title": "Max Seq Len", "default": 256, "type": "integer" }, "use_auth_token": { "title": "Use Auth Token", "anyOf": [ { "type": "boolean" }, { "type": "string" }, { "type": "null" } ] } }, "description": "Each parameter can reference other components defined in the same YAML file.", "additionalProperties": false } }, "required": [ "type", "name" ], "additionalProperties": false }, "RouteDocumentsComponent": { "type": "object", "properties": { "name": { "title": "Name", "description": "Custom name for the component. Helpful for visualization and debugging.", "type": "string" }, "type": { "title": "Type", "description": "Haystack Class name for the component.", "type": "string", "const": "RouteDocuments" }, "params": { "title": "Parameters", "type": "object", "properties": { "split_by": { "title": "Split By", "default": "content_type", "type": "string" }, "metadata_values": { "title": "Metadata Values", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "array", "items": { "type": "array", "items": { "type": "string" } } }, { "type": "null" } ] }, "return_remaining": { "title": "Return Remaining", "default": false, "type": "boolean" } }, "description": "Each parameter can reference other components defined in the same YAML file.", "additionalProperties": false } }, "required": [ "type", "name" ], "additionalProperties": false }, "SentenceTransformersRankerComponent": { "type": "object", "properties": { "name": { "title": "Name", "description": "Custom name for the component. Helpful for visualization and debugging.", "type": "string" }, "type": { "title": "Type", "description": "Haystack Class name for the component.", "type": "string", "const": "SentenceTransformersRanker" }, "params": { "title": "Parameters", "type": "object", "properties": { "model_name_or_path": { "title": "Model Name Or Path", "anyOf": [ { "type": "string" }, { "type": "string", "format": "path" } ] }, "model_version": { "title": "Model Version", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "top_k": { "title": "Top K", "default": 10, "type": "integer" }, "use_gpu": { "title": "Use Gpu", "default": true, "type": "boolean" }, "devices": { "title": "Devices", "anyOf": [ { "type": "array", "items": { "anyOf": [ { "type": "string" }, {} ] } }, { "type": "null" } ] }, "batch_size": { "title": "Batch Size", "default": 16, "type": "integer" }, "scale_score": { "title": "Scale Score", "default": true, "type": "boolean" }, "progress_bar": { "title": "Progress Bar", "default": true, "type": "boolean" }, "use_auth_token": { "title": "Use Auth Token", "anyOf": [ { "type": "boolean" }, { "type": "string" }, { "type": "null" } ] } }, "required": [ "model_name_or_path" ], "description": "Each parameter can reference other components defined in the same YAML file.", "additionalProperties": false } }, "required": [ "type", "name" ], "additionalProperties": false }, "ShaperComponent": { "type": "object", "properties": { "name": { "title": "Name", "description": "Custom name for the component. Helpful for visualization and debugging.", "type": "string" }, "type": { "title": "Type", "description": "Haystack Class name for the component.", "type": "string", "const": "Shaper" }, "params": { "title": "Parameters", "type": "object", "properties": { "func": { "title": "Func", "type": "string" }, "outputs": { "title": "Outputs", "type": "array", "items": { "type": "string" } }, "inputs": { "title": "Inputs", "anyOf": [ { "type": "object" }, { "type": "null" } ], "additionalProperties": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "string" } ] } }, "params": { "title": "Params", "anyOf": [ { "type": "object" }, { "type": "null" } ] }, "publish_outputs": { "title": "Publish Outputs", "default": true, "anyOf": [ { "type": "boolean" }, { "type": "array", "items": { "type": "string" } } ] } }, "required": [ "func", "outputs" ], "description": "Each parameter can reference other components defined in the same YAML file.", "additionalProperties": false } }, "required": [ "type", "name" ], "additionalProperties": false }, "SklearnQueryClassifierComponent": { "type": "object", "properties": { "name": { "title": "Name", "description": "Custom name for the component. Helpful for visualization and debugging.", "type": "string" }, "type": { "title": "Type", "description": "Haystack Class name for the component.", "type": "string", "const": "SklearnQueryClassifier" }, "params": { "title": "Parameters", "type": "object", "properties": { "model_name_or_path": { "title": "Model Name Or Path", "default": "https://ext-models-haystack.s3.eu-central-1.amazonaws.com/gradboost_query_classifier_2022/model.pickle", "anyOf": [ { "type": "string" }, {} ] }, "vectorizer_name_or_path": { "title": "Vectorizer Name Or Path", "default": "https://ext-models-haystack.s3.eu-central-1.amazonaws.com/gradboost_query_classifier_2022/vectorizer.pickle", "anyOf": [ { "type": "string" }, {} ] }, "batch_size": { "title": "Batch Size", "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "progress_bar": { "title": "Progress Bar", "default": true, "type": "boolean" } }, "description": "Each parameter can reference other components defined in the same YAML file.", "additionalProperties": false } }, "required": [ "type", "name" ], "additionalProperties": false }, "TableReaderComponent": { "type": "object", "properties": { "name": { "title": "Name", "description": "Custom name for the component. Helpful for visualization and debugging.", "type": "string" }, "type": { "title": "Type", "description": "Haystack Class name for the component.", "type": "string", "const": "TableReader" }, "params": { "title": "Parameters", "type": "object", "properties": { "model_name_or_path": { "title": "Model Name Or Path", "default": "google/tapas-base-finetuned-wtq", "type": "string" }, "model_version": { "title": "Model Version", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "tokenizer": { "title": "Tokenizer", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "use_gpu": { "title": "Use Gpu", "default": true, "type": "boolean" }, "top_k": { "title": "Top K", "default": 10, "type": "integer" }, "top_k_per_candidate": { "title": "Top K Per Candidate", "default": 3, "type": "integer" }, "return_no_answer": { "title": "Return No Answer", "default": false, "type": "boolean" }, "max_seq_len": { "title": "Max Seq Len", "default": 256, "type": "integer" }, "use_auth_token": { "title": "Use Auth Token", "anyOf": [ { "type": "boolean" }, { "type": "string" }, { "type": "null" } ] }, "devices": { "title": "Devices", "anyOf": [ { "type": "array", "items": { "anyOf": [ { "type": "string" }, {} ] } }, { "type": "null" } ] } }, "description": "Each parameter can reference other components defined in the same YAML file.", "additionalProperties": false } }, "required": [ "type", "name" ], "additionalProperties": false }, "TableTextRetrieverComponent": { "type": "object", "properties": { "name": { "title": "Name", "description": "Custom name for the component. Helpful for visualization and debugging.", "type": "string" }, "type": { "title": "Type", "description": "Haystack Class name for the component.", "type": "string", "const": "TableTextRetriever" }, "params": { "title": "Parameters", "type": "object", "properties": { "document_store": { "title": "Document Store", "default": null, "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "query_embedding_model": { "title": "Query Embedding Model", "default": "deepset/bert-small-mm_retrieval-question_encoder", "anyOf": [ { "type": "string", "format": "path" }, { "type": "string" } ] }, "passage_embedding_model": { "title": "Passage Embedding Model", "default": "deepset/bert-small-mm_retrieval-passage_encoder", "anyOf": [ { "type": "string", "format": "path" }, { "type": "string" } ] }, "table_embedding_model": { "title": "Table Embedding Model", "default": "deepset/bert-small-mm_retrieval-table_encoder", "anyOf": [ { "type": "string", "format": "path" }, { "type": "string" } ] }, "model_version": { "title": "Model Version", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "max_seq_len_query": { "title": "Max Seq Len Query", "default": 64, "type": "integer" }, "max_seq_len_passage": { "title": "Max Seq Len Passage", "default": 256, "type": "integer" }, "max_seq_len_table": { "title": "Max Seq Len Table", "default": 256, "type": "integer" }, "top_k": { "title": "Top K", "default": 10, "type": "integer" }, "use_gpu": { "title": "Use Gpu", "default": true, "type": "boolean" }, "batch_size": { "title": "Batch Size", "default": 16, "type": "integer" }, "embed_meta_fields": { "title": "Embed Meta Fields", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "use_fast_tokenizers": { "title": "Use Fast Tokenizers", "default": true, "type": "boolean" }, "similarity_function": { "title": "Similarity Function", "default": "dot_product", "type": "string" }, "global_loss_buffer_size": { "title": "Global Loss Buffer Size", "default": 150000, "type": "integer" }, "progress_bar": { "title": "Progress Bar", "default": true, "type": "boolean" }, "devices": { "title": "Devices", "anyOf": [ { "type": "array", "items": { "anyOf": [ { "type": "string" }, {} ] } }, { "type": "null" } ] }, "use_auth_token": { "title": "Use Auth Token", "anyOf": [ { "type": "boolean" }, { "type": "string" }, { "type": "null" } ] }, "scale_score": { "title": "Scale Score", "default": true, "type": "boolean" }, "use_fast": { "title": "Use Fast", "default": true, "type": "boolean" } }, "description": "Each parameter can reference other components defined in the same YAML file.", "additionalProperties": false } }, "required": [ "type", "name" ], "additionalProperties": false }, "TextConverterComponent": { "type": "object", "properties": { "name": { "title": "Name", "description": "Custom name for the component. Helpful for visualization and debugging.", "type": "string" }, "type": { "title": "Type", "description": "Haystack Class name for the component.", "type": "string", "const": "TextConverter" }, "params": { "title": "Parameters", "type": "object", "properties": { "remove_numeric_tables": { "title": "Remove Numeric Tables", "default": false, "type": "boolean" }, "valid_languages": { "title": "Valid Languages", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "id_hash_keys": { "title": "Id Hash Keys", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "progress_bar": { "title": "Progress Bar", "default": true, "type": "boolean" } }, "description": "Each parameter can reference other components defined in the same YAML file.", "additionalProperties": false } }, "required": [ "type", "name" ], "additionalProperties": false }, "TfidfRetrieverComponent": { "type": "object", "properties": { "name": { "title": "Name", "description": "Custom name for the component. Helpful for visualization and debugging.", "type": "string" }, "type": { "title": "Type", "description": "Haystack Class name for the component.", "type": "string", "const": "TfidfRetriever" }, "params": { "title": "Parameters", "type": "object", "properties": { "document_store": { "title": "Document Store", "default": null, "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "top_k": { "title": "Top K", "default": 10, "type": "integer" }, "auto_fit": { "title": "Auto Fit", "default": true } }, "description": "Each parameter can reference other components defined in the same YAML file.", "additionalProperties": false } }, "required": [ "type", "name" ], "additionalProperties": false }, "TikaConverterComponent": { "type": "object", "properties": { "name": { "title": "Name", "description": "Custom name for the component. Helpful for visualization and debugging.", "type": "string" }, "type": { "title": "Type", "description": "Haystack Class name for the component.", "type": "string", "const": "TikaConverter" }, "params": { "title": "Parameters", "type": "object", "properties": { "tika_url": { "title": "Tika Url", "default": "http://localhost:9998/tika", "type": "string" }, "remove_numeric_tables": { "title": "Remove Numeric Tables", "default": false, "type": "boolean" }, "valid_languages": { "title": "Valid Languages", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "id_hash_keys": { "title": "Id Hash Keys", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "timeout": { "title": "Timeout", "default": 10.0, "anyOf": [ { "type": "number" }, { "type": "array", "minItems": 2, "maxItems": 2, "prefixItems": [ { "type": "number" }, { "type": "number" } ] } ] } }, "description": "Each parameter can reference other components defined in the same YAML file.", "additionalProperties": false } }, "required": [ "type", "name" ], "additionalProperties": false }, "TopPSamplerComponent": { "type": "object", "properties": { "name": { "title": "Name", "description": "Custom name for the component. Helpful for visualization and debugging.", "type": "string" }, "type": { "title": "Type", "description": "Haystack Class name for the component.", "type": "string", "const": "TopPSampler" }, "params": { "title": "Parameters", "type": "object", "properties": { "model_name_or_path": { "title": "Model Name Or Path", "default": "cross-encoder/ms-marco-MiniLM-L-6-v2", "anyOf": [ { "type": "string" }, { "type": "string", "format": "path" } ] }, "top_p": { "title": "Top P", "default": 1.0, "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "strict": { "title": "Strict", "default": false, "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "score_field": { "title": "Score Field", "default": "score", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "use_gpu": { "title": "Use Gpu", "default": true, "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "devices": { "title": "Devices", "anyOf": [ { "type": "array", "items": { "anyOf": [ { "type": "string" }, {} ] } }, { "type": "null" } ] } }, "description": "Each parameter can reference other components defined in the same YAML file.", "additionalProperties": false } }, "required": [ "type", "name" ], "additionalProperties": false }, "TransformersDocumentClassifierComponent": { "type": "object", "properties": { "name": { "title": "Name", "description": "Custom name for the component. Helpful for visualization and debugging.", "type": "string" }, "type": { "title": "Type", "description": "Haystack Class name for the component.", "type": "string", "const": "TransformersDocumentClassifier" }, "params": { "title": "Parameters", "type": "object", "properties": { "model_name_or_path": { "title": "Model Name Or Path", "default": "bhadresh-savani/distilbert-base-uncased-emotion", "type": "string" }, "model_version": { "title": "Model Version", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "tokenizer": { "title": "Tokenizer", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "use_gpu": { "title": "Use Gpu", "default": true, "type": "boolean" }, "top_k": { "title": "Top K", "default": 1, "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "task": { "title": "Task", "default": "text-classification", "type": "string" }, "labels": { "title": "Labels", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "batch_size": { "title": "Batch Size", "default": 16, "type": "integer" }, "classification_field": { "title": "Classification Field", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "progress_bar": { "title": "Progress Bar", "default": true, "type": "boolean" }, "use_auth_token": { "title": "Use Auth Token", "anyOf": [ { "type": "boolean" }, { "type": "string" }, { "type": "null" } ] }, "devices": { "title": "Devices", "anyOf": [ { "type": "array", "items": { "anyOf": [ { "type": "string" }, {} ] } }, { "type": "null" } ] } }, "description": "Each parameter can reference other components defined in the same YAML file.", "additionalProperties": false } }, "required": [ "type", "name" ], "additionalProperties": false }, "TransformersDocumentLanguageClassifierComponent": { "type": "object", "properties": { "name": { "title": "Name", "description": "Custom name for the component. Helpful for visualization and debugging.", "type": "string" }, "type": { "title": "Type", "description": "Haystack Class name for the component.", "type": "string", "const": "TransformersDocumentLanguageClassifier" }, "params": { "title": "Parameters", "type": "object", "properties": { "route_by_language": { "title": "Route By Language", "default": true, "type": "boolean" }, "languages_to_route": { "title": "Languages To Route", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "labels_to_languages_mapping": { "title": "Labels To Languages Mapping", "anyOf": [ { "type": "object" }, { "type": "null" } ], "additionalProperties": { "type": "string" } }, "model_name_or_path": { "title": "Model Name Or Path", "default": "papluca/xlm-roberta-base-language-detection", "type": "string" }, "model_version": { "title": "Model Version", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "tokenizer": { "title": "Tokenizer", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "use_gpu": { "title": "Use Gpu", "default": true, "type": "boolean" }, "batch_size": { "title": "Batch Size", "default": 16, "type": "integer" }, "progress_bar": { "title": "Progress Bar", "default": true, "type": "boolean" }, "use_auth_token": { "title": "Use Auth Token", "anyOf": [ { "type": "boolean" }, { "type": "string" }, { "type": "null" } ] }, "devices": { "title": "Devices", "anyOf": [ { "type": "array", "items": { "anyOf": [ { "type": "string" }, {} ] } }, { "type": "null" } ] } }, "description": "Each parameter can reference other components defined in the same YAML file.", "additionalProperties": false } }, "required": [ "type", "name" ], "additionalProperties": false }, "TransformersImageToTextComponent": { "type": "object", "properties": { "name": { "title": "Name", "description": "Custom name for the component. Helpful for visualization and debugging.", "type": "string" }, "type": { "title": "Type", "description": "Haystack Class name for the component.", "type": "string", "const": "TransformersImageToText" }, "params": { "title": "Parameters", "type": "object", "properties": { "model_name_or_path": { "title": "Model Name Or Path", "default": "Salesforce/blip-image-captioning-base", "type": "string" }, "model_version": { "title": "Model Version", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "generation_kwargs": { "title": "Generation Kwargs", "anyOf": [ { "type": "object" }, { "type": "null" } ] }, "use_gpu": { "title": "Use Gpu", "default": true, "type": "boolean" }, "batch_size": { "title": "Batch Size", "default": 16, "type": "integer" }, "progress_bar": { "title": "Progress Bar", "default": true, "type": "boolean" }, "use_auth_token": { "title": "Use Auth Token", "anyOf": [ { "type": "boolean" }, { "type": "string" }, { "type": "null" } ] }, "devices": { "title": "Devices", "anyOf": [ { "type": "array", "items": { "anyOf": [ { "type": "string" }, {} ] } }, { "type": "null" } ] } }, "description": "Each parameter can reference other components defined in the same YAML file.", "additionalProperties": false } }, "required": [ "type", "name" ], "additionalProperties": false }, "TransformersQueryClassifierComponent": { "type": "object", "properties": { "name": { "title": "Name", "description": "Custom name for the component. Helpful for visualization and debugging.", "type": "string" }, "type": { "title": "Type", "description": "Haystack Class name for the component.", "type": "string", "const": "TransformersQueryClassifier" }, "params": { "title": "Parameters", "type": "object", "properties": { "model_name_or_path": { "title": "Model Name Or Path", "default": "shahrukhx01/bert-mini-finetune-question-detection", "anyOf": [ { "type": "string", "format": "path" }, { "type": "string" } ] }, "model_version": { "title": "Model Version", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "tokenizer": { "title": "Tokenizer", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "use_gpu": { "title": "Use Gpu", "default": true, "type": "boolean" }, "task": { "title": "Task", "default": "text-classification", "type": "string" }, "labels": { "title": "Labels", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "batch_size": { "title": "Batch Size", "default": 16, "type": "integer" }, "progress_bar": { "title": "Progress Bar", "default": true, "type": "boolean" }, "use_auth_token": { "title": "Use Auth Token", "anyOf": [ { "type": "boolean" }, { "type": "string" }, { "type": "null" } ] }, "devices": { "title": "Devices", "anyOf": [ { "type": "array", "items": { "anyOf": [ { "type": "string" }, {} ] } }, { "type": "null" } ] } }, "description": "Each parameter can reference other components defined in the same YAML file.", "additionalProperties": false } }, "required": [ "type", "name" ], "additionalProperties": false }, "TransformersReaderComponent": { "type": "object", "properties": { "name": { "title": "Name", "description": "Custom name for the component. Helpful for visualization and debugging.", "type": "string" }, "type": { "title": "Type", "description": "Haystack Class name for the component.", "type": "string", "const": "TransformersReader" }, "params": { "title": "Parameters", "type": "object", "properties": { "model_name_or_path": { "title": "Model Name Or Path", "default": "distilbert-base-uncased-distilled-squad", "type": "string" }, "model_version": { "title": "Model Version", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "tokenizer": { "title": "Tokenizer", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "context_window_size": { "title": "Context Window Size", "default": 70, "type": "integer" }, "use_gpu": { "title": "Use Gpu", "default": true, "type": "boolean" }, "top_k": { "title": "Top K", "default": 10, "type": "integer" }, "top_k_per_candidate": { "title": "Top K Per Candidate", "default": 3, "type": "integer" }, "return_no_answers": { "title": "Return No Answers", "default": false, "type": "boolean" }, "max_seq_len": { "title": "Max Seq Len", "default": 256, "type": "integer" }, "doc_stride": { "title": "Doc Stride", "default": 128, "type": "integer" }, "batch_size": { "title": "Batch Size", "default": 16, "type": "integer" }, "use_auth_token": { "title": "Use Auth Token", "anyOf": [ { "type": "boolean" }, { "type": "string" }, { "type": "null" } ] }, "devices": { "title": "Devices", "anyOf": [ { "type": "array", "items": { "anyOf": [ { "type": "string" }, {} ] } }, { "type": "null" } ] } }, "description": "Each parameter can reference other components defined in the same YAML file.", "additionalProperties": false } }, "required": [ "type", "name" ], "additionalProperties": false }, "TransformersSummarizerComponent": { "type": "object", "properties": { "name": { "title": "Name", "description": "Custom name for the component. Helpful for visualization and debugging.", "type": "string" }, "type": { "title": "Type", "description": "Haystack Class name for the component.", "type": "string", "const": "TransformersSummarizer" }, "params": { "title": "Parameters", "type": "object", "properties": { "model_name_or_path": { "title": "Model Name Or Path", "default": "google/pegasus-xsum", "type": "string" }, "model_version": { "title": "Model Version", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "tokenizer": { "title": "Tokenizer", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "max_length": { "title": "Max Length", "default": 200, "type": "integer" }, "min_length": { "title": "Min Length", "default": 5, "type": "integer" }, "use_gpu": { "title": "Use Gpu", "default": true, "type": "boolean" }, "clean_up_tokenization_spaces": { "title": "Clean Up Tokenization Spaces", "default": true, "type": "boolean" }, "batch_size": { "title": "Batch Size", "default": 16, "type": "integer" }, "progress_bar": { "title": "Progress Bar", "default": true, "type": "boolean" }, "use_auth_token": { "title": "Use Auth Token", "anyOf": [ { "type": "boolean" }, { "type": "string" }, { "type": "null" } ] }, "devices": { "title": "Devices", "anyOf": [ { "type": "array", "items": { "anyOf": [ { "type": "string" }, {} ] } }, { "type": "null" } ] } }, "description": "Each parameter can reference other components defined in the same YAML file.", "additionalProperties": false } }, "required": [ "type", "name" ], "additionalProperties": false }, "TransformersTranslatorComponent": { "type": "object", "properties": { "name": { "title": "Name", "description": "Custom name for the component. Helpful for visualization and debugging.", "type": "string" }, "type": { "title": "Type", "description": "Haystack Class name for the component.", "type": "string", "const": "TransformersTranslator" }, "params": { "title": "Parameters", "type": "object", "properties": { "model_name_or_path": { "title": "Model Name Or Path", "type": "string" }, "tokenizer_name": { "title": "Tokenizer Name", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "max_seq_len": { "title": "Max Seq Len", "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "clean_up_tokenization_spaces": { "title": "Clean Up Tokenization Spaces", "default": true, "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "use_gpu": { "title": "Use Gpu", "default": true, "type": "boolean" }, "progress_bar": { "title": "Progress Bar", "default": true, "type": "boolean" }, "use_auth_token": { "title": "Use Auth Token", "anyOf": [ { "type": "boolean" }, { "type": "string" }, { "type": "null" } ] }, "devices": { "title": "Devices", "anyOf": [ { "type": "array", "items": { "anyOf": [ { "type": "string" }, {} ] } }, { "type": "null" } ] } }, "required": [ "model_name_or_path" ], "description": "Each parameter can reference other components defined in the same YAML file.", "additionalProperties": false } }, "required": [ "type", "name" ], "additionalProperties": false }, "WebRetrieverComponent": { "type": "object", "properties": { "name": { "title": "Name", "description": "Custom name for the component. Helpful for visualization and debugging.", "type": "string" }, "type": { "title": "Type", "description": "Haystack Class name for the component.", "type": "string", "const": "WebRetriever" }, "params": { "title": "Parameters", "type": "object", "properties": { "api_key": { "title": "Api Key", "type": "string" }, "search_engine_provider": { "title": "Search Engine Provider", "default": "SerperDev", "anyOf": [ { "type": "string" }, { "type": "string" } ] }, "top_search_results": { "title": "Top Search Results", "default": 10, "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "top_k": { "title": "Top K", "default": 5, "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "mode": { "title": "Mode", "default": "snippets", "enum": [ "snippets", "raw_documents", "preprocessed_documents" ], "type": "string" }, "preprocessor": { "title": "Preprocessor", "default": null, "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "cache_document_store": { "title": "Cache Document Store", "default": null, "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "cache_index": { "title": "Cache Index", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "cache_headers": { "title": "Cache Headers", "anyOf": [ { "type": "object" }, { "type": "null" } ], "additionalProperties": { "type": "string" } }, "cache_time": { "title": "Cache Time", "default": 86400, "type": "integer" } }, "required": [ "api_key" ], "description": "Each parameter can reference other components defined in the same YAML file.", "additionalProperties": false } }, "required": [ "type", "name" ], "additionalProperties": false }, "WebSearchComponent": { "type": "object", "properties": { "name": { "title": "Name", "description": "Custom name for the component. Helpful for visualization and debugging.", "type": "string" }, "type": { "title": "Type", "description": "Haystack Class name for the component.", "type": "string", "const": "WebSearch" }, "params": { "title": "Parameters", "type": "object", "properties": { "api_key": { "title": "Api Key", "type": "string" }, "top_k": { "title": "Top K", "default": 10, "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "search_engine_provider": { "title": "Search Engine Provider", "default": "SerperDev", "anyOf": [ { "type": "string" }, { "type": "string" } ] }, "search_engine_kwargs": { "title": "Search Engine Kwargs", "anyOf": [ { "type": "object" }, { "type": "null" } ] } }, "required": [ "api_key" ], "description": "Each parameter can reference other components defined in the same YAML file.", "additionalProperties": false } }, "required": [ "type", "name" ], "additionalProperties": false }, "WhisperTranscriberComponent": { "type": "object", "properties": { "name": { "title": "Name", "description": "Custom name for the component. Helpful for visualization and debugging.", "type": "string" }, "type": { "title": "Type", "description": "Haystack Class name for the component.", "type": "string", "const": "WhisperTranscriber" }, "params": { "title": "Parameters", "type": "object", "properties": { "api_key": { "title": "Api Key", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "model_name_or_path": { "title": "Model Name Or Path", "default": "medium", "enum": [ "tiny", "small", "medium", "large", "large-v2" ], "type": "string" }, "device": { "title": "Device", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "api_base": { "title": "Api Base", "default": "https://api.openai.com/v1", "type": "string" } }, "description": "Each parameter can reference other components defined in the same YAML file.", "additionalProperties": false } }, "required": [ "type", "name" ], "additionalProperties": false } } }