Skip to main content
For the complete documentation index for agents and LLMs, see llms.txt.

STACKITTextEmbedder

Embeds text strings using STACKIT as the model provider and returns a floating-point embedding vector.

Key Features

  • Embeds text using STACKIT's OpenAI-compatible embedding API.
  • Adds optional prefix and suffix strings to the text before embedding.
  • Configurable timeout, retries, and custom HTTP client settings.

Configuration

Authentication

You need a STACKIT API key to use this component. Create a secret called STACKIT_API_KEY in your workspace. For more information, see Add Secrets.

  1. Drag the STACKITTextEmbedder component onto the canvas from the Component Library.
  2. Click the component to open the configuration panel.
  3. On the General tab:
    1. Enter the name of the STACKIT embedding model to use.
  4. Go to the Advanced tab to configure the API key, API base URL, timeout, maximum retries, and HTTP client settings.

Connections

STACKITTextEmbedder accepts a text string as input and outputs a floating-point embedding vector.

Use this component in query pipelines for semantic search. Connect its embedding output to an embedding retriever.

Usage Example

components:
STACKITTextEmbedder:
type: stackit.src.haystack_integrations.components.embedders.stackit.text_embedder.STACKITTextEmbedder
init_parameters:

Parameters

Inputs

ParameterTypeDefaultDescription

Outputs

ParameterTypeDefaultDescription

Init Parameters

These are the parameters you can configure in Pipeline Builder:

ParameterTypeDefaultDescription
api_keySecretSecret.from_env_var('STACKIT_API_KEY')The STACKIT API key.
modelstrThe name of the STACKIT embedding model to be used.
api_base_urlOptional[str]https://api.openai-compat.model-serving.eu01.onstackit.cloud/v1The STACKIT API Base url. For more details, see STACKIT docs.
prefixstrA string to add to the beginning of each text.
suffixstrA string to add to the end of each text.
timeoutOptional[float]NoneTimeout for STACKIT client calls. If not set, it defaults to either the OPENAI_TIMEOUT environment variable, or 30 seconds.
max_retriesOptional[int]NoneMaximum number of retries to contact STACKIT after an internal error. If not set, it defaults to either the OPENAI_MAX_RETRIES environment variable, or set to 5.
http_client_kwargsOptional[Dict[str, Any]]NoneA dictionary of keyword arguments to configure a custom httpx.Clientor httpx.AsyncClient. For more information, see the HTTPX documentation.

Run Method Parameters

These are the parameters you can configure for the component's run() method. This means you can pass these parameters at query time through the API, in Playground, or when running a job. For details, see Modify Pipeline Parameters at Query Time.

ParameterTypeDefaultDescription