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