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