Skip to content

Commit ee7aff4

Browse files
Sync Haystack API reference on Docusaurus (#10863)
Co-authored-by: julian-risch <4181769+julian-risch@users.noreply.github.com>
1 parent 6c73480 commit ee7aff4

6 files changed

Lines changed: 11 additions & 12 deletions

File tree

docs-website/reference/haystack-api/audio_api.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -111,8 +111,7 @@ Transcribes a list of audio files into a list of documents.
111111

112112
```python
113113
transcribe(
114-
sources: list[str | Path | ByteStream],
115-
**kwargs: list[str | Path | ByteStream]
114+
sources: list[str | Path | ByteStream], **kwargs: Any
116115
) -> list[Document]
117116
```
118117

docs-website/reference/haystack-api/builders_api.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -282,7 +282,7 @@ Constructs a ChatPromptBuilder component.
282282
run(
283283
template: list[ChatMessage] | str | None = None,
284284
template_variables: dict[str, Any] | None = None,
285-
**kwargs: dict[str, Any] | None
285+
**kwargs: Any
286286
) -> dict[str, list[ChatMessage]]
287287
```
288288

@@ -298,7 +298,7 @@ To overwrite pipeline kwargs, you can set the `template_variables` parameter.
298298
template.
299299
If `None`, the default template provided at initialization is used.
300300
- **template_variables** (<code>dict\[str, Any\] | None</code>) – An optional dictionary of template variables to overwrite the pipeline variables.
301-
- **kwargs** – Pipeline variables used for rendering the prompt.
301+
- **kwargs** (<code>Any</code>) – Pipeline variables used for rendering the prompt.
302302

303303
**Returns:**
304304

docs-website/reference/haystack-api/connectors_api.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -100,7 +100,7 @@ Invokes a REST endpoint specified in the OpenAPI specification.
100100

101101
```python
102102
patch_request(
103-
self,
103+
self: Operation,
104104
base_url: str,
105105
*,
106106
data: Any | None = None,

docs-website/reference/haystack-api/evaluators_api.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -166,7 +166,7 @@ If no LLM is specified using the `chat_generator` parameter, the component will
166166
#### run
167167

168168
```python
169-
run(**inputs) -> dict[str, Any]
169+
run(**inputs: Any) -> dict[str, Any]
170170
```
171171

172172
Run the LLM evaluator.
@@ -685,7 +685,7 @@ If no LLM is specified using the `chat_generator` parameter, the component will
685685
#### run
686686

687687
```python
688-
run(**inputs) -> dict[str, Any]
688+
run(**inputs: Any) -> dict[str, Any]
689689
```
690690

691691
Run the LLM evaluator.
@@ -837,14 +837,14 @@ Validate the init parameters.
837837
#### run
838838

839839
```python
840-
run(**inputs) -> dict[str, Any]
840+
run(**inputs: Any) -> dict[str, Any]
841841
```
842842

843843
Run the LLM evaluator.
844844

845845
**Parameters:**
846846

847-
- **inputs** – The input values to evaluate. The keys are the input names and the values are lists of input values.
847+
- **inputs** (<code>Any</code>) – The input values to evaluate. The keys are the input names and the values are lists of input values.
848848

849849
**Returns:**
850850

docs-website/reference/haystack-api/generators_api.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -220,7 +220,7 @@ __init__(
220220
AzureADTokenProvider | AsyncAzureADTokenProvider | None
221221
) = None,
222222
http_client_kwargs: dict[str, Any] | None = None
223-
)
223+
) -> None
224224
```
225225

226226
Initialize the Azure OpenAI Chat Generator component.

docs-website/reference/haystack-api/joiners_api.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -255,14 +255,14 @@ Deserializes a `BranchJoiner` instance from a dictionary.
255255
#### run
256256

257257
```python
258-
run(**kwargs) -> dict[str, Any]
258+
run(**kwargs: Any) -> dict[str, Any]
259259
```
260260

261261
Executes the `BranchJoiner`, selecting the first available input value and passing it downstream.
262262

263263
**Parameters:**
264264

265-
- \*\***kwargs** – The input data. Must be of the type declared by `type_` during initialization.
265+
- \*\***kwargs** (<code>Any</code>) – The input data. Must be of the type declared by `type_` during initialization.
266266

267267
**Returns:**
268268

0 commit comments

Comments
 (0)