version-2.18-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/external-integrations-audio", 153 "pipeline-components/audio/localwhispertranscriber", 154 "pipeline-components/audio/remotewhispertranscriber" 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/external-integrations-connectors", 198 "pipeline-components/connectors/githubfileeditor", 199 "pipeline-components/connectors/githubissuecommenter", 200 "pipeline-components/connectors/githubissueviewer", 201 "pipeline-components/connectors/githubprcreator", 202 "pipeline-components/connectors/githubrepoforker", 203 "pipeline-components/connectors/githubrepoviewer", 204 "pipeline-components/connectors/jinareaderconnector", 205 "pipeline-components/connectors/langfuseconnector", 206 "pipeline-components/connectors/openapiconnector", 207 "pipeline-components/connectors/openapiserviceconnector", 208 "pipeline-components/connectors/weaveconnector" 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/external-integrations-converters", 224 "pipeline-components/converters/htmltodocument", 225 "pipeline-components/converters/imagefiletodocument", 226 "pipeline-components/converters/imagefiletoimagecontent", 227 "pipeline-components/converters/jsonconverter", 228 "pipeline-components/converters/markdowntodocument", 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 ] 242 }, 243 { 244 "type": "category", 245 "label": "Downloaders", 246 "items": [ 247 "pipeline-components/downloaders/s3downloader" 248 ] 249 }, 250 { 251 "type": "category", 252 "label": "Embedders", 253 "link": { 254 "type": "doc", 255 "id": "pipeline-components/embedders" 256 }, 257 "items": [ 258 "pipeline-components/embedders/choosing-the-right-embedder", 259 "pipeline-components/embedders/amazonbedrockdocumentembedder", 260 "pipeline-components/embedders/amazonbedrockdocumentimageembedder", 261 "pipeline-components/embedders/amazonbedrocktextembedder", 262 "pipeline-components/embedders/azureopenaidocumentembedder", 263 "pipeline-components/embedders/azureopenaitextembedder", 264 "pipeline-components/embedders/coheredocumentembedder", 265 "pipeline-components/embedders/coheredocumentimageembedder", 266 "pipeline-components/embedders/coheretextembedder", 267 "pipeline-components/embedders/external-integrations-embedders", 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/sentencetransformerstextembedder", 292 "pipeline-components/embedders/stackitdocumentembedder", 293 "pipeline-components/embedders/stackittextembedder", 294 "pipeline-components/embedders/vertexaidocumentembedder", 295 "pipeline-components/embedders/vertexaitextembedder", 296 "pipeline-components/embedders/watsonxdocumentembedder", 297 "pipeline-components/embedders/watsonxtextembedder" 298 ] 299 }, 300 { 301 "type": "category", 302 "label": "Evaluators", 303 "link": { 304 "type": "doc", 305 "id": "pipeline-components/evaluators" 306 }, 307 "items": [ 308 "pipeline-components/evaluators/answerexactmatchevaluator", 309 "pipeline-components/evaluators/contextrelevanceevaluator", 310 "pipeline-components/evaluators/deepevalevaluator", 311 "pipeline-components/evaluators/documentmapevaluator", 312 "pipeline-components/evaluators/documentmrrevaluator", 313 "pipeline-components/evaluators/documentndcgevaluator", 314 "pipeline-components/evaluators/documentrecallevaluator", 315 "pipeline-components/evaluators/external-integrations-evaluators", 316 "pipeline-components/evaluators/faithfulnessevaluator", 317 "pipeline-components/evaluators/llmevaluator", 318 "pipeline-components/evaluators/ragasevaluator", 319 "pipeline-components/evaluators/sasevaluator" 320 ] 321 }, 322 { 323 "type": "category", 324 "label": "Extractors", 325 "link": { 326 "type": "doc", 327 "id": "pipeline-components/extractors" 328 }, 329 "items": [ 330 "pipeline-components/extractors/llmdocumentcontentextractor", 331 "pipeline-components/extractors/llmmetadataextractor", 332 "pipeline-components/extractors/namedentityextractor" 333 ] 334 }, 335 { 336 "type": "category", 337 "label": "Fetchers", 338 "link": { 339 "type": "doc", 340 "id": "pipeline-components/fetchers" 341 }, 342 "items": [ 343 "pipeline-components/fetchers/external-integrations-fetchers", 344 "pipeline-components/fetchers/linkcontentfetcher" 345 ] 346 }, 347 { 348 "type": "category", 349 "label": "Generators", 350 "link": { 351 "type": "doc", 352 "id": "pipeline-components/generators" 353 }, 354 "items": [ 355 { 356 "type": "category", 357 "label": "Guides to Generators", 358 "items": [ 359 "pipeline-components/generators/guides-to-generators/choosing-the-right-generator", 360 "pipeline-components/generators/guides-to-generators/function-calling", 361 "pipeline-components/generators/guides-to-generators/generators-vs-chat-generators" 362 ] 363 }, 364 "pipeline-components/generators/amazonbedrockchatgenerator", 365 "pipeline-components/generators/amazonbedrockgenerator", 366 "pipeline-components/generators/anthropicchatgenerator", 367 "pipeline-components/generators/anthropicgenerator", 368 "pipeline-components/generators/anthropicvertexchatgenerator", 369 "pipeline-components/generators/azureopenaichatgenerator", 370 "pipeline-components/generators/azureopenaigenerator", 371 "pipeline-components/generators/coherechatgenerator", 372 "pipeline-components/generators/coheregenerator", 373 "pipeline-components/generators/dalleimagegenerator", 374 "pipeline-components/generators/external-integrations-generators", 375 "pipeline-components/generators/googleaigeminichatgenerator", 376 "pipeline-components/generators/googleaigeminigenerator", 377 "pipeline-components/generators/googlegenaichatgenerator", 378 "pipeline-components/generators/huggingfaceapichatgenerator", 379 "pipeline-components/generators/huggingfaceapigenerator", 380 "pipeline-components/generators/huggingfacelocalchatgenerator", 381 "pipeline-components/generators/huggingfacelocalgenerator", 382 "pipeline-components/generators/llamacppchatgenerator", 383 "pipeline-components/generators/llamacppgenerator", 384 "pipeline-components/generators/llamastackchatgenerator", 385 "pipeline-components/generators/metallamachatgenerator", 386 "pipeline-components/generators/mistralchatgenerator", 387 "pipeline-components/generators/nvidiachatgenerator", 388 "pipeline-components/generators/nvidiagenerator", 389 "pipeline-components/generators/ollamachatgenerator", 390 "pipeline-components/generators/ollamagenerator", 391 "pipeline-components/generators/openaichatgenerator", 392 "pipeline-components/generators/openaigenerator", 393 "pipeline-components/generators/openrouterchatgenerator", 394 "pipeline-components/generators/sagemakergenerator", 395 "pipeline-components/generators/stackitchatgenerator", 396 "pipeline-components/generators/vertexaicodegenerator", 397 "pipeline-components/generators/vertexaigeminichatgenerator", 398 "pipeline-components/generators/vertexaigeminigenerator", 399 "pipeline-components/generators/vertexaiimagecaptioner", 400 "pipeline-components/generators/vertexaiimagegenerator", 401 "pipeline-components/generators/vertexaiimageqa", 402 "pipeline-components/generators/vertexaitextgenerator", 403 "pipeline-components/generators/watsonxchatgenerator", 404 "pipeline-components/generators/watsonxgenerator" 405 ] 406 }, 407 { 408 "type": "category", 409 "label": "Joiners", 410 "link": { 411 "type": "doc", 412 "id": "pipeline-components/joiners" 413 }, 414 "items": [ 415 "pipeline-components/joiners/answerjoiner", 416 "pipeline-components/joiners/branchjoiner", 417 "pipeline-components/joiners/documentjoiner", 418 "pipeline-components/joiners/listjoiner", 419 "pipeline-components/joiners/stringjoiner" 420 ] 421 }, 422 { 423 "type": "category", 424 "label": "Preprocessors", 425 "link": { 426 "type": "doc", 427 "id": "pipeline-components/preprocessors" 428 }, 429 "items": [ 430 "pipeline-components/preprocessors/chinesedocumentsplitter", 431 "pipeline-components/preprocessors/csvdocumentcleaner", 432 "pipeline-components/preprocessors/csvdocumentsplitter", 433 "pipeline-components/preprocessors/documentcleaner", 434 "pipeline-components/preprocessors/documentpreprocessor", 435 "pipeline-components/preprocessors/documentsplitter", 436 "pipeline-components/preprocessors/hierarchicaldocumentsplitter", 437 "pipeline-components/preprocessors/recursivesplitter", 438 "pipeline-components/preprocessors/textcleaner" 439 ] 440 }, 441 { 442 "type": "category", 443 "label": "Rankers", 444 "link": { 445 "type": "doc", 446 "id": "pipeline-components/rankers" 447 }, 448 "items": [ 449 "pipeline-components/rankers/choosing-the-right-ranker", 450 "pipeline-components/rankers/amazonbedrockranker", 451 "pipeline-components/rankers/cohereranker", 452 "pipeline-components/rankers/external-integrations-rankers", 453 "pipeline-components/rankers/fastembedranker", 454 "pipeline-components/rankers/huggingfaceteiranker", 455 "pipeline-components/rankers/jinaranker", 456 "pipeline-components/rankers/lostinthemiddleranker", 457 "pipeline-components/rankers/metafieldgroupingranker", 458 "pipeline-components/rankers/metafieldranker", 459 "pipeline-components/rankers/nvidiaranker", 460 "pipeline-components/rankers/pyversityranker", 461 "pipeline-components/rankers/sentencetransformersdiversityranker", 462 "pipeline-components/rankers/sentencetransformerssimilarityranker", 463 "pipeline-components/rankers/transformerssimilarityranker" 464 ] 465 }, 466 { 467 "type": "category", 468 "label": "Readers", 469 "link": { 470 "type": "doc", 471 "id": "pipeline-components/readers" 472 }, 473 "items": [ 474 "pipeline-components/readers/extractivereader" 475 ] 476 }, 477 { 478 "type": "category", 479 "label": "Retrievers", 480 "link": { 481 "type": "doc", 482 "id": "pipeline-components/retrievers" 483 }, 484 "items": [ 485 "pipeline-components/retrievers/astraretriever", 486 "pipeline-components/retrievers/automergingretriever", 487 "pipeline-components/retrievers/azureaisearchbm25retriever", 488 "pipeline-components/retrievers/azureaisearchembeddingretriever", 489 "pipeline-components/retrievers/azureaisearchhybridretriever", 490 "pipeline-components/retrievers/chromaembeddingretriever", 491 "pipeline-components/retrievers/chromaqueryretriever", 492 "pipeline-components/retrievers/elasticsearchbm25retriever", 493 "pipeline-components/retrievers/elasticsearchembeddingretriever", 494 "pipeline-components/retrievers/filterretriever", 495 "pipeline-components/retrievers/inmemorybm25retriever", 496 "pipeline-components/retrievers/inmemoryembeddingretriever", 497 "pipeline-components/retrievers/mongodbatlasembeddingretriever", 498 "pipeline-components/retrievers/mongodbatlasfulltextretriever", 499 "pipeline-components/retrievers/opensearchbm25retriever", 500 "pipeline-components/retrievers/opensearchembeddingretriever", 501 "pipeline-components/retrievers/opensearchhybridretriever", 502 "pipeline-components/retrievers/pgvectorembeddingretriever", 503 "pipeline-components/retrievers/pgvectorkeywordretriever", 504 "pipeline-components/retrievers/pineconedenseretriever", 505 "pipeline-components/retrievers/qdrantembeddingretriever", 506 "pipeline-components/retrievers/qdranthybridretriever", 507 "pipeline-components/retrievers/qdrantsparseembeddingretriever", 508 "pipeline-components/retrievers/sentencewindowretrieval", 509 "pipeline-components/retrievers/snowflaketableretriever", 510 "pipeline-components/retrievers/weaviatebm25retriever", 511 "pipeline-components/retrievers/weaviateembeddingretriever", 512 "pipeline-components/retrievers/weaviatehybridretriever" 513 ] 514 }, 515 { 516 "type": "category", 517 "label": "Routers", 518 "link": { 519 "type": "doc", 520 "id": "pipeline-components/routers" 521 }, 522 "items": [ 523 "pipeline-components/routers/conditionalrouter", 524 "pipeline-components/routers/documentlengthrouter", 525 "pipeline-components/routers/documenttyperouter", 526 "pipeline-components/routers/filetyperouter", 527 "pipeline-components/routers/llmmessagesrouter", 528 "pipeline-components/routers/metadatarouter", 529 "pipeline-components/routers/textlanguagerouter", 530 "pipeline-components/routers/transformerstextrouter", 531 "pipeline-components/routers/transformerszeroshottextrouter" 532 ] 533 }, 534 { 535 "type": "category", 536 "label": "Samplers", 537 "items": [ 538 "pipeline-components/samplers/toppsampler" 539 ] 540 }, 541 { 542 "type": "category", 543 "label": "Tools", 544 "items": [ 545 "pipeline-components/tools/toolinvoker" 546 ] 547 }, 548 { 549 "type": "category", 550 "label": "Validators", 551 "items": [ 552 "pipeline-components/validators/jsonschemavalidator" 553 ] 554 }, 555 { 556 "type": "category", 557 "label": "Websearch", 558 "link": { 559 "type": "doc", 560 "id": "pipeline-components/websearch" 561 }, 562 "items": [ 563 "pipeline-components/websearch/external-integrations-websearch", 564 "pipeline-components/websearch/searchapiwebsearch", 565 "pipeline-components/websearch/serperdevwebsearch" 566 ] 567 }, 568 { 569 "type": "category", 570 "label": "Writers", 571 "items": [ 572 "pipeline-components/writers/documentwriter" 573 ] 574 } 575 ] 576 }, 577 { 578 "type": "category", 579 "label": "Tools", 580 "items": [ 581 "tools/tool", 582 "tools/componenttool", 583 "tools/pipelinetool", 584 "tools/toolset", 585 "tools/mcptool", 586 "tools/mcptoolset", 587 { 588 "type": "category", 589 "label": "Ready-made Tools", 590 "items": [ 591 "tools/ready-made-tools/githubfileeditortool", 592 "tools/ready-made-tools/githubissuecommentertool", 593 "tools/ready-made-tools/githubissueviewertool", 594 "tools/ready-made-tools/githubprcreatortool", 595 "tools/ready-made-tools/githubrepoviewertool" 596 ] 597 } 598 ] 599 }, 600 { 601 "type": "category", 602 "label": "Optimization", 603 "items": [ 604 { 605 "type": "category", 606 "label": "Evaluation", 607 "link": { 608 "type": "doc", 609 "id": "optimization/evaluation" 610 }, 611 "items": [ 612 "optimization/evaluation/model-based-evaluation", 613 "optimization/evaluation/statistical-evaluation" 614 ] 615 }, 616 { 617 "type": "category", 618 "label": "Advanced RAG Techniques", 619 "link": { 620 "type": "doc", 621 "id": "optimization/advanced-rag-techniques" 622 }, 623 "items": [ 624 "optimization/advanced-rag-techniques/hypothetical-document-embeddings-hyde" 625 ] 626 } 627 ] 628 }, 629 { 630 "type": "category", 631 "label": "Development", 632 "items": [ 633 "development/logging", 634 "development/tracing", 635 "development/external-integrations-development", 636 "development/enabling-gpu-acceleration", 637 "development/hayhooks", 638 { 639 "type": "category", 640 "label": "Deployment", 641 "link": { 642 "type": "doc", 643 "id": "development/deployment" 644 }, 645 "items": [ 646 "development/deployment/docker", 647 "development/deployment/kubernetes", 648 "development/deployment/openshift" 649 ] 650 } 651 ] 652 } 653 ] 654 }