diff --git a/haystack/json-schemas/generate_schema.py b/haystack/json-schemas/generate_schema.py new file mode 100644 index 000000000..427c2a85e --- /dev/null +++ b/haystack/json-schemas/generate_schema.py @@ -0,0 +1,23 @@ +import os +import logging +import sysconfig +from pathlib import Path + +from haystack.nodes._json_schema import update_json_schema + +logger = logging.getLogger("hatch_autorun") + +try: + logger.warning( + "Haystack is generating the YAML schema for Pipelines validation. This only happens once, after installing the package." + ) + update_json_schema(main_only=True) + + # Destroy the hatch-autorun hook if it exists (needs to run just once after installation) + try: + os.remove(Path(sysconfig.get_paths()["purelib"]) / "hatch_autorun_farm_haystack.pth") + except FileNotFoundError: + pass + +except Exception as e: + logger.exception("Could not generate the Haystack Pipeline schemas.", e) diff --git a/haystack/json-schemas/haystack-pipeline-1.10.0.schema.json b/haystack/json-schemas/haystack-pipeline-1.10.0.schema.json deleted file mode 100644 index 68b4e890f..000000000 --- a/haystack/json-schemas/haystack-pipeline-1.10.0.schema.json +++ /dev/null @@ -1,6658 +0,0 @@ -{ - "$id": "https://raw.githubusercontent.com/deepset-ai/haystack/main/haystack/json-schemas/haystack-pipeline-1.10.0.schema.json", - "$schema": "http://json-schema.org/draft-07/schema", - "additionalProperties": false, - "definitions": { - "AnswerToSpeechComponent": { - "additionalProperties": false, - "properties": { - "name": { - "description": "Custom name for the component. Helpful for visualization and debugging.", - "title": "Name", - "type": "string" - }, - "params": { - "additionalProperties": false, - "description": "Each parameter can reference other components defined in the same YAML file.", - "properties": { - "audio_params": { - "anyOf": [ - { - "type": "object" - }, - { - "type": "null" - } - ], - "title": "Audio Params" - }, - "devices": { - "anyOf": [ - { - "items": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "string" - } - ] - }, - "type": "array" - }, - { - "type": "null" - } - ], - "title": "Devices" - }, - "generated_audio_dir": { - "default": "generated_audio_answers", - "format": "path", - "title": "Generated Audio Dir", - "type": "string" - }, - "model_name_or_path": { - "anyOf": [ - { - "type": "string" - }, - { - "format": "path", - "type": "string" - } - ], - "default": "espnet/kan-bayashi_ljspeech_vits", - "title": "Model Name Or Path" - }, - "progress_bar": { - "default": true, - "title": "Progress Bar", - "type": "boolean" - }, - "transformers_params": { - "anyOf": [ - { - "type": "object" - }, - { - "type": "null" - } - ], - "title": "Transformers Params" - } - }, - "title": "Parameters", - "type": "object" - }, - "type": { - "const": "AnswerToSpeech", - "description": "Haystack Class name for the component.", - "title": "Type", - "type": "string" - } - }, - "required": [ - "type", - "name" - ], - "type": "object" - }, - "AzureConverterComponent": { - "additionalProperties": false, - "properties": { - "name": { - "description": "Custom name for the component. Helpful for visualization and debugging.", - "title": "Name", - "type": "string" - }, - "params": { - "additionalProperties": false, - "description": "Each parameter can reference other components defined in the same YAML file.", - "properties": { - "add_page_number": { - "default": true, - "title": "Add Page Number", - "type": "boolean" - }, - "credential_key": { - "title": "Credential Key", - "type": "string" - }, - "endpoint": { - "title": "Endpoint", - "type": "string" - }, - "following_context_len": { - "default": 3, - "title": "Following Context Len", - "type": "integer" - }, - "id_hash_keys": { - "anyOf": [ - { - "items": { - "type": "string" - }, - "type": "array" - }, - { - "type": "null" - } - ], - "title": "Id Hash Keys" - }, - "merge_multiple_column_headers": { - "default": true, - "title": "Merge Multiple Column Headers", - "type": "boolean" - }, - "model_id": { - "default": "prebuilt-document", - "title": "Model Id", - "type": "string" - }, - "preceding_context_len": { - "default": 3, - "title": "Preceding Context Len", - "type": "integer" - }, - "save_json": { - "default": false, - "title": "Save Json", - "type": "boolean" - }, - "valid_languages": { - "anyOf": [ - { - "items": { - "type": "string" - }, - "type": "array" - }, - { - "type": "null" - } - ], - "title": "Valid Languages" - } - }, - "required": [ - "endpoint", - "credential_key" - ], - "title": "Parameters", - "type": "object" - }, - "type": { - "const": "AzureConverter", - "description": "Haystack Class name for the component.", - "title": "Type", - "type": "string" - } - }, - "required": [ - "type", - "name" - ], - "type": "object" - }, - "BM25RetrieverComponent": { - "additionalProperties": false, - "properties": { - "name": { - "description": "Custom name for the component. Helpful for visualization and debugging.", - "title": "Name", - "type": "string" - }, - "params": { - "additionalProperties": false, - "description": "Each parameter can reference other components defined in the same YAML file.", - "properties": { - "all_terms_must_match": { - "default": false, - "title": "All Terms Must Match", - "type": "boolean" - }, - "custom_query": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Custom Query" - }, - "document_store": { - "title": "Document Store", - "type": "string" - }, - "scale_score": { - "default": true, - "title": "Scale Score", - "type": "boolean" - }, - "top_k": { - "default": 10, - "title": "Top K", - "type": "integer" - } - }, - "required": [ - "document_store" - ], - "title": "Parameters", - "type": "object" - }, - "type": { - "const": "BM25Retriever", - "description": "Haystack Class name for the component.", - "title": "Type", - "type": "string" - } - }, - "required": [ - "type", - "name" - ], - "type": "object" - }, - "CrawlerComponent": { - "additionalProperties": false, - "properties": { - "name": { - "description": "Custom name for the component. Helpful for visualization and debugging.", - "title": "Name", - "type": "string" - }, - "params": { - "additionalProperties": false, - "description": "Each parameter can reference other components defined in the same YAML file.", - "properties": { - "crawler_depth": { - "default": 1, - "title": "Crawler Depth", - "type": "integer" - }, - "crawler_naming_function": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "default": null, - "title": "Crawler Naming Function" - }, - "extract_hidden_text": { - "default": true, - "title": "Extract Hidden Text" - }, - "filter_urls": { - "anyOf": [ - { - "items": {}, - "type": "array" - }, - { - "type": "null" - } - ], - "title": "Filter Urls" - }, - "id_hash_keys": { - "anyOf": [ - { - "items": { - "type": "string" - }, - "type": "array" - }, - { - "type": "null" - } - ], - "title": "Id Hash Keys" - }, - "loading_wait_time": { - "anyOf": [ - { - "type": "integer" - }, - { - "type": "null" - } - ], - "title": "Loading Wait Time" - }, - "output_dir": { - "title": "Output Dir", - "type": "string" - }, - "overwrite_existing_files": { - "default": true, - "title": "Overwrite Existing Files" - }, - "urls": { - "anyOf": [ - { - "items": { - "type": "string" - }, - "type": "array" - }, - { - "type": "null" - } - ], - "title": "Urls" - }, - "webdriver_options": { - "anyOf": [ - { - "items": { - "type": "string" - }, - "type": "array" - }, - { - "type": "null" - } - ], - "title": "Webdriver Options" - } - }, - "required": [ - "output_dir" - ], - "title": "Parameters", - "type": "object" - }, - "type": { - "const": "Crawler", - "description": "Haystack Class name for the component.", - "title": "Type", - "type": "string" - } - }, - "required": [ - "type", - "name" - ], - "type": "object" - }, - "DeepsetCloudDocumentStoreComponent": { - "additionalProperties": false, - "properties": { - "name": { - "description": "Custom name for the component. Helpful for visualization and debugging.", - "title": "Name", - "type": "string" - }, - "params": { - "additionalProperties": false, - "description": "Each parameter can reference other components defined in the same YAML file.", - "properties": { - "api_endpoint": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Api Endpoint" - }, - "api_key": { - "title": "Api Key", - "type": "string" - }, - "duplicate_documents": { - "default": "overwrite", - "title": "Duplicate Documents", - "type": "string" - }, - "embedding_dim": { - "default": 768, - "title": "Embedding Dim", - "type": "integer" - }, - "index": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Index" - }, - "label_index": { - "default": "default", - "title": "Label Index", - "type": "string" - }, - "return_embedding": { - "default": false, - "title": "Return Embedding", - "type": "boolean" - }, - "similarity": { - "default": "dot_product", - "title": "Similarity", - "type": "string" - }, - "workspace": { - "default": "default", - "title": "Workspace", - "type": "string" - } - }, - "title": "Parameters", - "type": "object" - }, - "type": { - "const": "DeepsetCloudDocumentStore", - "description": "Haystack Class name for the component.", - "title": "Type", - "type": "string" - } - }, - "required": [ - "type", - "name" - ], - "type": "object" - }, - "DensePassageRetrieverComponent": { - "additionalProperties": false, - "properties": { - "name": { - "description": "Custom name for the component. Helpful for visualization and debugging.", - "title": "Name", - "type": "string" - }, - "params": { - "additionalProperties": false, - "description": "Each parameter can reference other components defined in the same YAML file.", - "properties": { - "batch_size": { - "default": 16, - "title": "Batch Size", - "type": "integer" - }, - "devices": { - "anyOf": [ - { - "items": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "string" - } - ] - }, - "type": "array" - }, - { - "type": "null" - } - ], - "title": "Devices" - }, - "document_store": { - "title": "Document Store", - "type": "string" - }, - "embed_title": { - "default": true, - "title": "Embed Title", - "type": "boolean" - }, - "global_loss_buffer_size": { - "default": 150000, - "title": "Global Loss Buffer Size", - "type": "integer" - }, - "max_seq_len_passage": { - "default": 256, - "title": "Max Seq Len Passage", - "type": "integer" - }, - "max_seq_len_query": { - "default": 64, - "title": "Max Seq Len Query", - "type": "integer" - }, - "model_version": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Model Version" - }, - "passage_embedding_model": { - "anyOf": [ - { - "format": "path", - "type": "string" - }, - { - "type": "string" - } - ], - "default": "facebook/dpr-ctx_encoder-single-nq-base", - "title": "Passage Embedding Model" - }, - "progress_bar": { - "default": true, - "title": "Progress Bar", - "type": "boolean" - }, - "query_embedding_model": { - "anyOf": [ - { - "format": "path", - "type": "string" - }, - { - "type": "string" - } - ], - "default": "facebook/dpr-question_encoder-single-nq-base", - "title": "Query Embedding Model" - }, - "scale_score": { - "default": true, - "title": "Scale Score", - "type": "boolean" - }, - "similarity_function": { - "default": "dot_product", - "title": "Similarity Function", - "type": "string" - }, - "top_k": { - "default": 10, - "title": "Top K", - "type": "integer" - }, - "use_auth_token": { - "anyOf": [ - { - "type": "boolean" - }, - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Use Auth Token" - }, - "use_fast_tokenizers": { - "default": true, - "title": "Use Fast Tokenizers", - "type": "boolean" - }, - "use_gpu": { - "default": true, - "title": "Use Gpu", - "type": "boolean" - } - }, - "required": [ - "document_store" - ], - "title": "Parameters", - "type": "object" - }, - "type": { - "const": "DensePassageRetriever", - "description": "Haystack Class name for the component.", - "title": "Type", - "type": "string" - } - }, - "required": [ - "type", - "name" - ], - "type": "object" - }, - "Docs2AnswersComponent": { - "additionalProperties": false, - "properties": { - "name": { - "description": "Custom name for the component. Helpful for visualization and debugging.", - "title": "Name", - "type": "string" - }, - "params": { - "additionalProperties": false, - "description": "Each parameter can reference other components defined in the same YAML file.", - "properties": { - "progress_bar": { - "default": true, - "title": "Progress Bar", - "type": "boolean" - } - }, - "title": "Parameters", - "type": "object" - }, - "type": { - "const": "Docs2Answers", - "description": "Haystack Class name for the component.", - "title": "Type", - "type": "string" - } - }, - "required": [ - "type", - "name" - ], - "type": "object" - }, - "DocumentToSpeechComponent": { - "additionalProperties": false, - "properties": { - "name": { - "description": "Custom name for the component. Helpful for visualization and debugging.", - "title": "Name", - "type": "string" - }, - "params": { - "additionalProperties": false, - "description": "Each parameter can reference other components defined in the same YAML file.", - "properties": { - "audio_params": { - "anyOf": [ - { - "type": "object" - }, - { - "type": "null" - } - ], - "title": "Audio Params" - }, - "generated_audio_dir": { - "default": "generated_audio_documents", - "format": "path", - "title": "Generated Audio Dir", - "type": "string" - }, - "model_name_or_path": { - "anyOf": [ - { - "type": "string" - }, - { - "format": "path", - "type": "string" - } - ], - "default": "espnet/kan-bayashi_ljspeech_vits", - "title": "Model Name Or Path" - }, - "transformers_params": { - "anyOf": [ - { - "type": "object" - }, - { - "type": "null" - } - ], - "title": "Transformers Params" - } - }, - "title": "Parameters", - "type": "object" - }, - "type": { - "const": "DocumentToSpeech", - "description": "Haystack Class name for the component.", - "title": "Type", - "type": "string" - } - }, - "required": [ - "type", - "name" - ], - "type": "object" - }, - "DocxToTextConverterComponent": { - "additionalProperties": false, - "properties": { - "name": { - "description": "Custom name for the component. Helpful for visualization and debugging.", - "title": "Name", - "type": "string" - }, - "params": { - "additionalProperties": false, - "description": "Each parameter can reference other components defined in the same YAML file.", - "properties": { - "id_hash_keys": { - "anyOf": [ - { - "items": { - "type": "string" - }, - "type": "array" - }, - { - "type": "null" - } - ], - "title": "Id Hash Keys" - }, - "progress_bar": { - "default": true, - "title": "Progress Bar", - "type": "boolean" - }, - "remove_numeric_tables": { - "default": false, - "title": "Remove Numeric Tables", - "type": "boolean" - }, - "valid_languages": { - "anyOf": [ - { - "items": { - "type": "string" - }, - "type": "array" - }, - { - "type": "null" - } - ], - "title": "Valid Languages" - } - }, - "title": "Parameters", - "type": "object" - }, - "type": { - "const": "DocxToTextConverter", - "description": "Haystack Class name for the component.", - "title": "Type", - "type": "string" - } - }, - "required": [ - "type", - "name" - ], - "type": "object" - }, - "ElasticsearchDocumentStoreComponent": { - "additionalProperties": false, - "properties": { - "name": { - "description": "Custom name for the component. Helpful for visualization and debugging.", - "title": "Name", - "type": "string" - }, - "params": { - "additionalProperties": false, - "description": "Each parameter can reference other components defined in the same YAML file.", - "properties": { - "analyzer": { - "default": "standard", - "title": "Analyzer", - "type": "string" - }, - "api_key": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Api Key" - }, - "api_key_id": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Api Key Id" - }, - "aws4auth": { - "title": "Aws4Auth" - }, - "ca_certs": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Ca Certs" - }, - "content_field": { - "default": "content", - "title": "Content Field", - "type": "string" - }, - "create_index": { - "default": true, - "title": "Create Index", - "type": "boolean" - }, - "custom_mapping": { - "anyOf": [ - { - "type": "object" - }, - { - "type": "null" - } - ], - "title": "Custom Mapping" - }, - "duplicate_documents": { - "default": "overwrite", - "title": "Duplicate Documents", - "type": "string" - }, - "embedding_dim": { - "default": 768, - "title": "Embedding Dim", - "type": "integer" - }, - "embedding_field": { - "default": "embedding", - "title": "Embedding Field", - "type": "string" - }, - "excluded_meta_data": { - "anyOf": [ - { - "items": {}, - "type": "array" - }, - { - "type": "null" - } - ], - "title": "Excluded Meta Data" - }, - "host": { - "anyOf": [ - { - "type": "string" - }, - { - "items": { - "type": "string" - }, - "type": "array" - } - ], - "default": "localhost", - "title": "Host" - }, - "index": { - "default": "document", - "title": "Index", - "type": "string" - }, - "index_type": { - "default": "flat", - "title": "Index Type", - "type": "string" - }, - "label_index": { - "default": "label", - "title": "Label Index", - "type": "string" - }, - "name_field": { - "default": "name", - "title": "Name Field", - "type": "string" - }, - "password": { - "default": "", - "title": "Password", - "type": "string" - }, - "port": { - "anyOf": [ - { - "type": "integer" - }, - { - "items": { - "type": "integer" - }, - "type": "array" - } - ], - "default": 9200, - "title": "Port" - }, - "recreate_index": { - "default": false, - "title": "Recreate Index", - "type": "boolean" - }, - "refresh_type": { - "default": "wait_for", - "title": "Refresh Type", - "type": "string" - }, - "return_embedding": { - "default": false, - "title": "Return Embedding", - "type": "boolean" - }, - "scheme": { - "default": "http", - "title": "Scheme", - "type": "string" - }, - "scroll": { - "default": "1d", - "title": "Scroll", - "type": "string" - }, - "search_fields": { - "anyOf": [ - { - "type": "string" - }, - { - "items": {}, - "type": "array" - } - ], - "default": "content", - "title": "Search Fields" - }, - "similarity": { - "default": "dot_product", - "title": "Similarity", - "type": "string" - }, - "skip_missing_embeddings": { - "default": true, - "title": "Skip Missing Embeddings", - "type": "boolean" - }, - "synonym_type": { - "default": "synonym", - "title": "Synonym Type", - "type": "string" - }, - "synonyms": { - "anyOf": [ - { - "items": {}, - "type": "array" - }, - { - "type": "null" - } - ], - "title": "Synonyms" - }, - "timeout": { - "default": 30, - "title": "Timeout", - "type": "integer" - }, - "use_system_proxy": { - "default": false, - "title": "Use System Proxy", - "type": "boolean" - }, - "username": { - "default": "", - "title": "Username", - "type": "string" - }, - "verify_certs": { - "default": true, - "title": "Verify Certs", - "type": "boolean" - } - }, - "title": "Parameters", - "type": "object" - }, - "type": { - "const": "ElasticsearchDocumentStore", - "description": "Haystack Class name for the component.", - "title": "Type", - "type": "string" - } - }, - "required": [ - "type", - "name" - ], - "type": "object" - }, - "ElasticsearchFilterOnlyRetrieverComponent": { - "additionalProperties": false, - "properties": { - "name": { - "description": "Custom name for the component. Helpful for visualization and debugging.", - "title": "Name", - "type": "string" - }, - "params": { - "additionalProperties": false, - "description": "Each parameter can reference other components defined in the same YAML file.", - "properties": { - "all_terms_must_match": { - "default": false, - "title": "All Terms Must Match", - "type": "boolean" - }, - "custom_query": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Custom Query" - }, - "document_store": { - "title": "Document Store", - "type": "string" - }, - "top_k": { - "default": 10, - "title": "Top K", - "type": "integer" - } - }, - "required": [ - "document_store" - ], - "title": "Parameters", - "type": "object" - }, - "type": { - "const": "ElasticsearchFilterOnlyRetriever", - "description": "Haystack Class name for the component.", - "title": "Type", - "type": "string" - } - }, - "required": [ - "type", - "name" - ], - "type": "object" - }, - "ElasticsearchRetrieverComponent": { - "additionalProperties": false, - "properties": { - "name": { - "description": "Custom name for the component. Helpful for visualization and debugging.", - "title": "Name", - "type": "string" - }, - "params": { - "additionalProperties": false, - "description": "Each parameter can reference other components defined in the same YAML file.", - "properties": { - "all_terms_must_match": { - "default": false, - "title": "All Terms Must Match", - "type": "boolean" - }, - "custom_query": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Custom Query" - }, - "document_store": { - "title": "Document Store", - "type": "string" - }, - "top_k": { - "default": 10, - "title": "Top K", - "type": "integer" - } - }, - "required": [ - "document_store" - ], - "title": "Parameters", - "type": "object" - }, - "type": { - "const": "ElasticsearchRetriever", - "description": "Haystack Class name for the component.", - "title": "Type", - "type": "string" - } - }, - "required": [ - "type", - "name" - ], - "type": "object" - }, - "EmbeddingRetrieverComponent": { - "additionalProperties": false, - "properties": { - "name": { - "description": "Custom name for the component. Helpful for visualization and debugging.", - "title": "Name", - "type": "string" - }, - "params": { - "additionalProperties": false, - "description": "Each parameter can reference other components defined in the same YAML file.", - "properties": { - "api_key": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Api Key" - }, - "batch_size": { - "default": 32, - "title": "Batch Size", - "type": "integer" - }, - "devices": { - "anyOf": [ - { - "items": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "string" - } - ] - }, - "type": "array" - }, - { - "type": "null" - } - ], - "title": "Devices" - }, - "document_store": { - "title": "Document Store", - "type": "string" - }, - "emb_extraction_layer": { - "default": -1, - "title": "Emb Extraction Layer", - "type": "integer" - }, - "embed_meta_fields": { - "default": [], - "items": { - "type": "string" - }, - "title": "Embed Meta Fields", - "type": "array" - }, - "embedding_model": { - "title": "Embedding Model", - "type": "string" - }, - "max_seq_len": { - "default": 512, - "title": "Max Seq Len", - "type": "integer" - }, - "model_format": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Model Format" - }, - "model_version": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Model Version" - }, - "pooling_strategy": { - "default": "reduce_mean", - "title": "Pooling Strategy", - "type": "string" - }, - "progress_bar": { - "default": true, - "title": "Progress Bar", - "type": "boolean" - }, - "scale_score": { - "default": true, - "title": "Scale Score", - "type": "boolean" - }, - "top_k": { - "default": 10, - "title": "Top K", - "type": "integer" - }, - "use_auth_token": { - "anyOf": [ - { - "type": "boolean" - }, - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Use Auth Token" - }, - "use_gpu": { - "default": true, - "title": "Use Gpu", - "type": "boolean" - } - }, - "required": [ - "document_store", - "embedding_model" - ], - "title": "Parameters", - "type": "object" - }, - "type": { - "const": "EmbeddingRetriever", - "description": "Haystack Class name for the component.", - "title": "Type", - "type": "string" - } - }, - "required": [ - "type", - "name" - ], - "type": "object" - }, - "EntityExtractorComponent": { - "additionalProperties": false, - "properties": { - "name": { - "description": "Custom name for the component. Helpful for visualization and debugging.", - "title": "Name", - "type": "string" - }, - "params": { - "additionalProperties": false, - "description": "Each parameter can reference other components defined in the same YAML file.", - "properties": { - "add_prefix_space": { - "anyOf": [ - { - "type": "boolean" - }, - { - "type": "null" - } - ], - "title": "Add Prefix Space" - }, - "aggregation_strategy": { - "default": "first", - "enum": [ - "simple", - "first", - "average", - "max" - ], - "title": "Aggregation Strategy", - "type": "string" - }, - "batch_size": { - "default": 16, - "title": "Batch Size", - "type": "integer" - }, - "devices": { - "anyOf": [ - { - "items": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "string" - } - ] - }, - "type": "array" - }, - { - "type": "null" - } - ], - "title": "Devices" - }, - "flatten_entities_in_meta_data": { - "default": false, - "title": "Flatten Entities In Meta Data", - "type": "boolean" - }, - "ignore_labels": { - "anyOf": [ - { - "items": { - "type": "string" - }, - "type": "array" - }, - { - "type": "null" - } - ], - "title": "Ignore Labels" - }, - "max_seq_len": { - "title": "Max Seq Len", - "type": "integer" - }, - "model_name_or_path": { - "default": "elastic/distilbert-base-cased-finetuned-conll03-english", - "title": "Model Name Or Path", - "type": "string" - }, - "model_version": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Model Version" - }, - "num_workers": { - "default": 0, - "title": "Num Workers", - "type": "integer" - }, - "pre_split_text": { - "default": false, - "title": "Pre Split Text", - "type": "boolean" - }, - "progress_bar": { - "default": true, - "title": "Progress Bar", - "type": "boolean" - }, - "use_auth_token": { - "anyOf": [ - { - "type": "boolean" - }, - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Use Auth Token" - }, - "use_gpu": { - "default": true, - "title": "Use Gpu", - "type": "boolean" - } - }, - "title": "Parameters", - "type": "object" - }, - "type": { - "const": "EntityExtractor", - "description": "Haystack Class name for the component.", - "title": "Type", - "type": "string" - } - }, - "required": [ - "type", - "name" - ], - "type": "object" - }, - "EvalAnswersComponent": { - "additionalProperties": false, - "properties": { - "name": { - "description": "Custom name for the component. Helpful for visualization and debugging.", - "title": "Name", - "type": "string" - }, - "params": { - "additionalProperties": false, - "description": "Each parameter can reference other components defined in the same YAML file.", - "properties": { - "debug": { - "default": false, - "title": "Debug", - "type": "boolean" - }, - "open_domain": { - "default": true, - "title": "Open Domain", - "type": "boolean" - }, - "sas_model": { - "title": "Sas Model", - "type": "string" - }, - "skip_incorrect_retrieval": { - "default": true, - "title": "Skip Incorrect Retrieval", - "type": "boolean" - } - }, - "title": "Parameters", - "type": "object" - }, - "type": { - "const": "EvalAnswers", - "description": "Haystack Class name for the component.", - "title": "Type", - "type": "string" - } - }, - "required": [ - "type", - "name" - ], - "type": "object" - }, - "EvalDocumentsComponent": { - "additionalProperties": false, - "properties": { - "name": { - "description": "Custom name for the component. Helpful for visualization and debugging.", - "title": "Name", - "type": "string" - }, - "params": { - "additionalProperties": false, - "description": "Each parameter can reference other components defined in the same YAML file.", - "properties": { - "debug": { - "default": false, - "title": "Debug", - "type": "boolean" - }, - "open_domain": { - "default": true, - "title": "Open Domain", - "type": "boolean" - }, - "top_k": { - "default": 10, - "title": "Top K", - "type": "integer" - } - }, - "title": "Parameters", - "type": "object" - }, - "type": { - "const": "EvalDocuments", - "description": "Haystack Class name for the component.", - "title": "Type", - "type": "string" - } - }, - "required": [ - "type", - "name" - ], - "type": "object" - }, - "FAISSDocumentStoreComponent": { - "additionalProperties": false, - "properties": { - "name": { - "description": "Custom name for the component. Helpful for visualization and debugging.", - "title": "Name", - "type": "string" - }, - "params": { - "additionalProperties": false, - "description": "Each parameter can reference other components defined in the same YAML file.", - "properties": { - "duplicate_documents": { - "default": "overwrite", - "title": "Duplicate Documents", - "type": "string" - }, - "ef_construction": { - "default": 80, - "title": "Ef Construction", - "type": "integer" - }, - "ef_search": { - "default": 20, - "title": "Ef Search", - "type": "integer" - }, - "embedding_dim": { - "default": 768, - "title": "Embedding Dim", - "type": "integer" - }, - "embedding_field": { - "default": "embedding", - "title": "Embedding Field", - "type": "string" - }, - "faiss_config_path": { - "anyOf": [ - { - "type": "string" - }, - { - "format": "path", - "type": "string" - } - ], - "title": "Faiss Config Path" - }, - "faiss_index": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "default": null, - "title": "Faiss Index" - }, - "faiss_index_factory_str": { - "default": "Flat", - "title": "Faiss Index Factory Str", - "type": "string" - }, - "faiss_index_path": { - "anyOf": [ - { - "type": "string" - }, - { - "format": "path", - "type": "string" - } - ], - "title": "Faiss Index Path" - }, - "index": { - "default": "document", - "title": "Index", - "type": "string" - }, - "isolation_level": { - "title": "Isolation Level", - "type": "string" - }, - "n_links": { - "default": 64, - "title": "N Links", - "type": "integer" - }, - "progress_bar": { - "default": true, - "title": "Progress Bar", - "type": "boolean" - }, - "return_embedding": { - "default": false, - "title": "Return Embedding", - "type": "boolean" - }, - "similarity": { - "default": "dot_product", - "title": "Similarity", - "type": "string" - }, - "sql_url": { - "default": "sqlite:///faiss_document_store.db", - "title": "Sql Url", - "type": "string" - }, - "validate_index_sync": { - "default": true, - "title": "Validate Index Sync", - "type": "boolean" - }, - "vector_dim": { - "title": "Vector Dim", - "type": "integer" - } - }, - "title": "Parameters", - "type": "object" - }, - "type": { - "const": "FAISSDocumentStore", - "description": "Haystack Class name for the component.", - "title": "Type", - "type": "string" - } - }, - "required": [ - "type", - "name" - ], - "type": "object" - }, - "FARMReaderComponent": { - "additionalProperties": false, - "properties": { - "name": { - "description": "Custom name for the component. Helpful for visualization and debugging.", - "title": "Name", - "type": "string" - }, - "params": { - "additionalProperties": false, - "description": "Each parameter can reference other components defined in the same YAML file.", - "properties": { - "batch_size": { - "default": 50, - "title": "Batch Size", - "type": "integer" - }, - "confidence_threshold": { - "anyOf": [ - { - "type": "number" - }, - { - "type": "null" - } - ], - "title": "Confidence Threshold" - }, - "context_window_size": { - "default": 150, - "title": "Context Window Size", - "type": "integer" - }, - "devices": { - "anyOf": [ - { - "items": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "string" - } - ] - }, - "type": "array" - }, - { - "type": "null" - } - ], - "title": "Devices" - }, - "doc_stride": { - "default": 128, - "title": "Doc Stride", - "type": "integer" - }, - "duplicate_filtering": { - "default": 0, - "title": "Duplicate Filtering", - "type": "integer" - }, - "force_download": { - "default": false, - "title": "Force Download" - }, - "local_files_only": { - "default": false, - "title": "Local Files Only" - }, - "max_seq_len": { - "default": 256, - "title": "Max Seq Len", - "type": "integer" - }, - "model_name_or_path": { - "title": "Model Name Or Path", - "type": "string" - }, - "model_version": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Model Version" - }, - "no_ans_boost": { - "default": 0.0, - "title": "No Ans Boost", - "type": "number" - }, - "num_processes": { - "anyOf": [ - { - "type": "integer" - }, - { - "type": "null" - } - ], - "title": "Num Processes" - }, - "progress_bar": { - "default": true, - "title": "Progress Bar", - "type": "boolean" - }, - "proxies": { - "additionalProperties": { - "type": "string" - }, - "anyOf": [ - { - "type": "object" - }, - { - "type": "null" - } - ], - "title": "Proxies" - }, - "return_no_answer": { - "default": false, - "title": "Return No Answer", - "type": "boolean" - }, - "top_k": { - "default": 10, - "title": "Top K", - "type": "integer" - }, - "top_k_per_candidate": { - "default": 3, - "title": "Top K Per Candidate", - "type": "integer" - }, - "top_k_per_sample": { - "default": 1, - "title": "Top K Per Sample", - "type": "integer" - }, - "use_auth_token": { - "anyOf": [ - { - "type": "boolean" - }, - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Use Auth Token" - }, - "use_confidence_scores": { - "default": true, - "title": "Use Confidence Scores", - "type": "boolean" - }, - "use_gpu": { - "default": true, - "title": "Use Gpu", - "type": "boolean" - } - }, - "required": [ - "model_name_or_path" - ], - "title": "Parameters", - "type": "object" - }, - "type": { - "const": "FARMReader", - "description": "Haystack Class name for the component.", - "title": "Type", - "type": "string" - } - }, - "required": [ - "type", - "name" - ], - "type": "object" - }, - "FileTypeClassifierComponent": { - "additionalProperties": false, - "properties": { - "name": { - "description": "Custom name for the component. Helpful for visualization and debugging.", - "title": "Name", - "type": "string" - }, - "params": { - "additionalProperties": false, - "description": "Each parameter can reference other components defined in the same YAML file.", - "properties": { - "supported_types": { - "default": [ - "txt", - "pdf", - "md", - "docx", - "html" - ], - "items": { - "type": "string" - }, - "title": "Supported Types", - "type": "array" - } - }, - "title": "Parameters", - "type": "object" - }, - "type": { - "const": "FileTypeClassifier", - "description": "Haystack Class name for the component.", - "title": "Type", - "type": "string" - } - }, - "required": [ - "type", - "name" - ], - "type": "object" - }, - "FilterRetrieverComponent": { - "additionalProperties": false, - "properties": { - "name": { - "description": "Custom name for the component. Helpful for visualization and debugging.", - "title": "Name", - "type": "string" - }, - "params": { - "additionalProperties": false, - "description": "Each parameter can reference other components defined in the same YAML file.", - "properties": { - "all_terms_must_match": { - "default": false, - "title": "All Terms Must Match", - "type": "boolean" - }, - "custom_query": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Custom Query" - }, - "document_store": { - "title": "Document Store", - "type": "string" - }, - "scale_score": { - "default": true, - "title": "Scale Score", - "type": "boolean" - }, - "top_k": { - "default": 10, - "title": "Top K", - "type": "integer" - } - }, - "required": [ - "document_store" - ], - "title": "Parameters", - "type": "object" - }, - "type": { - "const": "FilterRetriever", - "description": "Haystack Class name for the component.", - "title": "Type", - "type": "string" - } - }, - "required": [ - "type", - "name" - ], - "type": "object" - }, - "GraphDBKnowledgeGraphComponent": { - "additionalProperties": false, - "properties": { - "name": { - "description": "Custom name for the component. Helpful for visualization and debugging.", - "title": "Name", - "type": "string" - }, - "params": { - "additionalProperties": false, - "description": "Each parameter can reference other components defined in the same YAML file.", - "properties": { - "host": { - "default": "localhost", - "title": "Host", - "type": "string" - }, - "index": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Index" - }, - "password": { - "default": "", - "title": "Password", - "type": "string" - }, - "port": { - "default": 7200, - "title": "Port", - "type": "integer" - }, - "prefixes": { - "default": "", - "title": "Prefixes", - "type": "string" - }, - "username": { - "default": "", - "title": "Username", - "type": "string" - } - }, - "title": "Parameters", - "type": "object" - }, - "type": { - "const": "GraphDBKnowledgeGraph", - "description": "Haystack Class name for the component.", - "title": "Type", - "type": "string" - } - }, - "required": [ - "type", - "name" - ], - "type": "object" - }, - "ImageToTextConverterComponent": { - "additionalProperties": false, - "properties": { - "name": { - "description": "Custom name for the component. Helpful for visualization and debugging.", - "title": "Name", - "type": "string" - }, - "params": { - "additionalProperties": false, - "description": "Each parameter can reference other components defined in the same YAML file.", - "properties": { - "id_hash_keys": { - "anyOf": [ - { - "items": { - "type": "string" - }, - "type": "array" - }, - { - "type": "null" - } - ], - "title": "Id Hash Keys" - }, - "remove_numeric_tables": { - "default": false, - "title": "Remove Numeric Tables", - "type": "boolean" - }, - "valid_languages": { - "anyOf": [ - { - "items": { - "type": "string" - }, - "type": "array" - }, - { - "type": "null" - } - ], - "default": [ - "eng" - ], - "title": "Valid Languages" - } - }, - "title": "Parameters", - "type": "object" - }, - "type": { - "const": "ImageToTextConverter", - "description": "Haystack Class name for the component.", - "title": "Type", - "type": "string" - } - }, - "required": [ - "type", - "name" - ], - "type": "object" - }, - "InMemoryDocumentStoreComponent": { - "additionalProperties": false, - "properties": { - "name": { - "description": "Custom name for the component. Helpful for visualization and debugging.", - "title": "Name", - "type": "string" - }, - "params": { - "additionalProperties": false, - "description": "Each parameter can reference other components defined in the same YAML file.", - "properties": { - "devices": { - "anyOf": [ - { - "items": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "string" - } - ] - }, - "type": "array" - }, - { - "type": "null" - } - ], - "title": "Devices" - }, - "duplicate_documents": { - "default": "overwrite", - "title": "Duplicate Documents", - "type": "string" - }, - "embedding_dim": { - "default": 768, - "title": "Embedding Dim", - "type": "integer" - }, - "embedding_field": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "default": "embedding", - "title": "Embedding Field" - }, - "index": { - "default": "document", - "title": "Index", - "type": "string" - }, - "label_index": { - "default": "label", - "title": "Label Index", - "type": "string" - }, - "progress_bar": { - "default": true, - "title": "Progress Bar", - "type": "boolean" - }, - "return_embedding": { - "default": false, - "title": "Return Embedding", - "type": "boolean" - }, - "scoring_batch_size": { - "default": 500000, - "title": "Scoring Batch Size", - "type": "integer" - }, - "similarity": { - "default": "dot_product", - "title": "Similarity", - "type": "string" - }, - "use_gpu": { - "default": true, - "title": "Use Gpu", - "type": "boolean" - } - }, - "title": "Parameters", - "type": "object" - }, - "type": { - "const": "InMemoryDocumentStore", - "description": "Haystack Class name for the component.", - "title": "Type", - "type": "string" - } - }, - "required": [ - "type", - "name" - ], - "type": "object" - }, - "InMemoryKnowledgeGraphComponent": { - "additionalProperties": false, - "properties": { - "name": { - "description": "Custom name for the component. Helpful for visualization and debugging.", - "title": "Name", - "type": "string" - }, - "params": { - "additionalProperties": false, - "description": "Each parameter can reference other components defined in the same YAML file.", - "properties": { - "index": { - "default": "document", - "title": "Index", - "type": "string" - } - }, - "title": "Parameters", - "type": "object" - }, - "type": { - "const": "InMemoryKnowledgeGraph", - "description": "Haystack Class name for the component.", - "title": "Type", - "type": "string" - } - }, - "required": [ - "type", - "name" - ], - "type": "object" - }, - "JoinAnswersComponent": { - "additionalProperties": false, - "properties": { - "name": { - "description": "Custom name for the component. Helpful for visualization and debugging.", - "title": "Name", - "type": "string" - }, - "params": { - "additionalProperties": false, - "description": "Each parameter can reference other components defined in the same YAML file.", - "properties": { - "join_mode": { - "default": "concatenate", - "title": "Join Mode", - "type": "string" - }, - "sort_by_score": { - "default": true, - "title": "Sort By Score", - "type": "boolean" - }, - "top_k_join": { - "anyOf": [ - { - "type": "integer" - }, - { - "type": "null" - } - ], - "title": "Top K Join" - }, - "weights": { - "anyOf": [ - { - "items": { - "type": "number" - }, - "type": "array" - }, - { - "type": "null" - } - ], - "title": "Weights" - } - }, - "title": "Parameters", - "type": "object" - }, - "type": { - "const": "JoinAnswers", - "description": "Haystack Class name for the component.", - "title": "Type", - "type": "string" - } - }, - "required": [ - "type", - "name" - ], - "type": "object" - }, - "JoinDocumentsComponent": { - "additionalProperties": false, - "properties": { - "name": { - "description": "Custom name for the component. Helpful for visualization and debugging.", - "title": "Name", - "type": "string" - }, - "params": { - "additionalProperties": false, - "description": "Each parameter can reference other components defined in the same YAML file.", - "properties": { - "join_mode": { - "default": "concatenate", - "title": "Join Mode", - "type": "string" - }, - "sort_by_score": { - "default": true, - "title": "Sort By Score", - "type": "boolean" - }, - "top_k_join": { - "anyOf": [ - { - "type": "integer" - }, - { - "type": "null" - } - ], - "title": "Top K Join" - }, - "weights": { - "anyOf": [ - { - "items": { - "type": "number" - }, - "type": "array" - }, - { - "type": "null" - } - ], - "title": "Weights" - } - }, - "title": "Parameters", - "type": "object" - }, - "type": { - "const": "JoinDocuments", - "description": "Haystack Class name for the component.", - "title": "Type", - "type": "string" - } - }, - "required": [ - "type", - "name" - ], - "type": "object" - }, - "MarkdownConverterComponent": { - "additionalProperties": false, - "properties": { - "name": { - "description": "Custom name for the component. Helpful for visualization and debugging.", - "title": "Name", - "type": "string" - }, - "params": { - "additionalProperties": false, - "description": "Each parameter can reference other components defined in the same YAML file.", - "properties": { - "id_hash_keys": { - "anyOf": [ - { - "items": { - "type": "string" - }, - "type": "array" - }, - { - "type": "null" - } - ], - "title": "Id Hash Keys" - }, - "progress_bar": { - "default": true, - "title": "Progress Bar", - "type": "boolean" - }, - "remove_numeric_tables": { - "default": false, - "title": "Remove Numeric Tables", - "type": "boolean" - }, - "valid_languages": { - "anyOf": [ - { - "items": { - "type": "string" - }, - "type": "array" - }, - { - "type": "null" - } - ], - "title": "Valid Languages" - } - }, - "title": "Parameters", - "type": "object" - }, - "type": { - "const": "MarkdownConverter", - "description": "Haystack Class name for the component.", - "title": "Type", - "type": "string" - } - }, - "required": [ - "type", - "name" - ], - "type": "object" - }, - "Milvus2DocumentStoreComponent": { - "additionalProperties": false, - "properties": { - "name": { - "description": "Custom name for the component. Helpful for visualization and debugging.", - "title": "Name", - "type": "string" - }, - "params": { - "additionalProperties": false, - "description": "Each parameter can reference other components defined in the same YAML file.", - "properties": { - "connection_pool": { - "default": "SingletonThread", - "title": "Connection Pool", - "type": "string" - }, - "consistency_level": { - "default": 0, - "title": "Consistency Level", - "type": "integer" - }, - "custom_fields": { - "anyOf": [ - { - "items": {}, - "type": "array" - }, - { - "type": "null" - } - ], - "title": "Custom Fields" - }, - "duplicate_documents": { - "default": "overwrite", - "title": "Duplicate Documents", - "type": "string" - }, - "embedding_dim": { - "default": 768, - "title": "Embedding Dim", - "type": "integer" - }, - "embedding_field": { - "default": "embedding", - "title": "Embedding Field", - "type": "string" - }, - "host": { - "default": "localhost", - "title": "Host", - "type": "string" - }, - "id_field": { - "default": "id", - "title": "Id Field", - "type": "string" - }, - "index": { - "default": "document", - "title": "Index", - "type": "string" - }, - "index_file_size": { - "default": 1024, - "title": "Index File Size", - "type": "integer" - }, - "index_param": { - "anyOf": [ - { - "type": "object" - }, - { - "type": "null" - } - ], - "title": "Index Param" - }, - "index_type": { - "default": "IVF_FLAT", - "title": "Index Type", - "type": "string" - }, - "isolation_level": { - "title": "Isolation Level", - "type": "string" - }, - "port": { - "default": "19530", - "title": "Port", - "type": "string" - }, - "progress_bar": { - "default": true, - "title": "Progress Bar", - "type": "boolean" - }, - "recreate_index": { - "default": false, - "title": "Recreate Index", - "type": "boolean" - }, - "return_embedding": { - "default": false, - "title": "Return Embedding", - "type": "boolean" - }, - "search_param": { - "anyOf": [ - { - "type": "object" - }, - { - "type": "null" - } - ], - "title": "Search Param" - }, - "similarity": { - "default": "dot_product", - "title": "Similarity", - "type": "string" - }, - "sql_url": { - "default": "sqlite:///", - "title": "Sql Url", - "type": "string" - }, - "vector_dim": { - "title": "Vector Dim", - "type": "integer" - } - }, - "title": "Parameters", - "type": "object" - }, - "type": { - "const": "Milvus2DocumentStore", - "description": "Haystack Class name for the component.", - "title": "Type", - "type": "string" - } - }, - "required": [ - "type", - "name" - ], - "type": "object" - }, - "MultiModalRetrieverComponent": { - "additionalProperties": false, - "properties": { - "name": { - "description": "Custom name for the component. Helpful for visualization and debugging.", - "title": "Name", - "type": "string" - }, - "params": { - "additionalProperties": false, - "description": "Each parameter can reference other components defined in the same YAML file.", - "properties": { - "batch_size": { - "default": 16, - "title": "Batch Size", - "type": "integer" - }, - "devices": { - "anyOf": [ - { - "items": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "string" - } - ] - }, - "type": "array" - }, - { - "type": "null" - } - ], - "title": "Devices" - }, - "document_embedding_models": { - "additionalProperties": { - "anyOf": [ - { - "format": "path", - "type": "string" - }, - { - "type": "string" - } - ] - }, - "title": "Document Embedding Models", - "type": "object" - }, - "document_feature_extractors_params": { - "additionalProperties": { - "type": "object" - }, - "default": { - "text": { - "max_length": 256 - } - }, - "title": "Document Feature Extractors Params", - "type": "object" - }, - "document_store": { - "title": "Document Store", - "type": "string" - }, - "embed_meta_fields": { - "default": [ - "name" - ], - "items": { - "type": "string" - }, - "title": "Embed Meta Fields", - "type": "array" - }, - "progress_bar": { - "default": true, - "title": "Progress Bar", - "type": "boolean" - }, - "query_embedding_model": { - "anyOf": [ - { - "format": "path", - "type": "string" - }, - { - "type": "string" - } - ], - "title": "Query Embedding Model" - }, - "query_feature_extractor_params": { - "default": { - "max_length": 64 - }, - "title": "Query Feature Extractor Params", - "type": "object" - }, - "query_type": { - "default": "text", - "title": "Query Type", - "type": "string" - }, - "scale_score": { - "default": true, - "title": "Scale Score", - "type": "boolean" - }, - "similarity_function": { - "default": "dot_product", - "title": "Similarity Function", - "type": "string" - }, - "top_k": { - "default": 10, - "title": "Top K", - "type": "integer" - }, - "use_auth_token": { - "anyOf": [ - { - "type": "boolean" - }, - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Use Auth Token" - } - }, - "required": [ - "document_store", - "query_embedding_model", - "document_embedding_models" - ], - "title": "Parameters", - "type": "object" - }, - "type": { - "const": "MultiModalRetriever", - "description": "Haystack Class name for the component.", - "title": "Type", - "type": "string" - } - }, - "required": [ - "type", - "name" - ], - "type": "object" - }, - "MultihopEmbeddingRetrieverComponent": { - "additionalProperties": false, - "properties": { - "name": { - "description": "Custom name for the component. Helpful for visualization and debugging.", - "title": "Name", - "type": "string" - }, - "params": { - "additionalProperties": false, - "description": "Each parameter can reference other components defined in the same YAML file.", - "properties": { - "batch_size": { - "default": 32, - "title": "Batch Size", - "type": "integer" - }, - "devices": { - "anyOf": [ - { - "items": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "string" - } - ] - }, - "type": "array" - }, - { - "type": "null" - } - ], - "title": "Devices" - }, - "document_store": { - "title": "Document Store", - "type": "string" - }, - "emb_extraction_layer": { - "default": -1, - "title": "Emb Extraction Layer", - "type": "integer" - }, - "embed_meta_fields": { - "default": [], - "items": { - "type": "string" - }, - "title": "Embed Meta Fields", - "type": "array" - }, - "embedding_model": { - "title": "Embedding Model", - "type": "string" - }, - "max_seq_len": { - "default": 512, - "title": "Max Seq Len", - "type": "integer" - }, - "model_format": { - "default": "farm", - "title": "Model Format", - "type": "string" - }, - "model_version": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Model Version" - }, - "num_iterations": { - "default": 2, - "title": "Num Iterations", - "type": "integer" - }, - "pooling_strategy": { - "default": "reduce_mean", - "title": "Pooling Strategy", - "type": "string" - }, - "progress_bar": { - "default": true, - "title": "Progress Bar", - "type": "boolean" - }, - "scale_score": { - "default": true, - "title": "Scale Score", - "type": "boolean" - }, - "top_k": { - "default": 10, - "title": "Top K", - "type": "integer" - }, - "use_auth_token": { - "anyOf": [ - { - "type": "boolean" - }, - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Use Auth Token" - }, - "use_gpu": { - "default": true, - "title": "Use Gpu", - "type": "boolean" - } - }, - "required": [ - "document_store", - "embedding_model" - ], - "title": "Parameters", - "type": "object" - }, - "type": { - "const": "MultihopEmbeddingRetriever", - "description": "Haystack Class name for the component.", - "title": "Type", - "type": "string" - } - }, - "required": [ - "type", - "name" - ], - "type": "object" - }, - "OpenAIAnswerGeneratorComponent": { - "additionalProperties": false, - "properties": { - "name": { - "description": "Custom name for the component. Helpful for visualization and debugging.", - "title": "Name", - "type": "string" - }, - "params": { - "additionalProperties": false, - "description": "Each parameter can reference other components defined in the same YAML file.", - "properties": { - "api_key": { - "title": "Api Key", - "type": "string" - }, - "examples": { - "anyOf": [ - { - "items": {}, - "type": "array" - }, - { - "type": "null" - } - ], - "title": "Examples" - }, - "examples_context": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Examples Context" - }, - "frequency_penalty": { - "default": -2.0, - "title": "Frequency Penalty", - "type": "number" - }, - "max_tokens": { - "default": 13, - "title": "Max Tokens", - "type": "integer" - }, - "model": { - "default": "text-curie-001", - "title": "Model", - "type": "string" - }, - "presence_penalty": { - "default": -2.0, - "title": "Presence Penalty", - "type": "number" - }, - "progress_bar": { - "default": true, - "title": "Progress Bar", - "type": "boolean" - }, - "stop_words": { - "anyOf": [ - { - "items": {}, - "type": "array" - }, - { - "type": "null" - } - ], - "title": "Stop Words" - }, - "temperature": { - "default": 0.2, - "title": "Temperature", - "type": "number" - }, - "top_k": { - "default": 5, - "title": "Top K", - "type": "integer" - } - }, - "required": [ - "api_key" - ], - "title": "Parameters", - "type": "object" - }, - "type": { - "const": "OpenAIAnswerGenerator", - "description": "Haystack Class name for the component.", - "title": "Type", - "type": "string" - } - }, - "required": [ - "type", - "name" - ], - "type": "object" - }, - "OpenDistroElasticsearchDocumentStoreComponent": { - "additionalProperties": false, - "properties": { - "name": { - "description": "Custom name for the component. Helpful for visualization and debugging.", - "title": "Name", - "type": "string" - }, - "params": { - "additionalProperties": false, - "description": "Each parameter can reference other components defined in the same YAML file.", - "properties": { - "analyzer": { - "default": "standard", - "title": "Analyzer", - "type": "string" - }, - "api_key": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Api Key" - }, - "api_key_id": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Api Key Id" - }, - "aws4auth": { - "title": "Aws4Auth" - }, - "ca_certs": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Ca Certs" - }, - "content_field": { - "default": "content", - "title": "Content Field", - "type": "string" - }, - "create_index": { - "default": true, - "title": "Create Index", - "type": "boolean" - }, - "custom_mapping": { - "anyOf": [ - { - "type": "object" - }, - { - "type": "null" - } - ], - "title": "Custom Mapping" - }, - "duplicate_documents": { - "default": "overwrite", - "title": "Duplicate Documents", - "type": "string" - }, - "embedding_dim": { - "default": 768, - "title": "Embedding Dim", - "type": "integer" - }, - "embedding_field": { - "default": "embedding", - "title": "Embedding Field", - "type": "string" - }, - "excluded_meta_data": { - "anyOf": [ - { - "items": {}, - "type": "array" - }, - { - "type": "null" - } - ], - "title": "Excluded Meta Data" - }, - "host": { - "anyOf": [ - { - "type": "string" - }, - { - "items": { - "type": "string" - }, - "type": "array" - } - ], - "default": "localhost", - "title": "Host" - }, - "index": { - "default": "document", - "title": "Index", - "type": "string" - }, - "index_type": { - "default": "flat", - "title": "Index Type", - "type": "string" - }, - "label_index": { - "default": "label", - "title": "Label Index", - "type": "string" - }, - "name_field": { - "default": "name", - "title": "Name Field", - "type": "string" - }, - "password": { - "default": "admin", - "title": "Password", - "type": "string" - }, - "port": { - "anyOf": [ - { - "type": "integer" - }, - { - "items": { - "type": "integer" - }, - "type": "array" - } - ], - "default": 9200, - "title": "Port" - }, - "recreate_index": { - "default": false, - "title": "Recreate Index", - "type": "boolean" - }, - "refresh_type": { - "default": "wait_for", - "title": "Refresh Type", - "type": "string" - }, - "return_embedding": { - "default": false, - "title": "Return Embedding", - "type": "boolean" - }, - "scheme": { - "default": "https", - "title": "Scheme", - "type": "string" - }, - "scroll": { - "default": "1d", - "title": "Scroll", - "type": "string" - }, - "search_fields": { - "anyOf": [ - { - "type": "string" - }, - { - "items": {}, - "type": "array" - } - ], - "default": "content", - "title": "Search Fields" - }, - "similarity": { - "default": "cosine", - "title": "Similarity", - "type": "string" - }, - "skip_missing_embeddings": { - "default": true, - "title": "Skip Missing Embeddings", - "type": "boolean" - }, - "synonym_type": { - "default": "synonym", - "title": "Synonym Type", - "type": "string" - }, - "synonyms": { - "anyOf": [ - { - "items": {}, - "type": "array" - }, - { - "type": "null" - } - ], - "title": "Synonyms" - }, - "timeout": { - "default": 30, - "title": "Timeout", - "type": "integer" - }, - "use_system_proxy": { - "default": false, - "title": "Use System Proxy", - "type": "boolean" - }, - "username": { - "default": "admin", - "title": "Username", - "type": "string" - }, - "verify_certs": { - "default": false, - "title": "Verify Certs", - "type": "boolean" - } - }, - "title": "Parameters", - "type": "object" - }, - "type": { - "const": "OpenDistroElasticsearchDocumentStore", - "description": "Haystack Class name for the component.", - "title": "Type", - "type": "string" - } - }, - "required": [ - "type", - "name" - ], - "type": "object" - }, - "OpenSearchDocumentStoreComponent": { - "additionalProperties": false, - "properties": { - "name": { - "description": "Custom name for the component. Helpful for visualization and debugging.", - "title": "Name", - "type": "string" - }, - "params": { - "additionalProperties": false, - "description": "Each parameter can reference other components defined in the same YAML file.", - "properties": { - "analyzer": { - "default": "standard", - "title": "Analyzer", - "type": "string" - }, - "api_key": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Api Key" - }, - "api_key_id": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Api Key Id" - }, - "aws4auth": { - "title": "Aws4Auth" - }, - "ca_certs": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Ca Certs" - }, - "content_field": { - "default": "content", - "title": "Content Field", - "type": "string" - }, - "create_index": { - "default": true, - "title": "Create Index", - "type": "boolean" - }, - "custom_mapping": { - "anyOf": [ - { - "type": "object" - }, - { - "type": "null" - } - ], - "title": "Custom Mapping" - }, - "duplicate_documents": { - "default": "overwrite", - "title": "Duplicate Documents", - "type": "string" - }, - "embedding_dim": { - "default": 768, - "title": "Embedding Dim", - "type": "integer" - }, - "embedding_field": { - "default": "embedding", - "title": "Embedding Field", - "type": "string" - }, - "excluded_meta_data": { - "anyOf": [ - { - "items": {}, - "type": "array" - }, - { - "type": "null" - } - ], - "title": "Excluded Meta Data" - }, - "host": { - "anyOf": [ - { - "type": "string" - }, - { - "items": { - "type": "string" - }, - "type": "array" - } - ], - "default": "localhost", - "title": "Host" - }, - "index": { - "default": "document", - "title": "Index", - "type": "string" - }, - "index_type": { - "default": "flat", - "title": "Index Type", - "type": "string" - }, - "knn_engine": { - "default": "nmslib", - "title": "Knn Engine", - "type": "string" - }, - "label_index": { - "default": "label", - "title": "Label Index", - "type": "string" - }, - "name_field": { - "default": "name", - "title": "Name Field", - "type": "string" - }, - "password": { - "default": "admin", - "title": "Password", - "type": "string" - }, - "port": { - "anyOf": [ - { - "type": "integer" - }, - { - "items": { - "type": "integer" - }, - "type": "array" - } - ], - "default": 9200, - "title": "Port" - }, - "recreate_index": { - "default": false, - "title": "Recreate Index", - "type": "boolean" - }, - "refresh_type": { - "default": "wait_for", - "title": "Refresh Type", - "type": "string" - }, - "return_embedding": { - "default": false, - "title": "Return Embedding", - "type": "boolean" - }, - "scheme": { - "default": "https", - "title": "Scheme", - "type": "string" - }, - "scroll": { - "default": "1d", - "title": "Scroll", - "type": "string" - }, - "search_fields": { - "anyOf": [ - { - "type": "string" - }, - { - "items": {}, - "type": "array" - } - ], - "default": "content", - "title": "Search Fields" - }, - "similarity": { - "default": "dot_product", - "title": "Similarity", - "type": "string" - }, - "skip_missing_embeddings": { - "default": true, - "title": "Skip Missing Embeddings", - "type": "boolean" - }, - "synonym_type": { - "default": "synonym", - "title": "Synonym Type", - "type": "string" - }, - "synonyms": { - "anyOf": [ - { - "items": {}, - "type": "array" - }, - { - "type": "null" - } - ], - "title": "Synonyms" - }, - "timeout": { - "default": 30, - "title": "Timeout", - "type": "integer" - }, - "use_system_proxy": { - "default": false, - "title": "Use System Proxy", - "type": "boolean" - }, - "username": { - "default": "admin", - "title": "Username", - "type": "string" - }, - "verify_certs": { - "default": false, - "title": "Verify Certs", - "type": "boolean" - } - }, - "title": "Parameters", - "type": "object" - }, - "type": { - "const": "OpenSearchDocumentStore", - "description": "Haystack Class name for the component.", - "title": "Type", - "type": "string" - } - }, - "required": [ - "type", - "name" - ], - "type": "object" - }, - "PDFToTextConverterComponent": { - "additionalProperties": false, - "properties": { - "name": { - "description": "Custom name for the component. Helpful for visualization and debugging.", - "title": "Name", - "type": "string" - }, - "params": { - "additionalProperties": false, - "description": "Each parameter can reference other components defined in the same YAML file.", - "properties": { - "encoding": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "default": "UTF-8", - "title": "Encoding" - }, - "id_hash_keys": { - "anyOf": [ - { - "items": { - "type": "string" - }, - "type": "array" - }, - { - "type": "null" - } - ], - "title": "Id Hash Keys" - }, - "keep_physical_layout": { - "default": false, - "title": "Keep Physical Layout", - "type": "boolean" - }, - "remove_numeric_tables": { - "default": false, - "title": "Remove Numeric Tables", - "type": "boolean" - }, - "valid_languages": { - "anyOf": [ - { - "items": { - "type": "string" - }, - "type": "array" - }, - { - "type": "null" - } - ], - "title": "Valid Languages" - } - }, - "title": "Parameters", - "type": "object" - }, - "type": { - "const": "PDFToTextConverter", - "description": "Haystack Class name for the component.", - "title": "Type", - "type": "string" - } - }, - "required": [ - "type", - "name" - ], - "type": "object" - }, - "PDFToTextOCRConverterComponent": { - "additionalProperties": false, - "properties": { - "name": { - "description": "Custom name for the component. Helpful for visualization and debugging.", - "title": "Name", - "type": "string" - }, - "params": { - "additionalProperties": false, - "description": "Each parameter can reference other components defined in the same YAML file.", - "properties": { - "id_hash_keys": { - "anyOf": [ - { - "items": { - "type": "string" - }, - "type": "array" - }, - { - "type": "null" - } - ], - "title": "Id Hash Keys" - }, - "remove_numeric_tables": { - "default": false, - "title": "Remove Numeric Tables", - "type": "boolean" - }, - "valid_languages": { - "anyOf": [ - { - "items": { - "type": "string" - }, - "type": "array" - }, - { - "type": "null" - } - ], - "default": [ - "eng" - ], - "title": "Valid Languages" - } - }, - "title": "Parameters", - "type": "object" - }, - "type": { - "const": "PDFToTextOCRConverter", - "description": "Haystack Class name for the component.", - "title": "Type", - "type": "string" - } - }, - "required": [ - "type", - "name" - ], - "type": "object" - }, - "ParsrConverterComponent": { - "additionalProperties": false, - "properties": { - "name": { - "description": "Custom name for the component. Helpful for visualization and debugging.", - "title": "Name", - "type": "string" - }, - "params": { - "additionalProperties": false, - "description": "Each parameter can reference other components defined in the same YAML file.", - "properties": { - "add_page_number": { - "default": true, - "title": "Add Page Number", - "type": "boolean" - }, - "extractor": { - "default": "pdfminer", - "enum": [ - "pdfminer", - "pdfjs" - ], - "title": "Extractor", - "type": "string" - }, - "following_context_len": { - "default": 3, - "title": "Following Context Len", - "type": "integer" - }, - "id_hash_keys": { - "anyOf": [ - { - "items": { - "type": "string" - }, - "type": "array" - }, - { - "type": "null" - } - ], - "title": "Id Hash Keys" - }, - "parsr_url": { - "default": "http://localhost:3001", - "title": "Parsr Url", - "type": "string" - }, - "preceding_context_len": { - "default": 3, - "title": "Preceding Context Len", - "type": "integer" - }, - "remove_page_footers": { - "default": false, - "title": "Remove Page Footers", - "type": "boolean" - }, - "remove_page_headers": { - "default": false, - "title": "Remove Page Headers", - "type": "boolean" - }, - "remove_table_of_contents": { - "default": false, - "title": "Remove Table Of Contents", - "type": "boolean" - }, - "table_detection_mode": { - "default": "lattice", - "enum": [ - "lattice", - "stream" - ], - "title": "Table Detection Mode", - "type": "string" - }, - "valid_languages": { - "anyOf": [ - { - "items": { - "type": "string" - }, - "type": "array" - }, - { - "type": "null" - } - ], - "title": "Valid Languages" - } - }, - "title": "Parameters", - "type": "object" - }, - "type": { - "const": "ParsrConverter", - "description": "Haystack Class name for the component.", - "title": "Type", - "type": "string" - } - }, - "required": [ - "type", - "name" - ], - "type": "object" - }, - "PineconeDocumentStoreComponent": { - "additionalProperties": false, - "properties": { - "name": { - "description": "Custom name for the component. Helpful for visualization and debugging.", - "title": "Name", - "type": "string" - }, - "params": { - "additionalProperties": false, - "description": "Each parameter can reference other components defined in the same YAML file.", - "properties": { - "api_key": { - "title": "Api Key", - "type": "string" - }, - "duplicate_documents": { - "default": "overwrite", - "title": "Duplicate Documents", - "type": "string" - }, - "embedding_dim": { - "default": 768, - "title": "Embedding Dim", - "type": "integer" - }, - "embedding_field": { - "default": "embedding", - "title": "Embedding Field", - "type": "string" - }, - "environment": { - "default": "us-west1-gcp", - "title": "Environment", - "type": "string" - }, - "index": { - "default": "document", - "title": "Index", - "type": "string" - }, - "metadata_config": { - "default": { - "indexed": [] - }, - "title": "Metadata Config", - "type": "object" - }, - "pinecone_index": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "default": null, - "title": "Pinecone Index" - }, - "progress_bar": { - "default": true, - "title": "Progress Bar", - "type": "boolean" - }, - "recreate_index": { - "default": false, - "title": "Recreate Index", - "type": "boolean" - }, - "replicas": { - "default": 1, - "title": "Replicas", - "type": "integer" - }, - "return_embedding": { - "default": false, - "title": "Return Embedding", - "type": "boolean" - }, - "shards": { - "default": 1, - "title": "Shards", - "type": "integer" - }, - "similarity": { - "default": "cosine", - "title": "Similarity", - "type": "string" - }, - "validate_index_sync": { - "default": true, - "title": "Validate Index Sync", - "type": "boolean" - } - }, - "required": [ - "api_key" - ], - "title": "Parameters", - "type": "object" - }, - "type": { - "const": "PineconeDocumentStore", - "description": "Haystack Class name for the component.", - "title": "Type", - "type": "string" - } - }, - "required": [ - "type", - "name" - ], - "type": "object" - }, - "PreProcessorComponent": { - "additionalProperties": false, - "properties": { - "name": { - "description": "Custom name for the component. Helpful for visualization and debugging.", - "title": "Name", - "type": "string" - }, - "params": { - "additionalProperties": false, - "description": "Each parameter can reference other components defined in the same YAML file.", - "properties": { - "add_page_number": { - "default": false, - "title": "Add Page Number", - "type": "boolean" - }, - "clean_empty_lines": { - "default": true, - "title": "Clean Empty Lines", - "type": "boolean" - }, - "clean_header_footer": { - "default": false, - "title": "Clean Header Footer", - "type": "boolean" - }, - "clean_whitespace": { - "default": true, - "title": "Clean Whitespace", - "type": "boolean" - }, - "id_hash_keys": { - "anyOf": [ - { - "items": { - "type": "string" - }, - "type": "array" - }, - { - "type": "null" - } - ], - "title": "Id Hash Keys" - }, - "language": { - "default": "en", - "title": "Language", - "type": "string" - }, - "progress_bar": { - "default": true, - "title": "Progress Bar", - "type": "boolean" - }, - "remove_substrings": { - "default": [], - "items": { - "type": "string" - }, - "title": "Remove Substrings", - "type": "array" - }, - "split_by": { - "default": "word", - "enum": [ - "word", - "sentence", - "passage" - ], - "title": "Split By", - "type": "string" - }, - "split_length": { - "default": 200, - "title": "Split Length", - "type": "integer" - }, - "split_overlap": { - "default": 0, - "title": "Split Overlap", - "type": "integer" - }, - "split_respect_sentence_boundary": { - "default": true, - "title": "Split Respect Sentence Boundary", - "type": "boolean" - }, - "tokenizer_model_folder": { - "anyOf": [ - { - "type": "string" - }, - { - "format": "path", - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Tokenizer Model Folder" - } - }, - "title": "Parameters", - "type": "object" - }, - "type": { - "const": "PreProcessor", - "description": "Haystack Class name for the component.", - "title": "Type", - "type": "string" - } - }, - "required": [ - "type", - "name" - ], - "type": "object" - }, - "PseudoLabelGeneratorComponent": { - "additionalProperties": false, - "properties": { - "name": { - "description": "Custom name for the component. Helpful for visualization and debugging.", - "title": "Name", - "type": "string" - }, - "params": { - "additionalProperties": false, - "description": "Each parameter can reference other components defined in the same YAML file.", - "properties": { - "batch_size": { - "default": 16, - "title": "Batch Size", - "type": "integer" - }, - "cross_encoder_model_name_or_path": { - "default": "cross-encoder/ms-marco-MiniLM-L-6-v2", - "title": "Cross Encoder Model Name Or Path", - "type": "string" - }, - "devices": { - "anyOf": [ - { - "items": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "string" - } - ] - }, - "type": "array" - }, - { - "type": "null" - } - ], - "title": "Devices" - }, - "max_questions_per_document": { - "default": 3, - "title": "Max Questions Per Document", - "type": "integer" - }, - "progress_bar": { - "default": true, - "title": "Progress Bar", - "type": "boolean" - }, - "question_producer": { - "anyOf": [ - { - "type": "string" - }, - { - "items": { - "additionalProperties": { - "type": "string" - }, - "type": "object" - }, - "type": "array" - } - ], - "title": "Question Producer" - }, - "retriever": { - "title": "Retriever", - "type": "string" - }, - "top_k": { - "default": 50, - "title": "Top K", - "type": "integer" - }, - "use_auth_token": { - "anyOf": [ - { - "type": "boolean" - }, - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Use Auth Token" - }, - "use_gpu": { - "default": true, - "title": "Use Gpu", - "type": "boolean" - } - }, - "required": [ - "question_producer", - "retriever" - ], - "title": "Parameters", - "type": "object" - }, - "type": { - "const": "PseudoLabelGenerator", - "description": "Haystack Class name for the component.", - "title": "Type", - "type": "string" - } - }, - "required": [ - "type", - "name" - ], - "type": "object" - }, - "QuestionGeneratorComponent": { - "additionalProperties": false, - "properties": { - "name": { - "description": "Custom name for the component. Helpful for visualization and debugging.", - "title": "Name", - "type": "string" - }, - "params": { - "additionalProperties": false, - "description": "Each parameter can reference other components defined in the same YAML file.", - "properties": { - "batch_size": { - "default": 16, - "title": "Batch Size", - "type": "integer" - }, - "devices": { - "anyOf": [ - { - "items": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "string" - } - ] - }, - "type": "array" - }, - { - "type": "null" - } - ], - "title": "Devices" - }, - "early_stopping": { - "default": true, - "title": "Early Stopping", - "type": "boolean" - }, - "length_penalty": { - "default": 1.5, - "title": "Length Penalty", - "type": "number" - }, - "max_length": { - "default": 256, - "title": "Max Length", - "type": "integer" - }, - "model_name_or_path": { - "default": "valhalla/t5-base-e2e-qg", - "title": "Model Name Or Path", - "type": "string" - }, - "model_version": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Model Version" - }, - "no_repeat_ngram_size": { - "default": 3, - "title": "No Repeat Ngram Size", - "type": "integer" - }, - "num_beams": { - "default": 4, - "title": "Num Beams", - "type": "integer" - }, - "num_queries_per_doc": { - "default": 1, - "title": "Num Queries Per Doc", - "type": "integer" - }, - "progress_bar": { - "default": true, - "title": "Progress Bar", - "type": "boolean" - }, - "prompt": { - "default": "generate questions:", - "title": "Prompt", - "type": "string" - }, - "sep_token": { - "default": "", - "title": "Sep Token", - "type": "string" - }, - "split_length": { - "default": 50, - "title": "Split Length", - "type": "integer" - }, - "split_overlap": { - "default": 10, - "title": "Split Overlap", - "type": "integer" - }, - "use_auth_token": { - "anyOf": [ - { - "type": "boolean" - }, - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Use Auth Token" - }, - "use_gpu": { - "default": true, - "title": "Use Gpu", - "type": "boolean" - } - }, - "title": "Parameters", - "type": "object" - }, - "type": { - "const": "QuestionGenerator", - "description": "Haystack Class name for the component.", - "title": "Type", - "type": "string" - } - }, - "required": [ - "type", - "name" - ], - "type": "object" - }, - "RAGeneratorComponent": { - "additionalProperties": false, - "properties": { - "name": { - "description": "Custom name for the component. Helpful for visualization and debugging.", - "title": "Name", - "type": "string" - }, - "params": { - "additionalProperties": false, - "description": "Each parameter can reference other components defined in the same YAML file.", - "properties": { - "devices": { - "anyOf": [ - { - "items": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "string" - } - ] - }, - "type": "array" - }, - { - "type": "null" - } - ], - "title": "Devices" - }, - "embed_title": { - "default": true, - "title": "Embed Title", - "type": "boolean" - }, - "generator_type": { - "default": "token", - "title": "Generator Type", - "type": "string" - }, - "max_length": { - "default": 200, - "title": "Max Length", - "type": "integer" - }, - "min_length": { - "default": 2, - "title": "Min Length", - "type": "integer" - }, - "model_name_or_path": { - "default": "facebook/rag-token-nq", - "title": "Model Name Or Path", - "type": "string" - }, - "model_version": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Model Version" - }, - "num_beams": { - "default": 2, - "title": "Num Beams", - "type": "integer" - }, - "prefix": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Prefix" - }, - "progress_bar": { - "default": true, - "title": "Progress Bar", - "type": "boolean" - }, - "retriever": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "default": null, - "title": "Retriever" - }, - "top_k": { - "default": 2, - "title": "Top K", - "type": "integer" - }, - "use_auth_token": { - "anyOf": [ - { - "type": "boolean" - }, - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Use Auth Token" - }, - "use_gpu": { - "default": true, - "title": "Use Gpu", - "type": "boolean" - } - }, - "title": "Parameters", - "type": "object" - }, - "type": { - "const": "RAGenerator", - "description": "Haystack Class name for the component.", - "title": "Type", - "type": "string" - } - }, - "required": [ - "type", - "name" - ], - "type": "object" - }, - "RCIReaderComponent": { - "additionalProperties": false, - "properties": { - "name": { - "description": "Custom name for the component. Helpful for visualization and debugging.", - "title": "Name", - "type": "string" - }, - "params": { - "additionalProperties": false, - "description": "Each parameter can reference other components defined in the same YAML file.", - "properties": { - "column_model_name_or_path": { - "default": "michaelrglass/albert-base-rci-wikisql-col", - "title": "Column Model Name Or Path", - "type": "string" - }, - "column_model_version": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Column Model Version" - }, - "column_tokenizer": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Column Tokenizer" - }, - "max_seq_len": { - "default": 256, - "title": "Max Seq Len", - "type": "integer" - }, - "row_model_name_or_path": { - "default": "michaelrglass/albert-base-rci-wikisql-row", - "title": "Row Model Name Or Path", - "type": "string" - }, - "row_model_version": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Row Model Version" - }, - "row_tokenizer": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Row Tokenizer" - }, - "top_k": { - "default": 10, - "title": "Top K", - "type": "integer" - }, - "use_auth_token": { - "anyOf": [ - { - "type": "boolean" - }, - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Use Auth Token" - }, - "use_gpu": { - "default": true, - "title": "Use Gpu", - "type": "boolean" - } - }, - "title": "Parameters", - "type": "object" - }, - "type": { - "const": "RCIReader", - "description": "Haystack Class name for the component.", - "title": "Type", - "type": "string" - } - }, - "required": [ - "type", - "name" - ], - "type": "object" - }, - "RouteDocumentsComponent": { - "additionalProperties": false, - "properties": { - "name": { - "description": "Custom name for the component. Helpful for visualization and debugging.", - "title": "Name", - "type": "string" - }, - "params": { - "additionalProperties": false, - "description": "Each parameter can reference other components defined in the same YAML file.", - "properties": { - "metadata_values": { - "anyOf": [ - { - "items": { - "type": "string" - }, - "type": "array" - }, - { - "type": "null" - } - ], - "title": "Metadata Values" - }, - "split_by": { - "default": "content_type", - "title": "Split By", - "type": "string" - } - }, - "title": "Parameters", - "type": "object" - }, - "type": { - "const": "RouteDocuments", - "description": "Haystack Class name for the component.", - "title": "Type", - "type": "string" - } - }, - "required": [ - "type", - "name" - ], - "type": "object" - }, - "SQLDocumentStoreComponent": { - "additionalProperties": false, - "properties": { - "name": { - "description": "Custom name for the component. Helpful for visualization and debugging.", - "title": "Name", - "type": "string" - }, - "params": { - "additionalProperties": false, - "description": "Each parameter can reference other components defined in the same YAML file.", - "properties": { - "check_same_thread": { - "default": false, - "title": "Check Same Thread", - "type": "boolean" - }, - "duplicate_documents": { - "default": "overwrite", - "title": "Duplicate Documents", - "type": "string" - }, - "index": { - "default": "document", - "title": "Index", - "type": "string" - }, - "isolation_level": { - "title": "Isolation Level", - "type": "string" - }, - "label_index": { - "default": "label", - "title": "Label Index", - "type": "string" - }, - "url": { - "default": "sqlite://", - "title": "Url", - "type": "string" - } - }, - "title": "Parameters", - "type": "object" - }, - "type": { - "const": "SQLDocumentStore", - "description": "Haystack Class name for the component.", - "title": "Type", - "type": "string" - } - }, - "required": [ - "type", - "name" - ], - "type": "object" - }, - "SentenceTransformersRankerComponent": { - "additionalProperties": false, - "properties": { - "name": { - "description": "Custom name for the component. Helpful for visualization and debugging.", - "title": "Name", - "type": "string" - }, - "params": { - "additionalProperties": false, - "description": "Each parameter can reference other components defined in the same YAML file.", - "properties": { - "batch_size": { - "default": 16, - "title": "Batch Size", - "type": "integer" - }, - "devices": { - "anyOf": [ - { - "items": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "string" - } - ] - }, - "type": "array" - }, - { - "type": "null" - } - ], - "title": "Devices" - }, - "model_name_or_path": { - "anyOf": [ - { - "type": "string" - }, - { - "format": "path", - "type": "string" - } - ], - "title": "Model Name Or Path" - }, - "model_version": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Model Version" - }, - "progress_bar": { - "default": true, - "title": "Progress Bar", - "type": "boolean" - }, - "scale_score": { - "default": true, - "title": "Scale Score", - "type": "boolean" - }, - "top_k": { - "default": 10, - "title": "Top K", - "type": "integer" - }, - "use_auth_token": { - "anyOf": [ - { - "type": "boolean" - }, - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Use Auth Token" - }, - "use_gpu": { - "default": true, - "title": "Use Gpu", - "type": "boolean" - } - }, - "required": [ - "model_name_or_path" - ], - "title": "Parameters", - "type": "object" - }, - "type": { - "const": "SentenceTransformersRanker", - "description": "Haystack Class name for the component.", - "title": "Type", - "type": "string" - } - }, - "required": [ - "type", - "name" - ], - "type": "object" - }, - "Seq2SeqGeneratorComponent": { - "additionalProperties": false, - "properties": { - "name": { - "description": "Custom name for the component. Helpful for visualization and debugging.", - "title": "Name", - "type": "string" - }, - "params": { - "additionalProperties": false, - "description": "Each parameter can reference other components defined in the same YAML file.", - "properties": { - "devices": { - "anyOf": [ - { - "items": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "string" - } - ] - }, - "type": "array" - }, - { - "type": "null" - } - ], - "title": "Devices" - }, - "input_converter": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "default": null, - "title": "Input Converter" - }, - "max_length": { - "default": 200, - "title": "Max Length", - "type": "integer" - }, - "min_length": { - "default": 2, - "title": "Min Length", - "type": "integer" - }, - "model_name_or_path": { - "title": "Model Name Or Path", - "type": "string" - }, - "num_beams": { - "default": 8, - "title": "Num Beams", - "type": "integer" - }, - "progress_bar": { - "default": true, - "title": "Progress Bar", - "type": "boolean" - }, - "top_k": { - "default": 1, - "title": "Top K", - "type": "integer" - }, - "use_auth_token": { - "anyOf": [ - { - "type": "boolean" - }, - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Use Auth Token" - }, - "use_gpu": { - "default": true, - "title": "Use Gpu", - "type": "boolean" - } - }, - "required": [ - "model_name_or_path" - ], - "title": "Parameters", - "type": "object" - }, - "type": { - "const": "Seq2SeqGenerator", - "description": "Haystack Class name for the component.", - "title": "Type", - "type": "string" - } - }, - "required": [ - "type", - "name" - ], - "type": "object" - }, - "SklearnQueryClassifierComponent": { - "additionalProperties": false, - "properties": { - "name": { - "description": "Custom name for the component. Helpful for visualization and debugging.", - "title": "Name", - "type": "string" - }, - "params": { - "additionalProperties": false, - "description": "Each parameter can reference other components defined in the same YAML file.", - "properties": { - "batch_size": { - "anyOf": [ - { - "type": "integer" - }, - { - "type": "null" - } - ], - "title": "Batch Size" - }, - "model_name_or_path": { - "anyOf": [ - { - "type": "string" - }, - {} - ], - "default": "https://ext-models-haystack.s3.eu-central-1.amazonaws.com/gradboost_query_classifier/model.pickle", - "title": "Model Name Or Path" - }, - "progress_bar": { - "default": true, - "title": "Progress Bar", - "type": "boolean" - }, - "vectorizer_name_or_path": { - "anyOf": [ - { - "type": "string" - }, - {} - ], - "default": "https://ext-models-haystack.s3.eu-central-1.amazonaws.com/gradboost_query_classifier/vectorizer.pickle", - "title": "Vectorizer Name Or Path" - } - }, - "title": "Parameters", - "type": "object" - }, - "type": { - "const": "SklearnQueryClassifier", - "description": "Haystack Class name for the component.", - "title": "Type", - "type": "string" - } - }, - "required": [ - "type", - "name" - ], - "type": "object" - }, - "TableReaderComponent": { - "additionalProperties": false, - "properties": { - "name": { - "description": "Custom name for the component. Helpful for visualization and debugging.", - "title": "Name", - "type": "string" - }, - "params": { - "additionalProperties": false, - "description": "Each parameter can reference other components defined in the same YAML file.", - "properties": { - "devices": { - "anyOf": [ - { - "items": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "string" - } - ] - }, - "type": "array" - }, - { - "type": "null" - } - ], - "title": "Devices" - }, - "max_seq_len": { - "default": 256, - "title": "Max Seq Len", - "type": "integer" - }, - "model_name_or_path": { - "default": "google/tapas-base-finetuned-wtq", - "title": "Model Name Or Path", - "type": "string" - }, - "model_version": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Model Version" - }, - "return_no_answer": { - "default": false, - "title": "Return No Answer", - "type": "boolean" - }, - "tokenizer": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Tokenizer" - }, - "top_k": { - "default": 10, - "title": "Top K", - "type": "integer" - }, - "top_k_per_candidate": { - "default": 3, - "title": "Top K Per Candidate", - "type": "integer" - }, - "use_auth_token": { - "anyOf": [ - { - "type": "boolean" - }, - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Use Auth Token" - }, - "use_gpu": { - "default": true, - "title": "Use Gpu", - "type": "boolean" - } - }, - "title": "Parameters", - "type": "object" - }, - "type": { - "const": "TableReader", - "description": "Haystack Class name for the component.", - "title": "Type", - "type": "string" - } - }, - "required": [ - "type", - "name" - ], - "type": "object" - }, - "TableTextRetrieverComponent": { - "additionalProperties": false, - "properties": { - "name": { - "description": "Custom name for the component. Helpful for visualization and debugging.", - "title": "Name", - "type": "string" - }, - "params": { - "additionalProperties": false, - "description": "Each parameter can reference other components defined in the same YAML file.", - "properties": { - "batch_size": { - "default": 16, - "title": "Batch Size", - "type": "integer" - }, - "devices": { - "anyOf": [ - { - "items": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "string" - } - ] - }, - "type": "array" - }, - { - "type": "null" - } - ], - "title": "Devices" - }, - "document_store": { - "title": "Document Store", - "type": "string" - }, - "embed_meta_fields": { - "default": [ - "name", - "section_title", - "caption" - ], - "items": { - "type": "string" - }, - "title": "Embed Meta Fields", - "type": "array" - }, - "global_loss_buffer_size": { - "default": 150000, - "title": "Global Loss Buffer Size", - "type": "integer" - }, - "max_seq_len_passage": { - "default": 256, - "title": "Max Seq Len Passage", - "type": "integer" - }, - "max_seq_len_query": { - "default": 64, - "title": "Max Seq Len Query", - "type": "integer" - }, - "max_seq_len_table": { - "default": 256, - "title": "Max Seq Len Table", - "type": "integer" - }, - "model_version": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Model Version" - }, - "passage_embedding_model": { - "anyOf": [ - { - "format": "path", - "type": "string" - }, - { - "type": "string" - } - ], - "default": "deepset/bert-small-mm_retrieval-passage_encoder", - "title": "Passage Embedding Model" - }, - "progress_bar": { - "default": true, - "title": "Progress Bar", - "type": "boolean" - }, - "query_embedding_model": { - "anyOf": [ - { - "format": "path", - "type": "string" - }, - { - "type": "string" - } - ], - "default": "deepset/bert-small-mm_retrieval-question_encoder", - "title": "Query Embedding Model" - }, - "scale_score": { - "default": true, - "title": "Scale Score", - "type": "boolean" - }, - "similarity_function": { - "default": "dot_product", - "title": "Similarity Function", - "type": "string" - }, - "table_embedding_model": { - "anyOf": [ - { - "format": "path", - "type": "string" - }, - { - "type": "string" - } - ], - "default": "deepset/bert-small-mm_retrieval-table_encoder", - "title": "Table Embedding Model" - }, - "top_k": { - "default": 10, - "title": "Top K", - "type": "integer" - }, - "use_auth_token": { - "anyOf": [ - { - "type": "boolean" - }, - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Use Auth Token" - }, - "use_fast": { - "default": true, - "title": "Use Fast", - "type": "boolean" - }, - "use_fast_tokenizers": { - "default": true, - "title": "Use Fast Tokenizers", - "type": "boolean" - }, - "use_gpu": { - "default": true, - "title": "Use Gpu", - "type": "boolean" - } - }, - "required": [ - "document_store" - ], - "title": "Parameters", - "type": "object" - }, - "type": { - "const": "TableTextRetriever", - "description": "Haystack Class name for the component.", - "title": "Type", - "type": "string" - } - }, - "required": [ - "type", - "name" - ], - "type": "object" - }, - "Text2SparqlRetrieverComponent": { - "additionalProperties": false, - "properties": { - "name": { - "description": "Custom name for the component. Helpful for visualization and debugging.", - "title": "Name", - "type": "string" - }, - "params": { - "additionalProperties": false, - "description": "Each parameter can reference other components defined in the same YAML file.", - "properties": { - "knowledge_graph": { - "title": "Knowledge Graph", - "type": "string" - }, - "model_name_or_path": { - "title": "Model Name Or Path", - "type": "string" - }, - "model_version": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Model Version" - }, - "top_k": { - "default": 1, - "title": "Top K", - "type": "integer" - }, - "use_auth_token": { - "anyOf": [ - { - "type": "boolean" - }, - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Use Auth Token" - } - }, - "required": [ - "knowledge_graph" - ], - "title": "Parameters", - "type": "object" - }, - "type": { - "const": "Text2SparqlRetriever", - "description": "Haystack Class name for the component.", - "title": "Type", - "type": "string" - } - }, - "required": [ - "type", - "name" - ], - "type": "object" - }, - "TextConverterComponent": { - "additionalProperties": false, - "properties": { - "name": { - "description": "Custom name for the component. Helpful for visualization and debugging.", - "title": "Name", - "type": "string" - }, - "params": { - "additionalProperties": false, - "description": "Each parameter can reference other components defined in the same YAML file.", - "properties": { - "id_hash_keys": { - "anyOf": [ - { - "items": { - "type": "string" - }, - "type": "array" - }, - { - "type": "null" - } - ], - "title": "Id Hash Keys" - }, - "progress_bar": { - "default": true, - "title": "Progress Bar", - "type": "boolean" - }, - "remove_numeric_tables": { - "default": false, - "title": "Remove Numeric Tables", - "type": "boolean" - }, - "valid_languages": { - "anyOf": [ - { - "items": { - "type": "string" - }, - "type": "array" - }, - { - "type": "null" - } - ], - "title": "Valid Languages" - } - }, - "title": "Parameters", - "type": "object" - }, - "type": { - "const": "TextConverter", - "description": "Haystack Class name for the component.", - "title": "Type", - "type": "string" - } - }, - "required": [ - "type", - "name" - ], - "type": "object" - }, - "TfidfRetrieverComponent": { - "additionalProperties": false, - "properties": { - "name": { - "description": "Custom name for the component. Helpful for visualization and debugging.", - "title": "Name", - "type": "string" - }, - "params": { - "additionalProperties": false, - "description": "Each parameter can reference other components defined in the same YAML file.", - "properties": { - "auto_fit": { - "default": true, - "title": "Auto Fit" - }, - "document_store": { - "title": "Document Store", - "type": "string" - }, - "top_k": { - "default": 10, - "title": "Top K", - "type": "integer" - } - }, - "required": [ - "document_store" - ], - "title": "Parameters", - "type": "object" - }, - "type": { - "const": "TfidfRetriever", - "description": "Haystack Class name for the component.", - "title": "Type", - "type": "string" - } - }, - "required": [ - "type", - "name" - ], - "type": "object" - }, - "TikaConverterComponent": { - "additionalProperties": false, - "properties": { - "name": { - "description": "Custom name for the component. Helpful for visualization and debugging.", - "title": "Name", - "type": "string" - }, - "params": { - "additionalProperties": false, - "description": "Each parameter can reference other components defined in the same YAML file.", - "properties": { - "id_hash_keys": { - "anyOf": [ - { - "items": { - "type": "string" - }, - "type": "array" - }, - { - "type": "null" - } - ], - "title": "Id Hash Keys" - }, - "remove_numeric_tables": { - "default": false, - "title": "Remove Numeric Tables", - "type": "boolean" - }, - "tika_url": { - "default": "http://localhost:9998/tika", - "title": "Tika Url", - "type": "string" - }, - "valid_languages": { - "anyOf": [ - { - "items": { - "type": "string" - }, - "type": "array" - }, - { - "type": "null" - } - ], - "title": "Valid Languages" - } - }, - "title": "Parameters", - "type": "object" - }, - "type": { - "const": "TikaConverter", - "description": "Haystack Class name for the component.", - "title": "Type", - "type": "string" - } - }, - "required": [ - "type", - "name" - ], - "type": "object" - }, - "TransformersDocumentClassifierComponent": { - "additionalProperties": false, - "properties": { - "name": { - "description": "Custom name for the component. Helpful for visualization and debugging.", - "title": "Name", - "type": "string" - }, - "params": { - "additionalProperties": false, - "description": "Each parameter can reference other components defined in the same YAML file.", - "properties": { - "batch_size": { - "default": 16, - "title": "Batch Size", - "type": "integer" - }, - "classification_field": { - "title": "Classification Field", - "type": "string" - }, - "devices": { - "anyOf": [ - { - "items": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "string" - } - ] - }, - "type": "array" - }, - { - "type": "null" - } - ], - "title": "Devices" - }, - "labels": { - "anyOf": [ - { - "items": { - "type": "string" - }, - "type": "array" - }, - { - "type": "null" - } - ], - "title": "Labels" - }, - "model_name_or_path": { - "default": "bhadresh-savani/distilbert-base-uncased-emotion", - "title": "Model Name Or Path", - "type": "string" - }, - "model_version": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Model Version" - }, - "progress_bar": { - "default": true, - "title": "Progress Bar", - "type": "boolean" - }, - "task": { - "default": "text-classification", - "title": "Task", - "type": "string" - }, - "tokenizer": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Tokenizer" - }, - "top_k": { - "anyOf": [ - { - "type": "integer" - }, - { - "type": "null" - } - ], - "default": 1, - "title": "Top K" - }, - "use_auth_token": { - "anyOf": [ - { - "type": "boolean" - }, - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Use Auth Token" - }, - "use_gpu": { - "default": true, - "title": "Use Gpu", - "type": "boolean" - } - }, - "title": "Parameters", - "type": "object" - }, - "type": { - "const": "TransformersDocumentClassifier", - "description": "Haystack Class name for the component.", - "title": "Type", - "type": "string" - } - }, - "required": [ - "type", - "name" - ], - "type": "object" - }, - "TransformersQueryClassifierComponent": { - "additionalProperties": false, - "properties": { - "name": { - "description": "Custom name for the component. Helpful for visualization and debugging.", - "title": "Name", - "type": "string" - }, - "params": { - "additionalProperties": false, - "description": "Each parameter can reference other components defined in the same YAML file.", - "properties": { - "batch_size": { - "default": 16, - "title": "Batch Size", - "type": "integer" - }, - "devices": { - "anyOf": [ - { - "items": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "string" - } - ] - }, - "type": "array" - }, - { - "type": "null" - } - ], - "title": "Devices" - }, - "labels": { - "default": [ - "LABEL_1", - "LABEL_0" - ], - "items": { - "type": "string" - }, - "title": "Labels", - "type": "array" - }, - "model_name_or_path": { - "anyOf": [ - { - "format": "path", - "type": "string" - }, - { - "type": "string" - } - ], - "default": "shahrukhx01/bert-mini-finetune-question-detection", - "title": "Model Name Or Path" - }, - "model_version": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Model Version" - }, - "progress_bar": { - "default": true, - "title": "Progress Bar", - "type": "boolean" - }, - "task": { - "default": "text-classification", - "title": "Task", - "type": "string" - }, - "tokenizer": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Tokenizer" - }, - "use_auth_token": { - "anyOf": [ - { - "type": "boolean" - }, - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Use Auth Token" - }, - "use_gpu": { - "default": true, - "title": "Use Gpu", - "type": "boolean" - } - }, - "title": "Parameters", - "type": "object" - }, - "type": { - "const": "TransformersQueryClassifier", - "description": "Haystack Class name for the component.", - "title": "Type", - "type": "string" - } - }, - "required": [ - "type", - "name" - ], - "type": "object" - }, - "TransformersReaderComponent": { - "additionalProperties": false, - "properties": { - "name": { - "description": "Custom name for the component. Helpful for visualization and debugging.", - "title": "Name", - "type": "string" - }, - "params": { - "additionalProperties": false, - "description": "Each parameter can reference other components defined in the same YAML file.", - "properties": { - "batch_size": { - "default": 16, - "title": "Batch Size", - "type": "integer" - }, - "context_window_size": { - "default": 70, - "title": "Context Window Size", - "type": "integer" - }, - "devices": { - "anyOf": [ - { - "items": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "string" - } - ] - }, - "type": "array" - }, - { - "type": "null" - } - ], - "title": "Devices" - }, - "doc_stride": { - "default": 128, - "title": "Doc Stride", - "type": "integer" - }, - "max_seq_len": { - "default": 256, - "title": "Max Seq Len", - "type": "integer" - }, - "model_name_or_path": { - "default": "distilbert-base-uncased-distilled-squad", - "title": "Model Name Or Path", - "type": "string" - }, - "model_version": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Model Version" - }, - "return_no_answers": { - "default": false, - "title": "Return No Answers", - "type": "boolean" - }, - "tokenizer": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Tokenizer" - }, - "top_k": { - "default": 10, - "title": "Top K", - "type": "integer" - }, - "top_k_per_candidate": { - "default": 3, - "title": "Top K Per Candidate", - "type": "integer" - }, - "use_auth_token": { - "anyOf": [ - { - "type": "boolean" - }, - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Use Auth Token" - }, - "use_gpu": { - "default": true, - "title": "Use Gpu", - "type": "boolean" - } - }, - "title": "Parameters", - "type": "object" - }, - "type": { - "const": "TransformersReader", - "description": "Haystack Class name for the component.", - "title": "Type", - "type": "string" - } - }, - "required": [ - "type", - "name" - ], - "type": "object" - }, - "TransformersSummarizerComponent": { - "additionalProperties": false, - "properties": { - "name": { - "description": "Custom name for the component. Helpful for visualization and debugging.", - "title": "Name", - "type": "string" - }, - "params": { - "additionalProperties": false, - "description": "Each parameter can reference other components defined in the same YAML file.", - "properties": { - "batch_size": { - "default": 16, - "title": "Batch Size", - "type": "integer" - }, - "clean_up_tokenization_spaces": { - "default": true, - "title": "Clean Up Tokenization Spaces", - "type": "boolean" - }, - "devices": { - "anyOf": [ - { - "items": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "string" - } - ] - }, - "type": "array" - }, - { - "type": "null" - } - ], - "title": "Devices" - }, - "generate_single_summary": { - "default": false, - "title": "Generate Single Summary", - "type": "boolean" - }, - "max_length": { - "default": 200, - "title": "Max Length", - "type": "integer" - }, - "min_length": { - "default": 5, - "title": "Min Length", - "type": "integer" - }, - "model_name_or_path": { - "default": "google/pegasus-xsum", - "title": "Model Name Or Path", - "type": "string" - }, - "model_version": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Model Version" - }, - "progress_bar": { - "default": true, - "title": "Progress Bar", - "type": "boolean" - }, - "separator_for_single_summary": { - "default": " ", - "title": "Separator For Single Summary", - "type": "string" - }, - "tokenizer": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Tokenizer" - }, - "use_auth_token": { - "anyOf": [ - { - "type": "boolean" - }, - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Use Auth Token" - }, - "use_gpu": { - "default": true, - "title": "Use Gpu", - "type": "boolean" - } - }, - "title": "Parameters", - "type": "object" - }, - "type": { - "const": "TransformersSummarizer", - "description": "Haystack Class name for the component.", - "title": "Type", - "type": "string" - } - }, - "required": [ - "type", - "name" - ], - "type": "object" - }, - "TransformersTranslatorComponent": { - "additionalProperties": false, - "properties": { - "name": { - "description": "Custom name for the component. Helpful for visualization and debugging.", - "title": "Name", - "type": "string" - }, - "params": { - "additionalProperties": false, - "description": "Each parameter can reference other components defined in the same YAML file.", - "properties": { - "clean_up_tokenization_spaces": { - "anyOf": [ - { - "type": "boolean" - }, - { - "type": "null" - } - ], - "default": true, - "title": "Clean Up Tokenization Spaces" - }, - "devices": { - "anyOf": [ - { - "items": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "string" - } - ] - }, - "type": "array" - }, - { - "type": "null" - } - ], - "title": "Devices" - }, - "max_seq_len": { - "anyOf": [ - { - "type": "integer" - }, - { - "type": "null" - } - ], - "title": "Max Seq Len" - }, - "model_name_or_path": { - "title": "Model Name Or Path", - "type": "string" - }, - "progress_bar": { - "default": true, - "title": "Progress Bar", - "type": "boolean" - }, - "tokenizer_name": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Tokenizer Name" - }, - "use_auth_token": { - "anyOf": [ - { - "type": "boolean" - }, - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Use Auth Token" - }, - "use_gpu": { - "default": true, - "title": "Use Gpu", - "type": "boolean" - } - }, - "required": [ - "model_name_or_path" - ], - "title": "Parameters", - "type": "object" - }, - "type": { - "const": "TransformersTranslator", - "description": "Haystack Class name for the component.", - "title": "Type", - "type": "string" - } - }, - "required": [ - "type", - "name" - ], - "type": "object" - }, - "WeaviateDocumentStoreComponent": { - "additionalProperties": false, - "properties": { - "name": { - "description": "Custom name for the component. Helpful for visualization and debugging.", - "title": "Name", - "type": "string" - }, - "params": { - "additionalProperties": false, - "description": "Each parameter can reference other components defined in the same YAML file.", - "properties": { - "content_field": { - "default": "content", - "title": "Content Field", - "type": "string" - }, - "custom_schema": { - "anyOf": [ - { - "type": "object" - }, - { - "type": "null" - } - ], - "title": "Custom Schema" - }, - "duplicate_documents": { - "default": "overwrite", - "title": "Duplicate Documents", - "type": "string" - }, - "embedding_dim": { - "default": 768, - "title": "Embedding Dim", - "type": "integer" - }, - "embedding_field": { - "default": "embedding", - "title": "Embedding Field", - "type": "string" - }, - "host": { - "anyOf": [ - { - "type": "string" - }, - { - "items": { - "type": "string" - }, - "type": "array" - } - ], - "default": "http://localhost", - "title": "Host" - }, - "index": { - "default": "Document", - "title": "Index", - "type": "string" - }, - "index_type": { - "default": "hnsw", - "title": "Index Type", - "type": "string" - }, - "name_field": { - "default": "name", - "title": "Name Field", - "type": "string" - }, - "password": { - "title": "Password", - "type": "string" - }, - "port": { - "anyOf": [ - { - "type": "integer" - }, - { - "items": { - "type": "integer" - }, - "type": "array" - } - ], - "default": 8080, - "title": "Port" - }, - "progress_bar": { - "default": true, - "title": "Progress Bar", - "type": "boolean" - }, - "recreate_index": { - "default": false, - "title": "Recreate Index", - "type": "boolean" - }, - "return_embedding": { - "default": false, - "title": "Return Embedding", - "type": "boolean" - }, - "similarity": { - "default": "cosine", - "title": "Similarity", - "type": "string" - }, - "timeout_config": { - "default": [ - 5, - 15 - ], - "items": {}, - "title": "Timeout Config", - "type": "array" - }, - "username": { - "title": "Username", - "type": "string" - } - }, - "title": "Parameters", - "type": "object" - }, - "type": { - "const": "WeaviateDocumentStore", - "description": "Haystack Class name for the component.", - "title": "Type", - "type": "string" - } - }, - "required": [ - "type", - "name" - ], - "type": "object" - } - }, - "description": "Haystack Pipeline YAML file describing the nodes of the pipelines. For more info read the docs at: https://haystack.deepset.ai/components/pipelines#yaml-file-definitions", - "oneOf": [ - { - "not": { - "required": [ - "extras" - ] - }, - "properties": { - "pipelines": { - "items": { - "properties": { - "nodes": { - "items": { - "not": { - "required": [ - "serve_deployment_kwargs" - ] - } - } - } - } - }, - "title": "Pipelines" - } - } - }, - { - "properties": { - "extras": { - "enum": [ - "ray" - ] - } - }, - "required": [ - "extras" - ] - } - ], - "properties": { - "components": { - "additionalProperties": true, - "description": "Component nodes and their configurations, to later be used in the pipelines section. Define here all the building blocks for the pipelines.", - "items": { - "anyOf": [ - { - "$ref": "#/definitions/DeepsetCloudDocumentStoreComponent" - }, - { - "$ref": "#/definitions/ElasticsearchDocumentStoreComponent" - }, - { - "$ref": "#/definitions/FAISSDocumentStoreComponent" - }, - { - "$ref": "#/definitions/GraphDBKnowledgeGraphComponent" - }, - { - "$ref": "#/definitions/InMemoryDocumentStoreComponent" - }, - { - "$ref": "#/definitions/InMemoryKnowledgeGraphComponent" - }, - { - "$ref": "#/definitions/Milvus2DocumentStoreComponent" - }, - { - "$ref": "#/definitions/OpenDistroElasticsearchDocumentStoreComponent" - }, - { - "$ref": "#/definitions/OpenSearchDocumentStoreComponent" - }, - { - "$ref": "#/definitions/PineconeDocumentStoreComponent" - }, - { - "$ref": "#/definitions/SQLDocumentStoreComponent" - }, - { - "$ref": "#/definitions/WeaviateDocumentStoreComponent" - }, - { - "$ref": "#/definitions/AnswerToSpeechComponent" - }, - { - "$ref": "#/definitions/AzureConverterComponent" - }, - { - "$ref": "#/definitions/BM25RetrieverComponent" - }, - { - "$ref": "#/definitions/CrawlerComponent" - }, - { - "$ref": "#/definitions/DensePassageRetrieverComponent" - }, - { - "$ref": "#/definitions/Docs2AnswersComponent" - }, - { - "$ref": "#/definitions/DocumentToSpeechComponent" - }, - { - "$ref": "#/definitions/DocxToTextConverterComponent" - }, - { - "$ref": "#/definitions/ElasticsearchFilterOnlyRetrieverComponent" - }, - { - "$ref": "#/definitions/ElasticsearchRetrieverComponent" - }, - { - "$ref": "#/definitions/EmbeddingRetrieverComponent" - }, - { - "$ref": "#/definitions/EntityExtractorComponent" - }, - { - "$ref": "#/definitions/EvalAnswersComponent" - }, - { - "$ref": "#/definitions/EvalDocumentsComponent" - }, - { - "$ref": "#/definitions/FARMReaderComponent" - }, - { - "$ref": "#/definitions/FileTypeClassifierComponent" - }, - { - "$ref": "#/definitions/FilterRetrieverComponent" - }, - { - "$ref": "#/definitions/ImageToTextConverterComponent" - }, - { - "$ref": "#/definitions/JoinAnswersComponent" - }, - { - "$ref": "#/definitions/JoinDocumentsComponent" - }, - { - "$ref": "#/definitions/MarkdownConverterComponent" - }, - { - "$ref": "#/definitions/MultiModalRetrieverComponent" - }, - { - "$ref": "#/definitions/MultihopEmbeddingRetrieverComponent" - }, - { - "$ref": "#/definitions/OpenAIAnswerGeneratorComponent" - }, - { - "$ref": "#/definitions/PDFToTextConverterComponent" - }, - { - "$ref": "#/definitions/PDFToTextOCRConverterComponent" - }, - { - "$ref": "#/definitions/ParsrConverterComponent" - }, - { - "$ref": "#/definitions/PreProcessorComponent" - }, - { - "$ref": "#/definitions/PseudoLabelGeneratorComponent" - }, - { - "$ref": "#/definitions/QuestionGeneratorComponent" - }, - { - "$ref": "#/definitions/RAGeneratorComponent" - }, - { - "$ref": "#/definitions/RCIReaderComponent" - }, - { - "$ref": "#/definitions/RouteDocumentsComponent" - }, - { - "$ref": "#/definitions/SentenceTransformersRankerComponent" - }, - { - "$ref": "#/definitions/Seq2SeqGeneratorComponent" - }, - { - "$ref": "#/definitions/SklearnQueryClassifierComponent" - }, - { - "$ref": "#/definitions/TableReaderComponent" - }, - { - "$ref": "#/definitions/TableTextRetrieverComponent" - }, - { - "$ref": "#/definitions/Text2SparqlRetrieverComponent" - }, - { - "$ref": "#/definitions/TextConverterComponent" - }, - { - "$ref": "#/definitions/TfidfRetrieverComponent" - }, - { - "$ref": "#/definitions/TikaConverterComponent" - }, - { - "$ref": "#/definitions/TransformersDocumentClassifierComponent" - }, - { - "$ref": "#/definitions/TransformersQueryClassifierComponent" - }, - { - "$ref": "#/definitions/TransformersReaderComponent" - }, - { - "$ref": "#/definitions/TransformersSummarizerComponent" - }, - { - "$ref": "#/definitions/TransformersTranslatorComponent" - } - ] - }, - "required": [ - "type", - "name" - ], - "title": "Components", - "type": "array" - }, - "extras": { - "description": "To be specified only if contains special pipelines (for example, if this is a Ray pipeline)", - "enum": [ - "ray" - ], - "title": "Additional properties group", - "type": "string" - }, - "pipelines": { - "description": "Multiple pipelines can be defined using the components from the same YAML file.", - "items": { - "additionalProperties": false, - "properties": { - "additionalProperties": false, - "name": { - "description": "Name of the pipeline.", - "title": "Name", - "type": "string" - }, - "nodes": { - "additionalProperties": false, - "description": "Nodes to be used by this particular pipeline", - "items": { - "additionalProperties": false, - "properties": { - "inputs": { - "description": "Input parameters for this node.", - "items": { - "type": "string" - }, - "title": "Inputs", - "type": "array" - }, - "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.", - "title": "Name", - "type": "string" - }, - "serve_deployment_kwargs": { - "additionalProperties": true, - "description": "Arguments to be passed to the Ray Serve `deployment()` method (only for Ray pipelines)", - "properties": { - "init_args": { - "type": "array" - }, - "init_kwargs": { - "type": "object" - }, - "max_concurrent_queries": { - "type": "integer" - }, - "num_replicas": { - "description": "How many replicas Ray should create for this node (only for Ray pipelines)", - "type": "integer" - }, - "prev_version": { - "type": "string" - }, - "ray_actor_options": { - "type": "object" - }, - "router_prefix": { - "type": "string" - }, - "user_config": { - "type": {} - }, - "version": { - "type": "string" - } - }, - "title": "serve_deployment_kwargs", - "type": "object" - } - }, - "required": [ - "name", - "inputs" - ], - "type": "object" - }, - "required": [ - "name", - "nodes" - ], - "title": "Nodes", - "type": "array" - } - }, - "type": "object" - }, - "title": "Pipelines", - "type": "array" - }, - "version": { - "const": "1.10.0", - "description": "Version of the Haystack Pipeline file.", - "title": "Version", - "type": "string" - } - }, - "required": [ - "version", - "components", - "pipelines" - ], - "title": "Haystack Pipeline", - "type": "object" - } \ No newline at end of file diff --git a/haystack/json-schemas/haystack-pipeline-1.11.0rc0.schema.json b/haystack/json-schemas/haystack-pipeline-1.11.0rc0.schema.json new file mode 100644 index 000000000..94f911b1e --- /dev/null +++ b/haystack/json-schemas/haystack-pipeline-1.11.0rc0.schema.json @@ -0,0 +1,6717 @@ +{ + "$schema": "http://json-schema.org/draft-07/schema", + "$id": "https://raw.githubusercontent.com/deepset-ai/haystack-json-schema/main/json-schema/haystack-pipeline-1.11.0rc0.schema.json", + "title": "Haystack Pipeline", + "description": "Haystack Pipeline YAML file describing the nodes of the pipelines. For more info read the docs at: https://haystack.deepset.ai/components/pipelines#yaml-file-definitions", + "type": "object", + "properties": { + "version": { + "title": "Version", + "description": "Version of the Haystack Pipeline file.", + "type": "string", + "const": "1.11.0rc0" + }, + "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": "#/definitions/DeepsetCloudDocumentStoreComponent" + }, + { + "$ref": "#/definitions/ElasticsearchDocumentStoreComponent" + }, + { + "$ref": "#/definitions/FAISSDocumentStoreComponent" + }, + { + "$ref": "#/definitions/GraphDBKnowledgeGraphComponent" + }, + { + "$ref": "#/definitions/InMemoryDocumentStoreComponent" + }, + { + "$ref": "#/definitions/InMemoryKnowledgeGraphComponent" + }, + { + "$ref": "#/definitions/Milvus2DocumentStoreComponent" + }, + { + "$ref": "#/definitions/OpenDistroElasticsearchDocumentStoreComponent" + }, + { + "$ref": "#/definitions/OpenSearchDocumentStoreComponent" + }, + { + "$ref": "#/definitions/PineconeDocumentStoreComponent" + }, + { + "$ref": "#/definitions/SQLDocumentStoreComponent" + }, + { + "$ref": "#/definitions/WeaviateDocumentStoreComponent" + }, + { + "$ref": "#/definitions/AnswerToSpeechComponent" + }, + { + "$ref": "#/definitions/AzureConverterComponent" + }, + { + "$ref": "#/definitions/BM25RetrieverComponent" + }, + { + "$ref": "#/definitions/CrawlerComponent" + }, + { + "$ref": "#/definitions/DensePassageRetrieverComponent" + }, + { + "$ref": "#/definitions/Docs2AnswersComponent" + }, + { + "$ref": "#/definitions/DocumentToSpeechComponent" + }, + { + "$ref": "#/definitions/DocxToTextConverterComponent" + }, + { + "$ref": "#/definitions/ElasticsearchFilterOnlyRetrieverComponent" + }, + { + "$ref": "#/definitions/ElasticsearchRetrieverComponent" + }, + { + "$ref": "#/definitions/EmbeddingRetrieverComponent" + }, + { + "$ref": "#/definitions/EntityExtractorComponent" + }, + { + "$ref": "#/definitions/EvalAnswersComponent" + }, + { + "$ref": "#/definitions/EvalDocumentsComponent" + }, + { + "$ref": "#/definitions/FARMReaderComponent" + }, + { + "$ref": "#/definitions/FileTypeClassifierComponent" + }, + { + "$ref": "#/definitions/FilterRetrieverComponent" + }, + { + "$ref": "#/definitions/ImageToTextConverterComponent" + }, + { + "$ref": "#/definitions/JoinAnswersComponent" + }, + { + "$ref": "#/definitions/JoinDocumentsComponent" + }, + { + "$ref": "#/definitions/MarkdownConverterComponent" + }, + { + "$ref": "#/definitions/MultiModalRetrieverComponent" + }, + { + "$ref": "#/definitions/MultihopEmbeddingRetrieverComponent" + }, + { + "$ref": "#/definitions/OpenAIAnswerGeneratorComponent" + }, + { + "$ref": "#/definitions/PDFToTextConverterComponent" + }, + { + "$ref": "#/definitions/PDFToTextOCRConverterComponent" + }, + { + "$ref": "#/definitions/ParsrConverterComponent" + }, + { + "$ref": "#/definitions/PreProcessorComponent" + }, + { + "$ref": "#/definitions/PseudoLabelGeneratorComponent" + }, + { + "$ref": "#/definitions/QuestionGeneratorComponent" + }, + { + "$ref": "#/definitions/RAGeneratorComponent" + }, + { + "$ref": "#/definitions/RCIReaderComponent" + }, + { + "$ref": "#/definitions/RouteDocumentsComponent" + }, + { + "$ref": "#/definitions/SentenceTransformersRankerComponent" + }, + { + "$ref": "#/definitions/Seq2SeqGeneratorComponent" + }, + { + "$ref": "#/definitions/SklearnQueryClassifierComponent" + }, + { + "$ref": "#/definitions/TableReaderComponent" + }, + { + "$ref": "#/definitions/TableTextRetrieverComponent" + }, + { + "$ref": "#/definitions/Text2SparqlRetrieverComponent" + }, + { + "$ref": "#/definitions/TextConverterComponent" + }, + { + "$ref": "#/definitions/TfidfRetrieverComponent" + }, + { + "$ref": "#/definitions/TikaConverterComponent" + }, + { + "$ref": "#/definitions/TransformersDocumentClassifierComponent" + }, + { + "$ref": "#/definitions/TransformersQueryClassifierComponent" + }, + { + "$ref": "#/definitions/TransformersReaderComponent" + }, + { + "$ref": "#/definitions/TransformersSummarizerComponent" + }, + { + "$ref": "#/definitions/TransformersTranslatorComponent" + } + ] + }, + "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": { + "type": {} + }, + "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" + ] + } + } + } + } + } + } + } + }, + { + "properties": { + "extras": { + "enum": [ + "ray" + ] + } + }, + "required": [ + "extras" + ] + } + ], + "definitions": { + "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", + "type": "string" + }, + "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" + } + }, + "additionalProperties": false, + "description": "Each parameter can reference other components defined in the same YAML file." + } + }, + "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": 30, + "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" + } + }, + "additionalProperties": false, + "description": "Each parameter can reference other components defined in the same YAML file." + } + }, + "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", + "type": "integer" + }, + "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", + "default": null, + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] + }, + "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" + } + ] + }, + "faiss_config_path": { + "title": "Faiss Config Path", + "anyOf": [ + { + "type": "string" + }, + { + "type": "string", + "format": "path" + } + ] + }, + "isolation_level": { + "title": "Isolation Level", + "type": "string" + }, + "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" + } + }, + "additionalProperties": false, + "description": "Each parameter can reference other components defined in the same YAML file." + } + }, + "required": [ + "type", + "name" + ], + "additionalProperties": false + }, + "GraphDBKnowledgeGraphComponent": { + "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": "GraphDBKnowledgeGraph" + }, + "params": { + "title": "Parameters", + "type": "object", + "properties": { + "host": { + "title": "Host", + "default": "localhost", + "type": "string" + }, + "port": { + "title": "Port", + "default": 7200, + "type": "integer" + }, + "username": { + "title": "Username", + "default": "", + "type": "string" + }, + "password": { + "title": "Password", + "default": "", + "type": "string" + }, + "index": { + "title": "Index", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] + }, + "prefixes": { + "title": "Prefixes", + "default": "", + "type": "string" + } + }, + "additionalProperties": false, + "description": "Each parameter can reference other components defined in the same YAML file." + } + }, + "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": "string" + } + ] + } + }, + { + "type": "null" + } + ] + } + }, + "additionalProperties": false, + "description": "Each parameter can reference other components defined in the same YAML file." + } + }, + "required": [ + "type", + "name" + ], + "additionalProperties": false + }, + "InMemoryKnowledgeGraphComponent": { + "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": "InMemoryKnowledgeGraph" + }, + "params": { + "title": "Parameters", + "type": "object", + "properties": { + "index": { + "title": "Index", + "default": "document", + "type": "string" + } + }, + "additionalProperties": false, + "description": "Each parameter can reference other components defined in the same YAML file." + } + }, + "required": [ + "type", + "name" + ], + "additionalProperties": false + }, + "Milvus2DocumentStoreComponent": { + "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": "Milvus2DocumentStore" + }, + "params": { + "title": "Parameters", + "type": "object", + "properties": { + "sql_url": { + "title": "Sql Url", + "default": "sqlite:///", + "type": "string" + }, + "host": { + "title": "Host", + "default": "localhost", + "type": "string" + }, + "port": { + "title": "Port", + "default": "19530", + "type": "string" + }, + "connection_pool": { + "title": "Connection Pool", + "default": "SingletonThread", + "type": "string" + }, + "index": { + "title": "Index", + "default": "document", + "type": "string" + }, + "vector_dim": { + "title": "Vector Dim", + "type": "integer" + }, + "embedding_dim": { + "title": "Embedding Dim", + "default": 768, + "type": "integer" + }, + "index_file_size": { + "title": "Index File Size", + "default": 1024, + "type": "integer" + }, + "similarity": { + "title": "Similarity", + "default": "dot_product", + "type": "string" + }, + "index_type": { + "title": "Index Type", + "default": "IVF_FLAT", + "type": "string" + }, + "index_param": { + "title": "Index Param", + "anyOf": [ + { + "type": "object" + }, + { + "type": "null" + } + ] + }, + "search_param": { + "title": "Search Param", + "anyOf": [ + { + "type": "object" + }, + { + "type": "null" + } + ] + }, + "return_embedding": { + "title": "Return Embedding", + "default": false, + "type": "boolean" + }, + "embedding_field": { + "title": "Embedding Field", + "default": "embedding", + "type": "string" + }, + "id_field": { + "title": "Id Field", + "default": "id", + "type": "string" + }, + "custom_fields": { + "title": "Custom Fields", + "anyOf": [ + { + "type": "array", + "items": {} + }, + { + "type": "null" + } + ] + }, + "progress_bar": { + "title": "Progress Bar", + "default": true, + "type": "boolean" + }, + "duplicate_documents": { + "title": "Duplicate Documents", + "default": "overwrite", + "type": "string" + }, + "isolation_level": { + "title": "Isolation Level", + "type": "string" + }, + "consistency_level": { + "title": "Consistency Level", + "default": 0, + "type": "integer" + }, + "recreate_index": { + "title": "Recreate Index", + "default": false, + "type": "boolean" + } + }, + "additionalProperties": false, + "description": "Each parameter can reference other components defined in the same YAML file." + } + }, + "required": [ + "type", + "name" + ], + "additionalProperties": false + }, + "OpenDistroElasticsearchDocumentStoreComponent": { + "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": "OpenDistroElasticsearchDocumentStore" + }, + "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": "cosine", + "type": "string" + }, + "timeout": { + "title": "Timeout", + "default": 30, + "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" + } + }, + "additionalProperties": false, + "description": "Each parameter can reference other components defined in the same YAML file." + } + }, + "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": 30, + "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" + } + }, + "additionalProperties": false, + "description": "Each parameter can reference other components defined in the same YAML file." + } + }, + "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", + "default": null, + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] + }, + "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", + "default": { + "indexed": [] + }, + "type": "object" + }, + "validate_index_sync": { + "title": "Validate Index Sync", + "default": true, + "type": "boolean" + } + }, + "required": [ + "api_key" + ], + "additionalProperties": false, + "description": "Each parameter can reference other components defined in the same YAML file." + } + }, + "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", + "type": "string" + } + }, + "additionalProperties": false, + "description": "Each parameter can reference other components defined in the same YAML file." + } + }, + "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", + "type": "string" + }, + "password": { + "title": "Password", + "type": "string" + }, + "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" + } + }, + "additionalProperties": false, + "description": "Each parameter can reference other components defined in the same YAML file." + } + }, + "required": [ + "type", + "name" + ], + "additionalProperties": false + }, + "AnswerToSpeechComponent": { + "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": "AnswerToSpeech" + }, + "params": { + "title": "Parameters", + "type": "object", + "properties": { + "model_name_or_path": { + "title": "Model Name Or Path", + "default": "espnet/kan-bayashi_ljspeech_vits", + "anyOf": [ + { + "type": "string" + }, + { + "type": "string", + "format": "path" + } + ] + }, + "generated_audio_dir": { + "title": "Generated Audio Dir", + "default": "generated_audio_answers", + "type": "string", + "format": "path" + }, + "audio_params": { + "title": "Audio Params", + "anyOf": [ + { + "type": "object" + }, + { + "type": "null" + } + ] + }, + "transformers_params": { + "title": "Transformers Params", + "anyOf": [ + { + "type": "object" + }, + { + "type": "null" + } + ] + }, + "progress_bar": { + "title": "Progress Bar", + "default": true, + "type": "boolean" + }, + "devices": { + "title": "Devices", + "anyOf": [ + { + "type": "array", + "items": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "string" + } + ] + } + }, + { + "type": "null" + } + ] + } + }, + "additionalProperties": false, + "description": "Each parameter can reference other components defined in the same YAML file." + } + }, + "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" + ], + "additionalProperties": false, + "description": "Each parameter can reference other components defined in the same YAML file." + } + }, + "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" + } + }, + "additionalProperties": false, + "description": "Each parameter can reference other components defined in the same YAML file." + } + }, + "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": { + "output_dir": { + "title": "Output Dir", + "type": "string" + }, + "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" + } + ] + }, + "overwrite_existing_files": { + "title": "Overwrite Existing Files", + "default": true + }, + "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" + } + ] + }, + "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" + } + ] + } + }, + "required": [ + "output_dir" + ], + "additionalProperties": false, + "description": "Each parameter can reference other components defined in the same YAML file." + } + }, + "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": "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" + } + }, + "additionalProperties": false, + "description": "Each parameter can reference other components defined in the same YAML file." + } + }, + "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" + } + }, + "additionalProperties": false, + "description": "Each parameter can reference other components defined in the same YAML file." + } + }, + "required": [ + "type", + "name" + ], + "additionalProperties": false + }, + "DocumentToSpeechComponent": { + "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": "DocumentToSpeech" + }, + "params": { + "title": "Parameters", + "type": "object", + "properties": { + "model_name_or_path": { + "title": "Model Name Or Path", + "default": "espnet/kan-bayashi_ljspeech_vits", + "anyOf": [ + { + "type": "string" + }, + { + "type": "string", + "format": "path" + } + ] + }, + "generated_audio_dir": { + "title": "Generated Audio Dir", + "default": "generated_audio_documents", + "type": "string", + "format": "path" + }, + "audio_params": { + "title": "Audio Params", + "anyOf": [ + { + "type": "object" + }, + { + "type": "null" + } + ] + }, + "transformers_params": { + "title": "Transformers Params", + "anyOf": [ + { + "type": "object" + }, + { + "type": "null" + } + ] + } + }, + "additionalProperties": false, + "description": "Each parameter can reference other components defined in the same YAML file." + } + }, + "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" + } + }, + "additionalProperties": false, + "description": "Each parameter can reference other components defined in the same YAML file." + } + }, + "required": [ + "type", + "name" + ], + "additionalProperties": false + }, + "ElasticsearchFilterOnlyRetrieverComponent": { + "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": "ElasticsearchFilterOnlyRetriever" + }, + "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" + } + ] + } + }, + "additionalProperties": false, + "description": "Each parameter can reference other components defined in the same YAML file." + } + }, + "required": [ + "type", + "name" + ], + "additionalProperties": false + }, + "ElasticsearchRetrieverComponent": { + "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": "ElasticsearchRetriever" + }, + "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" + } + ] + } + }, + "additionalProperties": false, + "description": "Each parameter can reference other components defined in the same YAML file." + } + }, + "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": "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", + "default": [], + "type": "array", + "items": { + "type": "string" + } + }, + "api_key": { + "title": "Api Key", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] + } + }, + "required": [ + "embedding_model" + ], + "additionalProperties": false, + "description": "Each parameter can reference other components defined in the same YAML file." + } + }, + "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": "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", + "type": "integer" + }, + "pre_split_text": { + "title": "Pre Split Text", + "default": false, + "type": "boolean" + }, + "ignore_labels": { + "title": "Ignore Labels", + "anyOf": [ + { + "type": "array", + "items": { + "type": "string" + } + }, + { + "type": "null" + } + ] + } + }, + "additionalProperties": false, + "description": "Each parameter can reference other components defined in the same YAML file." + } + }, + "required": [ + "type", + "name" + ], + "additionalProperties": false + }, + "EvalAnswersComponent": { + "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": "EvalAnswers" + }, + "params": { + "title": "Parameters", + "type": "object", + "properties": { + "skip_incorrect_retrieval": { + "title": "Skip Incorrect Retrieval", + "default": true, + "type": "boolean" + }, + "open_domain": { + "title": "Open Domain", + "default": true, + "type": "boolean" + }, + "sas_model": { + "title": "Sas Model", + "type": "string" + }, + "debug": { + "title": "Debug", + "default": false, + "type": "boolean" + } + }, + "additionalProperties": false, + "description": "Each parameter can reference other components defined in the same YAML file." + } + }, + "required": [ + "type", + "name" + ], + "additionalProperties": false + }, + "EvalDocumentsComponent": { + "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": "EvalDocuments" + }, + "params": { + "title": "Parameters", + "type": "object", + "properties": { + "debug": { + "title": "Debug", + "default": false, + "type": "boolean" + }, + "open_domain": { + "title": "Open Domain", + "default": true, + "type": "boolean" + }, + "top_k": { + "title": "Top K", + "default": 10, + "type": "integer" + } + }, + "additionalProperties": false, + "description": "Each parameter can reference other components defined in the same YAML file." + } + }, + "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": "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", + "additionalProperties": { + "type": "string" + }, + "anyOf": [ + { + "type": "object" + }, + { + "type": "null" + } + ] + }, + "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" + } + ] + } + }, + "required": [ + "model_name_or_path" + ], + "additionalProperties": false, + "description": "Each parameter can reference other components defined in the same YAML file." + } + }, + "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", + "default": [ + "txt", + "pdf", + "md", + "docx", + "html" + ], + "type": "array", + "items": { + "type": "string" + } + } + }, + "additionalProperties": false, + "description": "Each parameter can reference other components defined in the same YAML file." + } + }, + "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" + } + }, + "additionalProperties": false, + "description": "Each parameter can reference other components defined in the same YAML file." + } + }, + "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", + "default": [ + "eng" + ], + "anyOf": [ + { + "type": "array", + "items": { + "type": "string" + } + }, + { + "type": "null" + } + ] + }, + "id_hash_keys": { + "title": "Id Hash Keys", + "anyOf": [ + { + "type": "array", + "items": { + "type": "string" + } + }, + { + "type": "null" + } + ] + } + }, + "additionalProperties": false, + "description": "Each parameter can reference other components defined in the same YAML file." + } + }, + "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" + } + }, + "additionalProperties": false, + "description": "Each parameter can reference other components defined in the same YAML file." + } + }, + "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" + } + }, + "additionalProperties": false, + "description": "Each parameter can reference other components defined in the same YAML file." + } + }, + "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" + } + }, + "additionalProperties": false, + "description": "Each parameter can reference other components defined in the same YAML file." + } + }, + "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", + "default": { + "max_length": 64 + }, + "type": "object" + }, + "document_feature_extractors_params": { + "title": "Document Feature Extractors Params", + "default": { + "text": { + "max_length": 256 + } + }, + "type": "object", + "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", + "default": [ + "name" + ], + "type": "array", + "items": { + "type": "string" + } + }, + "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": "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" + ], + "additionalProperties": false, + "description": "Each parameter can reference other components defined in the same YAML file." + } + }, + "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": "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", + "default": [], + "type": "array", + "items": { + "type": "string" + } + } + }, + "required": [ + "embedding_model" + ], + "additionalProperties": false, + "description": "Each parameter can reference other components defined in the same YAML file." + } + }, + "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" + }, + "model": { + "title": "Model", + "default": "text-curie-001", + "type": "string" + }, + "max_tokens": { + "title": "Max Tokens", + "default": 13, + "type": "integer" + }, + "top_k": { + "title": "Top K", + "default": 5, + "type": "integer" + }, + "temperature": { + "title": "Temperature", + "default": 0.2, + "type": "number" + }, + "presence_penalty": { + "title": "Presence Penalty", + "default": -2.0, + "type": "number" + }, + "frequency_penalty": { + "title": "Frequency Penalty", + "default": -2.0, + "type": "number" + }, + "examples_context": { + "title": "Examples Context", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] + }, + "examples": { + "title": "Examples", + "anyOf": [ + { + "type": "array", + "items": {} + }, + { + "type": "null" + } + ] + }, + "stop_words": { + "title": "Stop Words", + "anyOf": [ + { + "type": "array", + "items": {} + }, + { + "type": "null" + } + ] + }, + "progress_bar": { + "title": "Progress Bar", + "default": true, + "type": "boolean" + } + }, + "required": [ + "api_key" + ], + "additionalProperties": false, + "description": "Each parameter can reference other components defined in the same YAML file." + } + }, + "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" + } + }, + "additionalProperties": false, + "description": "Each parameter can reference other components defined in the same YAML file." + } + }, + "required": [ + "type", + "name" + ], + "additionalProperties": false + }, + "PDFToTextOCRConverterComponent": { + "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": "PDFToTextOCRConverter" + }, + "params": { + "title": "Parameters", + "type": "object", + "properties": { + "remove_numeric_tables": { + "title": "Remove Numeric Tables", + "default": false, + "type": "boolean" + }, + "valid_languages": { + "title": "Valid Languages", + "default": [ + "eng" + ], + "anyOf": [ + { + "type": "array", + "items": { + "type": "string" + } + }, + { + "type": "null" + } + ] + }, + "id_hash_keys": { + "title": "Id Hash Keys", + "anyOf": [ + { + "type": "array", + "items": { + "type": "string" + } + }, + { + "type": "null" + } + ] + } + }, + "additionalProperties": false, + "description": "Each parameter can reference other components defined in the same YAML file." + } + }, + "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" + } + }, + "additionalProperties": false, + "description": "Each parameter can reference other components defined in the same YAML file." + } + }, + "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", + "default": [], + "type": "array", + "items": { + "type": "string" + } + }, + "split_by": { + "title": "Split By", + "default": "word", + "enum": [ + "word", + "sentence", + "passage" + ], + "type": "string" + }, + "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" + } + }, + "additionalProperties": false, + "description": "Each parameter can reference other components defined in the same YAML file." + } + }, + "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", + "type": "string" + }, + "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": "string" + } + ] + } + }, + { + "type": "null" + } + ] + } + }, + "required": [ + "question_producer", + "retriever" + ], + "additionalProperties": false, + "description": "Each parameter can reference other components defined in the same YAML file." + } + }, + "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": "string" + } + ] + } + }, + { + "type": "null" + } + ] + } + }, + "additionalProperties": false, + "description": "Each parameter can reference other components defined in the same YAML file." + } + }, + "required": [ + "type", + "name" + ], + "additionalProperties": false + }, + "RAGeneratorComponent": { + "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": "RAGenerator" + }, + "params": { + "title": "Parameters", + "type": "object", + "properties": { + "model_name_or_path": { + "title": "Model Name Or Path", + "default": "facebook/rag-token-nq", + "type": "string" + }, + "model_version": { + "title": "Model Version", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] + }, + "retriever": { + "title": "Retriever", + "default": null, + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] + }, + "generator_type": { + "title": "Generator Type", + "default": "token", + "type": "string" + }, + "top_k": { + "title": "Top K", + "default": 2, + "type": "integer" + }, + "max_length": { + "title": "Max Length", + "default": 200, + "type": "integer" + }, + "min_length": { + "title": "Min Length", + "default": 2, + "type": "integer" + }, + "num_beams": { + "title": "Num Beams", + "default": 2, + "type": "integer" + }, + "embed_title": { + "title": "Embed Title", + "default": true, + "type": "boolean" + }, + "prefix": { + "title": "Prefix", + "anyOf": [ + { + "type": "string" + }, + { + "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": "string" + } + ] + } + }, + { + "type": "null" + } + ] + } + }, + "additionalProperties": false, + "description": "Each parameter can reference other components defined in the same YAML file." + } + }, + "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" + } + ] + } + }, + "additionalProperties": false, + "description": "Each parameter can reference other components defined in the same YAML file." + } + }, + "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": "null" + } + ] + } + }, + "additionalProperties": false, + "description": "Each parameter can reference other components defined in the same YAML file." + } + }, + "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": "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" + ], + "additionalProperties": false, + "description": "Each parameter can reference other components defined in the same YAML file." + } + }, + "required": [ + "type", + "name" + ], + "additionalProperties": false + }, + "Seq2SeqGeneratorComponent": { + "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": "Seq2SeqGenerator" + }, + "params": { + "title": "Parameters", + "type": "object", + "properties": { + "model_name_or_path": { + "title": "Model Name Or Path", + "type": "string" + }, + "input_converter": { + "title": "Input Converter", + "default": null, + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] + }, + "top_k": { + "title": "Top K", + "default": 1, + "type": "integer" + }, + "max_length": { + "title": "Max Length", + "default": 200, + "type": "integer" + }, + "min_length": { + "title": "Min Length", + "default": 2, + "type": "integer" + }, + "num_beams": { + "title": "Num Beams", + "default": 8, + "type": "integer" + }, + "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": "string" + } + ] + } + }, + { + "type": "null" + } + ] + } + }, + "required": [ + "model_name_or_path" + ], + "additionalProperties": false, + "description": "Each parameter can reference other components defined in the same YAML file." + } + }, + "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/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/vectorizer.pickle", + "anyOf": [ + { + "type": "string" + }, + {} + ] + }, + "batch_size": { + "title": "Batch Size", + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ] + }, + "progress_bar": { + "title": "Progress Bar", + "default": true, + "type": "boolean" + } + }, + "additionalProperties": false, + "description": "Each parameter can reference other components defined in the same YAML file." + } + }, + "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": "string" + } + ] + } + }, + { + "type": "null" + } + ] + } + }, + "additionalProperties": false, + "description": "Each parameter can reference other components defined in the same YAML file." + } + }, + "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", + "default": [ + "name", + "section_title", + "caption" + ], + "type": "array", + "items": { + "type": "string" + } + }, + "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": "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" + } + }, + "additionalProperties": false, + "description": "Each parameter can reference other components defined in the same YAML file." + } + }, + "required": [ + "type", + "name" + ], + "additionalProperties": false + }, + "Text2SparqlRetrieverComponent": { + "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": "Text2SparqlRetriever" + }, + "params": { + "title": "Parameters", + "type": "object", + "properties": { + "knowledge_graph": { + "title": "Knowledge Graph", + "type": "string" + }, + "model_name_or_path": { + "title": "Model Name Or Path", + "type": "string" + }, + "model_version": { + "title": "Model Version", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] + }, + "top_k": { + "title": "Top K", + "default": 1, + "type": "integer" + }, + "use_auth_token": { + "title": "Use Auth Token", + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "string" + }, + { + "type": "null" + } + ] + } + }, + "required": [ + "knowledge_graph" + ], + "additionalProperties": false, + "description": "Each parameter can reference other components defined in the same YAML file." + } + }, + "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" + } + }, + "additionalProperties": false, + "description": "Each parameter can reference other components defined in the same YAML file." + } + }, + "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 + } + }, + "additionalProperties": false, + "description": "Each parameter can reference other components defined in the same YAML file." + } + }, + "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" + } + ] + } + }, + "additionalProperties": false, + "description": "Each parameter can reference other components defined in the same YAML file." + } + }, + "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", + "type": "string" + }, + "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": "string" + } + ] + } + }, + { + "type": "null" + } + ] + } + }, + "additionalProperties": false, + "description": "Each parameter can reference other components defined in the same YAML file." + } + }, + "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", + "default": [ + "LABEL_1", + "LABEL_0" + ], + "type": "array", + "items": { + "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": "string" + } + ] + } + }, + { + "type": "null" + } + ] + } + }, + "additionalProperties": false, + "description": "Each parameter can reference other components defined in the same YAML file." + } + }, + "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": "string" + } + ] + } + }, + { + "type": "null" + } + ] + } + }, + "additionalProperties": false, + "description": "Each parameter can reference other components defined in the same YAML file." + } + }, + "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" + }, + "separator_for_single_summary": { + "title": "Separator For Single Summary", + "default": " ", + "type": "string" + }, + "generate_single_summary": { + "title": "Generate Single Summary", + "default": false, + "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": "string" + } + ] + } + }, + { + "type": "null" + } + ] + } + }, + "additionalProperties": false, + "description": "Each parameter can reference other components defined in the same YAML file." + } + }, + "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": "string" + } + ] + } + }, + { + "type": "null" + } + ] + } + }, + "required": [ + "model_name_or_path" + ], + "additionalProperties": false, + "description": "Each parameter can reference other components defined in the same YAML file." + } + }, + "required": [ + "type", + "name" + ], + "additionalProperties": false + } + } +} \ No newline at end of file diff --git a/haystack/json-schemas/haystack-pipeline-1.9.1.schema.json b/haystack/json-schemas/haystack-pipeline-1.9.1.schema.json deleted file mode 100644 index aefc96e5b..000000000 --- a/haystack/json-schemas/haystack-pipeline-1.9.1.schema.json +++ /dev/null @@ -1,6418 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema", - "$id": "https://raw.githubusercontent.com/deepset-ai/haystack/main/haystack/json-schemas/haystack-pipeline-1.9.1.schema.json", - "title": "Haystack Pipeline", - "description": "Haystack Pipeline YAML file describing the nodes of the pipelines. For more info read the docs at: https://haystack.deepset.ai/components/pipelines#yaml-file-definitions", - "type": "object", - "properties": { - "version": { - "title": "Version", - "description": "Version of the Haystack Pipeline file.", - "type": "string", - "const": "1.9.1" - }, - "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": "#/definitions/DeepsetCloudDocumentStoreComponent" - }, - { - "$ref": "#/definitions/ElasticsearchDocumentStoreComponent" - }, - { - "$ref": "#/definitions/FAISSDocumentStoreComponent" - }, - { - "$ref": "#/definitions/GraphDBKnowledgeGraphComponent" - }, - { - "$ref": "#/definitions/InMemoryDocumentStoreComponent" - }, - { - "$ref": "#/definitions/InMemoryKnowledgeGraphComponent" - }, - { - "$ref": "#/definitions/Milvus2DocumentStoreComponent" - }, - { - "$ref": "#/definitions/OpenDistroElasticsearchDocumentStoreComponent" - }, - { - "$ref": "#/definitions/OpenSearchDocumentStoreComponent" - }, - { - "$ref": "#/definitions/PineconeDocumentStoreComponent" - }, - { - "$ref": "#/definitions/SQLDocumentStoreComponent" - }, - { - "$ref": "#/definitions/WeaviateDocumentStoreComponent" - }, - { - "$ref": "#/definitions/AnswerToSpeechComponent" - }, - { - "$ref": "#/definitions/AzureConverterComponent" - }, - { - "$ref": "#/definitions/BM25RetrieverComponent" - }, - { - "$ref": "#/definitions/CrawlerComponent" - }, - { - "$ref": "#/definitions/DensePassageRetrieverComponent" - }, - { - "$ref": "#/definitions/Docs2AnswersComponent" - }, - { - "$ref": "#/definitions/DocumentToSpeechComponent" - }, - { - "$ref": "#/definitions/DocxToTextConverterComponent" - }, - { - "$ref": "#/definitions/ElasticsearchFilterOnlyRetrieverComponent" - }, - { - "$ref": "#/definitions/ElasticsearchRetrieverComponent" - }, - { - "$ref": "#/definitions/EmbeddingRetrieverComponent" - }, - { - "$ref": "#/definitions/EntityExtractorComponent" - }, - { - "$ref": "#/definitions/EvalAnswersComponent" - }, - { - "$ref": "#/definitions/EvalDocumentsComponent" - }, - { - "$ref": "#/definitions/FARMReaderComponent" - }, - { - "$ref": "#/definitions/FileTypeClassifierComponent" - }, - { - "$ref": "#/definitions/FilterRetrieverComponent" - }, - { - "$ref": "#/definitions/ImageToTextConverterComponent" - }, - { - "$ref": "#/definitions/JoinAnswersComponent" - }, - { - "$ref": "#/definitions/JoinDocumentsComponent" - }, - { - "$ref": "#/definitions/MarkdownConverterComponent" - }, - { - "$ref": "#/definitions/MultihopEmbeddingRetrieverComponent" - }, - { - "$ref": "#/definitions/OpenAIAnswerGeneratorComponent" - }, - { - "$ref": "#/definitions/PDFToTextConverterComponent" - }, - { - "$ref": "#/definitions/PDFToTextOCRConverterComponent" - }, - { - "$ref": "#/definitions/ParsrConverterComponent" - }, - { - "$ref": "#/definitions/PreProcessorComponent" - }, - { - "$ref": "#/definitions/PseudoLabelGeneratorComponent" - }, - { - "$ref": "#/definitions/QuestionGeneratorComponent" - }, - { - "$ref": "#/definitions/RAGeneratorComponent" - }, - { - "$ref": "#/definitions/RCIReaderComponent" - }, - { - "$ref": "#/definitions/RouteDocumentsComponent" - }, - { - "$ref": "#/definitions/SentenceTransformersRankerComponent" - }, - { - "$ref": "#/definitions/Seq2SeqGeneratorComponent" - }, - { - "$ref": "#/definitions/SklearnQueryClassifierComponent" - }, - { - "$ref": "#/definitions/TableReaderComponent" - }, - { - "$ref": "#/definitions/TableTextRetrieverComponent" - }, - { - "$ref": "#/definitions/Text2SparqlRetrieverComponent" - }, - { - "$ref": "#/definitions/TextConverterComponent" - }, - { - "$ref": "#/definitions/TfidfRetrieverComponent" - }, - { - "$ref": "#/definitions/TikaConverterComponent" - }, - { - "$ref": "#/definitions/TransformersDocumentClassifierComponent" - }, - { - "$ref": "#/definitions/TransformersQueryClassifierComponent" - }, - { - "$ref": "#/definitions/TransformersReaderComponent" - }, - { - "$ref": "#/definitions/TransformersSummarizerComponent" - }, - { - "$ref": "#/definitions/TransformersTranslatorComponent" - } - ] - }, - "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": { - "type": {} - }, - "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" - ] - } - } - } - } - } - } - } - }, - { - "properties": { - "extras": { - "enum": [ - "ray" - ] - } - }, - "required": [ - "extras" - ] - } - ], - "definitions": { - "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", - "type": "string" - }, - "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" - } - }, - "additionalProperties": false, - "description": "Each parameter can reference other components defined in the same YAML file." - } - }, - "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": 30, - "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" - } - }, - "additionalProperties": false, - "description": "Each parameter can reference other components defined in the same YAML file." - } - }, - "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", - "type": "integer" - }, - "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", - "default": null, - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] - }, - "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" - } - ] - }, - "faiss_config_path": { - "title": "Faiss Config Path", - "anyOf": [ - { - "type": "string" - }, - { - "type": "string", - "format": "path" - } - ] - }, - "isolation_level": { - "title": "Isolation Level", - "type": "string" - }, - "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" - } - }, - "additionalProperties": false, - "description": "Each parameter can reference other components defined in the same YAML file." - } - }, - "required": [ - "type", - "name" - ], - "additionalProperties": false - }, - "GraphDBKnowledgeGraphComponent": { - "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": "GraphDBKnowledgeGraph" - }, - "params": { - "title": "Parameters", - "type": "object", - "properties": { - "host": { - "title": "Host", - "default": "localhost", - "type": "string" - }, - "port": { - "title": "Port", - "default": 7200, - "type": "integer" - }, - "username": { - "title": "Username", - "default": "", - "type": "string" - }, - "password": { - "title": "Password", - "default": "", - "type": "string" - }, - "index": { - "title": "Index", - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] - }, - "prefixes": { - "title": "Prefixes", - "default": "", - "type": "string" - } - }, - "additionalProperties": false, - "description": "Each parameter can reference other components defined in the same YAML file." - } - }, - "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": "string" - } - ] - } - }, - { - "type": "null" - } - ] - } - }, - "additionalProperties": false, - "description": "Each parameter can reference other components defined in the same YAML file." - } - }, - "required": [ - "type", - "name" - ], - "additionalProperties": false - }, - "InMemoryKnowledgeGraphComponent": { - "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": "InMemoryKnowledgeGraph" - }, - "params": { - "title": "Parameters", - "type": "object", - "properties": { - "index": { - "title": "Index", - "default": "document", - "type": "string" - } - }, - "additionalProperties": false, - "description": "Each parameter can reference other components defined in the same YAML file." - } - }, - "required": [ - "type", - "name" - ], - "additionalProperties": false - }, - "Milvus2DocumentStoreComponent": { - "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": "Milvus2DocumentStore" - }, - "params": { - "title": "Parameters", - "type": "object", - "properties": { - "sql_url": { - "title": "Sql Url", - "default": "sqlite:///", - "type": "string" - }, - "host": { - "title": "Host", - "default": "localhost", - "type": "string" - }, - "port": { - "title": "Port", - "default": "19530", - "type": "string" - }, - "connection_pool": { - "title": "Connection Pool", - "default": "SingletonThread", - "type": "string" - }, - "index": { - "title": "Index", - "default": "document", - "type": "string" - }, - "vector_dim": { - "title": "Vector Dim", - "type": "integer" - }, - "embedding_dim": { - "title": "Embedding Dim", - "default": 768, - "type": "integer" - }, - "index_file_size": { - "title": "Index File Size", - "default": 1024, - "type": "integer" - }, - "similarity": { - "title": "Similarity", - "default": "dot_product", - "type": "string" - }, - "index_type": { - "title": "Index Type", - "default": "IVF_FLAT", - "type": "string" - }, - "index_param": { - "title": "Index Param", - "anyOf": [ - { - "type": "object" - }, - { - "type": "null" - } - ] - }, - "search_param": { - "title": "Search Param", - "anyOf": [ - { - "type": "object" - }, - { - "type": "null" - } - ] - }, - "return_embedding": { - "title": "Return Embedding", - "default": false, - "type": "boolean" - }, - "embedding_field": { - "title": "Embedding Field", - "default": "embedding", - "type": "string" - }, - "id_field": { - "title": "Id Field", - "default": "id", - "type": "string" - }, - "custom_fields": { - "title": "Custom Fields", - "anyOf": [ - { - "type": "array", - "items": {} - }, - { - "type": "null" - } - ] - }, - "progress_bar": { - "title": "Progress Bar", - "default": true, - "type": "boolean" - }, - "duplicate_documents": { - "title": "Duplicate Documents", - "default": "overwrite", - "type": "string" - }, - "isolation_level": { - "title": "Isolation Level", - "type": "string" - }, - "consistency_level": { - "title": "Consistency Level", - "default": 0, - "type": "integer" - }, - "recreate_index": { - "title": "Recreate Index", - "default": false, - "type": "boolean" - } - }, - "additionalProperties": false, - "description": "Each parameter can reference other components defined in the same YAML file." - } - }, - "required": [ - "type", - "name" - ], - "additionalProperties": false - }, - "OpenDistroElasticsearchDocumentStoreComponent": { - "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": "OpenDistroElasticsearchDocumentStore" - }, - "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": "cosine", - "type": "string" - }, - "timeout": { - "title": "Timeout", - "default": 30, - "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" - } - }, - "additionalProperties": false, - "description": "Each parameter can reference other components defined in the same YAML file." - } - }, - "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": 30, - "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" - } - }, - "additionalProperties": false, - "description": "Each parameter can reference other components defined in the same YAML file." - } - }, - "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", - "default": null, - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] - }, - "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", - "default": { - "indexed": [] - }, - "type": "object" - }, - "validate_index_sync": { - "title": "Validate Index Sync", - "default": true, - "type": "boolean" - } - }, - "required": [ - "api_key" - ], - "additionalProperties": false, - "description": "Each parameter can reference other components defined in the same YAML file." - } - }, - "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", - "type": "string" - } - }, - "additionalProperties": false, - "description": "Each parameter can reference other components defined in the same YAML file." - } - }, - "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", - "type": "string" - }, - "password": { - "title": "Password", - "type": "string" - }, - "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" - } - }, - "additionalProperties": false, - "description": "Each parameter can reference other components defined in the same YAML file." - } - }, - "required": [ - "type", - "name" - ], - "additionalProperties": false - }, - "AnswerToSpeechComponent": { - "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": "AnswerToSpeech" - }, - "params": { - "title": "Parameters", - "type": "object", - "properties": { - "model_name_or_path": { - "title": "Model Name Or Path", - "default": "espnet/kan-bayashi_ljspeech_vits", - "anyOf": [ - { - "type": "string" - }, - { - "type": "string", - "format": "path" - } - ] - }, - "generated_audio_dir": { - "title": "Generated Audio Dir", - "default": "generated_audio_answers", - "type": "string", - "format": "path" - }, - "audio_params": { - "title": "Audio Params", - "anyOf": [ - { - "type": "object" - }, - { - "type": "null" - } - ] - }, - "transformers_params": { - "title": "Transformers Params", - "anyOf": [ - { - "type": "object" - }, - { - "type": "null" - } - ] - }, - "progress_bar": { - "title": "Progress Bar", - "default": true, - "type": "boolean" - }, - "devices": { - "title": "Devices", - "anyOf": [ - { - "type": "array", - "items": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "string" - } - ] - } - }, - { - "type": "null" - } - ] - } - }, - "additionalProperties": false, - "description": "Each parameter can reference other components defined in the same YAML file." - } - }, - "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" - ], - "additionalProperties": false, - "description": "Each parameter can reference other components defined in the same YAML file." - } - }, - "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", - "type": "string" - }, - "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" - } - }, - "required": [ - "document_store" - ], - "additionalProperties": false, - "description": "Each parameter can reference other components defined in the same YAML file." - } - }, - "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": { - "output_dir": { - "title": "Output Dir", - "type": "string" - }, - "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" - } - ] - }, - "overwrite_existing_files": { - "title": "Overwrite Existing Files", - "default": true - }, - "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" - } - ] - }, - "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" - } - ] - } - }, - "required": [ - "output_dir" - ], - "additionalProperties": false, - "description": "Each parameter can reference other components defined in the same YAML file." - } - }, - "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", - "type": "string" - }, - "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": "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" - ], - "additionalProperties": false, - "description": "Each parameter can reference other components defined in the same YAML file." - } - }, - "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" - } - }, - "additionalProperties": false, - "description": "Each parameter can reference other components defined in the same YAML file." - } - }, - "required": [ - "type", - "name" - ], - "additionalProperties": false - }, - "DocumentToSpeechComponent": { - "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": "DocumentToSpeech" - }, - "params": { - "title": "Parameters", - "type": "object", - "properties": { - "model_name_or_path": { - "title": "Model Name Or Path", - "default": "espnet/kan-bayashi_ljspeech_vits", - "anyOf": [ - { - "type": "string" - }, - { - "type": "string", - "format": "path" - } - ] - }, - "generated_audio_dir": { - "title": "Generated Audio Dir", - "default": "generated_audio_documents", - "type": "string", - "format": "path" - }, - "audio_params": { - "title": "Audio Params", - "anyOf": [ - { - "type": "object" - }, - { - "type": "null" - } - ] - }, - "transformers_params": { - "title": "Transformers Params", - "anyOf": [ - { - "type": "object" - }, - { - "type": "null" - } - ] - } - }, - "additionalProperties": false, - "description": "Each parameter can reference other components defined in the same YAML file." - } - }, - "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" - } - }, - "additionalProperties": false, - "description": "Each parameter can reference other components defined in the same YAML file." - } - }, - "required": [ - "type", - "name" - ], - "additionalProperties": false - }, - "ElasticsearchFilterOnlyRetrieverComponent": { - "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": "ElasticsearchFilterOnlyRetriever" - }, - "params": { - "title": "Parameters", - "type": "object", - "properties": { - "document_store": { - "title": "Document Store", - "type": "string" - }, - "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" - } - ] - } - }, - "required": [ - "document_store" - ], - "additionalProperties": false, - "description": "Each parameter can reference other components defined in the same YAML file." - } - }, - "required": [ - "type", - "name" - ], - "additionalProperties": false - }, - "ElasticsearchRetrieverComponent": { - "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": "ElasticsearchRetriever" - }, - "params": { - "title": "Parameters", - "type": "object", - "properties": { - "document_store": { - "title": "Document Store", - "type": "string" - }, - "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" - } - ] - } - }, - "required": [ - "document_store" - ], - "additionalProperties": false, - "description": "Each parameter can reference other components defined in the same YAML file." - } - }, - "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": { - "document_store": { - "title": "Document Store", - "type": "string" - }, - "embedding_model": { - "title": "Embedding Model", - "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": 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": "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", - "default": [], - "type": "array", - "items": { - "type": "string" - } - } - }, - "required": [ - "document_store", - "embedding_model" - ], - "additionalProperties": false, - "description": "Each parameter can reference other components defined in the same YAML file." - } - }, - "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": "dslim/bert-base-NER", - "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": "string" - } - ] - } - }, - { - "type": "null" - } - ] - } - }, - "additionalProperties": false, - "description": "Each parameter can reference other components defined in the same YAML file." - } - }, - "required": [ - "type", - "name" - ], - "additionalProperties": false - }, - "EvalAnswersComponent": { - "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": "EvalAnswers" - }, - "params": { - "title": "Parameters", - "type": "object", - "properties": { - "skip_incorrect_retrieval": { - "title": "Skip Incorrect Retrieval", - "default": true, - "type": "boolean" - }, - "open_domain": { - "title": "Open Domain", - "default": true, - "type": "boolean" - }, - "sas_model": { - "title": "Sas Model", - "type": "string" - }, - "debug": { - "title": "Debug", - "default": false, - "type": "boolean" - } - }, - "additionalProperties": false, - "description": "Each parameter can reference other components defined in the same YAML file." - } - }, - "required": [ - "type", - "name" - ], - "additionalProperties": false - }, - "EvalDocumentsComponent": { - "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": "EvalDocuments" - }, - "params": { - "title": "Parameters", - "type": "object", - "properties": { - "debug": { - "title": "Debug", - "default": false, - "type": "boolean" - }, - "open_domain": { - "title": "Open Domain", - "default": true, - "type": "boolean" - }, - "top_k": { - "title": "Top K", - "default": 10, - "type": "integer" - } - }, - "additionalProperties": false, - "description": "Each parameter can reference other components defined in the same YAML file." - } - }, - "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": "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", - "additionalProperties": { - "type": "string" - }, - "anyOf": [ - { - "type": "object" - }, - { - "type": "null" - } - ] - }, - "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" - } - ] - } - }, - "required": [ - "model_name_or_path" - ], - "additionalProperties": false, - "description": "Each parameter can reference other components defined in the same YAML file." - } - }, - "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", - "default": [ - "txt", - "pdf", - "md", - "docx", - "html" - ], - "type": "array", - "items": { - "type": "string" - } - } - }, - "additionalProperties": false, - "description": "Each parameter can reference other components defined in the same YAML file." - } - }, - "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", - "type": "string" - }, - "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" - } - }, - "required": [ - "document_store" - ], - "additionalProperties": false, - "description": "Each parameter can reference other components defined in the same YAML file." - } - }, - "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", - "default": [ - "eng" - ], - "anyOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "type": "null" - } - ] - }, - "id_hash_keys": { - "title": "Id Hash Keys", - "anyOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "type": "null" - } - ] - } - }, - "additionalProperties": false, - "description": "Each parameter can reference other components defined in the same YAML file." - } - }, - "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" - } - }, - "additionalProperties": false, - "description": "Each parameter can reference other components defined in the same YAML file." - } - }, - "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" - } - }, - "additionalProperties": false, - "description": "Each parameter can reference other components defined in the same YAML file." - } - }, - "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" - } - }, - "additionalProperties": false, - "description": "Each parameter can reference other components defined in the same YAML file." - } - }, - "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": { - "document_store": { - "title": "Document Store", - "type": "string" - }, - "embedding_model": { - "title": "Embedding Model", - "type": "string" - }, - "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": "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", - "default": [], - "type": "array", - "items": { - "type": "string" - } - } - }, - "required": [ - "document_store", - "embedding_model" - ], - "additionalProperties": false, - "description": "Each parameter can reference other components defined in the same YAML file." - } - }, - "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" - }, - "model": { - "title": "Model", - "default": "text-curie-001", - "type": "string" - }, - "max_tokens": { - "title": "Max Tokens", - "default": 13, - "type": "integer" - }, - "top_k": { - "title": "Top K", - "default": 5, - "type": "integer" - }, - "temperature": { - "title": "Temperature", - "default": 0.2, - "type": "number" - }, - "presence_penalty": { - "title": "Presence Penalty", - "default": -2.0, - "type": "number" - }, - "frequency_penalty": { - "title": "Frequency Penalty", - "default": -2.0, - "type": "number" - }, - "examples_context": { - "title": "Examples Context", - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] - }, - "examples": { - "title": "Examples", - "anyOf": [ - { - "type": "array", - "items": {} - }, - { - "type": "null" - } - ] - }, - "stop_words": { - "title": "Stop Words", - "anyOf": [ - { - "type": "array", - "items": {} - }, - { - "type": "null" - } - ] - }, - "progress_bar": { - "title": "Progress Bar", - "default": true, - "type": "boolean" - } - }, - "required": [ - "api_key" - ], - "additionalProperties": false, - "description": "Each parameter can reference other components defined in the same YAML file." - } - }, - "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" - } - }, - "additionalProperties": false, - "description": "Each parameter can reference other components defined in the same YAML file." - } - }, - "required": [ - "type", - "name" - ], - "additionalProperties": false - }, - "PDFToTextOCRConverterComponent": { - "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": "PDFToTextOCRConverter" - }, - "params": { - "title": "Parameters", - "type": "object", - "properties": { - "remove_numeric_tables": { - "title": "Remove Numeric Tables", - "default": false, - "type": "boolean" - }, - "valid_languages": { - "title": "Valid Languages", - "default": [ - "eng" - ], - "anyOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "type": "null" - } - ] - }, - "id_hash_keys": { - "title": "Id Hash Keys", - "anyOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "type": "null" - } - ] - } - }, - "additionalProperties": false, - "description": "Each parameter can reference other components defined in the same YAML file." - } - }, - "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" - } - }, - "additionalProperties": false, - "description": "Each parameter can reference other components defined in the same YAML file." - } - }, - "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", - "default": [], - "type": "array", - "items": { - "type": "string" - } - }, - "split_by": { - "title": "Split By", - "default": "word", - "type": "string" - }, - "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" - } - }, - "additionalProperties": false, - "description": "Each parameter can reference other components defined in the same YAML file." - } - }, - "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", - "type": "string" - }, - "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": "string" - } - ] - } - }, - { - "type": "null" - } - ] - } - }, - "required": [ - "question_producer", - "retriever" - ], - "additionalProperties": false, - "description": "Each parameter can reference other components defined in the same YAML file." - } - }, - "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": "string" - } - ] - } - }, - { - "type": "null" - } - ] - } - }, - "additionalProperties": false, - "description": "Each parameter can reference other components defined in the same YAML file." - } - }, - "required": [ - "type", - "name" - ], - "additionalProperties": false - }, - "RAGeneratorComponent": { - "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": "RAGenerator" - }, - "params": { - "title": "Parameters", - "type": "object", - "properties": { - "model_name_or_path": { - "title": "Model Name Or Path", - "default": "facebook/rag-token-nq", - "type": "string" - }, - "model_version": { - "title": "Model Version", - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] - }, - "retriever": { - "title": "Retriever", - "default": null, - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] - }, - "generator_type": { - "title": "Generator Type", - "default": "token", - "type": "string" - }, - "top_k": { - "title": "Top K", - "default": 2, - "type": "integer" - }, - "max_length": { - "title": "Max Length", - "default": 200, - "type": "integer" - }, - "min_length": { - "title": "Min Length", - "default": 2, - "type": "integer" - }, - "num_beams": { - "title": "Num Beams", - "default": 2, - "type": "integer" - }, - "embed_title": { - "title": "Embed Title", - "default": true, - "type": "boolean" - }, - "prefix": { - "title": "Prefix", - "anyOf": [ - { - "type": "string" - }, - { - "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": "string" - } - ] - } - }, - { - "type": "null" - } - ] - } - }, - "additionalProperties": false, - "description": "Each parameter can reference other components defined in the same YAML file." - } - }, - "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" - } - ] - } - }, - "additionalProperties": false, - "description": "Each parameter can reference other components defined in the same YAML file." - } - }, - "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": "null" - } - ] - } - }, - "additionalProperties": false, - "description": "Each parameter can reference other components defined in the same YAML file." - } - }, - "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": "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" - ], - "additionalProperties": false, - "description": "Each parameter can reference other components defined in the same YAML file." - } - }, - "required": [ - "type", - "name" - ], - "additionalProperties": false - }, - "Seq2SeqGeneratorComponent": { - "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": "Seq2SeqGenerator" - }, - "params": { - "title": "Parameters", - "type": "object", - "properties": { - "model_name_or_path": { - "title": "Model Name Or Path", - "type": "string" - }, - "input_converter": { - "title": "Input Converter", - "default": null, - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] - }, - "top_k": { - "title": "Top K", - "default": 1, - "type": "integer" - }, - "max_length": { - "title": "Max Length", - "default": 200, - "type": "integer" - }, - "min_length": { - "title": "Min Length", - "default": 2, - "type": "integer" - }, - "num_beams": { - "title": "Num Beams", - "default": 8, - "type": "integer" - }, - "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": "string" - } - ] - } - }, - { - "type": "null" - } - ] - } - }, - "required": [ - "model_name_or_path" - ], - "additionalProperties": false, - "description": "Each parameter can reference other components defined in the same YAML file." - } - }, - "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/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/vectorizer.pickle", - "anyOf": [ - { - "type": "string" - }, - {} - ] - }, - "batch_size": { - "title": "Batch Size", - "anyOf": [ - { - "type": "integer" - }, - { - "type": "null" - } - ] - }, - "progress_bar": { - "title": "Progress Bar", - "default": true, - "type": "boolean" - } - }, - "additionalProperties": false, - "description": "Each parameter can reference other components defined in the same YAML file." - } - }, - "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": "string" - } - ] - } - }, - { - "type": "null" - } - ] - } - }, - "additionalProperties": false, - "description": "Each parameter can reference other components defined in the same YAML file." - } - }, - "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", - "type": "string" - }, - "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", - "default": [ - "name", - "section_title", - "caption" - ], - "type": "array", - "items": { - "type": "string" - } - }, - "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": "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" - } - }, - "required": [ - "document_store" - ], - "additionalProperties": false, - "description": "Each parameter can reference other components defined in the same YAML file." - } - }, - "required": [ - "type", - "name" - ], - "additionalProperties": false - }, - "Text2SparqlRetrieverComponent": { - "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": "Text2SparqlRetriever" - }, - "params": { - "title": "Parameters", - "type": "object", - "properties": { - "knowledge_graph": { - "title": "Knowledge Graph", - "type": "string" - }, - "model_name_or_path": { - "title": "Model Name Or Path", - "type": "string" - }, - "model_version": { - "title": "Model Version", - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] - }, - "top_k": { - "title": "Top K", - "default": 1, - "type": "integer" - }, - "use_auth_token": { - "title": "Use Auth Token", - "anyOf": [ - { - "type": "boolean" - }, - { - "type": "string" - }, - { - "type": "null" - } - ] - } - }, - "required": [ - "knowledge_graph" - ], - "additionalProperties": false, - "description": "Each parameter can reference other components defined in the same YAML file." - } - }, - "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" - } - }, - "additionalProperties": false, - "description": "Each parameter can reference other components defined in the same YAML file." - } - }, - "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", - "type": "string" - }, - "top_k": { - "title": "Top K", - "default": 10, - "type": "integer" - }, - "auto_fit": { - "title": "Auto Fit", - "default": true - } - }, - "required": [ - "document_store" - ], - "additionalProperties": false, - "description": "Each parameter can reference other components defined in the same YAML file." - } - }, - "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" - } - ] - } - }, - "additionalProperties": false, - "description": "Each parameter can reference other components defined in the same YAML file." - } - }, - "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" - }, - "return_all_scores": { - "title": "Return All Scores", - "default": false, - "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" - }, - "classification_field": { - "title": "Classification Field", - "type": "string" - }, - "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": "string" - } - ] - } - }, - { - "type": "null" - } - ] - } - }, - "additionalProperties": false, - "description": "Each parameter can reference other components defined in the same YAML file." - } - }, - "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", - "default": [ - "LABEL_1", - "LABEL_0" - ], - "type": "array", - "items": { - "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": "string" - } - ] - } - }, - { - "type": "null" - } - ] - } - }, - "additionalProperties": false, - "description": "Each parameter can reference other components defined in the same YAML file." - } - }, - "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": "string" - } - ] - } - }, - { - "type": "null" - } - ] - } - }, - "additionalProperties": false, - "description": "Each parameter can reference other components defined in the same YAML file." - } - }, - "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" - }, - "separator_for_single_summary": { - "title": "Separator For Single Summary", - "default": " ", - "type": "string" - }, - "generate_single_summary": { - "title": "Generate Single Summary", - "default": false, - "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": "string" - } - ] - } - }, - { - "type": "null" - } - ] - } - }, - "additionalProperties": false, - "description": "Each parameter can reference other components defined in the same YAML file." - } - }, - "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": "string" - } - ] - } - }, - { - "type": "null" - } - ] - } - }, - "required": [ - "model_name_or_path" - ], - "additionalProperties": false, - "description": "Each parameter can reference other components defined in the same YAML file." - } - }, - "required": [ - "type", - "name" - ], - "additionalProperties": false - } - } - } \ No newline at end of file diff --git a/haystack/json-schemas/haystack-pipeline-main.schema.json b/haystack/json-schemas/haystack-pipeline-main.schema.json index 95c443de2..ca705c918 100644 --- a/haystack/json-schemas/haystack-pipeline-main.schema.json +++ b/haystack/json-schemas/haystack-pipeline-main.schema.json @@ -1,6423 +1,28 @@ { - "$id": "https://raw.githubusercontent.com/deepset-ai/haystack/main/haystack/json-schemas/haystack-pipeline-main.schema.json", "$schema": "http://json-schema.org/draft-07/schema", - "additionalProperties": false, - "definitions": { - "AnswerToSpeechComponent": { - "additionalProperties": false, - "properties": { - "name": { - "description": "Custom name for the component. Helpful for visualization and debugging.", - "title": "Name", - "type": "string" - }, - "params": { - "additionalProperties": false, - "description": "Each parameter can reference other components defined in the same YAML file.", - "properties": { - "audio_params": { - "anyOf": [ - { - "type": "object" - }, - { - "type": "null" - } - ], - "title": "Audio Params" - }, - "devices": { - "anyOf": [ - { - "items": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "string" - } - ] - }, - "type": "array" - }, - { - "type": "null" - } - ], - "title": "Devices" - }, - "generated_audio_dir": { - "default": "generated_audio_answers", - "format": "path", - "title": "Generated Audio Dir", - "type": "string" - }, - "model_name_or_path": { - "anyOf": [ - { - "type": "string" - }, - { - "format": "path", - "type": "string" - } - ], - "default": "espnet/kan-bayashi_ljspeech_vits", - "title": "Model Name Or Path" - }, - "progress_bar": { - "default": true, - "title": "Progress Bar", - "type": "boolean" - }, - "transformers_params": { - "anyOf": [ - { - "type": "object" - }, - { - "type": "null" - } - ], - "title": "Transformers Params" - } - }, - "title": "Parameters", - "type": "object" - }, - "type": { - "const": "AnswerToSpeech", - "description": "Haystack Class name for the component.", - "title": "Type", - "type": "string" - } - }, - "required": [ - "type", - "name" - ], - "type": "object" - }, - "AzureConverterComponent": { - "additionalProperties": false, - "properties": { - "name": { - "description": "Custom name for the component. Helpful for visualization and debugging.", - "title": "Name", - "type": "string" - }, - "params": { - "additionalProperties": false, - "description": "Each parameter can reference other components defined in the same YAML file.", - "properties": { - "add_page_number": { - "default": true, - "title": "Add Page Number", - "type": "boolean" - }, - "credential_key": { - "title": "Credential Key", - "type": "string" - }, - "endpoint": { - "title": "Endpoint", - "type": "string" - }, - "following_context_len": { - "default": 3, - "title": "Following Context Len", - "type": "integer" - }, - "id_hash_keys": { - "anyOf": [ - { - "items": { - "type": "string" - }, - "type": "array" - }, - { - "type": "null" - } - ], - "title": "Id Hash Keys" - }, - "merge_multiple_column_headers": { - "default": true, - "title": "Merge Multiple Column Headers", - "type": "boolean" - }, - "model_id": { - "default": "prebuilt-document", - "title": "Model Id", - "type": "string" - }, - "preceding_context_len": { - "default": 3, - "title": "Preceding Context Len", - "type": "integer" - }, - "save_json": { - "default": false, - "title": "Save Json", - "type": "boolean" - }, - "valid_languages": { - "anyOf": [ - { - "items": { - "type": "string" - }, - "type": "array" - }, - { - "type": "null" - } - ], - "title": "Valid Languages" - } - }, - "required": [ - "endpoint", - "credential_key" - ], - "title": "Parameters", - "type": "object" - }, - "type": { - "const": "AzureConverter", - "description": "Haystack Class name for the component.", - "title": "Type", - "type": "string" - } - }, - "required": [ - "type", - "name" - ], - "type": "object" - }, - "BM25RetrieverComponent": { - "additionalProperties": false, - "properties": { - "name": { - "description": "Custom name for the component. Helpful for visualization and debugging.", - "title": "Name", - "type": "string" - }, - "params": { - "additionalProperties": false, - "description": "Each parameter can reference other components defined in the same YAML file.", - "properties": { - "all_terms_must_match": { - "default": false, - "title": "All Terms Must Match", - "type": "boolean" - }, - "custom_query": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Custom Query" - }, - "document_store": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "default": null, - "title": "Document Store" - }, - "scale_score": { - "default": true, - "title": "Scale Score", - "type": "boolean" - }, - "top_k": { - "default": 10, - "title": "Top K", - "type": "integer" - } - }, - "title": "Parameters", - "type": "object" - }, - "type": { - "const": "BM25Retriever", - "description": "Haystack Class name for the component.", - "title": "Type", - "type": "string" - } - }, - "required": [ - "type", - "name" - ], - "type": "object" - }, - "CrawlerComponent": { - "additionalProperties": false, - "properties": { - "name": { - "description": "Custom name for the component. Helpful for visualization and debugging.", - "title": "Name", - "type": "string" - }, - "params": { - "additionalProperties": false, - "description": "Each parameter can reference other components defined in the same YAML file.", - "properties": { - "crawler_depth": { - "default": 1, - "title": "Crawler Depth", - "type": "integer" - }, - "crawler_naming_function": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "default": null, - "title": "Crawler Naming Function" - }, - "extract_hidden_text": { - "default": true, - "title": "Extract Hidden Text" - }, - "filter_urls": { - "anyOf": [ - { - "items": {}, - "type": "array" - }, - { - "type": "null" - } - ], - "title": "Filter Urls" - }, - "id_hash_keys": { - "anyOf": [ - { - "items": { - "type": "string" - }, - "type": "array" - }, - { - "type": "null" - } - ], - "title": "Id Hash Keys" - }, - "loading_wait_time": { - "anyOf": [ - { - "type": "integer" - }, - { - "type": "null" - } - ], - "title": "Loading Wait Time" - }, - "output_dir": { - "title": "Output Dir", - "type": "string" - }, - "overwrite_existing_files": { - "default": true, - "title": "Overwrite Existing Files" - }, - "urls": { - "anyOf": [ - { - "items": { - "type": "string" - }, - "type": "array" - }, - { - "type": "null" - } - ], - "title": "Urls" - }, - "webdriver_options": { - "anyOf": [ - { - "items": { - "type": "string" - }, - "type": "array" - }, - { - "type": "null" - } - ], - "title": "Webdriver Options" - } - }, - "required": [ - "output_dir" - ], - "title": "Parameters", - "type": "object" - }, - "type": { - "const": "Crawler", - "description": "Haystack Class name for the component.", - "title": "Type", - "type": "string" - } - }, - "required": [ - "type", - "name" - ], - "type": "object" - }, - "DeepsetCloudDocumentStoreComponent": { - "additionalProperties": false, - "properties": { - "name": { - "description": "Custom name for the component. Helpful for visualization and debugging.", - "title": "Name", - "type": "string" - }, - "params": { - "additionalProperties": false, - "description": "Each parameter can reference other components defined in the same YAML file.", - "properties": { - "api_endpoint": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Api Endpoint" - }, - "api_key": { - "title": "Api Key", - "type": "string" - }, - "duplicate_documents": { - "default": "overwrite", - "title": "Duplicate Documents", - "type": "string" - }, - "embedding_dim": { - "default": 768, - "title": "Embedding Dim", - "type": "integer" - }, - "index": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Index" - }, - "label_index": { - "default": "default", - "title": "Label Index", - "type": "string" - }, - "return_embedding": { - "default": false, - "title": "Return Embedding", - "type": "boolean" - }, - "similarity": { - "default": "dot_product", - "title": "Similarity", - "type": "string" - }, - "workspace": { - "default": "default", - "title": "Workspace", - "type": "string" - } - }, - "title": "Parameters", - "type": "object" - }, - "type": { - "const": "DeepsetCloudDocumentStore", - "description": "Haystack Class name for the component.", - "title": "Type", - "type": "string" - } - }, - "required": [ - "type", - "name" - ], - "type": "object" - }, - "DensePassageRetrieverComponent": { - "additionalProperties": false, - "properties": { - "name": { - "description": "Custom name for the component. Helpful for visualization and debugging.", - "title": "Name", - "type": "string" - }, - "params": { - "additionalProperties": false, - "description": "Each parameter can reference other components defined in the same YAML file.", - "properties": { - "batch_size": { - "default": 16, - "title": "Batch Size", - "type": "integer" - }, - "devices": { - "anyOf": [ - { - "items": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "string" - } - ] - }, - "type": "array" - }, - { - "type": "null" - } - ], - "title": "Devices" - }, - "document_store": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "default": null, - "title": "Document Store" - }, - "embed_title": { - "default": true, - "title": "Embed Title", - "type": "boolean" - }, - "global_loss_buffer_size": { - "default": 150000, - "title": "Global Loss Buffer Size", - "type": "integer" - }, - "max_seq_len_passage": { - "default": 256, - "title": "Max Seq Len Passage", - "type": "integer" - }, - "max_seq_len_query": { - "default": 64, - "title": "Max Seq Len Query", - "type": "integer" - }, - "model_version": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Model Version" - }, - "passage_embedding_model": { - "anyOf": [ - { - "format": "path", - "type": "string" - }, - { - "type": "string" - } - ], - "default": "facebook/dpr-ctx_encoder-single-nq-base", - "title": "Passage Embedding Model" - }, - "progress_bar": { - "default": true, - "title": "Progress Bar", - "type": "boolean" - }, - "query_embedding_model": { - "anyOf": [ - { - "format": "path", - "type": "string" - }, - { - "type": "string" - } - ], - "default": "facebook/dpr-question_encoder-single-nq-base", - "title": "Query Embedding Model" - }, - "scale_score": { - "default": true, - "title": "Scale Score", - "type": "boolean" - }, - "similarity_function": { - "default": "dot_product", - "title": "Similarity Function", - "type": "string" - }, - "top_k": { - "default": 10, - "title": "Top K", - "type": "integer" - }, - "use_auth_token": { - "anyOf": [ - { - "type": "boolean" - }, - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Use Auth Token" - }, - "use_fast_tokenizers": { - "default": true, - "title": "Use Fast Tokenizers", - "type": "boolean" - }, - "use_gpu": { - "default": true, - "title": "Use Gpu", - "type": "boolean" - } - }, - "title": "Parameters", - "type": "object" - }, - "type": { - "const": "DensePassageRetriever", - "description": "Haystack Class name for the component.", - "title": "Type", - "type": "string" - } - }, - "required": [ - "type", - "name" - ], - "type": "object" - }, - "Docs2AnswersComponent": { - "additionalProperties": false, - "properties": { - "name": { - "description": "Custom name for the component. Helpful for visualization and debugging.", - "title": "Name", - "type": "string" - }, - "params": { - "additionalProperties": false, - "description": "Each parameter can reference other components defined in the same YAML file.", - "properties": { - "progress_bar": { - "default": true, - "title": "Progress Bar", - "type": "boolean" - } - }, - "title": "Parameters", - "type": "object" - }, - "type": { - "const": "Docs2Answers", - "description": "Haystack Class name for the component.", - "title": "Type", - "type": "string" - } - }, - "required": [ - "type", - "name" - ], - "type": "object" - }, - "DocumentToSpeechComponent": { - "additionalProperties": false, - "properties": { - "name": { - "description": "Custom name for the component. Helpful for visualization and debugging.", - "title": "Name", - "type": "string" - }, - "params": { - "additionalProperties": false, - "description": "Each parameter can reference other components defined in the same YAML file.", - "properties": { - "audio_params": { - "anyOf": [ - { - "type": "object" - }, - { - "type": "null" - } - ], - "title": "Audio Params" - }, - "generated_audio_dir": { - "default": "generated_audio_documents", - "format": "path", - "title": "Generated Audio Dir", - "type": "string" - }, - "model_name_or_path": { - "anyOf": [ - { - "type": "string" - }, - { - "format": "path", - "type": "string" - } - ], - "default": "espnet/kan-bayashi_ljspeech_vits", - "title": "Model Name Or Path" - }, - "transformers_params": { - "anyOf": [ - { - "type": "object" - }, - { - "type": "null" - } - ], - "title": "Transformers Params" - } - }, - "title": "Parameters", - "type": "object" - }, - "type": { - "const": "DocumentToSpeech", - "description": "Haystack Class name for the component.", - "title": "Type", - "type": "string" - } - }, - "required": [ - "type", - "name" - ], - "type": "object" - }, - "DocxToTextConverterComponent": { - "additionalProperties": false, - "properties": { - "name": { - "description": "Custom name for the component. Helpful for visualization and debugging.", - "title": "Name", - "type": "string" - }, - "params": { - "additionalProperties": false, - "description": "Each parameter can reference other components defined in the same YAML file.", - "properties": { - "id_hash_keys": { - "anyOf": [ - { - "items": { - "type": "string" - }, - "type": "array" - }, - { - "type": "null" - } - ], - "title": "Id Hash Keys" - }, - "progress_bar": { - "default": true, - "title": "Progress Bar", - "type": "boolean" - }, - "remove_numeric_tables": { - "default": false, - "title": "Remove Numeric Tables", - "type": "boolean" - }, - "valid_languages": { - "anyOf": [ - { - "items": { - "type": "string" - }, - "type": "array" - }, - { - "type": "null" - } - ], - "title": "Valid Languages" - } - }, - "title": "Parameters", - "type": "object" - }, - "type": { - "const": "DocxToTextConverter", - "description": "Haystack Class name for the component.", - "title": "Type", - "type": "string" - } - }, - "required": [ - "type", - "name" - ], - "type": "object" - }, - "ElasticsearchDocumentStoreComponent": { - "additionalProperties": false, - "properties": { - "name": { - "description": "Custom name for the component. Helpful for visualization and debugging.", - "title": "Name", - "type": "string" - }, - "params": { - "additionalProperties": false, - "description": "Each parameter can reference other components defined in the same YAML file.", - "properties": { - "analyzer": { - "default": "standard", - "title": "Analyzer", - "type": "string" - }, - "api_key": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Api Key" - }, - "api_key_id": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Api Key Id" - }, - "aws4auth": { - "title": "Aws4Auth" - }, - "ca_certs": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Ca Certs" - }, - "content_field": { - "default": "content", - "title": "Content Field", - "type": "string" - }, - "create_index": { - "default": true, - "title": "Create Index", - "type": "boolean" - }, - "custom_mapping": { - "anyOf": [ - { - "type": "object" - }, - { - "type": "null" - } - ], - "title": "Custom Mapping" - }, - "duplicate_documents": { - "default": "overwrite", - "title": "Duplicate Documents", - "type": "string" - }, - "embedding_dim": { - "default": 768, - "title": "Embedding Dim", - "type": "integer" - }, - "embedding_field": { - "default": "embedding", - "title": "Embedding Field", - "type": "string" - }, - "excluded_meta_data": { - "anyOf": [ - { - "items": {}, - "type": "array" - }, - { - "type": "null" - } - ], - "title": "Excluded Meta Data" - }, - "host": { - "anyOf": [ - { - "type": "string" - }, - { - "items": { - "type": "string" - }, - "type": "array" - } - ], - "default": "localhost", - "title": "Host" - }, - "index": { - "default": "document", - "title": "Index", - "type": "string" - }, - "index_type": { - "default": "flat", - "title": "Index Type", - "type": "string" - }, - "label_index": { - "default": "label", - "title": "Label Index", - "type": "string" - }, - "name_field": { - "default": "name", - "title": "Name Field", - "type": "string" - }, - "password": { - "default": "", - "title": "Password", - "type": "string" - }, - "port": { - "anyOf": [ - { - "type": "integer" - }, - { - "items": { - "type": "integer" - }, - "type": "array" - } - ], - "default": 9200, - "title": "Port" - }, - "recreate_index": { - "default": false, - "title": "Recreate Index", - "type": "boolean" - }, - "refresh_type": { - "default": "wait_for", - "title": "Refresh Type", - "type": "string" - }, - "return_embedding": { - "default": false, - "title": "Return Embedding", - "type": "boolean" - }, - "scheme": { - "default": "http", - "title": "Scheme", - "type": "string" - }, - "scroll": { - "default": "1d", - "title": "Scroll", - "type": "string" - }, - "search_fields": { - "anyOf": [ - { - "type": "string" - }, - { - "items": {}, - "type": "array" - } - ], - "default": "content", - "title": "Search Fields" - }, - "similarity": { - "default": "dot_product", - "title": "Similarity", - "type": "string" - }, - "skip_missing_embeddings": { - "default": true, - "title": "Skip Missing Embeddings", - "type": "boolean" - }, - "synonym_type": { - "default": "synonym", - "title": "Synonym Type", - "type": "string" - }, - "synonyms": { - "anyOf": [ - { - "items": {}, - "type": "array" - }, - { - "type": "null" - } - ], - "title": "Synonyms" - }, - "timeout": { - "default": 30, - "title": "Timeout", - "type": "integer" - }, - "use_system_proxy": { - "default": false, - "title": "Use System Proxy", - "type": "boolean" - }, - "username": { - "default": "", - "title": "Username", - "type": "string" - }, - "verify_certs": { - "default": true, - "title": "Verify Certs", - "type": "boolean" - } - }, - "title": "Parameters", - "type": "object" - }, - "type": { - "const": "ElasticsearchDocumentStore", - "description": "Haystack Class name for the component.", - "title": "Type", - "type": "string" - } - }, - "required": [ - "type", - "name" - ], - "type": "object" - }, - "ElasticsearchFilterOnlyRetrieverComponent": { - "additionalProperties": false, - "properties": { - "name": { - "description": "Custom name for the component. Helpful for visualization and debugging.", - "title": "Name", - "type": "string" - }, - "params": { - "additionalProperties": false, - "description": "Each parameter can reference other components defined in the same YAML file.", - "properties": { - "all_terms_must_match": { - "default": false, - "title": "All Terms Must Match", - "type": "boolean" - }, - "custom_query": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Custom Query" - }, - "document_store": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "default": null, - "title": "Document Store" - }, - "top_k": { - "default": 10, - "title": "Top K", - "type": "integer" - } - }, - "title": "Parameters", - "type": "object" - }, - "type": { - "const": "ElasticsearchFilterOnlyRetriever", - "description": "Haystack Class name for the component.", - "title": "Type", - "type": "string" - } - }, - "required": [ - "type", - "name" - ], - "type": "object" - }, - "ElasticsearchRetrieverComponent": { - "additionalProperties": false, - "properties": { - "name": { - "description": "Custom name for the component. Helpful for visualization and debugging.", - "title": "Name", - "type": "string" - }, - "params": { - "additionalProperties": false, - "description": "Each parameter can reference other components defined in the same YAML file.", - "properties": { - "all_terms_must_match": { - "default": false, - "title": "All Terms Must Match", - "type": "boolean" - }, - "custom_query": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Custom Query" - }, - "document_store": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "default": null, - "title": "Document Store" - }, - "top_k": { - "default": 10, - "title": "Top K", - "type": "integer" - } - }, - "title": "Parameters", - "type": "object" - }, - "type": { - "const": "ElasticsearchRetriever", - "description": "Haystack Class name for the component.", - "title": "Type", - "type": "string" - } - }, - "required": [ - "type", - "name" - ], - "type": "object" - }, - "EmbeddingRetrieverComponent": { - "additionalProperties": false, - "properties": { - "name": { - "description": "Custom name for the component. Helpful for visualization and debugging.", - "title": "Name", - "type": "string" - }, - "params": { - "additionalProperties": false, - "description": "Each parameter can reference other components defined in the same YAML file.", - "properties": { - "api_key": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Api Key" - }, - "batch_size": { - "default": 32, - "title": "Batch Size", - "type": "integer" - }, - "devices": { - "anyOf": [ - { - "items": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "string" - } - ] - }, - "type": "array" - }, - { - "type": "null" - } - ], - "title": "Devices" - }, - "document_store": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "default": null, - "title": "Document Store" - }, - "emb_extraction_layer": { - "default": -1, - "title": "Emb Extraction Layer", - "type": "integer" - }, - "embed_meta_fields": { - "default": [], - "items": { - "type": "string" - }, - "title": "Embed Meta Fields", - "type": "array" - }, - "embedding_model": { - "title": "Embedding Model", - "type": "string" - }, - "max_seq_len": { - "default": 512, - "title": "Max Seq Len", - "type": "integer" - }, - "model_format": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Model Format" - }, - "model_version": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Model Version" - }, - "pooling_strategy": { - "default": "reduce_mean", - "title": "Pooling Strategy", - "type": "string" - }, - "progress_bar": { - "default": true, - "title": "Progress Bar", - "type": "boolean" - }, - "scale_score": { - "default": true, - "title": "Scale Score", - "type": "boolean" - }, - "top_k": { - "default": 10, - "title": "Top K", - "type": "integer" - }, - "use_auth_token": { - "anyOf": [ - { - "type": "boolean" - }, - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Use Auth Token" - }, - "use_gpu": { - "default": true, - "title": "Use Gpu", - "type": "boolean" - } - }, - "required": [ - "embedding_model" - ], - "title": "Parameters", - "type": "object" - }, - "type": { - "const": "EmbeddingRetriever", - "description": "Haystack Class name for the component.", - "title": "Type", - "type": "string" - } - }, - "required": [ - "type", - "name" - ], - "type": "object" - }, - "EntityExtractorComponent": { - "additionalProperties": false, - "properties": { - "name": { - "description": "Custom name for the component. Helpful for visualization and debugging.", - "title": "Name", - "type": "string" - }, - "params": { - "additionalProperties": false, - "description": "Each parameter can reference other components defined in the same YAML file.", - "properties": { - "add_prefix_space": { - "anyOf": [ - { - "type": "boolean" - }, - { - "type": "null" - } - ], - "title": "Add Prefix Space" - }, - "aggregation_strategy": { - "default": "first", - "enum": [ - "simple", - "first", - "average", - "max" - ], - "title": "Aggregation Strategy", - "type": "string" - }, - "batch_size": { - "default": 16, - "title": "Batch Size", - "type": "integer" - }, - "devices": { - "anyOf": [ - { - "items": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "string" - } - ] - }, - "type": "array" - }, - { - "type": "null" - } - ], - "title": "Devices" - }, - "flatten_entities_in_meta_data": { - "default": false, - "title": "Flatten Entities In Meta Data", - "type": "boolean" - }, - "ignore_labels": { - "anyOf": [ - { - "items": { - "type": "string" - }, - "type": "array" - }, - { - "type": "null" - } - ], - "title": "Ignore Labels" - }, - "max_seq_len": { - "title": "Max Seq Len", - "type": "integer" - }, - "model_name_or_path": { - "default": "elastic/distilbert-base-cased-finetuned-conll03-english", - "title": "Model Name Or Path", - "type": "string" - }, - "model_version": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Model Version" - }, - "num_workers": { - "default": 0, - "title": "Num Workers", - "type": "integer" - }, - "pre_split_text": { - "default": false, - "title": "Pre Split Text", - "type": "boolean" - }, - "progress_bar": { - "default": true, - "title": "Progress Bar", - "type": "boolean" - }, - "use_auth_token": { - "anyOf": [ - { - "type": "boolean" - }, - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Use Auth Token" - }, - "use_gpu": { - "default": true, - "title": "Use Gpu", - "type": "boolean" - } - }, - "title": "Parameters", - "type": "object" - }, - "type": { - "const": "EntityExtractor", - "description": "Haystack Class name for the component.", - "title": "Type", - "type": "string" - } - }, - "required": [ - "type", - "name" - ], - "type": "object" - }, - "EvalAnswersComponent": { - "additionalProperties": false, - "properties": { - "name": { - "description": "Custom name for the component. Helpful for visualization and debugging.", - "title": "Name", - "type": "string" - }, - "params": { - "additionalProperties": false, - "description": "Each parameter can reference other components defined in the same YAML file.", - "properties": { - "debug": { - "default": false, - "title": "Debug", - "type": "boolean" - }, - "open_domain": { - "default": true, - "title": "Open Domain", - "type": "boolean" - }, - "sas_model": { - "title": "Sas Model", - "type": "string" - }, - "skip_incorrect_retrieval": { - "default": true, - "title": "Skip Incorrect Retrieval", - "type": "boolean" - } - }, - "title": "Parameters", - "type": "object" - }, - "type": { - "const": "EvalAnswers", - "description": "Haystack Class name for the component.", - "title": "Type", - "type": "string" - } - }, - "required": [ - "type", - "name" - ], - "type": "object" - }, - "EvalDocumentsComponent": { - "additionalProperties": false, - "properties": { - "name": { - "description": "Custom name for the component. Helpful for visualization and debugging.", - "title": "Name", - "type": "string" - }, - "params": { - "additionalProperties": false, - "description": "Each parameter can reference other components defined in the same YAML file.", - "properties": { - "debug": { - "default": false, - "title": "Debug", - "type": "boolean" - }, - "open_domain": { - "default": true, - "title": "Open Domain", - "type": "boolean" - }, - "top_k": { - "default": 10, - "title": "Top K", - "type": "integer" - } - }, - "title": "Parameters", - "type": "object" - }, - "type": { - "const": "EvalDocuments", - "description": "Haystack Class name for the component.", - "title": "Type", - "type": "string" - } - }, - "required": [ - "type", - "name" - ], - "type": "object" - }, - "FAISSDocumentStoreComponent": { - "additionalProperties": false, - "properties": { - "name": { - "description": "Custom name for the component. Helpful for visualization and debugging.", - "title": "Name", - "type": "string" - }, - "params": { - "additionalProperties": false, - "description": "Each parameter can reference other components defined in the same YAML file.", - "properties": { - "duplicate_documents": { - "default": "overwrite", - "title": "Duplicate Documents", - "type": "string" - }, - "ef_construction": { - "default": 80, - "title": "Ef Construction", - "type": "integer" - }, - "ef_search": { - "default": 20, - "title": "Ef Search", - "type": "integer" - }, - "embedding_dim": { - "default": 768, - "title": "Embedding Dim", - "type": "integer" - }, - "embedding_field": { - "default": "embedding", - "title": "Embedding Field", - "type": "string" - }, - "faiss_config_path": { - "anyOf": [ - { - "type": "string" - }, - { - "format": "path", - "type": "string" - } - ], - "title": "Faiss Config Path" - }, - "faiss_index": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "default": null, - "title": "Faiss Index" - }, - "faiss_index_factory_str": { - "default": "Flat", - "title": "Faiss Index Factory Str", - "type": "string" - }, - "faiss_index_path": { - "anyOf": [ - { - "type": "string" - }, - { - "format": "path", - "type": "string" - } - ], - "title": "Faiss Index Path" - }, - "index": { - "default": "document", - "title": "Index", - "type": "string" - }, - "isolation_level": { - "title": "Isolation Level", - "type": "string" - }, - "n_links": { - "default": 64, - "title": "N Links", - "type": "integer" - }, - "progress_bar": { - "default": true, - "title": "Progress Bar", - "type": "boolean" - }, - "return_embedding": { - "default": false, - "title": "Return Embedding", - "type": "boolean" - }, - "similarity": { - "default": "dot_product", - "title": "Similarity", - "type": "string" - }, - "sql_url": { - "default": "sqlite:///faiss_document_store.db", - "title": "Sql Url", - "type": "string" - }, - "validate_index_sync": { - "default": true, - "title": "Validate Index Sync", - "type": "boolean" - }, - "vector_dim": { - "title": "Vector Dim", - "type": "integer" - } - }, - "title": "Parameters", - "type": "object" - }, - "type": { - "const": "FAISSDocumentStore", - "description": "Haystack Class name for the component.", - "title": "Type", - "type": "string" - } - }, - "required": [ - "type", - "name" - ], - "type": "object" - }, - "FARMReaderComponent": { - "additionalProperties": false, - "properties": { - "name": { - "description": "Custom name for the component. Helpful for visualization and debugging.", - "title": "Name", - "type": "string" - }, - "params": { - "additionalProperties": false, - "description": "Each parameter can reference other components defined in the same YAML file.", - "properties": { - "batch_size": { - "default": 50, - "title": "Batch Size", - "type": "integer" - }, - "confidence_threshold": { - "anyOf": [ - { - "type": "number" - }, - { - "type": "null" - } - ], - "title": "Confidence Threshold" - }, - "context_window_size": { - "default": 150, - "title": "Context Window Size", - "type": "integer" - }, - "devices": { - "anyOf": [ - { - "items": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "string" - } - ] - }, - "type": "array" - }, - { - "type": "null" - } - ], - "title": "Devices" - }, - "doc_stride": { - "default": 128, - "title": "Doc Stride", - "type": "integer" - }, - "duplicate_filtering": { - "default": 0, - "title": "Duplicate Filtering", - "type": "integer" - }, - "force_download": { - "default": false, - "title": "Force Download" - }, - "local_files_only": { - "default": false, - "title": "Local Files Only" - }, - "max_seq_len": { - "default": 256, - "title": "Max Seq Len", - "type": "integer" - }, - "model_name_or_path": { - "title": "Model Name Or Path", - "type": "string" - }, - "model_version": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Model Version" - }, - "no_ans_boost": { - "default": 0.0, - "title": "No Ans Boost", - "type": "number" - }, - "num_processes": { - "anyOf": [ - { - "type": "integer" - }, - { - "type": "null" - } - ], - "title": "Num Processes" - }, - "progress_bar": { - "default": true, - "title": "Progress Bar", - "type": "boolean" - }, - "proxies": { - "additionalProperties": { - "type": "string" - }, - "anyOf": [ - { - "type": "object" - }, - { - "type": "null" - } - ], - "title": "Proxies" - }, - "return_no_answer": { - "default": false, - "title": "Return No Answer", - "type": "boolean" - }, - "top_k": { - "default": 10, - "title": "Top K", - "type": "integer" - }, - "top_k_per_candidate": { - "default": 3, - "title": "Top K Per Candidate", - "type": "integer" - }, - "top_k_per_sample": { - "default": 1, - "title": "Top K Per Sample", - "type": "integer" - }, - "use_auth_token": { - "anyOf": [ - { - "type": "boolean" - }, - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Use Auth Token" - }, - "use_confidence_scores": { - "default": true, - "title": "Use Confidence Scores", - "type": "boolean" - }, - "use_gpu": { - "default": true, - "title": "Use Gpu", - "type": "boolean" - } - }, - "required": [ - "model_name_or_path" - ], - "title": "Parameters", - "type": "object" - }, - "type": { - "const": "FARMReader", - "description": "Haystack Class name for the component.", - "title": "Type", - "type": "string" - } - }, - "required": [ - "type", - "name" - ], - "type": "object" - }, - "FileTypeClassifierComponent": { - "additionalProperties": false, - "properties": { - "name": { - "description": "Custom name for the component. Helpful for visualization and debugging.", - "title": "Name", - "type": "string" - }, - "params": { - "additionalProperties": false, - "description": "Each parameter can reference other components defined in the same YAML file.", - "properties": { - "supported_types": { - "default": [ - "txt", - "pdf", - "md", - "docx", - "html" - ], - "items": { - "type": "string" - }, - "title": "Supported Types", - "type": "array" - } - }, - "title": "Parameters", - "type": "object" - }, - "type": { - "const": "FileTypeClassifier", - "description": "Haystack Class name for the component.", - "title": "Type", - "type": "string" - } - }, - "required": [ - "type", - "name" - ], - "type": "object" - }, - "FilterRetrieverComponent": { - "additionalProperties": false, - "properties": { - "name": { - "description": "Custom name for the component. Helpful for visualization and debugging.", - "title": "Name", - "type": "string" - }, - "params": { - "additionalProperties": false, - "description": "Each parameter can reference other components defined in the same YAML file.", - "properties": { - "all_terms_must_match": { - "default": false, - "title": "All Terms Must Match", - "type": "boolean" - }, - "custom_query": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Custom Query" - }, - "document_store": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "default": null, - "title": "Document Store" - }, - "scale_score": { - "default": true, - "title": "Scale Score", - "type": "boolean" - }, - "top_k": { - "default": 10, - "title": "Top K", - "type": "integer" - } - }, - "title": "Parameters", - "type": "object" - }, - "type": { - "const": "FilterRetriever", - "description": "Haystack Class name for the component.", - "title": "Type", - "type": "string" - } - }, - "required": [ - "type", - "name" - ], - "type": "object" - }, - "GraphDBKnowledgeGraphComponent": { - "additionalProperties": false, - "properties": { - "name": { - "description": "Custom name for the component. Helpful for visualization and debugging.", - "title": "Name", - "type": "string" - }, - "params": { - "additionalProperties": false, - "description": "Each parameter can reference other components defined in the same YAML file.", - "properties": { - "host": { - "default": "localhost", - "title": "Host", - "type": "string" - }, - "index": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Index" - }, - "password": { - "default": "", - "title": "Password", - "type": "string" - }, - "port": { - "default": 7200, - "title": "Port", - "type": "integer" - }, - "prefixes": { - "default": "", - "title": "Prefixes", - "type": "string" - }, - "username": { - "default": "", - "title": "Username", - "type": "string" - } - }, - "title": "Parameters", - "type": "object" - }, - "type": { - "const": "GraphDBKnowledgeGraph", - "description": "Haystack Class name for the component.", - "title": "Type", - "type": "string" - } - }, - "required": [ - "type", - "name" - ], - "type": "object" - }, - "ImageToTextConverterComponent": { - "additionalProperties": false, - "properties": { - "name": { - "description": "Custom name for the component. Helpful for visualization and debugging.", - "title": "Name", - "type": "string" - }, - "params": { - "additionalProperties": false, - "description": "Each parameter can reference other components defined in the same YAML file.", - "properties": { - "id_hash_keys": { - "anyOf": [ - { - "items": { - "type": "string" - }, - "type": "array" - }, - { - "type": "null" - } - ], - "title": "Id Hash Keys" - }, - "remove_numeric_tables": { - "default": false, - "title": "Remove Numeric Tables", - "type": "boolean" - }, - "valid_languages": { - "anyOf": [ - { - "items": { - "type": "string" - }, - "type": "array" - }, - { - "type": "null" - } - ], - "default": [ - "eng" - ], - "title": "Valid Languages" - } - }, - "title": "Parameters", - "type": "object" - }, - "type": { - "const": "ImageToTextConverter", - "description": "Haystack Class name for the component.", - "title": "Type", - "type": "string" - } - }, - "required": [ - "type", - "name" - ], - "type": "object" - }, - "InMemoryDocumentStoreComponent": { - "additionalProperties": false, - "properties": { - "name": { - "description": "Custom name for the component. Helpful for visualization and debugging.", - "title": "Name", - "type": "string" - }, - "params": { - "additionalProperties": false, - "description": "Each parameter can reference other components defined in the same YAML file.", - "properties": { - "devices": { - "anyOf": [ - { - "items": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "string" - } - ] - }, - "type": "array" - }, - { - "type": "null" - } - ], - "title": "Devices" - }, - "duplicate_documents": { - "default": "overwrite", - "title": "Duplicate Documents", - "type": "string" - }, - "embedding_dim": { - "default": 768, - "title": "Embedding Dim", - "type": "integer" - }, - "embedding_field": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "default": "embedding", - "title": "Embedding Field" - }, - "index": { - "default": "document", - "title": "Index", - "type": "string" - }, - "label_index": { - "default": "label", - "title": "Label Index", - "type": "string" - }, - "progress_bar": { - "default": true, - "title": "Progress Bar", - "type": "boolean" - }, - "return_embedding": { - "default": false, - "title": "Return Embedding", - "type": "boolean" - }, - "scoring_batch_size": { - "default": 500000, - "title": "Scoring Batch Size", - "type": "integer" - }, - "similarity": { - "default": "dot_product", - "title": "Similarity", - "type": "string" - }, - "use_gpu": { - "default": true, - "title": "Use Gpu", - "type": "boolean" - } - }, - "title": "Parameters", - "type": "object" - }, - "type": { - "const": "InMemoryDocumentStore", - "description": "Haystack Class name for the component.", - "title": "Type", - "type": "string" - } - }, - "required": [ - "type", - "name" - ], - "type": "object" - }, - "InMemoryKnowledgeGraphComponent": { - "additionalProperties": false, - "properties": { - "name": { - "description": "Custom name for the component. Helpful for visualization and debugging.", - "title": "Name", - "type": "string" - }, - "params": { - "additionalProperties": false, - "description": "Each parameter can reference other components defined in the same YAML file.", - "properties": { - "index": { - "default": "document", - "title": "Index", - "type": "string" - } - }, - "title": "Parameters", - "type": "object" - }, - "type": { - "const": "InMemoryKnowledgeGraph", - "description": "Haystack Class name for the component.", - "title": "Type", - "type": "string" - } - }, - "required": [ - "type", - "name" - ], - "type": "object" - }, - "JoinAnswersComponent": { - "additionalProperties": false, - "properties": { - "name": { - "description": "Custom name for the component. Helpful for visualization and debugging.", - "title": "Name", - "type": "string" - }, - "params": { - "additionalProperties": false, - "description": "Each parameter can reference other components defined in the same YAML file.", - "properties": { - "join_mode": { - "default": "concatenate", - "title": "Join Mode", - "type": "string" - }, - "sort_by_score": { - "default": true, - "title": "Sort By Score", - "type": "boolean" - }, - "top_k_join": { - "anyOf": [ - { - "type": "integer" - }, - { - "type": "null" - } - ], - "title": "Top K Join" - }, - "weights": { - "anyOf": [ - { - "items": { - "type": "number" - }, - "type": "array" - }, - { - "type": "null" - } - ], - "title": "Weights" - } - }, - "title": "Parameters", - "type": "object" - }, - "type": { - "const": "JoinAnswers", - "description": "Haystack Class name for the component.", - "title": "Type", - "type": "string" - } - }, - "required": [ - "type", - "name" - ], - "type": "object" - }, - "JoinDocumentsComponent": { - "additionalProperties": false, - "properties": { - "name": { - "description": "Custom name for the component. Helpful for visualization and debugging.", - "title": "Name", - "type": "string" - }, - "params": { - "additionalProperties": false, - "description": "Each parameter can reference other components defined in the same YAML file.", - "properties": { - "join_mode": { - "default": "concatenate", - "title": "Join Mode", - "type": "string" - }, - "sort_by_score": { - "default": true, - "title": "Sort By Score", - "type": "boolean" - }, - "top_k_join": { - "anyOf": [ - { - "type": "integer" - }, - { - "type": "null" - } - ], - "title": "Top K Join" - }, - "weights": { - "anyOf": [ - { - "items": { - "type": "number" - }, - "type": "array" - }, - { - "type": "null" - } - ], - "title": "Weights" - } - }, - "title": "Parameters", - "type": "object" - }, - "type": { - "const": "JoinDocuments", - "description": "Haystack Class name for the component.", - "title": "Type", - "type": "string" - } - }, - "required": [ - "type", - "name" - ], - "type": "object" - }, - "MarkdownConverterComponent": { - "additionalProperties": false, - "properties": { - "name": { - "description": "Custom name for the component. Helpful for visualization and debugging.", - "title": "Name", - "type": "string" - }, - "params": { - "additionalProperties": false, - "description": "Each parameter can reference other components defined in the same YAML file.", - "properties": { - "extract_headlines": { - "default": false, - "title": "Extract Headlines", - "type": "boolean" - }, - "id_hash_keys": { - "anyOf": [ - { - "items": { - "type": "string" - }, - "type": "array" - }, - { - "type": "null" - } - ], - "title": "Id Hash Keys" - }, - "progress_bar": { - "default": true, - "title": "Progress Bar", - "type": "boolean" - }, - "remove_code_snippets": { - "default": true, - "title": "Remove Code Snippets", - "type": "boolean" - }, - "remove_numeric_tables": { - "default": false, - "title": "Remove Numeric Tables", - "type": "boolean" - }, - "valid_languages": { - "anyOf": [ - { - "items": { - "type": "string" - }, - "type": "array" - }, - { - "type": "null" - } - ], - "title": "Valid Languages" - } - }, - "title": "Parameters", - "type": "object" - }, - "type": { - "const": "MarkdownConverter", - "description": "Haystack Class name for the component.", - "title": "Type", - "type": "string" - } - }, - "required": [ - "type", - "name" - ], - "type": "object" - }, - "Milvus2DocumentStoreComponent": { - "additionalProperties": false, - "properties": { - "name": { - "description": "Custom name for the component. Helpful for visualization and debugging.", - "title": "Name", - "type": "string" - }, - "params": { - "additionalProperties": false, - "description": "Each parameter can reference other components defined in the same YAML file.", - "properties": { - "connection_pool": { - "default": "SingletonThread", - "title": "Connection Pool", - "type": "string" - }, - "consistency_level": { - "default": 0, - "title": "Consistency Level", - "type": "integer" - }, - "custom_fields": { - "anyOf": [ - { - "items": {}, - "type": "array" - }, - { - "type": "null" - } - ], - "title": "Custom Fields" - }, - "duplicate_documents": { - "default": "overwrite", - "title": "Duplicate Documents", - "type": "string" - }, - "embedding_dim": { - "default": 768, - "title": "Embedding Dim", - "type": "integer" - }, - "embedding_field": { - "default": "embedding", - "title": "Embedding Field", - "type": "string" - }, - "host": { - "default": "localhost", - "title": "Host", - "type": "string" - }, - "id_field": { - "default": "id", - "title": "Id Field", - "type": "string" - }, - "index": { - "default": "document", - "title": "Index", - "type": "string" - }, - "index_file_size": { - "default": 1024, - "title": "Index File Size", - "type": "integer" - }, - "index_param": { - "anyOf": [ - { - "type": "object" - }, - { - "type": "null" - } - ], - "title": "Index Param" - }, - "index_type": { - "default": "IVF_FLAT", - "title": "Index Type", - "type": "string" - }, - "isolation_level": { - "title": "Isolation Level", - "type": "string" - }, - "port": { - "default": "19530", - "title": "Port", - "type": "string" - }, - "progress_bar": { - "default": true, - "title": "Progress Bar", - "type": "boolean" - }, - "recreate_index": { - "default": false, - "title": "Recreate Index", - "type": "boolean" - }, - "return_embedding": { - "default": false, - "title": "Return Embedding", - "type": "boolean" - }, - "search_param": { - "anyOf": [ - { - "type": "object" - }, - { - "type": "null" - } - ], - "title": "Search Param" - }, - "similarity": { - "default": "dot_product", - "title": "Similarity", - "type": "string" - }, - "sql_url": { - "default": "sqlite:///", - "title": "Sql Url", - "type": "string" - }, - "vector_dim": { - "title": "Vector Dim", - "type": "integer" - } - }, - "title": "Parameters", - "type": "object" - }, - "type": { - "const": "Milvus2DocumentStore", - "description": "Haystack Class name for the component.", - "title": "Type", - "type": "string" - } - }, - "required": [ - "type", - "name" - ], - "type": "object" - }, - "MultiModalRetrieverComponent": { - "additionalProperties": false, - "properties": { - "name": { - "description": "Custom name for the component. Helpful for visualization and debugging.", - "title": "Name", - "type": "string" - }, - "params": { - "additionalProperties": false, - "description": "Each parameter can reference other components defined in the same YAML file.", - "properties": { - "batch_size": { - "default": 16, - "title": "Batch Size", - "type": "integer" - }, - "devices": { - "anyOf": [ - { - "items": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "string" - } - ] - }, - "type": "array" - }, - { - "type": "null" - } - ], - "title": "Devices" - }, - "document_embedding_models": { - "additionalProperties": { - "anyOf": [ - { - "format": "path", - "type": "string" - }, - { - "type": "string" - } - ] - }, - "title": "Document Embedding Models", - "type": "object" - }, - "document_feature_extractors_params": { - "additionalProperties": { - "type": "object" - }, - "default": { - "text": { - "max_length": 256 - } - }, - "title": "Document Feature Extractors Params", - "type": "object" - }, - "document_store": { - "title": "Document Store", - "type": "string" - }, - "embed_meta_fields": { - "default": [ - "name" - ], - "items": { - "type": "string" - }, - "title": "Embed Meta Fields", - "type": "array" - }, - "progress_bar": { - "default": true, - "title": "Progress Bar", - "type": "boolean" - }, - "query_embedding_model": { - "anyOf": [ - { - "format": "path", - "type": "string" - }, - { - "type": "string" - } - ], - "title": "Query Embedding Model" - }, - "query_feature_extractor_params": { - "default": { - "max_length": 64 - }, - "title": "Query Feature Extractor Params", - "type": "object" - }, - "query_type": { - "default": "text", - "title": "Query Type", - "type": "string" - }, - "scale_score": { - "default": true, - "title": "Scale Score", - "type": "boolean" - }, - "similarity_function": { - "default": "dot_product", - "title": "Similarity Function", - "type": "string" - }, - "top_k": { - "default": 10, - "title": "Top K", - "type": "integer" - }, - "use_auth_token": { - "anyOf": [ - { - "type": "boolean" - }, - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Use Auth Token" - } - }, - "required": [ - "document_store", - "query_embedding_model", - "document_embedding_models" - ], - "title": "Parameters", - "type": "object" - }, - "type": { - "const": "MultiModalRetriever", - "description": "Haystack Class name for the component.", - "title": "Type", - "type": "string" - } - }, - "required": [ - "type", - "name" - ], - "type": "object" - }, - "MultihopEmbeddingRetrieverComponent": { - "additionalProperties": false, - "properties": { - "name": { - "description": "Custom name for the component. Helpful for visualization and debugging.", - "title": "Name", - "type": "string" - }, - "params": { - "additionalProperties": false, - "description": "Each parameter can reference other components defined in the same YAML file.", - "properties": { - "batch_size": { - "default": 32, - "title": "Batch Size", - "type": "integer" - }, - "devices": { - "anyOf": [ - { - "items": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "string" - } - ] - }, - "type": "array" - }, - { - "type": "null" - } - ], - "title": "Devices" - }, - "document_store": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "default": null, - "title": "Document Store" - }, - "emb_extraction_layer": { - "default": -1, - "title": "Emb Extraction Layer", - "type": "integer" - }, - "embed_meta_fields": { - "default": [], - "items": { - "type": "string" - }, - "title": "Embed Meta Fields", - "type": "array" - }, - "embedding_model": { - "title": "Embedding Model", - "type": "string" - }, - "max_seq_len": { - "default": 512, - "title": "Max Seq Len", - "type": "integer" - }, - "model_format": { - "default": "farm", - "title": "Model Format", - "type": "string" - }, - "model_version": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Model Version" - }, - "num_iterations": { - "default": 2, - "title": "Num Iterations", - "type": "integer" - }, - "pooling_strategy": { - "default": "reduce_mean", - "title": "Pooling Strategy", - "type": "string" - }, - "progress_bar": { - "default": true, - "title": "Progress Bar", - "type": "boolean" - }, - "scale_score": { - "default": true, - "title": "Scale Score", - "type": "boolean" - }, - "top_k": { - "default": 10, - "title": "Top K", - "type": "integer" - }, - "use_auth_token": { - "anyOf": [ - { - "type": "boolean" - }, - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Use Auth Token" - }, - "use_gpu": { - "default": true, - "title": "Use Gpu", - "type": "boolean" - } - }, - "required": [ - "embedding_model" - ], - "title": "Parameters", - "type": "object" - }, - "type": { - "const": "MultihopEmbeddingRetriever", - "description": "Haystack Class name for the component.", - "title": "Type", - "type": "string" - } - }, - "required": [ - "type", - "name" - ], - "type": "object" - }, - "OpenAIAnswerGeneratorComponent": { - "additionalProperties": false, - "properties": { - "name": { - "description": "Custom name for the component. Helpful for visualization and debugging.", - "title": "Name", - "type": "string" - }, - "params": { - "additionalProperties": false, - "description": "Each parameter can reference other components defined in the same YAML file.", - "properties": { - "api_key": { - "title": "Api Key", - "type": "string" - }, - "examples": { - "anyOf": [ - { - "items": {}, - "type": "array" - }, - { - "type": "null" - } - ], - "title": "Examples" - }, - "examples_context": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Examples Context" - }, - "frequency_penalty": { - "default": -2.0, - "title": "Frequency Penalty", - "type": "number" - }, - "max_tokens": { - "default": 13, - "title": "Max Tokens", - "type": "integer" - }, - "model": { - "default": "text-curie-001", - "title": "Model", - "type": "string" - }, - "presence_penalty": { - "default": -2.0, - "title": "Presence Penalty", - "type": "number" - }, - "progress_bar": { - "default": true, - "title": "Progress Bar", - "type": "boolean" - }, - "stop_words": { - "anyOf": [ - { - "items": {}, - "type": "array" - }, - { - "type": "null" - } - ], - "title": "Stop Words" - }, - "temperature": { - "default": 0.2, - "title": "Temperature", - "type": "number" - }, - "top_k": { - "default": 5, - "title": "Top K", - "type": "integer" - } - }, - "required": [ - "api_key" - ], - "title": "Parameters", - "type": "object" - }, - "type": { - "const": "OpenAIAnswerGenerator", - "description": "Haystack Class name for the component.", - "title": "Type", - "type": "string" - } - }, - "required": [ - "type", - "name" - ], - "type": "object" - }, - "OpenDistroElasticsearchDocumentStoreComponent": { - "additionalProperties": false, - "properties": { - "name": { - "description": "Custom name for the component. Helpful for visualization and debugging.", - "title": "Name", - "type": "string" - }, - "params": { - "additionalProperties": false, - "description": "Each parameter can reference other components defined in the same YAML file.", - "properties": { - "analyzer": { - "default": "standard", - "title": "Analyzer", - "type": "string" - }, - "api_key": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Api Key" - }, - "api_key_id": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Api Key Id" - }, - "aws4auth": { - "title": "Aws4Auth" - }, - "ca_certs": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Ca Certs" - }, - "content_field": { - "default": "content", - "title": "Content Field", - "type": "string" - }, - "create_index": { - "default": true, - "title": "Create Index", - "type": "boolean" - }, - "custom_mapping": { - "anyOf": [ - { - "type": "object" - }, - { - "type": "null" - } - ], - "title": "Custom Mapping" - }, - "duplicate_documents": { - "default": "overwrite", - "title": "Duplicate Documents", - "type": "string" - }, - "embedding_dim": { - "default": 768, - "title": "Embedding Dim", - "type": "integer" - }, - "embedding_field": { - "default": "embedding", - "title": "Embedding Field", - "type": "string" - }, - "excluded_meta_data": { - "anyOf": [ - { - "items": {}, - "type": "array" - }, - { - "type": "null" - } - ], - "title": "Excluded Meta Data" - }, - "host": { - "anyOf": [ - { - "type": "string" - }, - { - "items": { - "type": "string" - }, - "type": "array" - } - ], - "default": "localhost", - "title": "Host" - }, - "index": { - "default": "document", - "title": "Index", - "type": "string" - }, - "index_type": { - "default": "flat", - "title": "Index Type", - "type": "string" - }, - "label_index": { - "default": "label", - "title": "Label Index", - "type": "string" - }, - "name_field": { - "default": "name", - "title": "Name Field", - "type": "string" - }, - "password": { - "default": "admin", - "title": "Password", - "type": "string" - }, - "port": { - "anyOf": [ - { - "type": "integer" - }, - { - "items": { - "type": "integer" - }, - "type": "array" - } - ], - "default": 9200, - "title": "Port" - }, - "recreate_index": { - "default": false, - "title": "Recreate Index", - "type": "boolean" - }, - "refresh_type": { - "default": "wait_for", - "title": "Refresh Type", - "type": "string" - }, - "return_embedding": { - "default": false, - "title": "Return Embedding", - "type": "boolean" - }, - "scheme": { - "default": "https", - "title": "Scheme", - "type": "string" - }, - "scroll": { - "default": "1d", - "title": "Scroll", - "type": "string" - }, - "search_fields": { - "anyOf": [ - { - "type": "string" - }, - { - "items": {}, - "type": "array" - } - ], - "default": "content", - "title": "Search Fields" - }, - "similarity": { - "default": "cosine", - "title": "Similarity", - "type": "string" - }, - "skip_missing_embeddings": { - "default": true, - "title": "Skip Missing Embeddings", - "type": "boolean" - }, - "synonym_type": { - "default": "synonym", - "title": "Synonym Type", - "type": "string" - }, - "synonyms": { - "anyOf": [ - { - "items": {}, - "type": "array" - }, - { - "type": "null" - } - ], - "title": "Synonyms" - }, - "timeout": { - "default": 30, - "title": "Timeout", - "type": "integer" - }, - "use_system_proxy": { - "default": false, - "title": "Use System Proxy", - "type": "boolean" - }, - "username": { - "default": "admin", - "title": "Username", - "type": "string" - }, - "verify_certs": { - "default": false, - "title": "Verify Certs", - "type": "boolean" - } - }, - "title": "Parameters", - "type": "object" - }, - "type": { - "const": "OpenDistroElasticsearchDocumentStore", - "description": "Haystack Class name for the component.", - "title": "Type", - "type": "string" - } - }, - "required": [ - "type", - "name" - ], - "type": "object" - }, - "OpenSearchDocumentStoreComponent": { - "additionalProperties": false, - "properties": { - "name": { - "description": "Custom name for the component. Helpful for visualization and debugging.", - "title": "Name", - "type": "string" - }, - "params": { - "additionalProperties": false, - "description": "Each parameter can reference other components defined in the same YAML file.", - "properties": { - "analyzer": { - "default": "standard", - "title": "Analyzer", - "type": "string" - }, - "api_key": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Api Key" - }, - "api_key_id": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Api Key Id" - }, - "aws4auth": { - "title": "Aws4Auth" - }, - "ca_certs": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Ca Certs" - }, - "content_field": { - "default": "content", - "title": "Content Field", - "type": "string" - }, - "create_index": { - "default": true, - "title": "Create Index", - "type": "boolean" - }, - "custom_mapping": { - "anyOf": [ - { - "type": "object" - }, - { - "type": "null" - } - ], - "title": "Custom Mapping" - }, - "duplicate_documents": { - "default": "overwrite", - "title": "Duplicate Documents", - "type": "string" - }, - "embedding_dim": { - "default": 768, - "title": "Embedding Dim", - "type": "integer" - }, - "embedding_field": { - "default": "embedding", - "title": "Embedding Field", - "type": "string" - }, - "excluded_meta_data": { - "anyOf": [ - { - "items": {}, - "type": "array" - }, - { - "type": "null" - } - ], - "title": "Excluded Meta Data" - }, - "host": { - "anyOf": [ - { - "type": "string" - }, - { - "items": { - "type": "string" - }, - "type": "array" - } - ], - "default": "localhost", - "title": "Host" - }, - "index": { - "default": "document", - "title": "Index", - "type": "string" - }, - "index_type": { - "default": "flat", - "title": "Index Type", - "type": "string" - }, - "knn_engine": { - "default": "nmslib", - "title": "Knn Engine", - "type": "string" - }, - "label_index": { - "default": "label", - "title": "Label Index", - "type": "string" - }, - "name_field": { - "default": "name", - "title": "Name Field", - "type": "string" - }, - "password": { - "default": "admin", - "title": "Password", - "type": "string" - }, - "port": { - "anyOf": [ - { - "type": "integer" - }, - { - "items": { - "type": "integer" - }, - "type": "array" - } - ], - "default": 9200, - "title": "Port" - }, - "recreate_index": { - "default": false, - "title": "Recreate Index", - "type": "boolean" - }, - "refresh_type": { - "default": "wait_for", - "title": "Refresh Type", - "type": "string" - }, - "return_embedding": { - "default": false, - "title": "Return Embedding", - "type": "boolean" - }, - "scheme": { - "default": "https", - "title": "Scheme", - "type": "string" - }, - "scroll": { - "default": "1d", - "title": "Scroll", - "type": "string" - }, - "search_fields": { - "anyOf": [ - { - "type": "string" - }, - { - "items": {}, - "type": "array" - } - ], - "default": "content", - "title": "Search Fields" - }, - "similarity": { - "default": "dot_product", - "title": "Similarity", - "type": "string" - }, - "skip_missing_embeddings": { - "default": true, - "title": "Skip Missing Embeddings", - "type": "boolean" - }, - "synonym_type": { - "default": "synonym", - "title": "Synonym Type", - "type": "string" - }, - "synonyms": { - "anyOf": [ - { - "items": {}, - "type": "array" - }, - { - "type": "null" - } - ], - "title": "Synonyms" - }, - "timeout": { - "default": 30, - "title": "Timeout", - "type": "integer" - }, - "use_system_proxy": { - "default": false, - "title": "Use System Proxy", - "type": "boolean" - }, - "username": { - "default": "admin", - "title": "Username", - "type": "string" - }, - "verify_certs": { - "default": false, - "title": "Verify Certs", - "type": "boolean" - } - }, - "title": "Parameters", - "type": "object" - }, - "type": { - "const": "OpenSearchDocumentStore", - "description": "Haystack Class name for the component.", - "title": "Type", - "type": "string" - } - }, - "required": [ - "type", - "name" - ], - "type": "object" - }, - "PDFToTextConverterComponent": { - "additionalProperties": false, - "properties": { - "name": { - "description": "Custom name for the component. Helpful for visualization and debugging.", - "title": "Name", - "type": "string" - }, - "params": { - "additionalProperties": false, - "description": "Each parameter can reference other components defined in the same YAML file.", - "properties": { - "encoding": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "default": "UTF-8", - "title": "Encoding" - }, - "id_hash_keys": { - "anyOf": [ - { - "items": { - "type": "string" - }, - "type": "array" - }, - { - "type": "null" - } - ], - "title": "Id Hash Keys" - }, - "keep_physical_layout": { - "default": false, - "title": "Keep Physical Layout", - "type": "boolean" - }, - "remove_numeric_tables": { - "default": false, - "title": "Remove Numeric Tables", - "type": "boolean" - }, - "valid_languages": { - "anyOf": [ - { - "items": { - "type": "string" - }, - "type": "array" - }, - { - "type": "null" - } - ], - "title": "Valid Languages" - } - }, - "title": "Parameters", - "type": "object" - }, - "type": { - "const": "PDFToTextConverter", - "description": "Haystack Class name for the component.", - "title": "Type", - "type": "string" - } - }, - "required": [ - "type", - "name" - ], - "type": "object" - }, - "PDFToTextOCRConverterComponent": { - "additionalProperties": false, - "properties": { - "name": { - "description": "Custom name for the component. Helpful for visualization and debugging.", - "title": "Name", - "type": "string" - }, - "params": { - "additionalProperties": false, - "description": "Each parameter can reference other components defined in the same YAML file.", - "properties": { - "id_hash_keys": { - "anyOf": [ - { - "items": { - "type": "string" - }, - "type": "array" - }, - { - "type": "null" - } - ], - "title": "Id Hash Keys" - }, - "remove_numeric_tables": { - "default": false, - "title": "Remove Numeric Tables", - "type": "boolean" - }, - "valid_languages": { - "anyOf": [ - { - "items": { - "type": "string" - }, - "type": "array" - }, - { - "type": "null" - } - ], - "default": [ - "eng" - ], - "title": "Valid Languages" - } - }, - "title": "Parameters", - "type": "object" - }, - "type": { - "const": "PDFToTextOCRConverter", - "description": "Haystack Class name for the component.", - "title": "Type", - "type": "string" - } - }, - "required": [ - "type", - "name" - ], - "type": "object" - }, - "ParsrConverterComponent": { - "additionalProperties": false, - "properties": { - "name": { - "description": "Custom name for the component. Helpful for visualization and debugging.", - "title": "Name", - "type": "string" - }, - "params": { - "additionalProperties": false, - "description": "Each parameter can reference other components defined in the same YAML file.", - "properties": { - "add_page_number": { - "default": true, - "title": "Add Page Number", - "type": "boolean" - }, - "extractor": { - "default": "pdfminer", - "enum": [ - "pdfminer", - "pdfjs" - ], - "title": "Extractor", - "type": "string" - }, - "following_context_len": { - "default": 3, - "title": "Following Context Len", - "type": "integer" - }, - "id_hash_keys": { - "anyOf": [ - { - "items": { - "type": "string" - }, - "type": "array" - }, - { - "type": "null" - } - ], - "title": "Id Hash Keys" - }, - "parsr_url": { - "default": "http://localhost:3001", - "title": "Parsr Url", - "type": "string" - }, - "preceding_context_len": { - "default": 3, - "title": "Preceding Context Len", - "type": "integer" - }, - "remove_page_footers": { - "default": false, - "title": "Remove Page Footers", - "type": "boolean" - }, - "remove_page_headers": { - "default": false, - "title": "Remove Page Headers", - "type": "boolean" - }, - "remove_table_of_contents": { - "default": false, - "title": "Remove Table Of Contents", - "type": "boolean" - }, - "table_detection_mode": { - "default": "lattice", - "enum": [ - "lattice", - "stream" - ], - "title": "Table Detection Mode", - "type": "string" - }, - "valid_languages": { - "anyOf": [ - { - "items": { - "type": "string" - }, - "type": "array" - }, - { - "type": "null" - } - ], - "title": "Valid Languages" - } - }, - "title": "Parameters", - "type": "object" - }, - "type": { - "const": "ParsrConverter", - "description": "Haystack Class name for the component.", - "title": "Type", - "type": "string" - } - }, - "required": [ - "type", - "name" - ], - "type": "object" - }, - "PineconeDocumentStoreComponent": { - "additionalProperties": false, - "properties": { - "name": { - "description": "Custom name for the component. Helpful for visualization and debugging.", - "title": "Name", - "type": "string" - }, - "params": { - "additionalProperties": false, - "description": "Each parameter can reference other components defined in the same YAML file.", - "properties": { - "api_key": { - "title": "Api Key", - "type": "string" - }, - "duplicate_documents": { - "default": "overwrite", - "title": "Duplicate Documents", - "type": "string" - }, - "embedding_dim": { - "default": 768, - "title": "Embedding Dim", - "type": "integer" - }, - "embedding_field": { - "default": "embedding", - "title": "Embedding Field", - "type": "string" - }, - "environment": { - "default": "us-west1-gcp", - "title": "Environment", - "type": "string" - }, - "index": { - "default": "document", - "title": "Index", - "type": "string" - }, - "metadata_config": { - "default": { - "indexed": [] - }, - "title": "Metadata Config", - "type": "object" - }, - "pinecone_index": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "default": null, - "title": "Pinecone Index" - }, - "progress_bar": { - "default": true, - "title": "Progress Bar", - "type": "boolean" - }, - "recreate_index": { - "default": false, - "title": "Recreate Index", - "type": "boolean" - }, - "replicas": { - "default": 1, - "title": "Replicas", - "type": "integer" - }, - "return_embedding": { - "default": false, - "title": "Return Embedding", - "type": "boolean" - }, - "shards": { - "default": 1, - "title": "Shards", - "type": "integer" - }, - "similarity": { - "default": "cosine", - "title": "Similarity", - "type": "string" - }, - "validate_index_sync": { - "default": true, - "title": "Validate Index Sync", - "type": "boolean" - } - }, - "required": [ - "api_key" - ], - "title": "Parameters", - "type": "object" - }, - "type": { - "const": "PineconeDocumentStore", - "description": "Haystack Class name for the component.", - "title": "Type", - "type": "string" - } - }, - "required": [ - "type", - "name" - ], - "type": "object" - }, - "PreProcessorComponent": { - "additionalProperties": false, - "properties": { - "name": { - "description": "Custom name for the component. Helpful for visualization and debugging.", - "title": "Name", - "type": "string" - }, - "params": { - "additionalProperties": false, - "description": "Each parameter can reference other components defined in the same YAML file.", - "properties": { - "add_page_number": { - "default": false, - "title": "Add Page Number", - "type": "boolean" - }, - "clean_empty_lines": { - "default": true, - "title": "Clean Empty Lines", - "type": "boolean" - }, - "clean_header_footer": { - "default": false, - "title": "Clean Header Footer", - "type": "boolean" - }, - "clean_whitespace": { - "default": true, - "title": "Clean Whitespace", - "type": "boolean" - }, - "id_hash_keys": { - "anyOf": [ - { - "items": { - "type": "string" - }, - "type": "array" - }, - { - "type": "null" - } - ], - "title": "Id Hash Keys" - }, - "language": { - "default": "en", - "title": "Language", - "type": "string" - }, - "progress_bar": { - "default": true, - "title": "Progress Bar", - "type": "boolean" - }, - "remove_substrings": { - "default": [], - "items": { - "type": "string" - }, - "title": "Remove Substrings", - "type": "array" - }, - "split_by": { - "default": "word", - "enum": [ - "word", - "sentence", - "passage" - ], - "title": "Split By", - "type": "string" - }, - "split_length": { - "default": 200, - "title": "Split Length", - "type": "integer" - }, - "split_overlap": { - "default": 0, - "title": "Split Overlap", - "type": "integer" - }, - "split_respect_sentence_boundary": { - "default": true, - "title": "Split Respect Sentence Boundary", - "type": "boolean" - }, - "tokenizer_model_folder": { - "anyOf": [ - { - "type": "string" - }, - { - "format": "path", - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Tokenizer Model Folder" - } - }, - "title": "Parameters", - "type": "object" - }, - "type": { - "const": "PreProcessor", - "description": "Haystack Class name for the component.", - "title": "Type", - "type": "string" - } - }, - "required": [ - "type", - "name" - ], - "type": "object" - }, - "PseudoLabelGeneratorComponent": { - "additionalProperties": false, - "properties": { - "name": { - "description": "Custom name for the component. Helpful for visualization and debugging.", - "title": "Name", - "type": "string" - }, - "params": { - "additionalProperties": false, - "description": "Each parameter can reference other components defined in the same YAML file.", - "properties": { - "batch_size": { - "default": 16, - "title": "Batch Size", - "type": "integer" - }, - "cross_encoder_model_name_or_path": { - "default": "cross-encoder/ms-marco-MiniLM-L-6-v2", - "title": "Cross Encoder Model Name Or Path", - "type": "string" - }, - "devices": { - "anyOf": [ - { - "items": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "string" - } - ] - }, - "type": "array" - }, - { - "type": "null" - } - ], - "title": "Devices" - }, - "max_questions_per_document": { - "default": 3, - "title": "Max Questions Per Document", - "type": "integer" - }, - "progress_bar": { - "default": true, - "title": "Progress Bar", - "type": "boolean" - }, - "question_producer": { - "anyOf": [ - { - "type": "string" - }, - { - "items": { - "additionalProperties": { - "type": "string" - }, - "type": "object" - }, - "type": "array" - } - ], - "title": "Question Producer" - }, - "retriever": { - "title": "Retriever", - "type": "string" - }, - "top_k": { - "default": 50, - "title": "Top K", - "type": "integer" - }, - "use_auth_token": { - "anyOf": [ - { - "type": "boolean" - }, - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Use Auth Token" - }, - "use_gpu": { - "default": true, - "title": "Use Gpu", - "type": "boolean" - } - }, - "required": [ - "question_producer", - "retriever" - ], - "title": "Parameters", - "type": "object" - }, - "type": { - "const": "PseudoLabelGenerator", - "description": "Haystack Class name for the component.", - "title": "Type", - "type": "string" - } - }, - "required": [ - "type", - "name" - ], - "type": "object" - }, - "QuestionGeneratorComponent": { - "additionalProperties": false, - "properties": { - "name": { - "description": "Custom name for the component. Helpful for visualization and debugging.", - "title": "Name", - "type": "string" - }, - "params": { - "additionalProperties": false, - "description": "Each parameter can reference other components defined in the same YAML file.", - "properties": { - "batch_size": { - "default": 16, - "title": "Batch Size", - "type": "integer" - }, - "devices": { - "anyOf": [ - { - "items": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "string" - } - ] - }, - "type": "array" - }, - { - "type": "null" - } - ], - "title": "Devices" - }, - "early_stopping": { - "default": true, - "title": "Early Stopping", - "type": "boolean" - }, - "length_penalty": { - "default": 1.5, - "title": "Length Penalty", - "type": "number" - }, - "max_length": { - "default": 256, - "title": "Max Length", - "type": "integer" - }, - "model_name_or_path": { - "default": "valhalla/t5-base-e2e-qg", - "title": "Model Name Or Path", - "type": "string" - }, - "model_version": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Model Version" - }, - "no_repeat_ngram_size": { - "default": 3, - "title": "No Repeat Ngram Size", - "type": "integer" - }, - "num_beams": { - "default": 4, - "title": "Num Beams", - "type": "integer" - }, - "num_queries_per_doc": { - "default": 1, - "title": "Num Queries Per Doc", - "type": "integer" - }, - "progress_bar": { - "default": true, - "title": "Progress Bar", - "type": "boolean" - }, - "prompt": { - "default": "generate questions:", - "title": "Prompt", - "type": "string" - }, - "sep_token": { - "default": "", - "title": "Sep Token", - "type": "string" - }, - "split_length": { - "default": 50, - "title": "Split Length", - "type": "integer" - }, - "split_overlap": { - "default": 10, - "title": "Split Overlap", - "type": "integer" - }, - "use_auth_token": { - "anyOf": [ - { - "type": "boolean" - }, - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Use Auth Token" - }, - "use_gpu": { - "default": true, - "title": "Use Gpu", - "type": "boolean" - } - }, - "title": "Parameters", - "type": "object" - }, - "type": { - "const": "QuestionGenerator", - "description": "Haystack Class name for the component.", - "title": "Type", - "type": "string" - } - }, - "required": [ - "type", - "name" - ], - "type": "object" - }, - "RAGeneratorComponent": { - "additionalProperties": false, - "properties": { - "name": { - "description": "Custom name for the component. Helpful for visualization and debugging.", - "title": "Name", - "type": "string" - }, - "params": { - "additionalProperties": false, - "description": "Each parameter can reference other components defined in the same YAML file.", - "properties": { - "devices": { - "anyOf": [ - { - "items": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "string" - } - ] - }, - "type": "array" - }, - { - "type": "null" - } - ], - "title": "Devices" - }, - "embed_title": { - "default": true, - "title": "Embed Title", - "type": "boolean" - }, - "generator_type": { - "default": "token", - "title": "Generator Type", - "type": "string" - }, - "max_length": { - "default": 200, - "title": "Max Length", - "type": "integer" - }, - "min_length": { - "default": 2, - "title": "Min Length", - "type": "integer" - }, - "model_name_or_path": { - "default": "facebook/rag-token-nq", - "title": "Model Name Or Path", - "type": "string" - }, - "model_version": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Model Version" - }, - "num_beams": { - "default": 2, - "title": "Num Beams", - "type": "integer" - }, - "prefix": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Prefix" - }, - "progress_bar": { - "default": true, - "title": "Progress Bar", - "type": "boolean" - }, - "retriever": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "default": null, - "title": "Retriever" - }, - "top_k": { - "default": 2, - "title": "Top K", - "type": "integer" - }, - "use_auth_token": { - "anyOf": [ - { - "type": "boolean" - }, - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Use Auth Token" - }, - "use_gpu": { - "default": true, - "title": "Use Gpu", - "type": "boolean" - } - }, - "title": "Parameters", - "type": "object" - }, - "type": { - "const": "RAGenerator", - "description": "Haystack Class name for the component.", - "title": "Type", - "type": "string" - } - }, - "required": [ - "type", - "name" - ], - "type": "object" - }, - "RCIReaderComponent": { - "additionalProperties": false, - "properties": { - "name": { - "description": "Custom name for the component. Helpful for visualization and debugging.", - "title": "Name", - "type": "string" - }, - "params": { - "additionalProperties": false, - "description": "Each parameter can reference other components defined in the same YAML file.", - "properties": { - "column_model_name_or_path": { - "default": "michaelrglass/albert-base-rci-wikisql-col", - "title": "Column Model Name Or Path", - "type": "string" - }, - "column_model_version": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Column Model Version" - }, - "column_tokenizer": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Column Tokenizer" - }, - "max_seq_len": { - "default": 256, - "title": "Max Seq Len", - "type": "integer" - }, - "row_model_name_or_path": { - "default": "michaelrglass/albert-base-rci-wikisql-row", - "title": "Row Model Name Or Path", - "type": "string" - }, - "row_model_version": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Row Model Version" - }, - "row_tokenizer": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Row Tokenizer" - }, - "top_k": { - "default": 10, - "title": "Top K", - "type": "integer" - }, - "use_auth_token": { - "anyOf": [ - { - "type": "boolean" - }, - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Use Auth Token" - }, - "use_gpu": { - "default": true, - "title": "Use Gpu", - "type": "boolean" - } - }, - "title": "Parameters", - "type": "object" - }, - "type": { - "const": "RCIReader", - "description": "Haystack Class name for the component.", - "title": "Type", - "type": "string" - } - }, - "required": [ - "type", - "name" - ], - "type": "object" - }, - "RouteDocumentsComponent": { - "additionalProperties": false, - "properties": { - "name": { - "description": "Custom name for the component. Helpful for visualization and debugging.", - "title": "Name", - "type": "string" - }, - "params": { - "additionalProperties": false, - "description": "Each parameter can reference other components defined in the same YAML file.", - "properties": { - "metadata_values": { - "anyOf": [ - { - "items": { - "type": "string" - }, - "type": "array" - }, - { - "type": "null" - } - ], - "title": "Metadata Values" - }, - "split_by": { - "default": "content_type", - "title": "Split By", - "type": "string" - } - }, - "title": "Parameters", - "type": "object" - }, - "type": { - "const": "RouteDocuments", - "description": "Haystack Class name for the component.", - "title": "Type", - "type": "string" - } - }, - "required": [ - "type", - "name" - ], - "type": "object" - }, - "SQLDocumentStoreComponent": { - "additionalProperties": false, - "properties": { - "name": { - "description": "Custom name for the component. Helpful for visualization and debugging.", - "title": "Name", - "type": "string" - }, - "params": { - "additionalProperties": false, - "description": "Each parameter can reference other components defined in the same YAML file.", - "properties": { - "check_same_thread": { - "default": false, - "title": "Check Same Thread", - "type": "boolean" - }, - "duplicate_documents": { - "default": "overwrite", - "title": "Duplicate Documents", - "type": "string" - }, - "index": { - "default": "document", - "title": "Index", - "type": "string" - }, - "isolation_level": { - "title": "Isolation Level", - "type": "string" - }, - "label_index": { - "default": "label", - "title": "Label Index", - "type": "string" - }, - "url": { - "default": "sqlite://", - "title": "Url", - "type": "string" - } - }, - "title": "Parameters", - "type": "object" - }, - "type": { - "const": "SQLDocumentStore", - "description": "Haystack Class name for the component.", - "title": "Type", - "type": "string" - } - }, - "required": [ - "type", - "name" - ], - "type": "object" - }, - "SentenceTransformersRankerComponent": { - "additionalProperties": false, - "properties": { - "name": { - "description": "Custom name for the component. Helpful for visualization and debugging.", - "title": "Name", - "type": "string" - }, - "params": { - "additionalProperties": false, - "description": "Each parameter can reference other components defined in the same YAML file.", - "properties": { - "batch_size": { - "default": 16, - "title": "Batch Size", - "type": "integer" - }, - "devices": { - "anyOf": [ - { - "items": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "string" - } - ] - }, - "type": "array" - }, - { - "type": "null" - } - ], - "title": "Devices" - }, - "model_name_or_path": { - "anyOf": [ - { - "type": "string" - }, - { - "format": "path", - "type": "string" - } - ], - "title": "Model Name Or Path" - }, - "model_version": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Model Version" - }, - "progress_bar": { - "default": true, - "title": "Progress Bar", - "type": "boolean" - }, - "scale_score": { - "default": true, - "title": "Scale Score", - "type": "boolean" - }, - "top_k": { - "default": 10, - "title": "Top K", - "type": "integer" - }, - "use_auth_token": { - "anyOf": [ - { - "type": "boolean" - }, - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Use Auth Token" - }, - "use_gpu": { - "default": true, - "title": "Use Gpu", - "type": "boolean" - } - }, - "required": [ - "model_name_or_path" - ], - "title": "Parameters", - "type": "object" - }, - "type": { - "const": "SentenceTransformersRanker", - "description": "Haystack Class name for the component.", - "title": "Type", - "type": "string" - } - }, - "required": [ - "type", - "name" - ], - "type": "object" - }, - "Seq2SeqGeneratorComponent": { - "additionalProperties": false, - "properties": { - "name": { - "description": "Custom name for the component. Helpful for visualization and debugging.", - "title": "Name", - "type": "string" - }, - "params": { - "additionalProperties": false, - "description": "Each parameter can reference other components defined in the same YAML file.", - "properties": { - "devices": { - "anyOf": [ - { - "items": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "string" - } - ] - }, - "type": "array" - }, - { - "type": "null" - } - ], - "title": "Devices" - }, - "input_converter": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "default": null, - "title": "Input Converter" - }, - "max_length": { - "default": 200, - "title": "Max Length", - "type": "integer" - }, - "min_length": { - "default": 2, - "title": "Min Length", - "type": "integer" - }, - "model_name_or_path": { - "title": "Model Name Or Path", - "type": "string" - }, - "num_beams": { - "default": 8, - "title": "Num Beams", - "type": "integer" - }, - "progress_bar": { - "default": true, - "title": "Progress Bar", - "type": "boolean" - }, - "top_k": { - "default": 1, - "title": "Top K", - "type": "integer" - }, - "use_auth_token": { - "anyOf": [ - { - "type": "boolean" - }, - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Use Auth Token" - }, - "use_gpu": { - "default": true, - "title": "Use Gpu", - "type": "boolean" - } - }, - "required": [ - "model_name_or_path" - ], - "title": "Parameters", - "type": "object" - }, - "type": { - "const": "Seq2SeqGenerator", - "description": "Haystack Class name for the component.", - "title": "Type", - "type": "string" - } - }, - "required": [ - "type", - "name" - ], - "type": "object" - }, - "SklearnQueryClassifierComponent": { - "additionalProperties": false, - "properties": { - "name": { - "description": "Custom name for the component. Helpful for visualization and debugging.", - "title": "Name", - "type": "string" - }, - "params": { - "additionalProperties": false, - "description": "Each parameter can reference other components defined in the same YAML file.", - "properties": { - "batch_size": { - "anyOf": [ - { - "type": "integer" - }, - { - "type": "null" - } - ], - "title": "Batch Size" - }, - "model_name_or_path": { - "anyOf": [ - { - "type": "string" - }, - {} - ], - "default": "https://ext-models-haystack.s3.eu-central-1.amazonaws.com/gradboost_query_classifier/model.pickle", - "title": "Model Name Or Path" - }, - "progress_bar": { - "default": true, - "title": "Progress Bar", - "type": "boolean" - }, - "vectorizer_name_or_path": { - "anyOf": [ - { - "type": "string" - }, - {} - ], - "default": "https://ext-models-haystack.s3.eu-central-1.amazonaws.com/gradboost_query_classifier/vectorizer.pickle", - "title": "Vectorizer Name Or Path" - } - }, - "title": "Parameters", - "type": "object" - }, - "type": { - "const": "SklearnQueryClassifier", - "description": "Haystack Class name for the component.", - "title": "Type", - "type": "string" - } - }, - "required": [ - "type", - "name" - ], - "type": "object" - }, - "TableReaderComponent": { - "additionalProperties": false, - "properties": { - "name": { - "description": "Custom name for the component. Helpful for visualization and debugging.", - "title": "Name", - "type": "string" - }, - "params": { - "additionalProperties": false, - "description": "Each parameter can reference other components defined in the same YAML file.", - "properties": { - "devices": { - "anyOf": [ - { - "items": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "string" - } - ] - }, - "type": "array" - }, - { - "type": "null" - } - ], - "title": "Devices" - }, - "max_seq_len": { - "default": 256, - "title": "Max Seq Len", - "type": "integer" - }, - "model_name_or_path": { - "default": "google/tapas-base-finetuned-wtq", - "title": "Model Name Or Path", - "type": "string" - }, - "model_version": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Model Version" - }, - "return_no_answer": { - "default": false, - "title": "Return No Answer", - "type": "boolean" - }, - "tokenizer": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Tokenizer" - }, - "top_k": { - "default": 10, - "title": "Top K", - "type": "integer" - }, - "top_k_per_candidate": { - "default": 3, - "title": "Top K Per Candidate", - "type": "integer" - }, - "use_auth_token": { - "anyOf": [ - { - "type": "boolean" - }, - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Use Auth Token" - }, - "use_gpu": { - "default": true, - "title": "Use Gpu", - "type": "boolean" - } - }, - "title": "Parameters", - "type": "object" - }, - "type": { - "const": "TableReader", - "description": "Haystack Class name for the component.", - "title": "Type", - "type": "string" - } - }, - "required": [ - "type", - "name" - ], - "type": "object" - }, - "TableTextRetrieverComponent": { - "additionalProperties": false, - "properties": { - "name": { - "description": "Custom name for the component. Helpful for visualization and debugging.", - "title": "Name", - "type": "string" - }, - "params": { - "additionalProperties": false, - "description": "Each parameter can reference other components defined in the same YAML file.", - "properties": { - "batch_size": { - "default": 16, - "title": "Batch Size", - "type": "integer" - }, - "devices": { - "anyOf": [ - { - "items": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "string" - } - ] - }, - "type": "array" - }, - { - "type": "null" - } - ], - "title": "Devices" - }, - "document_store": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "default": null, - "title": "Document Store" - }, - "embed_meta_fields": { - "default": [ - "name", - "section_title", - "caption" - ], - "items": { - "type": "string" - }, - "title": "Embed Meta Fields", - "type": "array" - }, - "global_loss_buffer_size": { - "default": 150000, - "title": "Global Loss Buffer Size", - "type": "integer" - }, - "max_seq_len_passage": { - "default": 256, - "title": "Max Seq Len Passage", - "type": "integer" - }, - "max_seq_len_query": { - "default": 64, - "title": "Max Seq Len Query", - "type": "integer" - }, - "max_seq_len_table": { - "default": 256, - "title": "Max Seq Len Table", - "type": "integer" - }, - "model_version": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Model Version" - }, - "passage_embedding_model": { - "anyOf": [ - { - "format": "path", - "type": "string" - }, - { - "type": "string" - } - ], - "default": "deepset/bert-small-mm_retrieval-passage_encoder", - "title": "Passage Embedding Model" - }, - "progress_bar": { - "default": true, - "title": "Progress Bar", - "type": "boolean" - }, - "query_embedding_model": { - "anyOf": [ - { - "format": "path", - "type": "string" - }, - { - "type": "string" - } - ], - "default": "deepset/bert-small-mm_retrieval-question_encoder", - "title": "Query Embedding Model" - }, - "scale_score": { - "default": true, - "title": "Scale Score", - "type": "boolean" - }, - "similarity_function": { - "default": "dot_product", - "title": "Similarity Function", - "type": "string" - }, - "table_embedding_model": { - "anyOf": [ - { - "format": "path", - "type": "string" - }, - { - "type": "string" - } - ], - "default": "deepset/bert-small-mm_retrieval-table_encoder", - "title": "Table Embedding Model" - }, - "top_k": { - "default": 10, - "title": "Top K", - "type": "integer" - }, - "use_auth_token": { - "anyOf": [ - { - "type": "boolean" - }, - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Use Auth Token" - }, - "use_fast": { - "default": true, - "title": "Use Fast", - "type": "boolean" - }, - "use_fast_tokenizers": { - "default": true, - "title": "Use Fast Tokenizers", - "type": "boolean" - }, - "use_gpu": { - "default": true, - "title": "Use Gpu", - "type": "boolean" - } - }, - "title": "Parameters", - "type": "object" - }, - "type": { - "const": "TableTextRetriever", - "description": "Haystack Class name for the component.", - "title": "Type", - "type": "string" - } - }, - "required": [ - "type", - "name" - ], - "type": "object" - }, - "Text2SparqlRetrieverComponent": { - "additionalProperties": false, - "properties": { - "name": { - "description": "Custom name for the component. Helpful for visualization and debugging.", - "title": "Name", - "type": "string" - }, - "params": { - "additionalProperties": false, - "description": "Each parameter can reference other components defined in the same YAML file.", - "properties": { - "knowledge_graph": { - "title": "Knowledge Graph", - "type": "string" - }, - "model_name_or_path": { - "title": "Model Name Or Path", - "type": "string" - }, - "model_version": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Model Version" - }, - "top_k": { - "default": 1, - "title": "Top K", - "type": "integer" - }, - "use_auth_token": { - "anyOf": [ - { - "type": "boolean" - }, - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Use Auth Token" - } - }, - "required": [ - "knowledge_graph" - ], - "title": "Parameters", - "type": "object" - }, - "type": { - "const": "Text2SparqlRetriever", - "description": "Haystack Class name for the component.", - "title": "Type", - "type": "string" - } - }, - "required": [ - "type", - "name" - ], - "type": "object" - }, - "TextConverterComponent": { - "additionalProperties": false, - "properties": { - "name": { - "description": "Custom name for the component. Helpful for visualization and debugging.", - "title": "Name", - "type": "string" - }, - "params": { - "additionalProperties": false, - "description": "Each parameter can reference other components defined in the same YAML file.", - "properties": { - "id_hash_keys": { - "anyOf": [ - { - "items": { - "type": "string" - }, - "type": "array" - }, - { - "type": "null" - } - ], - "title": "Id Hash Keys" - }, - "progress_bar": { - "default": true, - "title": "Progress Bar", - "type": "boolean" - }, - "remove_numeric_tables": { - "default": false, - "title": "Remove Numeric Tables", - "type": "boolean" - }, - "valid_languages": { - "anyOf": [ - { - "items": { - "type": "string" - }, - "type": "array" - }, - { - "type": "null" - } - ], - "title": "Valid Languages" - } - }, - "title": "Parameters", - "type": "object" - }, - "type": { - "const": "TextConverter", - "description": "Haystack Class name for the component.", - "title": "Type", - "type": "string" - } - }, - "required": [ - "type", - "name" - ], - "type": "object" - }, - "TfidfRetrieverComponent": { - "additionalProperties": false, - "properties": { - "name": { - "description": "Custom name for the component. Helpful for visualization and debugging.", - "title": "Name", - "type": "string" - }, - "params": { - "additionalProperties": false, - "description": "Each parameter can reference other components defined in the same YAML file.", - "properties": { - "auto_fit": { - "default": true, - "title": "Auto Fit" - }, - "document_store": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "default": null, - "title": "Document Store" - }, - "top_k": { - "default": 10, - "title": "Top K", - "type": "integer" - } - }, - "title": "Parameters", - "type": "object" - }, - "type": { - "const": "TfidfRetriever", - "description": "Haystack Class name for the component.", - "title": "Type", - "type": "string" - } - }, - "required": [ - "type", - "name" - ], - "type": "object" - }, - "TikaConverterComponent": { - "additionalProperties": false, - "properties": { - "name": { - "description": "Custom name for the component. Helpful for visualization and debugging.", - "title": "Name", - "type": "string" - }, - "params": { - "additionalProperties": false, - "description": "Each parameter can reference other components defined in the same YAML file.", - "properties": { - "id_hash_keys": { - "anyOf": [ - { - "items": { - "type": "string" - }, - "type": "array" - }, - { - "type": "null" - } - ], - "title": "Id Hash Keys" - }, - "remove_numeric_tables": { - "default": false, - "title": "Remove Numeric Tables", - "type": "boolean" - }, - "tika_url": { - "default": "http://localhost:9998/tika", - "title": "Tika Url", - "type": "string" - }, - "valid_languages": { - "anyOf": [ - { - "items": { - "type": "string" - }, - "type": "array" - }, - { - "type": "null" - } - ], - "title": "Valid Languages" - } - }, - "title": "Parameters", - "type": "object" - }, - "type": { - "const": "TikaConverter", - "description": "Haystack Class name for the component.", - "title": "Type", - "type": "string" - } - }, - "required": [ - "type", - "name" - ], - "type": "object" - }, - "TransformersDocumentClassifierComponent": { - "additionalProperties": false, - "properties": { - "name": { - "description": "Custom name for the component. Helpful for visualization and debugging.", - "title": "Name", - "type": "string" - }, - "params": { - "additionalProperties": false, - "description": "Each parameter can reference other components defined in the same YAML file.", - "properties": { - "batch_size": { - "default": 16, - "title": "Batch Size", - "type": "integer" - }, - "classification_field": { - "title": "Classification Field", - "type": "string" - }, - "devices": { - "anyOf": [ - { - "items": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "string" - } - ] - }, - "type": "array" - }, - { - "type": "null" - } - ], - "title": "Devices" - }, - "labels": { - "anyOf": [ - { - "items": { - "type": "string" - }, - "type": "array" - }, - { - "type": "null" - } - ], - "title": "Labels" - }, - "model_name_or_path": { - "default": "bhadresh-savani/distilbert-base-uncased-emotion", - "title": "Model Name Or Path", - "type": "string" - }, - "model_version": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Model Version" - }, - "progress_bar": { - "default": true, - "title": "Progress Bar", - "type": "boolean" - }, - "task": { - "default": "text-classification", - "title": "Task", - "type": "string" - }, - "tokenizer": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Tokenizer" - }, - "top_k": { - "anyOf": [ - { - "type": "integer" - }, - { - "type": "null" - } - ], - "default": 1, - "title": "Top K" - }, - "use_auth_token": { - "anyOf": [ - { - "type": "boolean" - }, - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Use Auth Token" - }, - "use_gpu": { - "default": true, - "title": "Use Gpu", - "type": "boolean" - } - }, - "title": "Parameters", - "type": "object" - }, - "type": { - "const": "TransformersDocumentClassifier", - "description": "Haystack Class name for the component.", - "title": "Type", - "type": "string" - } - }, - "required": [ - "type", - "name" - ], - "type": "object" - }, - "TransformersQueryClassifierComponent": { - "additionalProperties": false, - "properties": { - "name": { - "description": "Custom name for the component. Helpful for visualization and debugging.", - "title": "Name", - "type": "string" - }, - "params": { - "additionalProperties": false, - "description": "Each parameter can reference other components defined in the same YAML file.", - "properties": { - "batch_size": { - "default": 16, - "title": "Batch Size", - "type": "integer" - }, - "devices": { - "anyOf": [ - { - "items": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "string" - } - ] - }, - "type": "array" - }, - { - "type": "null" - } - ], - "title": "Devices" - }, - "labels": { - "default": [ - "LABEL_1", - "LABEL_0" - ], - "items": { - "type": "string" - }, - "title": "Labels", - "type": "array" - }, - "model_name_or_path": { - "anyOf": [ - { - "format": "path", - "type": "string" - }, - { - "type": "string" - } - ], - "default": "shahrukhx01/bert-mini-finetune-question-detection", - "title": "Model Name Or Path" - }, - "model_version": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Model Version" - }, - "progress_bar": { - "default": true, - "title": "Progress Bar", - "type": "boolean" - }, - "task": { - "default": "text-classification", - "title": "Task", - "type": "string" - }, - "tokenizer": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Tokenizer" - }, - "use_auth_token": { - "anyOf": [ - { - "type": "boolean" - }, - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Use Auth Token" - }, - "use_gpu": { - "default": true, - "title": "Use Gpu", - "type": "boolean" - } - }, - "title": "Parameters", - "type": "object" - }, - "type": { - "const": "TransformersQueryClassifier", - "description": "Haystack Class name for the component.", - "title": "Type", - "type": "string" - } - }, - "required": [ - "type", - "name" - ], - "type": "object" - }, - "TransformersReaderComponent": { - "additionalProperties": false, - "properties": { - "name": { - "description": "Custom name for the component. Helpful for visualization and debugging.", - "title": "Name", - "type": "string" - }, - "params": { - "additionalProperties": false, - "description": "Each parameter can reference other components defined in the same YAML file.", - "properties": { - "batch_size": { - "default": 16, - "title": "Batch Size", - "type": "integer" - }, - "context_window_size": { - "default": 70, - "title": "Context Window Size", - "type": "integer" - }, - "devices": { - "anyOf": [ - { - "items": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "string" - } - ] - }, - "type": "array" - }, - { - "type": "null" - } - ], - "title": "Devices" - }, - "doc_stride": { - "default": 128, - "title": "Doc Stride", - "type": "integer" - }, - "max_seq_len": { - "default": 256, - "title": "Max Seq Len", - "type": "integer" - }, - "model_name_or_path": { - "default": "distilbert-base-uncased-distilled-squad", - "title": "Model Name Or Path", - "type": "string" - }, - "model_version": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Model Version" - }, - "return_no_answers": { - "default": false, - "title": "Return No Answers", - "type": "boolean" - }, - "tokenizer": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Tokenizer" - }, - "top_k": { - "default": 10, - "title": "Top K", - "type": "integer" - }, - "top_k_per_candidate": { - "default": 3, - "title": "Top K Per Candidate", - "type": "integer" - }, - "use_auth_token": { - "anyOf": [ - { - "type": "boolean" - }, - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Use Auth Token" - }, - "use_gpu": { - "default": true, - "title": "Use Gpu", - "type": "boolean" - } - }, - "title": "Parameters", - "type": "object" - }, - "type": { - "const": "TransformersReader", - "description": "Haystack Class name for the component.", - "title": "Type", - "type": "string" - } - }, - "required": [ - "type", - "name" - ], - "type": "object" - }, - "TransformersSummarizerComponent": { - "additionalProperties": false, - "properties": { - "name": { - "description": "Custom name for the component. Helpful for visualization and debugging.", - "title": "Name", - "type": "string" - }, - "params": { - "additionalProperties": false, - "description": "Each parameter can reference other components defined in the same YAML file.", - "properties": { - "batch_size": { - "default": 16, - "title": "Batch Size", - "type": "integer" - }, - "clean_up_tokenization_spaces": { - "default": true, - "title": "Clean Up Tokenization Spaces", - "type": "boolean" - }, - "devices": { - "anyOf": [ - { - "items": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "string" - } - ] - }, - "type": "array" - }, - { - "type": "null" - } - ], - "title": "Devices" - }, - "generate_single_summary": { - "default": false, - "title": "Generate Single Summary", - "type": "boolean" - }, - "max_length": { - "default": 200, - "title": "Max Length", - "type": "integer" - }, - "min_length": { - "default": 5, - "title": "Min Length", - "type": "integer" - }, - "model_name_or_path": { - "default": "google/pegasus-xsum", - "title": "Model Name Or Path", - "type": "string" - }, - "model_version": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Model Version" - }, - "progress_bar": { - "default": true, - "title": "Progress Bar", - "type": "boolean" - }, - "separator_for_single_summary": { - "default": " ", - "title": "Separator For Single Summary", - "type": "string" - }, - "tokenizer": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Tokenizer" - }, - "use_auth_token": { - "anyOf": [ - { - "type": "boolean" - }, - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Use Auth Token" - }, - "use_gpu": { - "default": true, - "title": "Use Gpu", - "type": "boolean" - } - }, - "title": "Parameters", - "type": "object" - }, - "type": { - "const": "TransformersSummarizer", - "description": "Haystack Class name for the component.", - "title": "Type", - "type": "string" - } - }, - "required": [ - "type", - "name" - ], - "type": "object" - }, - "TransformersTranslatorComponent": { - "additionalProperties": false, - "properties": { - "name": { - "description": "Custom name for the component. Helpful for visualization and debugging.", - "title": "Name", - "type": "string" - }, - "params": { - "additionalProperties": false, - "description": "Each parameter can reference other components defined in the same YAML file.", - "properties": { - "clean_up_tokenization_spaces": { - "anyOf": [ - { - "type": "boolean" - }, - { - "type": "null" - } - ], - "default": true, - "title": "Clean Up Tokenization Spaces" - }, - "devices": { - "anyOf": [ - { - "items": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "string" - } - ] - }, - "type": "array" - }, - { - "type": "null" - } - ], - "title": "Devices" - }, - "max_seq_len": { - "anyOf": [ - { - "type": "integer" - }, - { - "type": "null" - } - ], - "title": "Max Seq Len" - }, - "model_name_or_path": { - "title": "Model Name Or Path", - "type": "string" - }, - "progress_bar": { - "default": true, - "title": "Progress Bar", - "type": "boolean" - }, - "tokenizer_name": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Tokenizer Name" - }, - "use_auth_token": { - "anyOf": [ - { - "type": "boolean" - }, - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Use Auth Token" - }, - "use_gpu": { - "default": true, - "title": "Use Gpu", - "type": "boolean" - } - }, - "required": [ - "model_name_or_path" - ], - "title": "Parameters", - "type": "object" - }, - "type": { - "const": "TransformersTranslator", - "description": "Haystack Class name for the component.", - "title": "Type", - "type": "string" - } - }, - "required": [ - "type", - "name" - ], - "type": "object" - }, - "WeaviateDocumentStoreComponent": { - "additionalProperties": false, - "properties": { - "name": { - "description": "Custom name for the component. Helpful for visualization and debugging.", - "title": "Name", - "type": "string" - }, - "params": { - "additionalProperties": false, - "description": "Each parameter can reference other components defined in the same YAML file.", - "properties": { - "content_field": { - "default": "content", - "title": "Content Field", - "type": "string" - }, - "custom_schema": { - "anyOf": [ - { - "type": "object" - }, - { - "type": "null" - } - ], - "title": "Custom Schema" - }, - "duplicate_documents": { - "default": "overwrite", - "title": "Duplicate Documents", - "type": "string" - }, - "embedding_dim": { - "default": 768, - "title": "Embedding Dim", - "type": "integer" - }, - "embedding_field": { - "default": "embedding", - "title": "Embedding Field", - "type": "string" - }, - "host": { - "anyOf": [ - { - "type": "string" - }, - { - "items": { - "type": "string" - }, - "type": "array" - } - ], - "default": "http://localhost", - "title": "Host" - }, - "index": { - "default": "Document", - "title": "Index", - "type": "string" - }, - "index_type": { - "default": "hnsw", - "title": "Index Type", - "type": "string" - }, - "name_field": { - "default": "name", - "title": "Name Field", - "type": "string" - }, - "password": { - "title": "Password", - "type": "string" - }, - "port": { - "anyOf": [ - { - "type": "integer" - }, - { - "items": { - "type": "integer" - }, - "type": "array" - } - ], - "default": 8080, - "title": "Port" - }, - "progress_bar": { - "default": true, - "title": "Progress Bar", - "type": "boolean" - }, - "recreate_index": { - "default": false, - "title": "Recreate Index", - "type": "boolean" - }, - "return_embedding": { - "default": false, - "title": "Return Embedding", - "type": "boolean" - }, - "similarity": { - "default": "cosine", - "title": "Similarity", - "type": "string" - }, - "timeout_config": { - "default": [ - 5, - 15 - ], - "items": {}, - "title": "Timeout Config", - "type": "array" - }, - "username": { - "title": "Username", - "type": "string" - } - }, - "title": "Parameters", - "type": "object" - }, - "type": { - "const": "WeaviateDocumentStore", - "description": "Haystack Class name for the component.", - "title": "Type", - "type": "string" - } - }, - "required": [ - "type", - "name" - ], - "type": "object" - } - }, + "$id": "https://raw.githubusercontent.com/deepset-ai/haystack-json-schema/main/json-schema/haystack-pipeline-main.schema.json", + "title": "Haystack Pipeline", "description": "Haystack Pipeline YAML file describing the nodes of the pipelines. For more info read the docs at: https://haystack.deepset.ai/components/pipelines#yaml-file-definitions", - "oneOf": [ - { - "not": { - "required": [ - "extras" - ] - }, - "properties": { - "pipelines": { - "items": { - "properties": { - "nodes": { - "items": { - "not": { - "required": [ - "serve_deployment_kwargs" - ] - } - } - } - } - }, - "title": "Pipelines" - } - } - }, - { - "properties": { - "extras": { - "enum": [ - "ray" - ] - } - }, - "required": [ - "extras" - ] - } - ], + "type": "object", "properties": { + "version": { + "title": "Version", + "description": "Version of the Haystack Pipeline file.", + "type": "string", + "const": "ignore" + }, + "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": { - "additionalProperties": true, + "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": [ { @@ -6603,108 +208,93 @@ "type", "name" ], - "title": "Components", - "type": "array" - }, - "extras": { - "description": "To be specified only if contains special pipelines (for example, if this is a Ray pipeline)", - "enum": [ - "ray" - ], - "title": "Additional properties group", - "type": "string" + "additionalProperties": true }, "pipelines": { + "title": "Pipelines", "description": "Multiple pipelines can be defined using the components from the same YAML file.", + "type": "array", "items": { - "additionalProperties": false, + "type": "object", "properties": { - "additionalProperties": false, "name": { - "description": "Name of the pipeline.", "title": "Name", + "description": "Name of the pipeline.", "type": "string" }, "nodes": { - "additionalProperties": false, + "title": "Nodes", "description": "Nodes to be used by this particular pipeline", + "type": "array", "items": { - "additionalProperties": false, + "type": "object", "properties": { - "inputs": { - "description": "Input parameters for this node.", - "items": { - "type": "string" - }, - "title": "Inputs", - "type": "array" - }, "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.", "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": { - "additionalProperties": true, + "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" }, - "max_concurrent_queries": { - "type": "integer" - }, - "num_replicas": { - "description": "How many replicas Ray should create for this node (only for Ray pipelines)", - "type": "integer" - }, - "prev_version": { + "router_prefix": { "type": "string" }, "ray_actor_options": { "type": "object" }, - "router_prefix": { - "type": "string" - }, "user_config": { "type": {} }, - "version": { - "type": "string" + "max_concurrent_queries": { + "type": "integer" } }, - "title": "serve_deployment_kwargs", - "type": "object" + "additionalProperties": true } }, "required": [ "name", "inputs" ], - "type": "object" + "additionalProperties": false }, "required": [ "name", "nodes" ], - "title": "Nodes", - "type": "array" - } + "additionalProperties": false + }, + "additionalProperties": false }, - "type": "object" - }, - "title": "Pipelines", - "type": "array" - }, - "version": { - "const": "ignore", - "description": "Version of the Haystack Pipeline file.", - "title": "Version", - "type": "string" + "additionalProperties": false + } } }, "required": [ @@ -6712,6 +302,6416 @@ "components", "pipelines" ], - "title": "Haystack Pipeline", - "type": "object" + "additionalProperties": false, + "oneOf": [ + { + "not": { + "required": [ + "extras" + ] + }, + "properties": { + "pipelines": { + "title": "Pipelines", + "items": { + "properties": { + "nodes": { + "items": { + "not": { + "required": [ + "serve_deployment_kwargs" + ] + } + } + } + } + } + } + } + }, + { + "properties": { + "extras": { + "enum": [ + "ray" + ] + } + }, + "required": [ + "extras" + ] + } + ], + "definitions": { + "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", + "type": "string" + }, + "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" + } + }, + "additionalProperties": false, + "description": "Each parameter can reference other components defined in the same YAML file." + } + }, + "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": 30, + "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" + } + }, + "additionalProperties": false, + "description": "Each parameter can reference other components defined in the same YAML file." + } + }, + "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", + "type": "integer" + }, + "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", + "default": null, + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] + }, + "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" + } + ] + }, + "faiss_config_path": { + "title": "Faiss Config Path", + "anyOf": [ + { + "type": "string" + }, + { + "type": "string", + "format": "path" + } + ] + }, + "isolation_level": { + "title": "Isolation Level", + "type": "string" + }, + "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" + } + }, + "additionalProperties": false, + "description": "Each parameter can reference other components defined in the same YAML file." + } + }, + "required": [ + "type", + "name" + ], + "additionalProperties": false + }, + "GraphDBKnowledgeGraphComponent": { + "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": "GraphDBKnowledgeGraph" + }, + "params": { + "title": "Parameters", + "type": "object", + "properties": { + "host": { + "title": "Host", + "default": "localhost", + "type": "string" + }, + "port": { + "title": "Port", + "default": 7200, + "type": "integer" + }, + "username": { + "title": "Username", + "default": "", + "type": "string" + }, + "password": { + "title": "Password", + "default": "", + "type": "string" + }, + "index": { + "title": "Index", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] + }, + "prefixes": { + "title": "Prefixes", + "default": "", + "type": "string" + } + }, + "additionalProperties": false, + "description": "Each parameter can reference other components defined in the same YAML file." + } + }, + "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": "string" + } + ] + } + }, + { + "type": "null" + } + ] + } + }, + "additionalProperties": false, + "description": "Each parameter can reference other components defined in the same YAML file." + } + }, + "required": [ + "type", + "name" + ], + "additionalProperties": false + }, + "InMemoryKnowledgeGraphComponent": { + "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": "InMemoryKnowledgeGraph" + }, + "params": { + "title": "Parameters", + "type": "object", + "properties": { + "index": { + "title": "Index", + "default": "document", + "type": "string" + } + }, + "additionalProperties": false, + "description": "Each parameter can reference other components defined in the same YAML file." + } + }, + "required": [ + "type", + "name" + ], + "additionalProperties": false + }, + "Milvus2DocumentStoreComponent": { + "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": "Milvus2DocumentStore" + }, + "params": { + "title": "Parameters", + "type": "object", + "properties": { + "sql_url": { + "title": "Sql Url", + "default": "sqlite:///", + "type": "string" + }, + "host": { + "title": "Host", + "default": "localhost", + "type": "string" + }, + "port": { + "title": "Port", + "default": "19530", + "type": "string" + }, + "connection_pool": { + "title": "Connection Pool", + "default": "SingletonThread", + "type": "string" + }, + "index": { + "title": "Index", + "default": "document", + "type": "string" + }, + "vector_dim": { + "title": "Vector Dim", + "type": "integer" + }, + "embedding_dim": { + "title": "Embedding Dim", + "default": 768, + "type": "integer" + }, + "index_file_size": { + "title": "Index File Size", + "default": 1024, + "type": "integer" + }, + "similarity": { + "title": "Similarity", + "default": "dot_product", + "type": "string" + }, + "index_type": { + "title": "Index Type", + "default": "IVF_FLAT", + "type": "string" + }, + "index_param": { + "title": "Index Param", + "anyOf": [ + { + "type": "object" + }, + { + "type": "null" + } + ] + }, + "search_param": { + "title": "Search Param", + "anyOf": [ + { + "type": "object" + }, + { + "type": "null" + } + ] + }, + "return_embedding": { + "title": "Return Embedding", + "default": false, + "type": "boolean" + }, + "embedding_field": { + "title": "Embedding Field", + "default": "embedding", + "type": "string" + }, + "id_field": { + "title": "Id Field", + "default": "id", + "type": "string" + }, + "custom_fields": { + "title": "Custom Fields", + "anyOf": [ + { + "type": "array", + "items": {} + }, + { + "type": "null" + } + ] + }, + "progress_bar": { + "title": "Progress Bar", + "default": true, + "type": "boolean" + }, + "duplicate_documents": { + "title": "Duplicate Documents", + "default": "overwrite", + "type": "string" + }, + "isolation_level": { + "title": "Isolation Level", + "type": "string" + }, + "consistency_level": { + "title": "Consistency Level", + "default": 0, + "type": "integer" + }, + "recreate_index": { + "title": "Recreate Index", + "default": false, + "type": "boolean" + } + }, + "additionalProperties": false, + "description": "Each parameter can reference other components defined in the same YAML file." + } + }, + "required": [ + "type", + "name" + ], + "additionalProperties": false + }, + "OpenDistroElasticsearchDocumentStoreComponent": { + "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": "OpenDistroElasticsearchDocumentStore" + }, + "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": "cosine", + "type": "string" + }, + "timeout": { + "title": "Timeout", + "default": 30, + "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" + } + }, + "additionalProperties": false, + "description": "Each parameter can reference other components defined in the same YAML file." + } + }, + "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": 30, + "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" + } + }, + "additionalProperties": false, + "description": "Each parameter can reference other components defined in the same YAML file." + } + }, + "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", + "default": null, + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] + }, + "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", + "default": { + "indexed": [] + }, + "type": "object" + }, + "validate_index_sync": { + "title": "Validate Index Sync", + "default": true, + "type": "boolean" + } + }, + "required": [ + "api_key" + ], + "additionalProperties": false, + "description": "Each parameter can reference other components defined in the same YAML file." + } + }, + "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", + "type": "string" + } + }, + "additionalProperties": false, + "description": "Each parameter can reference other components defined in the same YAML file." + } + }, + "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", + "type": "string" + }, + "password": { + "title": "Password", + "type": "string" + }, + "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" + } + }, + "additionalProperties": false, + "description": "Each parameter can reference other components defined in the same YAML file." + } + }, + "required": [ + "type", + "name" + ], + "additionalProperties": false + }, + "AnswerToSpeechComponent": { + "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": "AnswerToSpeech" + }, + "params": { + "title": "Parameters", + "type": "object", + "properties": { + "model_name_or_path": { + "title": "Model Name Or Path", + "default": "espnet/kan-bayashi_ljspeech_vits", + "anyOf": [ + { + "type": "string" + }, + { + "type": "string", + "format": "path" + } + ] + }, + "generated_audio_dir": { + "title": "Generated Audio Dir", + "default": "generated_audio_answers", + "type": "string", + "format": "path" + }, + "audio_params": { + "title": "Audio Params", + "anyOf": [ + { + "type": "object" + }, + { + "type": "null" + } + ] + }, + "transformers_params": { + "title": "Transformers Params", + "anyOf": [ + { + "type": "object" + }, + { + "type": "null" + } + ] + }, + "progress_bar": { + "title": "Progress Bar", + "default": true, + "type": "boolean" + }, + "devices": { + "title": "Devices", + "anyOf": [ + { + "type": "array", + "items": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "string" + } + ] + } + }, + { + "type": "null" + } + ] + } + }, + "additionalProperties": false, + "description": "Each parameter can reference other components defined in the same YAML file." + } + }, + "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" + ], + "additionalProperties": false, + "description": "Each parameter can reference other components defined in the same YAML file." + } + }, + "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" + } + }, + "additionalProperties": false, + "description": "Each parameter can reference other components defined in the same YAML file." + } + }, + "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": { + "output_dir": { + "title": "Output Dir", + "type": "string" + }, + "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" + } + ] + }, + "overwrite_existing_files": { + "title": "Overwrite Existing Files", + "default": true + }, + "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" + } + ] + }, + "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" + } + ] + } + }, + "required": [ + "output_dir" + ], + "additionalProperties": false, + "description": "Each parameter can reference other components defined in the same YAML file." + } + }, + "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": "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" + } + }, + "additionalProperties": false, + "description": "Each parameter can reference other components defined in the same YAML file." + } + }, + "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" + } + }, + "additionalProperties": false, + "description": "Each parameter can reference other components defined in the same YAML file." + } + }, + "required": [ + "type", + "name" + ], + "additionalProperties": false + }, + "DocumentToSpeechComponent": { + "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": "DocumentToSpeech" + }, + "params": { + "title": "Parameters", + "type": "object", + "properties": { + "model_name_or_path": { + "title": "Model Name Or Path", + "default": "espnet/kan-bayashi_ljspeech_vits", + "anyOf": [ + { + "type": "string" + }, + { + "type": "string", + "format": "path" + } + ] + }, + "generated_audio_dir": { + "title": "Generated Audio Dir", + "default": "generated_audio_documents", + "type": "string", + "format": "path" + }, + "audio_params": { + "title": "Audio Params", + "anyOf": [ + { + "type": "object" + }, + { + "type": "null" + } + ] + }, + "transformers_params": { + "title": "Transformers Params", + "anyOf": [ + { + "type": "object" + }, + { + "type": "null" + } + ] + } + }, + "additionalProperties": false, + "description": "Each parameter can reference other components defined in the same YAML file." + } + }, + "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" + } + }, + "additionalProperties": false, + "description": "Each parameter can reference other components defined in the same YAML file." + } + }, + "required": [ + "type", + "name" + ], + "additionalProperties": false + }, + "ElasticsearchFilterOnlyRetrieverComponent": { + "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": "ElasticsearchFilterOnlyRetriever" + }, + "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" + } + ] + } + }, + "additionalProperties": false, + "description": "Each parameter can reference other components defined in the same YAML file." + } + }, + "required": [ + "type", + "name" + ], + "additionalProperties": false + }, + "ElasticsearchRetrieverComponent": { + "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": "ElasticsearchRetriever" + }, + "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" + } + ] + } + }, + "additionalProperties": false, + "description": "Each parameter can reference other components defined in the same YAML file." + } + }, + "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": "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", + "default": [], + "type": "array", + "items": { + "type": "string" + } + }, + "api_key": { + "title": "Api Key", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] + } + }, + "required": [ + "embedding_model" + ], + "additionalProperties": false, + "description": "Each parameter can reference other components defined in the same YAML file." + } + }, + "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": "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", + "type": "integer" + }, + "pre_split_text": { + "title": "Pre Split Text", + "default": false, + "type": "boolean" + }, + "ignore_labels": { + "title": "Ignore Labels", + "anyOf": [ + { + "type": "array", + "items": { + "type": "string" + } + }, + { + "type": "null" + } + ] + } + }, + "additionalProperties": false, + "description": "Each parameter can reference other components defined in the same YAML file." + } + }, + "required": [ + "type", + "name" + ], + "additionalProperties": false + }, + "EvalAnswersComponent": { + "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": "EvalAnswers" + }, + "params": { + "title": "Parameters", + "type": "object", + "properties": { + "skip_incorrect_retrieval": { + "title": "Skip Incorrect Retrieval", + "default": true, + "type": "boolean" + }, + "open_domain": { + "title": "Open Domain", + "default": true, + "type": "boolean" + }, + "sas_model": { + "title": "Sas Model", + "type": "string" + }, + "debug": { + "title": "Debug", + "default": false, + "type": "boolean" + } + }, + "additionalProperties": false, + "description": "Each parameter can reference other components defined in the same YAML file." + } + }, + "required": [ + "type", + "name" + ], + "additionalProperties": false + }, + "EvalDocumentsComponent": { + "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": "EvalDocuments" + }, + "params": { + "title": "Parameters", + "type": "object", + "properties": { + "debug": { + "title": "Debug", + "default": false, + "type": "boolean" + }, + "open_domain": { + "title": "Open Domain", + "default": true, + "type": "boolean" + }, + "top_k": { + "title": "Top K", + "default": 10, + "type": "integer" + } + }, + "additionalProperties": false, + "description": "Each parameter can reference other components defined in the same YAML file." + } + }, + "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": "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", + "additionalProperties": { + "type": "string" + }, + "anyOf": [ + { + "type": "object" + }, + { + "type": "null" + } + ] + }, + "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" + } + ] + } + }, + "required": [ + "model_name_or_path" + ], + "additionalProperties": false, + "description": "Each parameter can reference other components defined in the same YAML file." + } + }, + "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", + "default": [ + "txt", + "pdf", + "md", + "docx", + "html" + ], + "type": "array", + "items": { + "type": "string" + } + } + }, + "additionalProperties": false, + "description": "Each parameter can reference other components defined in the same YAML file." + } + }, + "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" + } + }, + "additionalProperties": false, + "description": "Each parameter can reference other components defined in the same YAML file." + } + }, + "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", + "default": [ + "eng" + ], + "anyOf": [ + { + "type": "array", + "items": { + "type": "string" + } + }, + { + "type": "null" + } + ] + }, + "id_hash_keys": { + "title": "Id Hash Keys", + "anyOf": [ + { + "type": "array", + "items": { + "type": "string" + } + }, + { + "type": "null" + } + ] + } + }, + "additionalProperties": false, + "description": "Each parameter can reference other components defined in the same YAML file." + } + }, + "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" + } + }, + "additionalProperties": false, + "description": "Each parameter can reference other components defined in the same YAML file." + } + }, + "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" + } + }, + "additionalProperties": false, + "description": "Each parameter can reference other components defined in the same YAML file." + } + }, + "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" + } + }, + "additionalProperties": false, + "description": "Each parameter can reference other components defined in the same YAML file." + } + }, + "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", + "default": { + "max_length": 64 + }, + "type": "object" + }, + "document_feature_extractors_params": { + "title": "Document Feature Extractors Params", + "default": { + "text": { + "max_length": 256 + } + }, + "type": "object", + "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", + "default": [ + "name" + ], + "type": "array", + "items": { + "type": "string" + } + }, + "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": "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" + ], + "additionalProperties": false, + "description": "Each parameter can reference other components defined in the same YAML file." + } + }, + "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": "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", + "default": [], + "type": "array", + "items": { + "type": "string" + } + } + }, + "required": [ + "embedding_model" + ], + "additionalProperties": false, + "description": "Each parameter can reference other components defined in the same YAML file." + } + }, + "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" + }, + "model": { + "title": "Model", + "default": "text-curie-001", + "type": "string" + }, + "max_tokens": { + "title": "Max Tokens", + "default": 13, + "type": "integer" + }, + "top_k": { + "title": "Top K", + "default": 5, + "type": "integer" + }, + "temperature": { + "title": "Temperature", + "default": 0.2, + "type": "number" + }, + "presence_penalty": { + "title": "Presence Penalty", + "default": -2.0, + "type": "number" + }, + "frequency_penalty": { + "title": "Frequency Penalty", + "default": -2.0, + "type": "number" + }, + "examples_context": { + "title": "Examples Context", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] + }, + "examples": { + "title": "Examples", + "anyOf": [ + { + "type": "array", + "items": {} + }, + { + "type": "null" + } + ] + }, + "stop_words": { + "title": "Stop Words", + "anyOf": [ + { + "type": "array", + "items": {} + }, + { + "type": "null" + } + ] + }, + "progress_bar": { + "title": "Progress Bar", + "default": true, + "type": "boolean" + } + }, + "required": [ + "api_key" + ], + "additionalProperties": false, + "description": "Each parameter can reference other components defined in the same YAML file." + } + }, + "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" + } + }, + "additionalProperties": false, + "description": "Each parameter can reference other components defined in the same YAML file." + } + }, + "required": [ + "type", + "name" + ], + "additionalProperties": false + }, + "PDFToTextOCRConverterComponent": { + "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": "PDFToTextOCRConverter" + }, + "params": { + "title": "Parameters", + "type": "object", + "properties": { + "remove_numeric_tables": { + "title": "Remove Numeric Tables", + "default": false, + "type": "boolean" + }, + "valid_languages": { + "title": "Valid Languages", + "default": [ + "eng" + ], + "anyOf": [ + { + "type": "array", + "items": { + "type": "string" + } + }, + { + "type": "null" + } + ] + }, + "id_hash_keys": { + "title": "Id Hash Keys", + "anyOf": [ + { + "type": "array", + "items": { + "type": "string" + } + }, + { + "type": "null" + } + ] + } + }, + "additionalProperties": false, + "description": "Each parameter can reference other components defined in the same YAML file." + } + }, + "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" + } + }, + "additionalProperties": false, + "description": "Each parameter can reference other components defined in the same YAML file." + } + }, + "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", + "default": [], + "type": "array", + "items": { + "type": "string" + } + }, + "split_by": { + "title": "Split By", + "default": "word", + "enum": [ + "word", + "sentence", + "passage" + ], + "type": "string" + }, + "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" + } + }, + "additionalProperties": false, + "description": "Each parameter can reference other components defined in the same YAML file." + } + }, + "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", + "type": "string" + }, + "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": "string" + } + ] + } + }, + { + "type": "null" + } + ] + } + }, + "required": [ + "question_producer", + "retriever" + ], + "additionalProperties": false, + "description": "Each parameter can reference other components defined in the same YAML file." + } + }, + "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": "string" + } + ] + } + }, + { + "type": "null" + } + ] + } + }, + "additionalProperties": false, + "description": "Each parameter can reference other components defined in the same YAML file." + } + }, + "required": [ + "type", + "name" + ], + "additionalProperties": false + }, + "RAGeneratorComponent": { + "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": "RAGenerator" + }, + "params": { + "title": "Parameters", + "type": "object", + "properties": { + "model_name_or_path": { + "title": "Model Name Or Path", + "default": "facebook/rag-token-nq", + "type": "string" + }, + "model_version": { + "title": "Model Version", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] + }, + "retriever": { + "title": "Retriever", + "default": null, + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] + }, + "generator_type": { + "title": "Generator Type", + "default": "token", + "type": "string" + }, + "top_k": { + "title": "Top K", + "default": 2, + "type": "integer" + }, + "max_length": { + "title": "Max Length", + "default": 200, + "type": "integer" + }, + "min_length": { + "title": "Min Length", + "default": 2, + "type": "integer" + }, + "num_beams": { + "title": "Num Beams", + "default": 2, + "type": "integer" + }, + "embed_title": { + "title": "Embed Title", + "default": true, + "type": "boolean" + }, + "prefix": { + "title": "Prefix", + "anyOf": [ + { + "type": "string" + }, + { + "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": "string" + } + ] + } + }, + { + "type": "null" + } + ] + } + }, + "additionalProperties": false, + "description": "Each parameter can reference other components defined in the same YAML file." + } + }, + "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" + } + ] + } + }, + "additionalProperties": false, + "description": "Each parameter can reference other components defined in the same YAML file." + } + }, + "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": "null" + } + ] + } + }, + "additionalProperties": false, + "description": "Each parameter can reference other components defined in the same YAML file." + } + }, + "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": "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" + ], + "additionalProperties": false, + "description": "Each parameter can reference other components defined in the same YAML file." + } + }, + "required": [ + "type", + "name" + ], + "additionalProperties": false + }, + "Seq2SeqGeneratorComponent": { + "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": "Seq2SeqGenerator" + }, + "params": { + "title": "Parameters", + "type": "object", + "properties": { + "model_name_or_path": { + "title": "Model Name Or Path", + "type": "string" + }, + "input_converter": { + "title": "Input Converter", + "default": null, + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] + }, + "top_k": { + "title": "Top K", + "default": 1, + "type": "integer" + }, + "max_length": { + "title": "Max Length", + "default": 200, + "type": "integer" + }, + "min_length": { + "title": "Min Length", + "default": 2, + "type": "integer" + }, + "num_beams": { + "title": "Num Beams", + "default": 8, + "type": "integer" + }, + "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": "string" + } + ] + } + }, + { + "type": "null" + } + ] + } + }, + "required": [ + "model_name_or_path" + ], + "additionalProperties": false, + "description": "Each parameter can reference other components defined in the same YAML file." + } + }, + "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/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/vectorizer.pickle", + "anyOf": [ + { + "type": "string" + }, + {} + ] + }, + "batch_size": { + "title": "Batch Size", + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ] + }, + "progress_bar": { + "title": "Progress Bar", + "default": true, + "type": "boolean" + } + }, + "additionalProperties": false, + "description": "Each parameter can reference other components defined in the same YAML file." + } + }, + "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": "string" + } + ] + } + }, + { + "type": "null" + } + ] + } + }, + "additionalProperties": false, + "description": "Each parameter can reference other components defined in the same YAML file." + } + }, + "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", + "default": [ + "name", + "section_title", + "caption" + ], + "type": "array", + "items": { + "type": "string" + } + }, + "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": "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" + } + }, + "additionalProperties": false, + "description": "Each parameter can reference other components defined in the same YAML file." + } + }, + "required": [ + "type", + "name" + ], + "additionalProperties": false + }, + "Text2SparqlRetrieverComponent": { + "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": "Text2SparqlRetriever" + }, + "params": { + "title": "Parameters", + "type": "object", + "properties": { + "knowledge_graph": { + "title": "Knowledge Graph", + "type": "string" + }, + "model_name_or_path": { + "title": "Model Name Or Path", + "type": "string" + }, + "model_version": { + "title": "Model Version", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] + }, + "top_k": { + "title": "Top K", + "default": 1, + "type": "integer" + }, + "use_auth_token": { + "title": "Use Auth Token", + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "string" + }, + { + "type": "null" + } + ] + } + }, + "required": [ + "knowledge_graph" + ], + "additionalProperties": false, + "description": "Each parameter can reference other components defined in the same YAML file." + } + }, + "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" + } + }, + "additionalProperties": false, + "description": "Each parameter can reference other components defined in the same YAML file." + } + }, + "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 + } + }, + "additionalProperties": false, + "description": "Each parameter can reference other components defined in the same YAML file." + } + }, + "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" + } + ] + } + }, + "additionalProperties": false, + "description": "Each parameter can reference other components defined in the same YAML file." + } + }, + "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", + "type": "string" + }, + "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": "string" + } + ] + } + }, + { + "type": "null" + } + ] + } + }, + "additionalProperties": false, + "description": "Each parameter can reference other components defined in the same YAML file." + } + }, + "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", + "default": [ + "LABEL_1", + "LABEL_0" + ], + "type": "array", + "items": { + "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": "string" + } + ] + } + }, + { + "type": "null" + } + ] + } + }, + "additionalProperties": false, + "description": "Each parameter can reference other components defined in the same YAML file." + } + }, + "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": "string" + } + ] + } + }, + { + "type": "null" + } + ] + } + }, + "additionalProperties": false, + "description": "Each parameter can reference other components defined in the same YAML file." + } + }, + "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" + }, + "separator_for_single_summary": { + "title": "Separator For Single Summary", + "default": " ", + "type": "string" + }, + "generate_single_summary": { + "title": "Generate Single Summary", + "default": false, + "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": "string" + } + ] + } + }, + { + "type": "null" + } + ] + } + }, + "additionalProperties": false, + "description": "Each parameter can reference other components defined in the same YAML file." + } + }, + "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": "string" + } + ] + } + }, + { + "type": "null" + } + ] + } + }, + "required": [ + "model_name_or_path" + ], + "additionalProperties": false, + "description": "Each parameter can reference other components defined in the same YAML file." + } + }, + "required": [ + "type", + "name" + ], + "additionalProperties": false + } + } } \ No newline at end of file diff --git a/haystack/json-schemas/haystack-pipeline.schema.json b/haystack/json-schemas/haystack-pipeline.schema.json index 2888900ae..27d25bc11 100644 --- a/haystack/json-schemas/haystack-pipeline.schema.json +++ b/haystack/json-schemas/haystack-pipeline.schema.json @@ -254,6 +254,20 @@ "$ref": "https://raw.githubusercontent.com/deepset-ai/haystack/main/haystack/json-schemas/haystack-pipeline-1.10.0.schema.json" } ] + }, + { + "allOf": [ + { + "properties": { + "version": { + "const": "1.11.0rc0" + } + } + }, + { + "$ref": "https://raw.githubusercontent.com/deepset-ai/haystack-json-schema/main/json-schema/haystack-pipeline-1.11.0rc0.schema.json" + } + ] } ], "title": "Haystack Pipeline", diff --git a/haystack/nodes/_json_schema.py b/haystack/nodes/_json_schema.py index 5b2c3a962..218140c0c 100644 --- a/haystack/nodes/_json_schema.py +++ b/haystack/nodes/_json_schema.py @@ -24,11 +24,10 @@ from haystack.nodes.base import BaseComponent logger = logging.getLogger(__name__) -logger.setLevel(logging.INFO) JSON_SCHEMAS_PATH = Path(__file__).parent.parent.parent / "haystack" / "json-schemas" -SCHEMA_URL = "https://raw.githubusercontent.com/deepset-ai/haystack/main/haystack/json-schemas/" +SCHEMA_URL = "https://raw.githubusercontent.com/deepset-ai/haystack-json-schema/main/json-schema/" # Allows accessory classes (like enums and helpers) to be registered as valid input for # custom node's init parameters. For now we disable this feature, but flipping this variables @@ -406,35 +405,35 @@ def inject_definition_in_schema(node_class: Type[BaseComponent], schema: Dict[st return schema -def update_json_schema(destination_path: Path = JSON_SCHEMAS_PATH): +def update_json_schema(destination_path: Path = JSON_SCHEMAS_PATH, main_only: bool = False): """ Create (or update) a new schema. """ # `main` schema is always updated and will contain the same data as the latest # commit from `main` or a release branch filename = f"haystack-pipeline-main.schema.json" - with open(destination_path / filename, "w") as json_file: - json.dump(get_json_schema(filename=filename, version="ignore"), json_file, indent=2, sort_keys=True) - # Create/update the specific version file too - filename = f"haystack-pipeline-{haystack_version}.schema.json" with open(destination_path / filename, "w") as json_file: - json.dump(get_json_schema(filename=filename, version=haystack_version), json_file, indent=2, sort_keys=True) + json.dump(get_json_schema(filename=filename, version="ignore"), json_file, indent=2) - # Update the index - index_name = "haystack-pipeline.schema.json" - with open(destination_path / index_name, "r") as json_file: - index = json.load(json_file) - new_entry = { - "allOf": [ - {"properties": {"version": {"const": haystack_version}}}, - { - "$ref": "https://raw.githubusercontent.com/deepset-ai/haystack/main/haystack/json-schemas/" - f"haystack-pipeline-{haystack_version}.schema.json" - }, - ] - } - if new_entry not in index["oneOf"]: - index["oneOf"].append(new_entry) - with open(destination_path / index_name, "w") as json_file: - json.dump(obj=index, fp=json_file, indent=2, sort_keys=True) + if not main_only and "rc" not in haystack_version: + + # Create/update the specific version file too + filename = f"haystack-pipeline-{haystack_version}.schema.json" + with open(destination_path / filename, "w") as json_file: + json.dump(get_json_schema(filename=filename, version=haystack_version), json_file, indent=2) + + # Update the index + index_name = "haystack-pipeline.schema.json" + with open(destination_path / index_name, "r") as json_file: + index = json.load(json_file) + new_entry = { + "allOf": [ + {"properties": {"version": {"const": haystack_version}}}, + {"$ref": f"{SCHEMA_URL}haystack-pipeline-{haystack_version}.schema.json"}, + ] + } + if new_entry not in index["oneOf"]: + index["oneOf"].append(new_entry) + with open(destination_path / index_name, "w") as json_file: + json.dump(obj=index, fp=json_file, indent=2, sort_keys=True) diff --git a/pyproject.toml b/pyproject.toml index 6681b0586..2e41b078c 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -245,6 +245,10 @@ packages = [ "haystack", ] +[tool.hatch.build.targets.wheel.hooks.autorun] +dependencies = ["hatch-autorun"] +file = "haystack/json-schemas/generate_schema.py" + [tool.black] line-length = 120 skip_magic_trailing_comma = true # For compatibility with pydoc>=4.6, check if still needed.