diff --git a/VERSION.txt b/VERSION.txt index 6bd3f0760f..81c871de46 100644 --- a/VERSION.txt +++ b/VERSION.txt @@ -1 +1 @@ -1.10.0rc1 +1.10.0 diff --git a/docs/_src/api/openapi/openapi-1.10.0.json b/docs/_src/api/openapi/openapi-1.10.0.json new file mode 100644 index 0000000000..a620ed820d --- /dev/null +++ b/docs/_src/api/openapi/openapi-1.10.0.json @@ -0,0 +1,1028 @@ +{ + "openapi": "3.0.2", + "info": { + "title": "Haystack REST API", + "version": "1.10.0" + }, + "paths": { + "/initialized": { + "get": { + "tags": [ + "search" + ], + "summary": "Check Status", + "description": "This endpoint can be used during startup to understand if the\nserver is ready to take any requests, or is still loading.\n\nThe recommended approach is to call this endpoint with a short timeout,\nlike 500ms, and in case of no reply, consider the server busy.", + "operationId": "check_status", + "responses": { + "200": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": {} + } + } + } + } + } + }, + "/hs_version": { + "get": { + "tags": [ + "search" + ], + "summary": "Haystack Version", + "description": "Get the running Haystack version.", + "operationId": "haystack_version", + "responses": { + "200": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": {} + } + } + } + } + } + }, + "/query": { + "post": { + "tags": [ + "search" + ], + "summary": "Query", + "description": "This endpoint receives the question as a string and allows the requester to set\nadditional parameters that will be passed on to the Haystack pipeline.", + "operationId": "query", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/QueryRequest" + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/QueryResponse" + } + } + } + }, + "422": { + "description": "Validation Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } + } + } + } + } + } + }, + "/feedback": { + "get": { + "tags": [ + "feedback" + ], + "summary": "Get Feedback", + "description": "This endpoint allows the API user to retrieve all the feedback that has been submitted\nthrough the `POST /feedback` endpoint.", + "operationId": "get_feedback", + "responses": { + "200": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": { + "title": "Response Get Feedback Feedback Get", + "type": "array", + "items": { + "$ref": "#/components/schemas/Label" + } + } + } + } + } + } + }, + "post": { + "tags": [ + "feedback" + ], + "summary": "Post Feedback", + "description": "This endpoint allows the API user to submit feedback on an answer for a particular query.\n\nFor example, the user can send feedback on whether the answer was correct and\nwhether the right snippet was identified as the answer.\n\nInformation submitted through this endpoint is used to train the underlying QA model.", + "operationId": "post_feedback", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CreateLabelSerialized" + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": {} + } + } + }, + "422": { + "description": "Validation Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } + } + } + } + } + }, + "delete": { + "tags": [ + "feedback" + ], + "summary": "Delete Feedback", + "description": "This endpoint allows the API user to delete all the\nfeedback that has been sumbitted through the\n`POST /feedback` endpoint", + "operationId": "delete_feedback", + "responses": { + "200": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": {} + } + } + } + } + } + }, + "/eval-feedback": { + "post": { + "tags": [ + "feedback" + ], + "summary": "Get Feedback Metrics", + "description": "This endpoint returns basic accuracy metrics based on user feedback,\ne.g., the ratio of correct answers or correctly identified documents.\nYou can filter the output by document or label.\n\nExample:\n\n`curl --location --request POST 'http://127.0.0.1:8000/eval-doc-qa-feedback' --header 'Content-Type: application/json' --data-raw '{ \"filters\": {\"document_id\": [\"XRR3xnEBCYVTkbTystOB\"]} }'`", + "operationId": "get_feedback_metrics", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/FilterRequest" + } + } + } + }, + "responses": { + "200": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": {} + } + } + }, + "422": { + "description": "Validation Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } + } + } + } + } + } + }, + "/export-feedback": { + "get": { + "tags": [ + "feedback" + ], + "summary": "Export Feedback", + "description": "This endpoint returns JSON output in the SQuAD format for question/answer pairs\nthat were marked as \"relevant\" by user feedback through the `POST /feedback` endpoint.\n\nThe context_size param can be used to limit response size for large documents.", + "operationId": "export_feedback", + "parameters": [ + { + "required": false, + "schema": { + "title": "Context Size", + "type": "integer", + "default": 100000 + }, + "name": "context_size", + "in": "query" + }, + { + "required": false, + "schema": { + "title": "Full Document Context", + "type": "boolean", + "default": true + }, + "name": "full_document_context", + "in": "query" + }, + { + "required": false, + "schema": { + "title": "Only Positive Labels", + "type": "boolean", + "default": false + }, + "name": "only_positive_labels", + "in": "query" + } + ], + "responses": { + "200": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": {} + } + } + }, + "422": { + "description": "Validation Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } + } + } + } + } + } + }, + "/file-upload": { + "post": { + "tags": [ + "file-upload" + ], + "summary": "Upload File", + "description": "You can use this endpoint to upload a file for indexing\n(see https://haystack.deepset.ai/guides/rest-api#indexing-documents-in-the-haystack-rest-api-document-store).", + "operationId": "upload_file", + "requestBody": { + "content": { + "multipart/form-data": { + "schema": { + "$ref": "#/components/schemas/Body_upload_file_file_upload_post" + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": {} + } + } + }, + "422": { + "description": "Validation Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } + } + } + } + } + } + }, + "/documents/get_by_filters": { + "post": { + "tags": [ + "document" + ], + "summary": "Get Documents", + "description": "This endpoint allows you to retrieve documents contained in your document store.\nYou can filter the documents to retrieve by metadata (like the document's name),\nor provide an empty JSON object to clear the document store.\n\nExample of filters:\n`'{\"filters\": {{\"name\": [\"some\", \"more\"], \"category\": [\"only_one\"]}}'`\n\nTo get all documents you should provide an empty dict, like:\n`'{\"filters\": {}}'`", + "operationId": "get_documents", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/FilterRequest" + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": { + "title": "Response Get Documents Documents Get By Filters Post", + "type": "array", + "items": { + "$ref": "#/components/schemas/Document" + } + } + } + } + }, + "422": { + "description": "Validation Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } + } + } + } + } + } + }, + "/documents/delete_by_filters": { + "post": { + "tags": [ + "document" + ], + "summary": "Delete Documents", + "description": "This endpoint allows you to delete documents contained in your document store.\nYou can filter the documents to delete by metadata (like the document's name),\nor provide an empty JSON object to clear the document store.\n\nExample of filters:\n`'{\"filters\": {{\"name\": [\"some\", \"more\"], \"category\": [\"only_one\"]}}'`\n\nTo get all documents you should provide an empty dict, like:\n`'{\"filters\": {}}'`", + "operationId": "delete_documents", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/FilterRequest" + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": { + "title": "Response Delete Documents Documents Delete By Filters Post", + "type": "boolean" + } + } + } + }, + "422": { + "description": "Validation Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } + } + } + } + } + } + }, + "/health": { + "get": { + "tags": [ + "health" + ], + "summary": "Get Health Status", + "description": "This endpoint allows external systems to monitor the health of the Haystack REST API.", + "operationId": "get_health_status", + "responses": { + "200": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HealthResponse" + } + } + } + } + } + } + } + }, + "components": { + "schemas": { + "Answer": { + "title": "Answer", + "required": [ + "answer" + ], + "type": "object", + "properties": { + "answer": { + "title": "Answer", + "type": "string" + }, + "type": { + "title": "Type", + "enum": [ + "generative", + "extractive", + "other" + ], + "type": "string", + "default": "extractive" + }, + "score": { + "title": "Score", + "type": "number" + }, + "context": { + "title": "Context", + "anyOf": [ + { + "type": "string" + }, + { + "type": "string" + } + ] + }, + "offsets_in_document": { + "title": "Offsets In Document", + "type": "array", + "items": { + "$ref": "#/components/schemas/Span" + } + }, + "offsets_in_context": { + "title": "Offsets In Context", + "type": "array", + "items": { + "$ref": "#/components/schemas/Span" + } + }, + "document_id": { + "title": "Document Id", + "type": "string" + }, + "meta": { + "title": "Meta", + "type": "object" + } + } + }, + "Body_upload_file_file_upload_post": { + "title": "Body_upload_file_file_upload_post", + "required": [ + "files" + ], + "type": "object", + "properties": { + "files": { + "title": "Files", + "type": "array", + "items": { + "type": "string", + "format": "binary" + } + }, + "meta": { + "title": "Meta", + "type": "string", + "default": "null" + }, + "remove_numeric_tables": { + "title": "Remove Numeric Tables" + }, + "valid_languages": { + "title": "Valid Languages" + }, + "clean_whitespace": { + "title": "Clean Whitespace" + }, + "clean_empty_lines": { + "title": "Clean Empty Lines" + }, + "clean_header_footer": { + "title": "Clean Header Footer" + }, + "split_by": { + "title": "Split By" + }, + "split_length": { + "title": "Split Length" + }, + "split_overlap": { + "title": "Split Overlap" + }, + "split_respect_sentence_boundary": { + "title": "Split Respect Sentence Boundary" + } + } + }, + "CPUUsage": { + "title": "CPUUsage", + "required": [ + "used" + ], + "type": "object", + "properties": { + "used": { + "title": "Used", + "type": "number", + "description": "REST API average CPU usage in percentage" + } + } + }, + "CreateLabelSerialized": { + "title": "CreateLabelSerialized", + "required": [ + "query", + "document", + "is_correct_answer", + "is_correct_document", + "origin" + ], + "type": "object", + "properties": { + "id": { + "title": "Id", + "type": "string" + }, + "query": { + "title": "Query", + "type": "string" + }, + "document": { + "$ref": "#/components/schemas/Document" + }, + "is_correct_answer": { + "title": "Is Correct Answer", + "type": "boolean" + }, + "is_correct_document": { + "title": "Is Correct Document", + "type": "boolean" + }, + "origin": { + "title": "Origin", + "enum": [ + "user-feedback", + "gold-label" + ], + "type": "string" + }, + "answer": { + "$ref": "#/components/schemas/Answer" + }, + "no_answer": { + "title": "No Answer", + "type": "boolean" + }, + "pipeline_id": { + "title": "Pipeline Id", + "type": "string" + }, + "created_at": { + "title": "Created At", + "type": "string" + }, + "updated_at": { + "title": "Updated At", + "type": "string" + }, + "meta": { + "title": "Meta", + "type": "object" + }, + "filters": { + "title": "Filters", + "type": "object" + } + }, + "additionalProperties": false + }, + "Document": { + "title": "Document", + "required": [ + "id", + "content" + ], + "type": "object", + "properties": { + "id": { + "title": "Id", + "type": "string" + }, + "content": { + "title": "Content", + "anyOf": [ + { + "type": "string" + }, + { + "type": "string" + } + ] + }, + "content_type": { + "title": "Content Type", + "enum": [ + "text", + "table", + "image", + "audio" + ], + "type": "string", + "default": "text" + }, + "meta": { + "title": "Meta", + "type": "object", + "default": {} + }, + "score": { + "title": "Score", + "type": "number" + }, + "embedding": { + "title": "Embedding", + "type": "string" + } + } + }, + "FilterRequest": { + "title": "FilterRequest", + "type": "object", + "properties": { + "filters": { + "title": "Filters", + "type": "object", + "additionalProperties": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "integer" + }, + { + "type": "number" + }, + { + "type": "boolean" + }, + { + "type": "array", + "items": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "integer" + }, + { + "type": "number" + }, + { + "type": "boolean" + } + ] + } + }, + { + "type": "object", + "additionalProperties": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "integer" + }, + { + "type": "number" + }, + { + "type": "boolean" + } + ] + } + } + ] + } + } + }, + "additionalProperties": false + }, + "GPUInfo": { + "title": "GPUInfo", + "required": [ + "index", + "usage" + ], + "type": "object", + "properties": { + "index": { + "title": "Index", + "type": "integer", + "description": "GPU index" + }, + "usage": { + "title": "Usage", + "allOf": [ + { + "$ref": "#/components/schemas/GPUUsage" + } + ], + "description": "GPU usage details" + } + } + }, + "GPUUsage": { + "title": "GPUUsage", + "required": [ + "kernel_usage", + "memory_total", + "memory_used" + ], + "type": "object", + "properties": { + "kernel_usage": { + "title": "Kernel Usage", + "type": "number", + "description": "GPU kernel usage in percentage" + }, + "memory_total": { + "title": "Memory Total", + "type": "integer", + "description": "Total GPU memory in megabytes" + }, + "memory_used": { + "title": "Memory Used", + "type": "integer", + "description": "REST API used GPU memory in megabytes" + } + } + }, + "HTTPValidationError": { + "title": "HTTPValidationError", + "type": "object", + "properties": { + "detail": { + "title": "Detail", + "type": "array", + "items": { + "$ref": "#/components/schemas/ValidationError" + } + } + } + }, + "HealthResponse": { + "title": "HealthResponse", + "required": [ + "version", + "cpu", + "memory" + ], + "type": "object", + "properties": { + "version": { + "title": "Version", + "type": "string", + "description": "Haystack version" + }, + "cpu": { + "title": "Cpu", + "allOf": [ + { + "$ref": "#/components/schemas/CPUUsage" + } + ], + "description": "CPU usage details" + }, + "memory": { + "title": "Memory", + "allOf": [ + { + "$ref": "#/components/schemas/MemoryUsage" + } + ], + "description": "Memory usage details" + }, + "gpus": { + "title": "Gpus", + "type": "array", + "items": { + "$ref": "#/components/schemas/GPUInfo" + }, + "description": "GPU usage details" + } + } + }, + "Label": { + "title": "Label", + "required": [ + "id", + "query", + "document", + "is_correct_answer", + "is_correct_document", + "origin" + ], + "type": "object", + "properties": { + "id": { + "title": "Id", + "type": "string" + }, + "query": { + "title": "Query", + "type": "string" + }, + "document": { + "$ref": "#/components/schemas/Document" + }, + "is_correct_answer": { + "title": "Is Correct Answer", + "type": "boolean" + }, + "is_correct_document": { + "title": "Is Correct Document", + "type": "boolean" + }, + "origin": { + "title": "Origin", + "enum": [ + "user-feedback", + "gold-label" + ], + "type": "string" + }, + "answer": { + "$ref": "#/components/schemas/Answer" + }, + "no_answer": { + "title": "No Answer", + "type": "boolean" + }, + "pipeline_id": { + "title": "Pipeline Id", + "type": "string" + }, + "created_at": { + "title": "Created At", + "type": "string" + }, + "updated_at": { + "title": "Updated At", + "type": "string" + }, + "meta": { + "title": "Meta", + "type": "object" + }, + "filters": { + "title": "Filters", + "type": "object" + } + } + }, + "MemoryUsage": { + "title": "MemoryUsage", + "required": [ + "used" + ], + "type": "object", + "properties": { + "used": { + "title": "Used", + "type": "number", + "description": "REST API used memory in percentage" + } + } + }, + "QueryRequest": { + "title": "QueryRequest", + "required": [ + "query" + ], + "type": "object", + "properties": { + "query": { + "title": "Query", + "type": "string" + }, + "params": { + "title": "Params", + "type": "object" + }, + "debug": { + "title": "Debug", + "type": "boolean", + "default": false + } + }, + "additionalProperties": false + }, + "QueryResponse": { + "title": "QueryResponse", + "required": [ + "query" + ], + "type": "object", + "properties": { + "query": { + "title": "Query", + "type": "string" + }, + "answers": { + "title": "Answers", + "type": "array", + "items": { + "$ref": "#/components/schemas/Answer" + }, + "default": [] + }, + "documents": { + "title": "Documents", + "type": "array", + "items": { + "$ref": "#/components/schemas/Document" + }, + "default": [] + }, + "_debug": { + "title": " Debug", + "type": "object" + } + } + }, + "Span": { + "title": "Span", + "required": [ + "start", + "end" + ], + "type": "object", + "properties": { + "start": { + "title": "Start", + "type": "integer" + }, + "end": { + "title": "End", + "type": "integer" + } + } + }, + "ValidationError": { + "title": "ValidationError", + "required": [ + "loc", + "msg", + "type" + ], + "type": "object", + "properties": { + "loc": { + "title": "Location", + "type": "array", + "items": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "integer" + } + ] + } + }, + "msg": { + "title": "Message", + "type": "string" + }, + "type": { + "title": "Error Type", + "type": "string" + } + } + } + } + } +} \ No newline at end of file diff --git a/docs/_src/api/openapi/openapi.json b/docs/_src/api/openapi/openapi.json index 5d6fbb5491..a620ed820d 100644 --- a/docs/_src/api/openapi/openapi.json +++ b/docs/_src/api/openapi/openapi.json @@ -2,7 +2,7 @@ "openapi": "3.0.2", "info": { "title": "Haystack REST API", - "version": "1.10.0rc1" + "version": "1.10.0" }, "paths": { "/initialized": { diff --git a/haystack/json-schemas/haystack-pipeline-1.10.0.schema.json b/haystack/json-schemas/haystack-pipeline-1.10.0.schema.json new file mode 100644 index 0000000000..6cf51ef9af --- /dev/null +++ b/haystack/json-schemas/haystack-pipeline-1.10.0.schema.json @@ -0,0 +1,6658 @@ +{ + "$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.schema.json b/haystack/json-schemas/haystack-pipeline.schema.json index 39b9530acf..16ccb7dafb 100644 --- a/haystack/json-schemas/haystack-pipeline.schema.json +++ b/haystack/json-schemas/haystack-pipeline.schema.json @@ -240,6 +240,20 @@ "$ref": "https://raw.githubusercontent.com/deepset-ai/haystack/main/haystack/json-schemas/haystack-pipeline-1.10.0rc1.schema.json" } ] + }, + { + "allOf": [ + { + "properties": { + "version": { + "const": "1.10.0" + } + } + }, + { + "$ref": "https://raw.githubusercontent.com/deepset-ai/haystack/main/haystack/json-schemas/haystack-pipeline-1.10.0.schema.json" + } + ] } ], "title": "Haystack Pipeline",