version-2.19-sidebars.json
1 { 2 "docs": [ 3 { 4 "type": "doc", 5 "id": "intro", 6 "label": "Introduction" 7 }, 8 { 9 "type": "category", 10 "label": "Overview", 11 "items": [ 12 "overview/installation", 13 "overview/get-started", 14 "overview/faq", 15 "overview/telemetry", 16 "overview/breaking-change-policy", 17 "overview/migration" 18 ] 19 }, 20 { 21 "type": "category", 22 "label": "Haystack Concepts", 23 "items": [ 24 "concepts/concepts-overview", 25 { 26 "type": "category", 27 "label": "Agents", 28 "link": { 29 "type": "doc", 30 "id": "concepts/agents" 31 }, 32 "items": [ 33 "concepts/agents/state" 34 ] 35 }, 36 { 37 "type": "category", 38 "label": "Components", 39 "link": { 40 "type": "doc", 41 "id": "concepts/components" 42 }, 43 "items": [ 44 "concepts/components/custom-components", 45 "concepts/components/supercomponents" 46 ] 47 }, 48 { 49 "type": "category", 50 "label": "Pipelines", 51 "link": { 52 "type": "doc", 53 "id": "concepts/pipelines" 54 }, 55 "items": [ 56 "concepts/pipelines/creating-pipelines", 57 "concepts/pipelines/serialization", 58 "concepts/pipelines/visualizing-pipelines", 59 "concepts/pipelines/debugging-pipelines", 60 "concepts/pipelines/pipeline-breakpoints", 61 "concepts/pipelines/pipeline-templates", 62 "concepts/pipelines/asyncpipeline" 63 ] 64 }, 65 { 66 "type": "category", 67 "label": "Data Classes", 68 "link": { 69 "type": "doc", 70 "id": "concepts/data-classes" 71 }, 72 "items": [ 73 "concepts/data-classes/chatmessage" 74 ] 75 }, 76 { 77 "type": "category", 78 "label": "Document Store", 79 "link": { 80 "type": "doc", 81 "id": "concepts/document-store" 82 }, 83 "items": [ 84 "concepts/document-store/choosing-a-document-store", 85 "concepts/document-store/creating-custom-document-stores" 86 ] 87 }, 88 "concepts/metadata-filtering", 89 "concepts/device-management", 90 "concepts/secret-management", 91 "concepts/jinja-templates", 92 "concepts/integrations", 93 "concepts/experimental-package" 94 ] 95 }, 96 { 97 "type": "category", 98 "label": "Document Stores", 99 "items": [ 100 "document-stores/inmemorydocumentstore", 101 "document-stores/astradocumentstore", 102 "document-stores/azureaisearchdocumentstore", 103 "document-stores/chromadocumentstore", 104 { 105 "type": "link", 106 "label": "CouchbaseDocumentStore", 107 "href": "https://haystack.deepset.ai/integrations/couchbase-document-store" 108 }, 109 "document-stores/elasticsearch-document-store", 110 { 111 "type": "link", 112 "label": "LanceDBDocumentStore", 113 "href": "https://haystack.deepset.ai/integrations/lancedb/" 114 }, 115 { 116 "type": "link", 117 "label": "MilvusDocumentStore", 118 "href": "https://haystack.deepset.ai/integrations/milvus-document-store" 119 }, 120 "document-stores/mongodbatlasdocumentstore", 121 { 122 "type": "link", 123 "label": "Neo4jDocumentStore", 124 "href": "https://haystack.deepset.ai/integrations/neo4j-document-store" 125 }, 126 "document-stores/opensearch-document-store", 127 "document-stores/pgvectordocumentstore", 128 "document-stores/pinecone-document-store", 129 "document-stores/qdrant-document-store", 130 "document-stores/weaviatedocumentstore" 131 ] 132 }, 133 { 134 "type": "category", 135 "label": "Pipeline Components", 136 "items": [ 137 { 138 "type": "category", 139 "label": "Agents", 140 "items": [ 141 "pipeline-components/agents-1/agent" 142 ] 143 }, 144 { 145 "type": "category", 146 "label": "Audio", 147 "link": { 148 "type": "doc", 149 "id": "pipeline-components/audio" 150 }, 151 "items": [ 152 "pipeline-components/audio/localwhispertranscriber", 153 "pipeline-components/audio/remotewhispertranscriber", 154 "pipeline-components/audio/external-integrations-audio" 155 ] 156 }, 157 { 158 "type": "category", 159 "label": "Builders", 160 "link": { 161 "type": "doc", 162 "id": "pipeline-components/builders" 163 }, 164 "items": [ 165 "pipeline-components/builders/answerbuilder", 166 "pipeline-components/builders/chatpromptbuilder", 167 "pipeline-components/builders/promptbuilder" 168 ] 169 }, 170 { 171 "type": "category", 172 "label": "Caching", 173 "items": [ 174 "pipeline-components/caching/cachechecker" 175 ] 176 }, 177 { 178 "type": "category", 179 "label": "Classifiers", 180 "link": { 181 "type": "doc", 182 "id": "pipeline-components/classifiers" 183 }, 184 "items": [ 185 "pipeline-components/classifiers/documentlanguageclassifier", 186 "pipeline-components/classifiers/transformerszeroshotdocumentclassifier" 187 ] 188 }, 189 { 190 "type": "category", 191 "label": "Connectors", 192 "link": { 193 "type": "doc", 194 "id": "pipeline-components/connectors" 195 }, 196 "items": [ 197 "pipeline-components/connectors/githubfileeditor", 198 "pipeline-components/connectors/githubissuecommenter", 199 "pipeline-components/connectors/githubissueviewer", 200 "pipeline-components/connectors/githubprcreator", 201 "pipeline-components/connectors/githubrepoforker", 202 "pipeline-components/connectors/githubrepoviewer", 203 "pipeline-components/connectors/jinareaderconnector", 204 "pipeline-components/connectors/langfuseconnector", 205 "pipeline-components/connectors/openapiconnector", 206 "pipeline-components/connectors/openapiserviceconnector", 207 "pipeline-components/connectors/weaveconnector", 208 "pipeline-components/connectors/external-integrations-connectors" 209 ] 210 }, 211 { 212 "type": "category", 213 "label": "Converters", 214 "link": { 215 "type": "doc", 216 "id": "pipeline-components/converters" 217 }, 218 "items": [ 219 "pipeline-components/converters/azureocrdocumentconverter", 220 "pipeline-components/converters/csvtodocument", 221 "pipeline-components/converters/documenttoimagecontent", 222 "pipeline-components/converters/docxtodocument", 223 "pipeline-components/converters/htmltodocument", 224 "pipeline-components/converters/imagefiletodocument", 225 "pipeline-components/converters/imagefiletoimagecontent", 226 "pipeline-components/converters/jsonconverter", 227 "pipeline-components/converters/markdowntodocument", 228 "pipeline-components/converters/mistralocrdocumentconverter", 229 "pipeline-components/converters/msgtodocument", 230 "pipeline-components/converters/multifileconverter", 231 "pipeline-components/converters/openapiservicetofunctions", 232 "pipeline-components/converters/outputadapter", 233 "pipeline-components/converters/pdfminertodocument", 234 "pipeline-components/converters/pdftoimagecontent", 235 "pipeline-components/converters/pptxtodocument", 236 "pipeline-components/converters/pypdftodocument", 237 "pipeline-components/converters/textfiletodocument", 238 "pipeline-components/converters/tikadocumentconverter", 239 "pipeline-components/converters/unstructuredfileconverter", 240 "pipeline-components/converters/xlsxtodocument", 241 "pipeline-components/converters/external-integrations-converters" 242 ] 243 }, 244 { 245 "type": "category", 246 "label": "Downloaders", 247 "items": [ 248 "pipeline-components/downloaders/s3downloader" 249 ] 250 }, 251 { 252 "type": "category", 253 "label": "Embedders", 254 "link": { 255 "type": "doc", 256 "id": "pipeline-components/embedders" 257 }, 258 "items": [ 259 "pipeline-components/embedders/choosing-the-right-embedder", 260 "pipeline-components/embedders/amazonbedrockdocumentembedder", 261 "pipeline-components/embedders/amazonbedrockdocumentimageembedder", 262 "pipeline-components/embedders/amazonbedrocktextembedder", 263 "pipeline-components/embedders/azureopenaidocumentembedder", 264 "pipeline-components/embedders/azureopenaitextembedder", 265 "pipeline-components/embedders/coheredocumentembedder", 266 "pipeline-components/embedders/coheredocumentimageembedder", 267 "pipeline-components/embedders/coheretextembedder", 268 "pipeline-components/embedders/fastembeddocumentembedder", 269 "pipeline-components/embedders/fastembedsparsedocumentembedder", 270 "pipeline-components/embedders/fastembedsparsetextembedder", 271 "pipeline-components/embedders/fastembedtextembedder", 272 "pipeline-components/embedders/googlegenaidocumentembedder", 273 "pipeline-components/embedders/googlegenaitextembedder", 274 "pipeline-components/embedders/huggingfaceapidocumentembedder", 275 "pipeline-components/embedders/huggingfaceapitextembedder", 276 "pipeline-components/embedders/jinadocumentembedder", 277 "pipeline-components/embedders/jinadocumentimageembedder", 278 "pipeline-components/embedders/jinatextembedder", 279 "pipeline-components/embedders/mistraldocumentembedder", 280 "pipeline-components/embedders/mistraltextembedder", 281 "pipeline-components/embedders/nvidiadocumentembedder", 282 "pipeline-components/embedders/nvidiatextembedder", 283 "pipeline-components/embedders/ollamadocumentembedder", 284 "pipeline-components/embedders/ollamatextembedder", 285 "pipeline-components/embedders/openaidocumentembedder", 286 "pipeline-components/embedders/openaitextembedder", 287 "pipeline-components/embedders/optimumdocumentembedder", 288 "pipeline-components/embedders/optimumtextembedder", 289 "pipeline-components/embedders/sentencetransformersdocumentembedder", 290 "pipeline-components/embedders/sentencetransformersdocumentimageembedder", 291 "pipeline-components/embedders/sentencetransformerssparsedocumentembedder", 292 "pipeline-components/embedders/sentencetransformerssparsetextembedder", 293 "pipeline-components/embedders/sentencetransformerstextembedder", 294 "pipeline-components/embedders/stackitdocumentembedder", 295 "pipeline-components/embedders/stackittextembedder", 296 "pipeline-components/embedders/vertexaidocumentembedder", 297 "pipeline-components/embedders/vertexaitextembedder", 298 "pipeline-components/embedders/watsonxdocumentembedder", 299 "pipeline-components/embedders/watsonxtextembedder", 300 "pipeline-components/embedders/external-integrations-embedders" 301 ] 302 }, 303 { 304 "type": "category", 305 "label": "Evaluators", 306 "link": { 307 "type": "doc", 308 "id": "pipeline-components/evaluators" 309 }, 310 "items": [ 311 "pipeline-components/evaluators/answerexactmatchevaluator", 312 "pipeline-components/evaluators/contextrelevanceevaluator", 313 "pipeline-components/evaluators/deepevalevaluator", 314 "pipeline-components/evaluators/documentmapevaluator", 315 "pipeline-components/evaluators/documentmrrevaluator", 316 "pipeline-components/evaluators/documentndcgevaluator", 317 "pipeline-components/evaluators/documentrecallevaluator", 318 "pipeline-components/evaluators/faithfulnessevaluator", 319 "pipeline-components/evaluators/llmevaluator", 320 "pipeline-components/evaluators/ragasevaluator", 321 "pipeline-components/evaluators/sasevaluator", 322 "pipeline-components/evaluators/external-integrations-evaluators" 323 ] 324 }, 325 { 326 "type": "category", 327 "label": "Extractors", 328 "link": { 329 "type": "doc", 330 "id": "pipeline-components/extractors" 331 }, 332 "items": [ 333 "pipeline-components/extractors/llmdocumentcontentextractor", 334 "pipeline-components/extractors/llmmetadataextractor", 335 "pipeline-components/extractors/namedentityextractor" 336 ] 337 }, 338 { 339 "type": "category", 340 "label": "Fetchers", 341 "link": { 342 "type": "doc", 343 "id": "pipeline-components/fetchers" 344 }, 345 "items": [ 346 "pipeline-components/fetchers/linkcontentfetcher", 347 "pipeline-components/fetchers/external-integrations-fetchers" 348 ] 349 }, 350 { 351 "type": "category", 352 "label": "Generators", 353 "link": { 354 "type": "doc", 355 "id": "pipeline-components/generators" 356 }, 357 "items": [ 358 { 359 "type": "category", 360 "label": "Guides to Generators", 361 "items": [ 362 "pipeline-components/generators/guides-to-generators/choosing-the-right-generator", 363 "pipeline-components/generators/guides-to-generators/function-calling", 364 "pipeline-components/generators/guides-to-generators/generators-vs-chat-generators" 365 ] 366 }, 367 "pipeline-components/generators/amazonbedrockchatgenerator", 368 "pipeline-components/generators/amazonbedrockgenerator", 369 "pipeline-components/generators/anthropicchatgenerator", 370 "pipeline-components/generators/anthropicgenerator", 371 "pipeline-components/generators/anthropicvertexchatgenerator", 372 "pipeline-components/generators/azureopenaichatgenerator", 373 "pipeline-components/generators/azureopenaigenerator", 374 "pipeline-components/generators/coherechatgenerator", 375 "pipeline-components/generators/coheregenerator", 376 "pipeline-components/generators/dalleimagegenerator", 377 "pipeline-components/generators/fallbackchatgenerator", 378 "pipeline-components/generators/googleaigeminichatgenerator", 379 "pipeline-components/generators/googleaigeminigenerator", 380 "pipeline-components/generators/googlegenaichatgenerator", 381 "pipeline-components/generators/huggingfaceapichatgenerator", 382 "pipeline-components/generators/huggingfaceapigenerator", 383 "pipeline-components/generators/huggingfacelocalchatgenerator", 384 "pipeline-components/generators/huggingfacelocalgenerator", 385 "pipeline-components/generators/llamacppchatgenerator", 386 "pipeline-components/generators/llamacppgenerator", 387 "pipeline-components/generators/llamastackchatgenerator", 388 "pipeline-components/generators/metallamachatgenerator", 389 "pipeline-components/generators/mistralchatgenerator", 390 "pipeline-components/generators/nvidiachatgenerator", 391 "pipeline-components/generators/nvidiagenerator", 392 "pipeline-components/generators/ollamachatgenerator", 393 "pipeline-components/generators/ollamagenerator", 394 "pipeline-components/generators/openaichatgenerator", 395 "pipeline-components/generators/openaigenerator", 396 "pipeline-components/generators/openrouterchatgenerator", 397 "pipeline-components/generators/sagemakergenerator", 398 "pipeline-components/generators/stackitchatgenerator", 399 "pipeline-components/generators/togetheraichatgenerator", 400 "pipeline-components/generators/togetheraigenerator", 401 "pipeline-components/generators/vertexaicodegenerator", 402 "pipeline-components/generators/vertexaigeminichatgenerator", 403 "pipeline-components/generators/vertexaigeminigenerator", 404 "pipeline-components/generators/vertexaiimagecaptioner", 405 "pipeline-components/generators/vertexaiimagegenerator", 406 "pipeline-components/generators/vertexaiimageqa", 407 "pipeline-components/generators/vertexaitextgenerator", 408 "pipeline-components/generators/watsonxchatgenerator", 409 "pipeline-components/generators/watsonxgenerator", 410 "pipeline-components/generators/external-integrations-generators" 411 ] 412 }, 413 { 414 "type": "category", 415 "label": "Joiners", 416 "link": { 417 "type": "doc", 418 "id": "pipeline-components/joiners" 419 }, 420 "items": [ 421 "pipeline-components/joiners/answerjoiner", 422 "pipeline-components/joiners/branchjoiner", 423 "pipeline-components/joiners/documentjoiner", 424 "pipeline-components/joiners/listjoiner", 425 "pipeline-components/joiners/stringjoiner" 426 ] 427 }, 428 { 429 "type": "category", 430 "label": "Preprocessors", 431 "link": { 432 "type": "doc", 433 "id": "pipeline-components/preprocessors" 434 }, 435 "items": [ 436 "pipeline-components/preprocessors/chinesedocumentsplitter", 437 "pipeline-components/preprocessors/csvdocumentcleaner", 438 "pipeline-components/preprocessors/csvdocumentsplitter", 439 "pipeline-components/preprocessors/documentcleaner", 440 "pipeline-components/preprocessors/documentpreprocessor", 441 "pipeline-components/preprocessors/documentsplitter", 442 "pipeline-components/preprocessors/hierarchicaldocumentsplitter", 443 "pipeline-components/preprocessors/recursivesplitter", 444 "pipeline-components/preprocessors/textcleaner" 445 ] 446 }, 447 { 448 "type": "category", 449 "label": "Rankers", 450 "link": { 451 "type": "doc", 452 "id": "pipeline-components/rankers" 453 }, 454 "items": [ 455 "pipeline-components/rankers/choosing-the-right-ranker", 456 "pipeline-components/rankers/amazonbedrockranker", 457 "pipeline-components/rankers/cohereranker", 458 "pipeline-components/rankers/fastembedranker", 459 "pipeline-components/rankers/huggingfaceteiranker", 460 "pipeline-components/rankers/jinaranker", 461 "pipeline-components/rankers/lostinthemiddleranker", 462 "pipeline-components/rankers/metafieldgroupingranker", 463 "pipeline-components/rankers/metafieldranker", 464 "pipeline-components/rankers/nvidiaranker", 465 "pipeline-components/rankers/pyversityranker", 466 "pipeline-components/rankers/sentencetransformersdiversityranker", 467 "pipeline-components/rankers/sentencetransformerssimilarityranker", 468 "pipeline-components/rankers/transformerssimilarityranker", 469 "pipeline-components/rankers/external-integrations-rankers" 470 ] 471 }, 472 { 473 "type": "category", 474 "label": "Readers", 475 "link": { 476 "type": "doc", 477 "id": "pipeline-components/readers" 478 }, 479 "items": [ 480 "pipeline-components/readers/extractivereader" 481 ] 482 }, 483 { 484 "type": "category", 485 "label": "Retrievers", 486 "link": { 487 "type": "doc", 488 "id": "pipeline-components/retrievers" 489 }, 490 "items": [ 491 "pipeline-components/retrievers/astraretriever", 492 "pipeline-components/retrievers/automergingretriever", 493 "pipeline-components/retrievers/azureaisearchbm25retriever", 494 "pipeline-components/retrievers/azureaisearchembeddingretriever", 495 "pipeline-components/retrievers/azureaisearchhybridretriever", 496 "pipeline-components/retrievers/chromaembeddingretriever", 497 "pipeline-components/retrievers/chromaqueryretriever", 498 "pipeline-components/retrievers/elasticsearchbm25retriever", 499 "pipeline-components/retrievers/elasticsearchembeddingretriever", 500 "pipeline-components/retrievers/filterretriever", 501 "pipeline-components/retrievers/inmemorybm25retriever", 502 "pipeline-components/retrievers/inmemoryembeddingretriever", 503 "pipeline-components/retrievers/mongodbatlasembeddingretriever", 504 "pipeline-components/retrievers/mongodbatlasfulltextretriever", 505 "pipeline-components/retrievers/opensearchbm25retriever", 506 "pipeline-components/retrievers/opensearchembeddingretriever", 507 "pipeline-components/retrievers/opensearchhybridretriever", 508 "pipeline-components/retrievers/pgvectorembeddingretriever", 509 "pipeline-components/retrievers/pgvectorkeywordretriever", 510 "pipeline-components/retrievers/pineconedenseretriever", 511 "pipeline-components/retrievers/qdrantembeddingretriever", 512 "pipeline-components/retrievers/qdranthybridretriever", 513 "pipeline-components/retrievers/qdrantsparseembeddingretriever", 514 "pipeline-components/retrievers/sentencewindowretrieval", 515 "pipeline-components/retrievers/snowflaketableretriever", 516 "pipeline-components/retrievers/weaviatebm25retriever", 517 "pipeline-components/retrievers/weaviateembeddingretriever", 518 "pipeline-components/retrievers/weaviatehybridretriever" 519 ] 520 }, 521 { 522 "type": "category", 523 "label": "Routers", 524 "link": { 525 "type": "doc", 526 "id": "pipeline-components/routers" 527 }, 528 "items": [ 529 "pipeline-components/routers/conditionalrouter", 530 "pipeline-components/routers/documentlengthrouter", 531 "pipeline-components/routers/documenttyperouter", 532 "pipeline-components/routers/filetyperouter", 533 "pipeline-components/routers/llmmessagesrouter", 534 "pipeline-components/routers/metadatarouter", 535 "pipeline-components/routers/textlanguagerouter", 536 "pipeline-components/routers/transformerstextrouter", 537 "pipeline-components/routers/transformerszeroshottextrouter" 538 ] 539 }, 540 { 541 "type": "category", 542 "label": "Samplers", 543 "items": [ 544 "pipeline-components/samplers/toppsampler" 545 ] 546 }, 547 { 548 "type": "category", 549 "label": "Tools", 550 "items": [ 551 "pipeline-components/tools/toolinvoker" 552 ] 553 }, 554 { 555 "type": "category", 556 "label": "Validators", 557 "items": [ 558 "pipeline-components/validators/jsonschemavalidator" 559 ] 560 }, 561 { 562 "type": "category", 563 "label": "Websearch", 564 "link": { 565 "type": "doc", 566 "id": "pipeline-components/websearch" 567 }, 568 "items": [ 569 "pipeline-components/websearch/searchapiwebsearch", 570 "pipeline-components/websearch/serperdevwebsearch", 571 "pipeline-components/websearch/external-integrations-websearch" 572 ] 573 }, 574 { 575 "type": "category", 576 "label": "Writers", 577 "items": [ 578 "pipeline-components/writers/documentwriter" 579 ] 580 } 581 ] 582 }, 583 { 584 "type": "category", 585 "label": "Tools", 586 "items": [ 587 "tools/tool", 588 "tools/componenttool", 589 "tools/pipelinetool", 590 "tools/toolset", 591 "tools/mcptool", 592 "tools/mcptoolset", 593 { 594 "type": "category", 595 "label": "Ready-made Tools", 596 "items": [ 597 "tools/ready-made-tools/githubfileeditortool", 598 "tools/ready-made-tools/githubissuecommentertool", 599 "tools/ready-made-tools/githubissueviewertool", 600 "tools/ready-made-tools/githubprcreatortool", 601 "tools/ready-made-tools/githubrepoviewertool" 602 ] 603 } 604 ] 605 }, 606 { 607 "type": "category", 608 "label": "Optimization", 609 "items": [ 610 { 611 "type": "category", 612 "label": "Evaluation", 613 "link": { 614 "type": "doc", 615 "id": "optimization/evaluation" 616 }, 617 "items": [ 618 "optimization/evaluation/model-based-evaluation", 619 "optimization/evaluation/statistical-evaluation" 620 ] 621 }, 622 { 623 "type": "category", 624 "label": "Advanced RAG Techniques", 625 "link": { 626 "type": "doc", 627 "id": "optimization/advanced-rag-techniques" 628 }, 629 "items": [ 630 "optimization/advanced-rag-techniques/hypothetical-document-embeddings-hyde" 631 ] 632 } 633 ] 634 }, 635 { 636 "type": "category", 637 "label": "Development", 638 "items": [ 639 "development/logging", 640 "development/tracing", 641 "development/enabling-gpu-acceleration", 642 "development/hayhooks", 643 { 644 "type": "category", 645 "label": "Deployment", 646 "link": { 647 "type": "doc", 648 "id": "development/deployment" 649 }, 650 "items": [ 651 "development/deployment/docker", 652 "development/deployment/kubernetes", 653 "development/deployment/openshift" 654 ] 655 }, 656 "development/external-integrations-development" 657 ] 658 } 659 ] 660 }