Skip to content

docs: sync Haystack API reference on Docusaurus #11118

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
github-actions merged 1 commit into from
Apr 16, 2026
Merged

docs: sync Haystack API reference on Docusaurus #11118

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs-website/reference/haystack-api/audio_api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ For the supported audio formats, languages, and other parameters, see the

### Usage example

{/* test-ignore */}
{/\* test-ignore \*/}

```python
from haystack.components.audio import LocalWhisperTranscriber
Expand Down
6 changes: 2 additions & 4 deletions docs-website/reference/haystack-api/connectors_api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,7 @@ arguments to it from a Haystack pipeline run method or by other components in a
pass input arguments to this component.

Example:

{/* test-ignore */}
{/\* test-ignore \*/}

```python
from haystack.utils import Secret
Expand Down Expand Up @@ -166,8 +165,7 @@ Can be through the `SERPERDEV_API_KEY` environment variable or by directly assig
variable in the code.

Usage example:

{/* test-ignore */}
{/\* test-ignore \*/}

```python
import json
Expand Down
9 changes: 4 additions & 5 deletions docs-website/reference/haystack-api/converters_api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ and a Document Intelligence or Cognitive Services resource. For help with settin

### Usage example

{/* test-ignore */}
{/\* test-ignore \*/}

```python
import os
Expand Down Expand Up @@ -379,7 +379,7 @@ Converts files to FileContent objects to be included in ChatMessage objects.

### Usage example

{/* test-ignore */}
{/\* test-ignore \*/}

```python
from haystack.components.converters import FileToFileContent
Expand Down Expand Up @@ -537,7 +537,7 @@ Documents are expected to have metadata containing:

### Usage example

{/* test-ignore */}
{/\* test-ignore \*/}

```python
from haystack import Document
Expand Down Expand Up @@ -1740,8 +1740,7 @@ For more options on running Tika,
see the [official documentation](https://github.com/apache/tika-docker/blob/main/README.md#usage).

Usage example:

{/* test-ignore */}
{/\* test-ignore \*/}

```python
from haystack.components.converters.tika import TikaDocumentConverter
Expand Down
32 changes: 15 additions & 17 deletions docs-website/reference/haystack-api/embedders_api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Calculates document embeddings using OpenAI models deployed on Azure.

### Usage example

{/* test-ignore */}
{/\* test-ignore \*/}

```python
from haystack import Document
Expand Down Expand Up @@ -139,7 +139,7 @@ Embeds strings using OpenAI models deployed on Azure.

### Usage example

{/* test-ignore */}
{/\* test-ignore \*/}

```python
from haystack.components.embedders import AzureOpenAITextEmbedder
Expand Down Expand Up @@ -257,7 +257,7 @@ Use it with the following Hugging Face APIs:

#### With free serverless inference API

{/* test-ignore */}
{/\* test-ignore \*/}

```python
from haystack.components.embedders import HuggingFaceAPIDocumentEmbedder
Expand All @@ -278,7 +278,7 @@ print(result["documents"][0].embedding)

#### With paid inference endpoints

{/* test-ignore */}
{/\* test-ignore \*/}

```python
from haystack.components.embedders import HuggingFaceAPIDocumentEmbedder
Expand All @@ -299,7 +299,7 @@ print(result["documents"][0].embedding)

#### With self-hosted text embeddings inference

{/* test-ignore */}
{/\* test-ignore \*/}

```python
from haystack.components.embedders import HuggingFaceAPIDocumentEmbedder
Expand Down Expand Up @@ -443,7 +443,7 @@ Use it with the following Hugging Face APIs:

#### With free serverless inference API

{/* test-ignore */}
{/\* test-ignore \*/}

```python
from haystack.components.embedders import HuggingFaceAPITextEmbedder
Expand All @@ -460,7 +460,7 @@ print(text_embedder.run("I love pizza!"))

#### With paid inference endpoints

{/* test-ignore */}
{/\* test-ignore \*/}

```python
from haystack.components.embedders import HuggingFaceAPITextEmbedder
Expand All @@ -476,7 +476,7 @@ print(text_embedder.run("I love pizza!"))

#### With self-hosted text embeddings inference

{/* test-ignore */}
{/\* test-ignore \*/}

```python
from haystack.components.embedders import HuggingFaceAPITextEmbedder
Expand Down Expand Up @@ -600,7 +600,7 @@ The embedding of each Document is stored in the `embedding` field of the Documen

### Usage example

{/* test-ignore */}
{/\* test-ignore \*/}

```python
from haystack import Document
Expand Down Expand Up @@ -756,7 +756,7 @@ Computes document embeddings using OpenAI models.

### Usage example

{/* test-ignore */}
{/\* test-ignore \*/}

```python
from haystack import Document
Expand Down Expand Up @@ -902,7 +902,7 @@ You can use it to embed user query and send it to an embedding Retriever.

### Usage example

{/* test-ignore */}
{/\* test-ignore \*/}

```python
from haystack.components.embedders import OpenAITextEmbedder
Expand Down Expand Up @@ -1042,7 +1042,7 @@ and send them to DocumentWriter to write into a Document Store.

### Usage example:

{/* test-ignore */}
{/\* test-ignore \*/}

```python
from haystack import Document
Expand Down Expand Up @@ -1195,7 +1195,7 @@ and send them to DocumentWriter to write a into a Document Store.

### Usage example:

{/* test-ignore */}
{/\* test-ignore \*/}

```python
from haystack import Document
Expand Down Expand Up @@ -1327,8 +1327,7 @@ Embeds strings using sparse embedding models from Sentence Transformers.
You can use it to embed user query and send it to a sparse embedding retriever.

Usage example:

{/* test-ignore */}
{/\* test-ignore \*/}

```python
from haystack.components.embedders import SentenceTransformersSparseTextEmbedder
Expand Down Expand Up @@ -1450,8 +1449,7 @@ Embeds strings using Sentence Transformers models.
You can use it to embed user query and send it to an embedding retriever.

Usage example:

{/* test-ignore */}
{/\* test-ignore \*/}

```python
from haystack.components.embedders import SentenceTransformersTextEmbedder
Expand Down
3 changes: 1 addition & 2 deletions docs-website/reference/haystack-api/extractors_api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -466,8 +466,7 @@ that contains an NER component. Annotations are stored as metadata
in the documents.

Usage example:

{/* test-ignore */}
{/\* test-ignore \*/}

```python
from haystack import Document
Expand Down
22 changes: 11 additions & 11 deletions docs-website/reference/haystack-api/generators_api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ For details on OpenAI API parameters, see

### Usage example

{/* test-ignore */}
{/\* test-ignore \*/}

```python
from haystack.components.generators import AzureOpenAIGenerator
Expand Down Expand Up @@ -170,7 +170,7 @@ For details on OpenAI API parameters, see

### Usage example

{/* test-ignore */}
{/\* test-ignore \*/}

```python
from haystack.components.generators.chat import AzureOpenAIChatGenerator
Expand Down Expand Up @@ -388,7 +388,7 @@ For details on OpenAI API parameters, see

### Usage example

{/* test-ignore */}
{/\* test-ignore \*/}

```python
from haystack.components.generators.chat import AzureOpenAIResponsesChatGenerator
Expand Down Expand Up @@ -701,7 +701,7 @@ format for input and output. Use it to generate text with Hugging Face APIs:

#### With the serverless inference API (Inference Providers) - free tier available

{/* test-ignore */}
{/\* test-ignore \*/}

```python
from haystack.components.generators.chat import HuggingFaceAPIChatGenerator
Expand All @@ -727,7 +727,7 @@ print(result)

#### With the serverless inference API (Inference Providers) and text+image input

{/* test-ignore */}
{/\* test-ignore \*/}

```python
from haystack.components.generators.chat import HuggingFaceAPIChatGenerator
Expand Down Expand Up @@ -756,7 +756,7 @@ print(result)

#### With paid inference endpoints

{/* test-ignore */}
{/\* test-ignore \*/}

```python
from haystack.components.generators.chat import HuggingFaceAPIChatGenerator
Expand All @@ -776,7 +776,7 @@ print(result)

#### With self-hosted text generation inference

{/* test-ignore */}
{/\* test-ignore \*/}

```python
from haystack.components.generators.chat import HuggingFaceAPIChatGenerator
Expand Down Expand Up @@ -955,7 +955,7 @@ LLMs running locally may need powerful hardware.

### Usage example

{/* test-ignore */}
{/\* test-ignore \*/}

```python
from haystack.components.generators.chat import HuggingFaceLocalChatGenerator
Expand Down Expand Up @@ -1876,7 +1876,7 @@ Use the `HuggingFaceAPIChatGenerator` component, which supports the `chat_comple

#### With Hugging Face Inference Endpoints

{/* test-ignore */}
{/\* test-ignore \*/}

```python
from haystack.components.generators import HuggingFaceAPIGenerator
Expand All @@ -1892,7 +1892,7 @@ print(result)

#### With self-hosted text generation inference

{/* test-ignore */}
{/\* test-ignore \*/}

```python
from haystack.components.generators import HuggingFaceAPIGenerator
Expand All @@ -1910,7 +1910,7 @@ Be aware that this example might not work as the Hugging Face Inference API no l
`text_generation` endpoint. Use the `HuggingFaceAPIChatGenerator` for generative models through the
`chat_completion` endpoint.

{/* test-ignore */}
{/\* test-ignore \*/}

```python
from haystack.components.generators import HuggingFaceAPIGenerator
Expand Down
2 changes: 1 addition & 1 deletion docs-website/reference/haystack-api/image_converters_api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ Documents are expected to have metadata containing:

### Usage example

{/* test-ignore */}
{/\* test-ignore \*/}

```python
from haystack import Document
Expand Down
3 changes: 1 addition & 2 deletions docs-website/reference/haystack-api/rankers_api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,8 +28,7 @@ It can be used with a Text Embeddings Inference (TEI) API endpoint:
- [Hugging Face Inference Endpoints](https://huggingface.co/inference-endpoints)

Usage example:

{/* test-ignore */}
{/\* test-ignore \*/}

```python
from haystack import Document
Expand Down
2 changes: 1 addition & 1 deletion docs-website/reference/haystack-api/routers_api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -867,7 +867,7 @@ The labels are specific to each model and can be found it its description on Hug

### Usage example

{/* test-ignore */}
{/\* test-ignore \*/}

```python
from haystack.core.pipeline import Pipeline
Expand Down
2 changes: 1 addition & 1 deletion docs-website/reference/haystack-api/tools_api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ Below is an example of creating a ComponentTool from an existing SerperDevWebSea

## Usage Example:

{/* test-ignore */}
{/\* test-ignore \*/}

```python
from haystack import component, Pipeline
Expand Down
3 changes: 1 addition & 2 deletions docs-website/reference/haystack-api/utils_api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -944,8 +944,7 @@ request_with_retry(
Executes an HTTP request with a configurable exponential backoff retry on failures.

Usage example:

{/* test-ignore */}
{/\* test-ignore \*/}

```python
from haystack.utils import request_with_retry
Expand Down
6 changes: 2 additions & 4 deletions docs-website/reference/haystack-api/websearch_api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,7 @@ slug: "/websearch-api"
Uses [SearchApi](https://www.searchapi.io/) to search the web for relevant documents.

Usage example:

{/* test-ignore */}
{/\* test-ignore \*/}

```python
from haystack.components.websearch import SearchApiWebSearch
Expand Down Expand Up @@ -137,8 +136,7 @@ Uses [Serper](https://serper.dev/) to search the web for relevant documents.
See the [Serper Dev website](https://serper.dev/) for more details.

Usage example:

{/* test-ignore */}
{/\* test-ignore \*/}

```python
from haystack.components.websearch import SerperDevWebSearch
Expand Down
Loading