Skip to content

docs: sync Haystack API reference on Docusaurus #11102

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 14, 2026
+3 −15
Merged

docs: sync Haystack API reference on Docusaurus #11102

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
6 changes: 2 additions & 4 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 @@ -29,8 +29,6 @@ Documents that fail extraction are returned in `failed_documents` with `content_

### Usage example

<!-- test-ignore -->

```python
from haystack import Document
from haystack.components.generators.chat import OpenAIChatGenerator
Expand Down Expand Up @@ -74,8 +72,8 @@ extractor = LLMDocumentContentExtractor(
)

documents = [
Document(content="", meta={"file_path": "/test/test_files/images/image_metadata.png"}),
Document(content="", meta={"file_path": "/test/test_files/images/apple.jpg", "page_number": 1})
Document(content="", meta={"file_path": "test/test_files/images/image_metadata.png"}),
Document(content="", meta={"file_path": "test/test_files/images/apple.jpg", "page_number": 1})
]
result = extractor.run(documents=documents)
updated_documents = result["documents"]
Expand Down
4 changes: 1 addition & 3 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 @@ -2016,8 +2016,6 @@ LLMs running locally may need powerful hardware.

### Usage example

<!-- test-ignore -->

```python
from haystack.components.generators import HuggingFaceLocalGenerator

Expand All @@ -2028,7 +2026,7 @@ generator = HuggingFaceLocalGenerator(
)

print(generator.run("Who is the best American actor?"))
# {'replies': ['John Cusack']}
# >> {'replies': ['John Cusack']}
```

#### __init__
Expand Down
4 changes: 0 additions & 4 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 @@ -697,8 +697,6 @@ if a score is present.

### Usage example

<!-- test-ignore -->

```python
from haystack import Document
from haystack.components.rankers import SentenceTransformersDiversityRanker
Expand Down Expand Up @@ -1018,8 +1016,6 @@ additional features.

### Usage example

<!-- test-ignore -->

```python
from haystack import Document
from haystack.components.rankers import TransformersSimilarityRanker
Expand Down
4 changes: 0 additions & 4 deletions 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 @@ -522,8 +522,6 @@ This component can be used with general-purpose LLMs and with specialized LLMs f

### Usage example

<!-- test-ignore -->

```python
from haystack.components.generators.chat import HuggingFaceAPIChatGenerator
from haystack.components.routers.llm_messages_router import LLMMessagesRouter
Expand Down Expand Up @@ -1008,8 +1006,6 @@ Specify the set of labels for categorization when initializing the component.

### Usage example

<!-- test-ignore -->

```python
from haystack import Document
from haystack.document_stores.in_memory import InMemoryDocumentStore
Expand Down
Loading