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