Skip to content

Commit 4d63087

Browse files
julian-rischclaude
andauthored
docs: remove API leftovers that no longer exist in core (#11949)
Co-authored-by: Claude Fable 5 <noreply@anthropic.com>
1 parent acc9e58 commit 4d63087

11 files changed

Lines changed: 22 additions & 31 deletions

docs-website/docs/pipeline-components/connectors/jinareaderconnector.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -163,7 +163,7 @@ result = pipe.run(
163163
)
164164
print(result)
165165

166-
# {'llm': {'replies': ['The most famous landmark in Berlin is the **Brandenburg Gate**. It is considered the symbol of the city and represents reunification.'], 'meta': [{'model': 'gpt-4o-mini-2024-07-18', 'index': 0, 'finish_reason': 'stop', 'usage': {'completion_tokens': 27, 'prompt_tokens': 4479, 'total_tokens': 4506, 'completion_tokens_details': CompletionTokensDetails(accepted_prediction_tokens=0, audio_tokens=0, reasoning_tokens=0, rejected_prediction_tokens=0), 'prompt_tokens_details': PromptTokensDetails(audio_tokens=0, cached_tokens=0)}}]}}
166+
# {'llm': {'replies': [ChatMessage(_role=<ChatRole.ASSISTANT: 'assistant'>, _content=[TextContent(text='The most famous landmark in Berlin is the **Brandenburg Gate**. It is considered the symbol of the city and represents reunification.')], _name=None, _meta={'model': 'gpt-4o-mini-2024-07-18', 'index': 0, 'finish_reason': 'stop', 'usage': {'completion_tokens': 27, 'prompt_tokens': 4479, 'total_tokens': 4506}})]}}
167167
```
168168

169169
The same component in search mode could also be used in an indexing pipeline.

docs-website/docs/pipeline-components/generators/azureopenaichatgenerator.mdx

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -121,15 +121,12 @@ You can stream output as it’s generated. Pass a callback to `streaming_callbac
121121
```python
122122
from haystack.components.generators.utils import print_streaming_chunk
123123

124-
# Configure any `Generator` or `ChatGenerator` with a streaming callback
125-
component = SomeGeneratorOrChatGenerator(streaming_callback=print_streaming_chunk)
124+
# Configure any `ChatGenerator` with a streaming callback
125+
component = SomeChatGenerator(streaming_callback=print_streaming_chunk)
126126

127-
# If this is a `ChatGenerator`, pass a list of messages:
127+
# Pass a list of messages:
128128
# from haystack.dataclasses import ChatMessage
129129
# component.run([ChatMessage.from_user("Your question here")])
130-
131-
# If this is a (non-chat) `Generator`, pass a prompt:
132-
# component.run({"prompt": "Your prompt here"})
133130
```
134131

135132
:::info

docs-website/docs/pipeline-components/generators/azureopenairesponseschatgenerator.mdx

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -255,15 +255,12 @@ You can stream output as it's generated. Pass a callback to `streaming_callback`
255255
```python
256256
from haystack.components.generators.utils import print_streaming_chunk
257257

258-
# Configure any `Generator` or `ChatGenerator` with a streaming callback
259-
component = SomeGeneratorOrChatGenerator(streaming_callback=print_streaming_chunk)
258+
# Configure any `ChatGenerator` with a streaming callback
259+
component = SomeChatGenerator(streaming_callback=print_streaming_chunk)
260260

261-
# If this is a `ChatGenerator`, pass a list of messages:
261+
# Pass a list of messages:
262262
# from haystack.dataclasses import ChatMessage
263263
# component.run([ChatMessage.from_user("Your question here")])
264-
265-
# If this is a (non-chat) `Generator`, pass a prompt:
266-
# component.run({"prompt": "Your prompt here"})
267264
```
268265

269266
:::info

docs-website/docs/pipeline-components/generators/openaichatgenerator.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -99,7 +99,7 @@ You can stream output as it’s generated. Pass a callback to `streaming_callbac
9999
from haystack.components.generators.chat.openai import OpenAIChatGenerator
100100
from haystack.components.generators.utils import print_streaming_chunk
101101

102-
# Configure any `Generator` or `ChatGenerator` with a streaming callback
102+
# Configure any `ChatGenerator` with a streaming callback
103103
component = OpenAIChatGenerator(streaming_callback=print_streaming_chunk)
104104

105105
# pass a list of messages or a single string to `run()`

docs-website/docs/pipeline-components/generators/openairesponseschatgenerator.mdx

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -223,15 +223,12 @@ You can stream output as it's generated. Pass a callback to `streaming_callback`
223223
```python
224224
from haystack.components.generators.utils import print_streaming_chunk
225225

226-
# Configure any `Generator` or `ChatGenerator` with a streaming callback
227-
component = SomeGeneratorOrChatGenerator(streaming_callback=print_streaming_chunk)
226+
# Configure any `ChatGenerator` with a streaming callback
227+
component = SomeChatGenerator(streaming_callback=print_streaming_chunk)
228228

229-
# If this is a `ChatGenerator`, pass a list of messages:
229+
# Pass a list of messages:
230230
# from haystack.dataclasses import ChatMessage
231231
# component.run([ChatMessage.from_user("Your question here")])
232-
233-
# If this is a (non-chat) `Generator`, pass a prompt:
234-
# component.run({"prompt": "Your prompt here"})
235232
```
236233

237234
:::info

docs-website/docs/pipeline-components/retrievers/elasticsearchhybridretriever.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ A Hybrid Retriever uses both traditional keyword-based search (BM25) and embeddi
1515

1616
| | |
1717
| --- | --- |
18-
| **Most common position in a pipeline** | 1. After a TextEmbedder and before a PromptBuilder in a RAG pipeline 2. The last component in a hybrid search pipeline 3. After a TextEmbedder and before an ExtractiveReader in an extractive QA pipeline |
18+
| **Most common position in a pipeline** | 1. After a TextEmbedder and before a PromptBuilder in a RAG pipeline 2. The last component in a hybrid search pipeline 3. After a TextEmbedder and before a TransformersExtractiveReader in an extractive QA pipeline |
1919
| **Mandatory init variables** | `document_store`: An instance of [`ElasticsearchDocumentStore`](../../document-stores/elasticsearch-document-store.mdx) <br /> <br />`embedder`: Any [Embedder](../embedders.mdx) implementing the `TextEmbedder` protocol |
2020
| **Mandatory run variables** | `query`: A query string |
2121
| **Output variables** | `documents`: A list of documents matching the query |

docs-website/docs/tools/ready-made-tools/githubfileeditortool.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,12 @@
22
title: "GitHubFileEditorTool"
33
id: githubfileeditortool
44
slug: "/githubfileeditortool"
5-
description: "A Tool that allows Agents and ToolInvokers to edit files in GitHub repositories."
5+
description: "A Tool that allows Agents to edit files in GitHub repositories."
66
---
77

88
# GitHubFileEditorTool
99

10-
A Tool that allows Agents and ToolInvokers to edit files in GitHub repositories.
10+
A Tool that allows Agents to edit files in GitHub repositories.
1111

1212
<div className="key-value-table">
1313

docs-website/docs/tools/ready-made-tools/githubissuecommentertool.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,12 @@
22
title: "GitHubIssueCommenterTool"
33
id: githubissuecommentertool
44
slug: "/githubissuecommentertool"
5-
description: "A Tool that allows Agents and ToolInvokers to post comments to GitHub issues."
5+
description: "A Tool that allows Agents to post comments to GitHub issues."
66
---
77

88
# GitHubIssueCommenterTool
99

10-
A Tool that allows Agents and ToolInvokers to post comments to GitHub issues.
10+
A Tool that allows Agents to post comments to GitHub issues.
1111

1212
<div className="key-value-table">
1313

docs-website/docs/tools/ready-made-tools/githubissueviewertool.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,12 @@
22
title: "GitHubIssueViewerTool"
33
id: githubissueviewertool
44
slug: "/githubissueviewertool"
5-
description: "A Tool that allows Agents and ToolInvokers to fetch and parse GitHub issues into documents."
5+
description: "A Tool that allows Agents to fetch and parse GitHub issues into documents."
66
---
77

88
# GitHubIssueViewerTool
99

10-
A Tool that allows Agents and ToolInvokers to fetch and parse GitHub issues into documents.
10+
A Tool that allows Agents to fetch and parse GitHub issues into documents.
1111

1212
<div className="key-value-table">
1313

docs-website/docs/tools/ready-made-tools/githubprcreatortool.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,12 @@
22
title: "GitHubPRCreatorTool"
33
id: githubprcreatortool
44
slug: "/githubprcreatortool"
5-
description: "A Tool that allows Agents and ToolInvokers to create pull requests from a fork back to the original repository."
5+
description: "A Tool that allows Agents to create pull requests from a fork back to the original repository."
66
---
77

88
# GitHubPRCreatorTool
99

10-
A Tool that allows Agents and ToolInvokers to create pull requests from a fork back to the original repository.
10+
A Tool that allows Agents to create pull requests from a fork back to the original repository.
1111

1212
<div className="key-value-table">
1313

0 commit comments

Comments
 (0)