Skip to content

Commit 615dfad

Browse files
docs: sync Core Integrations API reference (stackit) on Docusaurus (#12014)
Co-authored-by: julian-risch <4181769+julian-risch@users.noreply.github.com>
1 parent 003fd26 commit 615dfad

15 files changed

Lines changed: 180 additions & 90 deletions

File tree

docs-website/reference/integrations-api/stackit.md

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ slug: "/integrations-stackit"
1313
Bases: <code>OpenAIDocumentEmbedder</code>
1414

1515
A component for computing Document embeddings using STACKIT as model provider.
16+
1617
The embedding of each Document is stored in the `embedding` field of the Document.
1718

1819
Usage example:
@@ -61,10 +62,11 @@ __init__(
6162
meta_fields_to_embed: list[str] | None = None,
6263
embedding_separator: str = "\n",
6364
*,
65+
dimensions: int | None = None,
6466
timeout: float | None = None,
6567
max_retries: int | None = None,
6668
http_client_kwargs: dict[str, Any] | None = None
67-
)
69+
) -> None
6870
```
6971

7072
Creates a STACKITDocumentEmbedder component.
@@ -82,6 +84,8 @@ Creates a STACKITDocumentEmbedder component.
8284
the logs clean.
8385
- **meta_fields_to_embed** (<code>list\[str\] | None</code>) – List of meta fields that should be embedded along with the Document text.
8486
- **embedding_separator** (<code>str</code>) – Separator used to concatenate the meta fields to the Document text.
87+
- **dimensions** (<code>int | None</code>) – The number of dimensions of the resulting embeddings. Only supported by some models -
88+
check the STACKIT model card for the model you are using to see if this parameter is supported.
8589
- **timeout** (<code>float | None</code>) – Timeout for STACKIT client calls. If not set, it defaults to either the `OPENAI_TIMEOUT` environment
8690
variable, or 30 seconds.
8791
- **max_retries** (<code>int | None</code>) – Maximum number of retries to contact STACKIT after an internal error.
@@ -145,10 +149,11 @@ __init__(
145149
prefix: str = "",
146150
suffix: str = "",
147151
*,
152+
dimensions: int | None = None,
148153
timeout: float | None = None,
149154
max_retries: int | None = None,
150155
http_client_kwargs: dict[str, Any] | None = None
151-
)
156+
) -> None
152157
```
153158

154159
Creates a STACKITTextEmbedder component.
@@ -161,6 +166,8 @@ Creates a STACKITTextEmbedder component.
161166
For more details, see STACKIT [docs](https://docs.stackit.cloud/stackit/en/basic-concepts-stackit-model-serving-319914567.html).
162167
- **prefix** (<code>str</code>) – A string to add to the beginning of each text.
163168
- **suffix** (<code>str</code>) – A string to add to the end of each text.
169+
- **dimensions** (<code>int | None</code>) – The number of dimensions of the resulting embeddings. Only supported by some models -
170+
check the STACKIT model card for the model you are using to see if this parameter is supported.
164171
- **timeout** (<code>float | None</code>) – Timeout for STACKIT client calls. If not set, it defaults to either the `OPENAI_TIMEOUT` environment
165172
variable, or 30 seconds.
166173
- **max_retries** (<code>int | None</code>) – Maximum number of retries to contact STACKIT after an internal error.
@@ -203,7 +210,7 @@ Details on the ChatMessage format can be found in the
203210
from haystack_integrations.components.generators.stackit import STACKITChatGenerator
204211
from haystack.dataclasses import ChatMessage
205212

206-
generator = STACKITChatGenerator(model="neuralmagic/Meta-Llama-3.1-70B-Instruct-FP8")
213+
generator = STACKITChatGenerator(model="cortecs/Llama-3.3-70B-Instruct-FP8-Dynamic")
207214

208215
result = generator.run([ChatMessage.from_user("Tell me a joke.")])
209216
print(result)
@@ -214,12 +221,11 @@ print(result)
214221
```python
215222
SUPPORTED_MODELS: list[str] = [
216223
"Qwen/Qwen3-VL-235B-A22B-Instruct-FP8",
224+
"Qwen/Qwen3.6-27B",
217225
"cortecs/Llama-3.3-70B-Instruct-FP8-Dynamic",
218226
"openai/gpt-oss-120b",
219227
"google/gemma-3-27b-it",
220228
"openai/gpt-oss-20b",
221-
"neuralmagic/Mistral-Nemo-Instruct-2407-FP8",
222-
"neuralmagic/Meta-Llama-3.1-8B-Instruct-FP8",
223229
]
224230

225231
```
@@ -243,7 +249,7 @@ __init__(
243249
timeout: float | None = None,
244250
max_retries: int | None = None,
245251
http_client_kwargs: dict[str, Any] | None = None
246-
)
252+
) -> None
247253
```
248254

249255
Creates an instance of STACKITChatGenerator class.

docs-website/reference_versioned_docs/version-2.18/integrations-api/stackit.md

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ slug: "/integrations-stackit"
1313
Bases: <code>OpenAIDocumentEmbedder</code>
1414

1515
A component for computing Document embeddings using STACKIT as model provider.
16+
1617
The embedding of each Document is stored in the `embedding` field of the Document.
1718

1819
Usage example:
@@ -61,10 +62,11 @@ __init__(
6162
meta_fields_to_embed: list[str] | None = None,
6263
embedding_separator: str = "\n",
6364
*,
65+
dimensions: int | None = None,
6466
timeout: float | None = None,
6567
max_retries: int | None = None,
6668
http_client_kwargs: dict[str, Any] | None = None
67-
)
69+
) -> None
6870
```
6971

7072
Creates a STACKITDocumentEmbedder component.
@@ -82,6 +84,8 @@ Creates a STACKITDocumentEmbedder component.
8284
the logs clean.
8385
- **meta_fields_to_embed** (<code>list\[str\] | None</code>) – List of meta fields that should be embedded along with the Document text.
8486
- **embedding_separator** (<code>str</code>) – Separator used to concatenate the meta fields to the Document text.
87+
- **dimensions** (<code>int | None</code>) – The number of dimensions of the resulting embeddings. Only supported by some models -
88+
check the STACKIT model card for the model you are using to see if this parameter is supported.
8589
- **timeout** (<code>float | None</code>) – Timeout for STACKIT client calls. If not set, it defaults to either the `OPENAI_TIMEOUT` environment
8690
variable, or 30 seconds.
8791
- **max_retries** (<code>int | None</code>) – Maximum number of retries to contact STACKIT after an internal error.
@@ -145,10 +149,11 @@ __init__(
145149
prefix: str = "",
146150
suffix: str = "",
147151
*,
152+
dimensions: int | None = None,
148153
timeout: float | None = None,
149154
max_retries: int | None = None,
150155
http_client_kwargs: dict[str, Any] | None = None
151-
)
156+
) -> None
152157
```
153158

154159
Creates a STACKITTextEmbedder component.
@@ -161,6 +166,8 @@ Creates a STACKITTextEmbedder component.
161166
For more details, see STACKIT [docs](https://docs.stackit.cloud/stackit/en/basic-concepts-stackit-model-serving-319914567.html).
162167
- **prefix** (<code>str</code>) – A string to add to the beginning of each text.
163168
- **suffix** (<code>str</code>) – A string to add to the end of each text.
169+
- **dimensions** (<code>int | None</code>) – The number of dimensions of the resulting embeddings. Only supported by some models -
170+
check the STACKIT model card for the model you are using to see if this parameter is supported.
164171
- **timeout** (<code>float | None</code>) – Timeout for STACKIT client calls. If not set, it defaults to either the `OPENAI_TIMEOUT` environment
165172
variable, or 30 seconds.
166173
- **max_retries** (<code>int | None</code>) – Maximum number of retries to contact STACKIT after an internal error.
@@ -203,7 +210,7 @@ Details on the ChatMessage format can be found in the
203210
from haystack_integrations.components.generators.stackit import STACKITChatGenerator
204211
from haystack.dataclasses import ChatMessage
205212

206-
generator = STACKITChatGenerator(model="neuralmagic/Meta-Llama-3.1-70B-Instruct-FP8")
213+
generator = STACKITChatGenerator(model="cortecs/Llama-3.3-70B-Instruct-FP8-Dynamic")
207214

208215
result = generator.run([ChatMessage.from_user("Tell me a joke.")])
209216
print(result)
@@ -214,12 +221,11 @@ print(result)
214221
```python
215222
SUPPORTED_MODELS: list[str] = [
216223
"Qwen/Qwen3-VL-235B-A22B-Instruct-FP8",
224+
"Qwen/Qwen3.6-27B",
217225
"cortecs/Llama-3.3-70B-Instruct-FP8-Dynamic",
218226
"openai/gpt-oss-120b",
219227
"google/gemma-3-27b-it",
220228
"openai/gpt-oss-20b",
221-
"neuralmagic/Mistral-Nemo-Instruct-2407-FP8",
222-
"neuralmagic/Meta-Llama-3.1-8B-Instruct-FP8",
223229
]
224230

225231
```
@@ -243,7 +249,7 @@ __init__(
243249
timeout: float | None = None,
244250
max_retries: int | None = None,
245251
http_client_kwargs: dict[str, Any] | None = None
246-
)
252+
) -> None
247253
```
248254

249255
Creates an instance of STACKITChatGenerator class.

docs-website/reference_versioned_docs/version-2.19/integrations-api/stackit.md

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ slug: "/integrations-stackit"
1313
Bases: <code>OpenAIDocumentEmbedder</code>
1414

1515
A component for computing Document embeddings using STACKIT as model provider.
16+
1617
The embedding of each Document is stored in the `embedding` field of the Document.
1718

1819
Usage example:
@@ -61,10 +62,11 @@ __init__(
6162
meta_fields_to_embed: list[str] | None = None,
6263
embedding_separator: str = "\n",
6364
*,
65+
dimensions: int | None = None,
6466
timeout: float | None = None,
6567
max_retries: int | None = None,
6668
http_client_kwargs: dict[str, Any] | None = None
67-
)
69+
) -> None
6870
```
6971

7072
Creates a STACKITDocumentEmbedder component.
@@ -82,6 +84,8 @@ Creates a STACKITDocumentEmbedder component.
8284
the logs clean.
8385
- **meta_fields_to_embed** (<code>list\[str\] | None</code>) – List of meta fields that should be embedded along with the Document text.
8486
- **embedding_separator** (<code>str</code>) – Separator used to concatenate the meta fields to the Document text.
87+
- **dimensions** (<code>int | None</code>) – The number of dimensions of the resulting embeddings. Only supported by some models -
88+
check the STACKIT model card for the model you are using to see if this parameter is supported.
8589
- **timeout** (<code>float | None</code>) – Timeout for STACKIT client calls. If not set, it defaults to either the `OPENAI_TIMEOUT` environment
8690
variable, or 30 seconds.
8791
- **max_retries** (<code>int | None</code>) – Maximum number of retries to contact STACKIT after an internal error.
@@ -145,10 +149,11 @@ __init__(
145149
prefix: str = "",
146150
suffix: str = "",
147151
*,
152+
dimensions: int | None = None,
148153
timeout: float | None = None,
149154
max_retries: int | None = None,
150155
http_client_kwargs: dict[str, Any] | None = None
151-
)
156+
) -> None
152157
```
153158

154159
Creates a STACKITTextEmbedder component.
@@ -161,6 +166,8 @@ Creates a STACKITTextEmbedder component.
161166
For more details, see STACKIT [docs](https://docs.stackit.cloud/stackit/en/basic-concepts-stackit-model-serving-319914567.html).
162167
- **prefix** (<code>str</code>) – A string to add to the beginning of each text.
163168
- **suffix** (<code>str</code>) – A string to add to the end of each text.
169+
- **dimensions** (<code>int | None</code>) – The number of dimensions of the resulting embeddings. Only supported by some models -
170+
check the STACKIT model card for the model you are using to see if this parameter is supported.
164171
- **timeout** (<code>float | None</code>) – Timeout for STACKIT client calls. If not set, it defaults to either the `OPENAI_TIMEOUT` environment
165172
variable, or 30 seconds.
166173
- **max_retries** (<code>int | None</code>) – Maximum number of retries to contact STACKIT after an internal error.
@@ -203,7 +210,7 @@ Details on the ChatMessage format can be found in the
203210
from haystack_integrations.components.generators.stackit import STACKITChatGenerator
204211
from haystack.dataclasses import ChatMessage
205212

206-
generator = STACKITChatGenerator(model="neuralmagic/Meta-Llama-3.1-70B-Instruct-FP8")
213+
generator = STACKITChatGenerator(model="cortecs/Llama-3.3-70B-Instruct-FP8-Dynamic")
207214

208215
result = generator.run([ChatMessage.from_user("Tell me a joke.")])
209216
print(result)
@@ -214,12 +221,11 @@ print(result)
214221
```python
215222
SUPPORTED_MODELS: list[str] = [
216223
"Qwen/Qwen3-VL-235B-A22B-Instruct-FP8",
224+
"Qwen/Qwen3.6-27B",
217225
"cortecs/Llama-3.3-70B-Instruct-FP8-Dynamic",
218226
"openai/gpt-oss-120b",
219227
"google/gemma-3-27b-it",
220228
"openai/gpt-oss-20b",
221-
"neuralmagic/Mistral-Nemo-Instruct-2407-FP8",
222-
"neuralmagic/Meta-Llama-3.1-8B-Instruct-FP8",
223229
]
224230

225231
```
@@ -243,7 +249,7 @@ __init__(
243249
timeout: float | None = None,
244250
max_retries: int | None = None,
245251
http_client_kwargs: dict[str, Any] | None = None
246-
)
252+
) -> None
247253
```
248254

249255
Creates an instance of STACKITChatGenerator class.

docs-website/reference_versioned_docs/version-2.20/integrations-api/stackit.md

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ slug: "/integrations-stackit"
1313
Bases: <code>OpenAIDocumentEmbedder</code>
1414

1515
A component for computing Document embeddings using STACKIT as model provider.
16+
1617
The embedding of each Document is stored in the `embedding` field of the Document.
1718

1819
Usage example:
@@ -61,10 +62,11 @@ __init__(
6162
meta_fields_to_embed: list[str] | None = None,
6263
embedding_separator: str = "\n",
6364
*,
65+
dimensions: int | None = None,
6466
timeout: float | None = None,
6567
max_retries: int | None = None,
6668
http_client_kwargs: dict[str, Any] | None = None
67-
)
69+
) -> None
6870
```
6971

7072
Creates a STACKITDocumentEmbedder component.
@@ -82,6 +84,8 @@ Creates a STACKITDocumentEmbedder component.
8284
the logs clean.
8385
- **meta_fields_to_embed** (<code>list\[str\] | None</code>) – List of meta fields that should be embedded along with the Document text.
8486
- **embedding_separator** (<code>str</code>) – Separator used to concatenate the meta fields to the Document text.
87+
- **dimensions** (<code>int | None</code>) – The number of dimensions of the resulting embeddings. Only supported by some models -
88+
check the STACKIT model card for the model you are using to see if this parameter is supported.
8589
- **timeout** (<code>float | None</code>) – Timeout for STACKIT client calls. If not set, it defaults to either the `OPENAI_TIMEOUT` environment
8690
variable, or 30 seconds.
8791
- **max_retries** (<code>int | None</code>) – Maximum number of retries to contact STACKIT after an internal error.
@@ -145,10 +149,11 @@ __init__(
145149
prefix: str = "",
146150
suffix: str = "",
147151
*,
152+
dimensions: int | None = None,
148153
timeout: float | None = None,
149154
max_retries: int | None = None,
150155
http_client_kwargs: dict[str, Any] | None = None
151-
)
156+
) -> None
152157
```
153158

154159
Creates a STACKITTextEmbedder component.
@@ -161,6 +166,8 @@ Creates a STACKITTextEmbedder component.
161166
For more details, see STACKIT [docs](https://docs.stackit.cloud/stackit/en/basic-concepts-stackit-model-serving-319914567.html).
162167
- **prefix** (<code>str</code>) – A string to add to the beginning of each text.
163168
- **suffix** (<code>str</code>) – A string to add to the end of each text.
169+
- **dimensions** (<code>int | None</code>) – The number of dimensions of the resulting embeddings. Only supported by some models -
170+
check the STACKIT model card for the model you are using to see if this parameter is supported.
164171
- **timeout** (<code>float | None</code>) – Timeout for STACKIT client calls. If not set, it defaults to either the `OPENAI_TIMEOUT` environment
165172
variable, or 30 seconds.
166173
- **max_retries** (<code>int | None</code>) – Maximum number of retries to contact STACKIT after an internal error.
@@ -203,7 +210,7 @@ Details on the ChatMessage format can be found in the
203210
from haystack_integrations.components.generators.stackit import STACKITChatGenerator
204211
from haystack.dataclasses import ChatMessage
205212

206-
generator = STACKITChatGenerator(model="neuralmagic/Meta-Llama-3.1-70B-Instruct-FP8")
213+
generator = STACKITChatGenerator(model="cortecs/Llama-3.3-70B-Instruct-FP8-Dynamic")
207214

208215
result = generator.run([ChatMessage.from_user("Tell me a joke.")])
209216
print(result)
@@ -214,12 +221,11 @@ print(result)
214221
```python
215222
SUPPORTED_MODELS: list[str] = [
216223
"Qwen/Qwen3-VL-235B-A22B-Instruct-FP8",
224+
"Qwen/Qwen3.6-27B",
217225
"cortecs/Llama-3.3-70B-Instruct-FP8-Dynamic",
218226
"openai/gpt-oss-120b",
219227
"google/gemma-3-27b-it",
220228
"openai/gpt-oss-20b",
221-
"neuralmagic/Mistral-Nemo-Instruct-2407-FP8",
222-
"neuralmagic/Meta-Llama-3.1-8B-Instruct-FP8",
223229
]
224230

225231
```
@@ -243,7 +249,7 @@ __init__(
243249
timeout: float | None = None,
244250
max_retries: int | None = None,
245251
http_client_kwargs: dict[str, Any] | None = None
246-
)
252+
) -> None
247253
```
248254

249255
Creates an instance of STACKITChatGenerator class.

0 commit comments

Comments
 (0)