mirror of
https://github.com/deepset-ai/haystack.git
synced 2026-01-29 11:04:43 +00:00
90894491cf
* Update documentation and remove unused assets. Enhanced the 'agents' and 'components' sections with clearer descriptions and examples. Removed obsolete images and updated links for better navigation. Adjusted formatting for consistency across various documentation pages. * remove dependency * address comments * delete more empty pages * broken link * unduplicate headings * alphabetical components nav
40 lines
930 B
Plaintext
40 lines
930 B
Plaintext
---
|
|
title: "Component Name"
|
|
id: "component-name"
|
|
description: "A short description of the component"
|
|
slug: "/component-name"
|
|
---
|
|
|
|
# Component Name
|
|
|
|
| | |
|
|
| --- | --- |
|
|
| **Most common position in a pipeline** | |
|
|
| **Mandatory init variables** | |
|
|
| **Mandatory run variables** | |
|
|
| **Output variables** | |
|
|
| **API reference** | |
|
|
| **GitHub link** | |
|
|
|
|
## Overview
|
|
|
|
*What does it do in general? For example,..?*
|
|
|
|
*How does it work more specifically? Are there any pitfalls to pay attention to?*
|
|
|
|
*(if applicable) How is it different from this other very similar component? Which one do you choose?*
|
|
|
|
## Usage
|
|
|
|
*Any mandatory imports?*
|
|
|
|
### On its own
|
|
|
|
*Code snippet on how to run a component*
|
|
|
|
### In a pipeline
|
|
|
|
*Code snippet of a component being introduced in a pipeline*
|
|
|
|
*There can be more than one example. Add examples of pipelines where this component would be most useful, for example RAG, doc retrieval, etc.*
|