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